Configuration Properties

This section documents the different configuration properties that can be used when running Atoti Market Risk with DirectQuery enabled.

By default, the properties are defined in the application.yaml file for optimal readability. You can also define these properties in another .yaml or .properties file. If defining in a .properties file, you must specify the full property path.

Properties

Here is a list of all DirectQuery configuration properties available for all Databases:

• directquery
  • enabled
  • withAdjustments
  • database
    • type
    • snowflake
      • connectionString
      • username
      • password
      • warehouse
      • feedingWarehouse
      • database
      • schema
      • role
      • arrayAggWrapperFunctionName
      • additionalOptions
    • clickhouse
      • username
      • password
      • port
      • hostName
      • database
    • mssql
      • username
      • password
      • port
      • hostName
      • database
      • schema
      • encrypt
      • trustServerCertificate
      • connectRetryCount

Common DirectQuery Properties

Base path: directquery

These properties are applied to any database the application is connecting to.

enabled

Default Value: false

Enables DirectQuery. This property must be set to true to run the application against a remote database.

Database Specific Properties

Base path: directquery.database.xxx

These properties are applied to the specific database the application is connecting to and may be unique per database.

type

Default Value: snowflake

The database to use in the current instance of the application. This value must be the name of the database in lowercase.

Snowflake Database Properties

Base path: directquery.database.snowflake

These properties only apply to the Snowflake database.

connectionString

Default Value: ${SNOWFLAKE_CONNECTION_STRING}

The connection string used to connect to the remote Snowflake instance.

username

Default Value: ${SNOWFLAKE_USERNAME}

The username to use to authenticate the connection to Snowflake.

password

Default Value: ${SNOWFLAKE_PASSWORD}

The password to use to authenticate the connection to Snowflake.

warehouse

Default Value: ${SNOWFLAKE_WAREHOUSE}

The warehouse (compute) to use when executing queries on Snowflake.

feedingWarehouse

Default Value: ${SNOWFLAKE_WAREHOUSE}

Special wareHouse used during the feeding.

database

Default Value: ${SNOWFLAKE_DATABASE}

The Snowflake Database to connect to and use for queries.

schema

Default Value: ${SNOWFLAKE_SCHEMA}

The Snowflake Schema to connect to and use for queries.

role

Default Value: ${SNOWFLAKE_ROLE}

The Role with which the specified Database is used. This Role should allow request and use of the specified Warehouse on the specified Schema.

arrayAggWrapperFunctionName

Default Value: empty

Optional name of the User Defined Function that can be used to wrap the ARRAY_AGG operations and improve performance. This function must be defined in Snowflake and accessible to the role running the queries.

additionalOptions

Default Value: empty

Any connection option defined in snowflake documentation represented as a key/value pair under the additionalOptions entry.

ClickHouse Database Properties

Base path: directquery.database.clickhouse

These properties only apply to the ClickHouse database.

username

Default Value: ${CLICKHOUSE_USERNAME}

The optional username to use to authenticate the connection to ClickHouse. If no authentication is defined on your ClickHouse database, these properties can be ignored.

password

Default Value: ${CLICKHOUSE_PASSWORD}

The optional password to use to authenticate the connection to ClickHouse. If no authentication is defined on your ClickHouse database, these properties can be ignored.

port

Default Value: ${CLICKHOUSE_PORT}

The port the ClickHouse database is exposed on.

hostName

Default Value: ${CLICKHOUSE_HOSTNAME}

The hostname the ClickHouse database is hosted from. For example, when running locally, this would be localhost.

database

Default Value: ${CLICKHOUSE_DATABASE}

The ClickHouse Database to connect to and use for queries.

SQL Server Database Properties

Base path: directquery.database.mssql

These properties only apply to the SQL Server database.

username

Default Value: ${MSSQL_USERNAME}

The optional username to use to authenticate the connection to the SQL Server.

password

Default Value: ${MSSQL_PASSWORD}

The optional password to use to authenticate the connection to the SQL Server.

port

Default Value: ${MSSQL_PORT}

The port the SQL Server database is exposed on.

hostName

Default Value: ${MSSQL_HOSTNAME}

The hostname the SQL Server database is hosted from. For example, when running locally, this would be localhost.

database

Default Value: ${MSSQL_DATABASE}

The SQL Server Database to connect to and use for queries.

schema

Default Value: ${MSSQL_SCHEMA}

The SQL Server Schema to connect to and use for queries.

encrypt

Default Value: ${MSSQL_ENCRYPT}

Set to true true if the Secure Sockets Layer (SSL) encryption is enabled between the client and the SQL Server, false otherwise.

trustServerCertificate

Default Value: ${MSSQL_TRUST_SERVER_CERTIFICATE}

Set to true if the SSL certificate should be automatically trusted when the communication layer is encrypted using SSL, false otherwise.

connectRetryCount

Default Value: ${MSSQL_CONNECT_RETRY_COUNT}

The maximum number of attempts to re-establish a broken connection.