databaserepository

This configuration is optional when using the plugin Cadenza.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<databaseRepository
>
required

Settings for accessing the database schema for repositories, and settings for data sources defined without Data Source Templates.

<repositorySchemas
>
optional

Defines the connection settings for accessing one or more database schemas holding repositories. If configured, a Repository List is ignored completely.

<repositorySchema
<schemaId
>
optional
string

Unique technical identifier of the repository schema. Required for each schema if multiple schemas are defined.

</schemaId>
<printName
>
optional
string

Name of the repository schema as it should be displayed on the user interface, e.g. when creating or importing new repositories in the Management Center. Default is the schemaId value.

</printName>
<jdbcURL
>
required
string

JDBC URL of the repository database. Environment variables, system properties and Cadenza variables can be used. The JDBC URL may be parameterized, for example with a schema.

</jdbcURL>
<user
>
required
string

Database user to use when connecting to the database. Environment variables, system properties and Cadenza variables can be used.

</user>
<password
>
required
string

Password of the database user to use when connecting to the database. Environment variables, system properties and Cadenza variables can be used. Usually, the password has to be encoded (see also Secrets in Configuration).

</password>
<connectionPoolSize
>
optional
int

Number of concurrent connections to the database. Environment variables, system properties and Cadenza variables can be used.

Monitoring the available connections helps to find a good value for this parameter (see Database Connection Pools).

Default: 10

</connectionPoolSize>
>
requiredmax. unbounded

Defines the connection settings for accessing a single database schema containing repositories.

</repositorySchema>
</repositorySchemas>
<dataSources
<connectionPool
<maximumConnectionCount
>
optional
int

Maximum number of concurrent connections to the database. Environment variables and system properties can be used. Users can override this setting for individual databases in the Management Center.

Default: 5

</maximumConnectionCount>
<maximumWaitTimeInMilliseconds
>
optional
long

Maximum time (in ms) to wait for a free database connection. Environment variables and system properties can be used. Users can override this setting for individual databases in the Management Center.

Default: 30000

</maximumWaitTimeInMilliseconds>
<idleConnectionTimeoutInMilliseconds
>
optional
long

The time in milliseconds that a connection is allowed to be idle before it is closed and removed. A value of 0 means that connections will never be closed again. Environment variables and system properties can be used.

Default: 60000

</idleConnectionTimeoutInMilliseconds>
<minimumIdleConnectionCount
>
optional
int

The minimum number of idle connections in the pool before a new connection is created. When this number is not reached, new connections are created before they are requested, resulting in better performance for subsequent requests. maximumConnectionCount is never exceeded. Environment variables and system properties can be used.

Default: 2

</minimumIdleConnectionCount>
<validationSqlStatements
>
optional

The statement(s) used to validate connections.

<validationSqlStatement
xsd:string
type
optional
=
string

The type of the RDBMS data source (see docs). If no type is given, then this statement is used for data sources for which no type specific validation statement is configured in here.

>
requiredmax. unbounded
</validationSqlStatement>
</validationSqlStatements>
<validationQueryTimeoutInMilliseconds
>
optional
long

Defines the maximum number of milliseconds the validation of database connections can take. Please note that this setting also takes effect when validationSqlStatement is not provided, since connection pool will validate connection anyway by simply pinging the database server.

Default: 15000

</validationQueryTimeoutInMilliseconds>
>
optional

Configuration of the connection pool settings for RDBMS data sources in database repositories. Used for newly-created data sources and for existing data sources which do not have specific settings persisted.

</connectionPool>
>
optional

Settings for data sources managed in the Management Center without Data Source Templates.

</dataSources>
</databaseRepository>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    databaserepository:
      repositorySchemas:
      - schemaId: "text"
        printName: "text"
        jdbcURL: "text"
        user: "text"
        password: "text"
        connectionPoolSize: 15
      - schemaId: "text"
        printName: "text"
        jdbcURL: "text"
        user: "text"
        password: "text"
        connectionPoolSize: 15
      dataSources:
        connectionPool:
          maximumConnectionCount: 15
          maximumWaitTimeInMilliseconds: 25
          idleConnectionTimeoutInMilliseconds: 25
          minimumIdleConnectionCount: 15
          validationSqlStatements:
          - type: "text"
            value: "text"
          - type: "text"
            value: "text"
          validationQueryTimeoutInMilliseconds: 25

Filename: databaserepository-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<databaseRepository>
  <repositorySchemas>
    <repositorySchema>
      <schemaId>text</schemaId>
      <printName>text</printName>
      <jdbcURL>text</jdbcURL>
      <user>text</user>
      <password>text</password>
      <connectionPoolSize>15</connectionPoolSize>
    </repositorySchema>
    <repositorySchema>
      <schemaId>text</schemaId>
      <printName>text</printName>
      <jdbcURL>text</jdbcURL>
      <user>text</user>
      <password>text</password>
      <connectionPoolSize>15</connectionPoolSize>
    </repositorySchema>
  </repositorySchemas>
  <dataSources>
    <connectionPool>
      <maximumConnectionCount>15</maximumConnectionCount>
      <maximumWaitTimeInMilliseconds>25</maximumWaitTimeInMilliseconds>
      <idleConnectionTimeoutInMilliseconds>25</idleConnectionTimeoutInMilliseconds>
      <minimumIdleConnectionCount>15</minimumIdleConnectionCount>
      <validationSqlStatements>
        <validationSqlStatement type="text">text</validationSqlStatement>
        <validationSqlStatement type="text">text</validationSqlStatement>
      </validationSqlStatements>
      <validationQueryTimeoutInMilliseconds>25</validationQueryTimeoutInMilliseconds>
    </connectionPool>
  </dataSources>
</databaseRepository>