Application properties

How to set

There are several ways how to set system properties:

  • Create application.properties file in the same directory as the application JAR file and set values there. The content of application.properties:

    PROPERTY_NAME = PROPERTY_VALUE

  • Set properties when running a JAR file:

    export PROPERTY_NAME=PROPERTY_VALUE; java -jar app-[version].jar

Properties supported for both API and CLI

  • SECRETS_GCP_SECRET_MANAGER_ENABLED - indicates if Google Cloud Platform Secret Manager is enabled (default: false).

    If this feature is enabled, you can pass JDBC user and password credentials in the following format: {"type": "gcp", "project": "project", "secret": "secret", "version": "version"}, where:

    • project - GCP project ID,

    • secret - Secret Manager secret ID,

    • version (optional, default - latest) - Secret Manager secret version ID.

    Please note that access to GCP should be configured via built-in GCP credentials or by GOOGLE_APPLICATION_CREDENTIALS environment variable.

    If this property is enabled you can see the message Google Secret Manager enabled in the application logs.

    The value of the secret should be a UTF-8 encoded string.

  • TDK_WORKINGDIRECTORY_ENABLED

    If set to true, enables the usage of a directory on a local file system to optimize some TDK internal operations. Enabling this can noticeably increase the TDK throughput at the cost of occupied disk space. In the worst case, the disk space needed will be linear to the size of the input tables. However, there is a way to opt out of using the working directory for some tables (see use_working_directory setting in configuration section).

    If this property is enabled you can see the message Working directory enabled, path: $path in the application logs.

    Currently, the working directory usage will only affect the subsetting mode performance (when TDK is operating in MASKING mode with target_ratio less than 1). In the future, more disk-based optimizations will be added.

    Example:

    TDK_WORKINGDIRECTORY_ENABLED=true

  • TDK_WORKINGDIRECTORY_PATH

    If TDK_WORKINGDIRECTORY_ENABLED is set to true, this setting is mandatory and must contain an existing path to an empty directory which will be used by the TDK to optimize its operations. Although both relative and absolute paths are supported, it is recommended to specify an absolute path to make the operation reproducible regardless of what directory the TDK is run from.

    Example:

    TDK_WORKINGDIRECTORY_PATH=/home/tdk/working-directory

  • TDK_DB_MAXIMUM-POOL-SIZE

    Maximum database connection pool size.

Note: the level of parallelism for data transferring depends on this parameter.

Properties supported only for API

  • DB_URL - internal database JDBC URL (default: jdbc:h2:mem:db).

  • DB_USER - internal database user.

  • DB_PASSWORD - internal database password.

  • SQL_DIALECT - internal database SQL Dialect (default: H2).

  • SERVER_PORT - application port (default: 8081).