The Database configuration category includes the following configurable options:
Use IAM Authentication
Default Query Timeout (Seconds)
Log Abandoned
Max Idle Connections
Connection Max Lifetime (millis)
Max Total Connections
Max Wait (Seconds)
Min Idle Connections
Pool Prepared Statements
Remove Abandoned on Borrow
Remove Abandoned Timeout Seconds
Test Connections on Return
Database Type
Expect database to be writable
Database Password
Database Update Mode
DB Secrets Manager
SQL Parameter Bind Mode
Database Connection URL
Database Username
Default Page Size
FHIR Version
Maximum Page Size
Use ordinal date values for day precision searches.
|
|
Use IAM Authentication |
|
|
|
| BOOLEAN | |
| If enabled, database connections will be authenticated using AWS IAM credentials. See IAM Authentication for more information. | |
|
|
false
|
|
|
|
|
Default Query Timeout (Seconds) |
|
|
|
| NON_NEGATIVE_INTEGER | |
| This setting is the maximum number of seconds that a query may run before being automatically aborted by the database. This setting is a failsafe to prevent overly taxing searches from dominating the database. | |
|
|
60
|
|
|
|
|
Log Abandoned |
|
|
|
| BOOLEAN | |
| Log stack traces for abandoned database connections (default false) | |
|
|
false
|
|
|
|
|
Max Idle Connections |
|
|
|
| NON_NEGATIVE_INTEGER | |
| The maximum number of idle connections to keep in the database connection pool at any given time. | |
|
|
8
|
|
|
|
|
Connection Max Lifetime (millis) |
|
|
|
| POSITIVE_INTEGER | |
| If set, provides the maximum total number of milliseconds that a connection is allowed to live. Any connections that are open for longer will be closed instead of being reused. Note that this setting applies only to idle connections in the pool, it does not affect active database operations even if the timeout is exceeded. Minimum recommended value: 120000 | |
|
|
| (no default) | |
|
|
|
Max Total Connections |
|
|
|
| POSITIVE_INTEGER | |
| The maximum total number of connections to allow the database connection pool to hold at any given time. Set this value carefully as it may negatively impact database performance when set too low or too high. | |
|
|
32
|
|
|
|
|
Max Wait (Seconds) |
|
|
|
| POSITIVE_INTEGER | |
| The maximum number of seconds that a request should wait for a database connection before timing out and aborting. | |
|
|
30
|
|
|
|
|
Min Idle Connections |
|
|
|
| NON_NEGATIVE_INTEGER | |
| The minimum number of idle connections to keep in the database connection pool at any given time. | |
|
|
0
|
|
|
|
|
Pool Prepared Statements |
|
|
|
| BOOLEAN | |
| If enabled, prepared statements will be pooled by the connection pool. Note that when using schema-based multitenancy, Smile CDR may choose to ignore this setting. | |
|
|
false
|
|
|
|
|
Remove Abandoned on Borrow |
|
|
|
| BOOLEAN | |
| Remove abandoned connections when they are borrowed from the pool (default false) | |
|
|
false
|
|
|
|
|
Remove Abandoned Timeout Seconds |
|
|
|
| NON_NEGATIVE_INTEGER | |
| Sets the timeout in seconds before an abandoned connection can be removed (default 300) | |
|
|
300
|
|
|
|
|
Test Connections on Return |
|
|
|
| BOOLEAN | |
| If enabled, connections will be tested for validity when they are being returned to the pool. This adds a small amount of additional overhead, but can be helpful in order to speed up recovery from network and database issues. | |
|
|
true
|
|
|
|
|
Database Type |
|
|
|
| ENUM | |
| Values |
|
|
The database platform being used. Smile CDR supports several relational database platforms for persistence so this setting selects the dialect that is specific to the platform being used. For example, if you are using Postgres 9.4, select the POSTGRES_9_4 dialect.
|
|
|
|
| (no default) | |
|
|
|
Expect database to be writable |
|
|
|
| BOOLEAN | |
| Fail health-check if the database is read-only. | |
|
|
false
|
|
|
|
|
Database Password |
|
|
|
| PASSWORD | |
| Password for the database. | |
|
|
| (no default) | |
|
|
|
Database Update Mode |
|
|
|
| ENUM | |
| Values |
|
| Controls whether Smile CDR should attempt to update the FHIR storage database schema on startup. If the database schema is out of date, Smile CDR automatically runs migration on the FHIR storage schema at startup if the value is "UPDATE" If the value is "NONE", then Smile CDR will abort starting the FHIR storage module if its schema is out of date. When set to "NONE", you should use the "smileutil migrate" command to upgrade the database manually. | |
|
|
UPDATE
|
|
|
|
|
DB Secrets Manager |
|
|
|
| ENUM | |
| Values |
|
| The configured DB connection Secrets Manager provider. | |
|
|
NONE
|
|
|
|
|
SQL Parameter Bind Mode |
|
|
|
| ENUM | |
| Values |
|
| Specifies whether parameters in SQL statements should be inlined or bound to parameters. | |
|
|
NEVER_INLINE
|
|
|
|
|
Database Connection URL |
|
|
|
| STRING | |
|
JDBC Connection URL for the database. The following examples show JDBC URLs for a few different database platforms:
|
|
|
|
| (no default) | |
|
|
|
Database Username |
|
|
|
| STRING | |
| Username for the database. | |
|
|
| (no default) | |
|
|
|
Default Page Size |
|
|
|
| POSITIVE_INTEGER | |
| The default number of resources per page when querying mongo if _count is not provided. If not specified, will be set to 20. | |
|
|
20
|
|
|
|
|
FHIR Version |
|
|
|
| ENUM | |
| Values |
|
| The version of FHIR to support in this module | |
|
|
R4
|
|
|
|
|
Maximum Page Size |
|
|
|
| POSITIVE_INTEGER | |
| The maximum allowable value for _count. Higher values of _count will be reduced to this value. If not specified, will be set to 100. | |
|
|
100
|
|
|
|
|
Use ordinal date values for day precision searches. |
|
|
|
| BOOLEAN | |
| If enabled, causes date search params with DAY precision to rely on the ordinal versions of the dates. | |
|
|
true
|
|
|