Rds.json
Cautions¶
When changing parameters, please refer to "Confirmation When Changing Parameters".
Setting Values¶
The setting values of this parameter file are as follows.
| Parameter name | e.g. | Description |
|---|---|---|
| Dbms | "SQLServer" | Specify "SQLServer" or "PostgreSQL" according to the database you are using. In the .NET Framework version, you cannot change from "SQLServer". |
| Provider | "Local" | Normally, specify "Local". Specify "Azure" when using Azure SQL Database. |
| SaConnectionString | sa authority connection string | Specify the connection string to connect to the database instance with sa authority. |
| OwnerConnectionString | dbowner authority connection string | Specify the connection string to connect to the Pleasanter database with dbowner authority. |
| UserConnectionString | dbreader,dbwriter authority connection string | Specify the connection string to connect to the Pleasanter database with dbreader,dbwriter authority. |
| SqlCommandTimeOut | 600 | Specify the timeout time of the SQL command in seconds. |
| MinimumTime | 3 | Specify the minimum time unit that the database can identify in milliseconds. This parameter cannot be changed. |
| DeadlockRetryCount | 4 | Specify the maximum number of retries when a deadlock occurs. |
| DeadlockRetryInterval | 1000 | Specify the interval in milliseconds until retrying when a deadlock occurs. |
| DisableIndexChangeDetection | false | Specify true if you do not want to detect differences in database indexes when upgrading. Specify true to prevent the indexes you set up when setting indexes manually. |
| SysLogsSchemaVersion | 1 | Specify 2 if you are using the "System Log Extended Function". |
MySqlConnectingHost Setting Values¶
-
When building an environment where MySQL and Pleasanter coexist on the same server
Condition Setting value When there are no particular requirements below (default) "%" When prohibiting access to MySQL from external hosts "localhost" -
When building MySQL and Pleasanter on separate servers
Condition Setting value When there are no particular requirements below (default) "%" When allowing access to MySQL only from specified external hosts "Host name / IP address allowed to connect". Multiple values can be specified, separated by half-width commas (e.g., "hostname01,hostname02") Additional steps are required when building MySQL and Pleasanter on separate servers. For details, see "Configure MySQL to be used in a configuration where the web server and DB server are separated (Ver.1.4.18.0 and later)".
How to Register in System Environment Variables¶
SaConnectionString, OwnerConnectionString, UserConnectionString, and MySqlConnectingHost can be registered in system environment variables. For registration in system environment variables, also refer to the following page.
Register Credentials in System Environment Variables
1. Naming Convention¶
The naming convention of the system environment variables for connection strings is as follows.
| Column | Required | Description |
|---|---|---|
| Service name | ○ | Specify "EnvironmentName" or "Name" in Service.json |
| Database type | Specify one of the following values. "SQLServer", "PostgreSQL", "MySQL" | |
| User type | Specify one of the following values. "Sa", "Owner", "User" |
The user type and the database type can be omitted.
You can also set the values in this parameter file as before. For Azure, you can add or edit these values via [App Service Settings] -> [Configuration] -> [Application Settings].
Example Settings for SaConnectionString¶
| Database | Variable | Value |
|---|---|---|
| SQL Server | Implem.Pleasanter_Rds_SQLServer_SaConnectionString | Server=(local);Database=master;UID=sa;PWD=＜password you set＞;Connection Timeout=30; |
| PostgreSQL | Implem.Pleasanter_Rds_PostgreSQL_SaConnectionString | Server=localhost;Database=postgres;UID=postgres;PWD=＜password you set＞ |
Example Settings for OwnerConnectionString¶
| Database | Variable | Value |
|---|---|---|
| SQL Server | Implem.Pleasanter_Rds_SQLServer_OwnerConnectionString | Server=(local);Database=#ServiceName#;UID=#ServiceName#_Owner;PWD=＜password you set＞;Connection Timeout=30; |
| PostgreSQL | Implem.Pleasanter_Rds_PostgreSQL_OwnerConnectionString | Server=localhost;Database=#ServiceName#;UID=#ServiceName#_Owner;PWD=＜password you set＞ |
Example Settings for UserConnectionString¶
| Database | Variable | Value |
|---|---|---|
| SQL Server | Implem.Pleasanter_Rds_SQLServer_UserConnectionString | Server=(local);Database=#ServiceName#;UID=#ServiceName#_User;PWD=＜password you set＞;Connection Timeout=30; |
| PostgreSQL | Implem.Pleasanter_Rds_PostgreSQL_UserConnectionString | Server=localhost;Database=#ServiceName#;UID=#ServiceName#_User;PWD=＜password you set＞ |
Example Settings for MySqlConnectingHost¶
| Variable | Example |
|---|---|
| Implem.Pleasanter_Rds_MySqlConnectingHost | 192.168.1.100 |
2. Priority Order¶
If a value is set in both this parameter file and the system environment, or if it is set in an abbreviated form, the priority is as follows.
SaConnectionString Priority Order¶
| Priority order | Set value |
|---|---|
| 1 | "SaConnectionString" in this parameter file |
| 2 | "（Service name）Rds（Database type）_SaConnectionString" in the environment variable |
| 3 | "（Service name）Rds（Database type）_ConnectionString" in the environment variable |
| 4 | "（Service name）_Rds_SaConnectionString" in the environment variable |
| 5 | "（Service name）_Rds_ConnectionString" in the environment variable |
OwnerConnectionString Priority Order¶
| Priority order | Set value |
|---|---|
| 1 | "OwnerConnectionString" in this parameter file |
| 2 | "（Service name）Rds（Database type）_OwnerConnectionString" in the environment variable |
| 3 | "（Service name）Rds（Database type）_ConnectionString" in the environment variable |
| 4 | "（Service name）_Rds_OwnerConnectionString" in the environment variable |
| 5 | "（Service name）_Rds_ConnectionString" in the environment variable |
UserConnectionString Priority Order¶
| Priority order | Set value |
|---|---|
| 1 | "UserConnectionString" in this parameter file |
| 2 | "（Service name）Rds（Database type）_UserConnectionString" in the environment variable |
| 3 | "（Service name）Rds（Database type）_ConnectionString" in the environment variable |
| 4 | "（Service name）_Rds_UserConnectionString" in the environment variable |
| 5 | "（Service name）_Rds_ConnectionString" in the environment variable |
MySqlConnectingHost Priority Order¶
| Priority order | Set value |
|---|---|
| 1 | "MySqlConnectingHost" in this parameter file |
| 2 | "（Service name: EnvironmentName）_Rds_MySqlConnectingHost" in the environment variable |
| 3 | "（Service name: Name）_Rds_MySqlConnectingHost" in the environment variable |
3. Notes When Registering in System Environment Variables¶
As described in "2. Priority Order", the value set in the parameter file takes the highest priority. Therefore, when you register a value in a system environment variable, specify "null" in the parameter file.
Supported Versions¶
| Supported versions | Body |
|---|---|
| 1.4.9.0 and later | Supports MySQL |
| 1.4.18.0 and later | Added MySqlConnectingHost |