Jdbc (Section)#

Path: /facilities/data-sources/data-source{id}/jdbc

Parameters#

NameTypeRequiredDefaultDescription
attribute-querystringoptionalSELECT linked_accounts.* FROM linked_accounts JOIN accounts ON accounts.account_id = linked_accounts.account_id WHERE accounts.username = :subjectA custom search query for attribute searches. It should contain a statement that marks the subject as :subject to be the replaced variable. Example: SELECT * FROM user_attributes WHERE subject = :subject. :subject will be mapped against the value given when the query is called.
connection-stringstringrequiredThe JDBC connection string.
connection-timeoutint64optional30000The time in milliseconds that a client waits for a connection from the pool before giving up.
driverunionrequiredThe JDBC driver to use. Must be present in the $IDSVR_HOME/lib/plugins/data.access.jdbc directory when the plugin is loaded. The ones listed are those shipped with the server.
enable-pool-metricsbooleanoptionalfalseWhether connection pool metrics are published by the server.
idle-timeoutint64optional600000The maximum amount of time in milliseconds that a connection is allowed to sit idle in the pool. A value of 0 means that idle connections are never removed from the pool.
max-lifetimeint64optional1800000The maximum lifetime in milliseconds of a connection in the pool. When a connection reaches this timeout it will be retired from the pool, subject to a maximum variation of +30 seconds. We strongly recommend setting this value, and it should be at least 30 seconds less than any database-level connection timeout.
max-pool-sizeint32optional20Maximum number of connections to keep in the connection pool, counting both idle and active.
min-idle-pool-sizeint32optional10Minimum number of connections to keep in the connection pool.
multi-tenant-modebooleanoptionalfalseWhen enabled the JDBC data source stores data for multiple tenants and all issued queries will isolate results for tenant configured on profile or parent service. The database schema needs to be migrated before enabling multi-tenant mode. When false, the database only stores data for default tenant.
passwordstringoptionalPassword to use when connecting to this data source.
use-for-auditbooleanoptionalfalseWhen this is set to true, this JDBC data source will be used by log4j2 to store audit messages
usernamestringoptionalUsername to use when connecting to this data source.

Subsections#

NameTypeDescription
credentials-mode OneOfNone

Was this helpful?

New Documentation Site Available!


Check out our new docs at curity.io/docs/identity-server/