Skip to content

Database Configuration

If you'll be using the SQL Agent, the SQL Server database environment must be configured using the Database property in MasterConfig.json.

Database Configuration
{
  "Database": {
    "Server": "localhost",
    "Database": "KafkaReplication",
    "User": "KafkaReplicator",
    "Password": "p@ssw0rd",
    "AdminUser": "sa",
    "AdminPassword": "p@ssw0rd",
    "BatchSize": 10000,
    "BatchTimeoutSeconds": 0,
    "CompressionMode": "None",
    "RetryDelaySeconds": 30,
    "RetryMax": 10,
    "TimeoutSeconds": 60,
    "LoadTimeoutSeconds": 1800,
    "MasterKeyDecryptionPassword": "p@ssw0rd",
    "S3CredentialName": "S3Credential",
    "S3DataSourceName": "MinioDataSource",
    "Sql2022TimeProcessing": false
  }
}

Configuration Properties

Property Type Description
Server String The DNS name or TCP/IP address of the SQL Server.
Database String The name of the SQL Server database.
User String The SQL Server user account to use to connect to the database.
Password String The password of the SQL Server user account.
AdminUser String The name of a SQL Server user account that has admin rights (sysadmin or serveradmin).
AdminPassword String The password to the SQL Server admin account.
BatchSize Integer When processing changes, the number of change operations to include in a batch before committing the batch.
BatchTimeoutSeconds Integer When processing changes, the number of seconds to wait from the creation of a transaction until the transaction is committed.
CompressionMode String The compression mode to use: None, Page, or Row.
RetryDelaySeconds Integer In the case of a failure to communicate with the database, the number of seconds to wait before retrying the operation.
RetryMax Integer In the case of a failure to communicate with the database, the number of retry attempts to make before failing.
TimeoutSeconds Integer When communicating with the database, the number of seconds to wait before considering a general operation to have timed out.
LoadTimeoutSeconds Integer When communicating with the database, the number of seconds to wait before considering a bulk load operation to have timed out.
MasterDecryptionPassword String The master encryption password to use with the database (PolyBase).
S3CredentialName String The name of the credential to use when communicating with an external data sources (PolyBase).
S3DataSourceName String The name of the external data source to use when communicating with an external data source (PolyBase).
Sql2022TimeProcessing Boolean If SQL Server 2022 is in use, set to true to enable a workaround for a time processing bug in that version (PolyBase).