Skip to main content

Database Parameter Reference

This section contains reference information on the relevant Designer Cloud Powered by Trifacta platform parameters that can be modified for each database.

Note

Defaults are listed below. The default database server is PostgreSQL. If you have installed databases on a different server, updates are required.

Note

Parameters that you specify through the application must match the values that were applied to the database at the time of creation or that have been set through the database administration console.

Tip

You should modify the default password for each database.

Tip

The maxPoolSize for each database should be greater than or equal to the thread pool size for the related service. Otherwise, under heavy loads, database connection timeouts can be expected.

Parameters can be modified through:

  • Admin Settings Page: If the application is working, then you are able to connect to the Alteryx database. Parameters can be modified by an administrator from within the application. See Admin Settings Page.

    Tip

    This method is recommended.

  • trifacta-conf.json: If the application is not working, then an administrator must modify through the following file on the Alteryx node:

    trifacta-conf.json

  • For more information, see Platform Configuration Methods in the Configuration Guide.

Alteryx database

"webapp.database.username": "trifacta",
"webapp.database.logging": false,
"webapp.database.name": "trifacta",
"webapp.database.host": "localhost",
"webapp.database.password": "<pwd_trifactaDB>",
"webapp.database.type": "postgresql",
"webapp.database.port": 5432,
"webapp.database.mySqlServerTimezone": "",
"webapp.database.pool.maxIdleTimeInMillis": 30000,
"webapp.database.pool.maxConnections": 10,

The following parameters apply to the Alteryx database only:

Parameter

Description

logging

Set this value to true to enable logging on the Alteryx database.

pool.maxIdleTimeInMillis

Specifies the maximum permitted idle time for a database connection before it is automatically closed.

pool.maxConnections

Defines the maximum permitted database connections for the Alteryx database.

Jobs database

Modify the batch-job-runner.database settings:

"batch-job-runner.database.username": "trifactaactiviti", 
"batch-job-runner.database.name": "trifacta-activiti", 
"batch-job-runner.database.type": "postgresql", 
"batch-job-runner.database.driver": "org.postgresql.Driver", 
"batch-job-runner.database.host": "localhost", 
"batch-job-runner.database.password": "<pwd_trifactaactivitiDB>", 
"batch-job-runner.database.port": 5432,
"batch-job-runner.database.mySqlServerTimezone": "",
"batch-job-runner.database.verifyServerCertificate": false,
"batch-job-runner.database.poolMaxSize": 32,
"batch-job-runner.database.additionalConnectionProperties": "",

Jobs database thread pool size

The database thread pool size should be configured in conjunction with the other pool sizes for Batch Job Runner. For more information, see Configure Batch Job Runner.

Scheduling Service database

"scheduling-service.database.type": "POSTGRESQL",
"scheduling-service.database.host": "localhost",
"scheduling-service.database.port": "5432",
"scheduling-service.database.name": "trifactaschedulingservice",
"scheduling-service.database.username": "trifactaschedulingservice",
"scheduling-service.database.password": "<pwd_schedulingserviceDB>",
"scheduling-service.database.mySqlServerTimezone": "",
"scheduling-service.database.verifyServerCertificate": false,
"scheduling-service.database.poolMaxSize": 20,
"scheduling-service.database.additionalConnectionProperties": "",

Time-based Trigger Service database

"time-based-trigger-service.database.type": "POSTGRESQL",
"time-based-trigger-service.database.host": "localhost",
"time-based-trigger-service.database.port": "5432",
"time-based-trigger-service.database.name": "trifactatimebasedtriggerservice",
"time-based-trigger-service.database.username": "trifactatimebasedtriggerservice",
"time-based-trigger-service.database.password": "<pwd_triggerserviceDB>",
"time-based-trigger-service.database.mySqlServerTimezone": "",
"time-based-trigger-service.database.verifyServerCertificate": false,
"time-based-trigger-service.database.poolMaxSize": 20,
"time-based-trigger-service.database.additionalConnectionProperties": "",

Configuration Service database

"configuration-service.database.type": "POSTGRESQL",
"configuration-service.database.host": "localhost",
"configuration-service.database.port": "5432",
"configuration-service.database.name": "trifactaconfigurationservice",
"configuration-service.database.username": "trifactaconfigurationservice",
"configuration-service.database.password": "<pwd_trifactaconfigurationserviceDB>",
"configuration-service.database.mySqlServerTimezone": "",
"configuration-service.database.verifyServerCertificate": false,
"configuration-service.database.poolMaxSize": 20,
"configuration-service.database.additionalConnectionProperties": "",

Artifact Storage Service database

"artifact-storage-service.database.type": "POSTGRESQL",
"artifact-storage-service.database.host": "localhost",
"artifact-storage-service.database.port": "5432",
"artifact-storage-service.database.name": "trifactaartifactstorageservice",
"artifact-storage-service.database.username": "trifactaartifactstorageservice",
"artifact-storage-service.database.password": "<pwd_trifactaartifactstorageserviceDB>",
"artifact-storage-service.database.mySqlServerTimezone": "",
"artifact-storage-service.database.verifyServerCertificate": false,
"artifact-storage-service.database.poolMaxSize": 20,
"artifact-storage-service.database.additionalConnectionProperties": "",

Job Metadata Service database

"job-metadata-service.database.type": "POSTGRESQL",
"job-metadata-service.database.host": "localhost",
"job-metadata-service.database.port": "5432",
"job-metadata-service.database.name": "trifactajobmetadataservice",
"job-metadata-service.database.username": "trifactajobmetadataservice",
"job-metadata-service.database.password": "<pwd_trifactajobmetadataserviceDB>",
"job-metadata-service.database.mySqlServerTimezone": "",
"job-metadata-service.database.verifyServerCertificate": false,
"job-metadata-service.database.poolMaxSize": 20,
"job-metadata-service.database.additionalConnectionProperties": "",

Authorization Service database

"authorization-service.database.type": "POSTGRESQL",
"authorization-service.database.host": "localhost",
"authorization-service.database.port": "5432",
"authorization-service.database.name": "trifactaauthorizationservice",
"authorization-service.database.username": "trifactaauthorizationservice",
"authorization-service.database.password": "<pwd_trifactaauthorizationserviceDB>",
"authorization-service.database.mySqlServerTimezone": "",
"authorization-service.database.verifyServerCertificate": false,
"authorization-service.database.poolMaxSize": 20,
"authorization-service.database.additionalConnectionProperties": "",

Orchestration Service database

"orchestration-service.database.type": "POSTGRESQL",
"orchestration-service.database.host": "localhost",
"orchestration-service.database.port": "5432",
"orchestration-service.database.name": "trifactaorchestrationservice",
"orchestration-service.database.username": "trifactaorchestrationservice",
"orchestration-service.database.password": "<pwd_trifactaorchestrationserviceDB>",
"orchestration-service.database.mySqlServerTimezone": "",
"orchestration-service.database.verifyServerCertificate": false,
"orchestration-service.database.poolMaxSize": 20,
"orchestration-service.database.additionalConnectionProperties": "",

Optimizer Service database

"optimizer-service.database.type": "POSTGRESQL",
"optimizer-service.database.host": "localhost",
"optimizer-service.database.port": "5432",
"optimizer-service.database.name": "trifactaoptimizerservice",
"optimizer-service.database.username": "trifactaoptimizerservice",
"optimizer-service.database.password": "<pwd_trifactaoptimizerservice>",
"optimizer-service.database.mySqlServerTimezone": "",
"optimizer-service.database.verifyServerCertificate": false,
"optimizer-service.database.poolMaxSize": 20,
"optimizer-service.database.additionalConnectionProperties": "",

Secure Token Service database

"secure-token-service.database.type": "POSTGRESQL",
"secure-token-service.database.host": "localhost",
"secure-token-service.database.port": "5432",
"secure-token-service.database.name": "trifactasecuretokenservice",
"secure-token-service.database.username": "trifactasecuretokenservice",
"secure-token-service.database.password": "<pwd_trifactasecuretokenservice>",
"secure-token-service.database.mySqlServerTimezone": "",
"secure-token-service.database.verifyServerCertificate": false,
"secure-token-service.database.poolMaxSize": 20,
"secure-token-service.database.additionalConnectionProperties": "",

Connector Configuration Service database

"connector-configuration-service.database.type": "POSTGRESQL",
"connector-configuration-service.database.host": "localhost",
"connector-configuration-service.database.port": "5432",
"connector-configuration-service.database.name": "trifactaconnectorconfigservice",
"connector-configuration-service.database.username": "trifactaconnectorconfigservice",
"connector-configuration-service.database.password": "<pwd_trifactaconnectorconfigservice>",
"connector-configuration-service.database.mySqlServerTimezone": "",
"connector-configuration-service.database.verifyServerCertificate": false,
"connector-configuration-service.database.poolMaxSize": 20,
"connector-configuration-service.database.additionalConnectionProperties": "",

Parameter Reference

The following generalized parameters apply to one or more of the databases.

Parameter

Description

host

Host of the database. Default value is localhost, meaning the database is hosted on the Alteryx node.

port

Port number for the database. Default value is 5432 for all databases, assuming that they are PostgreSQL.

Modify this value accordingly if you have installed the databases onto a different type of database server.

name

Name of the database. This value should match what was used during installation.

user or username

The username to use to connect to the database.

password

Password to use to connect to the database.

Note

For each database, you should change the default password.

This change must also be applied on the database server.

type

The default database type is POSTGRESQL.

Note

Modify this value accordingly if you have installed the databases onto a different type of database server.

Note

H2 database type is used for internal testing. It is not a supported database.

driver

Name of the database. Do not modify.

mySqlServerTimezone

(mySQL DBs only) If populated, the MySQL connection string for the database is augmented with the specified timezone, which overrides the default mapping/detection of the timezone.

If empty, the default MySQL timezone settings are used for the database.

Note

Leave this value as empty if the Trifacta node and your MySQL databases are located in the same timezone.

For more information, see Install Databases for MySQL.

verifyServerCertificate

When true, the local database client does not check the validity of the database server certificate when connecting.

Default is false.

Note

Do not modify unless necessary for connectivity.

poolMaxSize

Maximum number of threads permitted in the connection pool for the database. Default is 20.

Note

Do not modify unless necessary.

additionalConnectionProperties

Additional query parameters can be appended to the connection URL in the following form:

param1Name=param1Value&param2Name=param2Value