Configuration options

Set configuration options to customize your Db2® Warehouse environment. Some configuration options can be set only during deployment.

Configuration options that can be set only during deployment

Table 1. Configuration options that can be set only during deployment
DB_CODESET=code_set

This option specifies the code set. The default value is UTF-8. For the complete list of values, see the code set columns in the tables in Supported territory codes and code pages.

You can change the value of the DB_CODESET option only if you use the docker run or podman run command in the following two cases:
  • If you are deploying Db2 Warehouse for the first time
  • If you are redeploying Db2 Warehouse and do not remove the container first
Changing the value of the DB_CODESET option does not take effect if you use the docker run or podman run command in the following two cases:
  • If you are updating Db2 Warehouse
  • If you remove the container before issuing the docker run or podman run command (so your data remains intact)
DB_COLLATION_SEQUENCE=collation_sequence

This option specifies the collating sequence. The default value is IDENTITY. For the complete list of values, see the collation columns in the tables in Supported territory codes and code pages.

Specify the collating sequence by using the SYSTEM_number value, such as SYSTEM_819, or the SYSTEM_number_territoryID value, such as SYSTEM_923_DK.

You can change the value of this option only if you use the docker run or podman run command in the following two cases:
  • If you are deploying Db2 Warehouse for the first time
  • If you are redeploying Db2 Warehouse and do not remove the container first
Changing the value of this option does not take effect if you use the docker run or podman run command in the following two cases:
  • If you are updating Db2 Warehouse
  • If you remove the container before issuing the docker run or podman run command (so your data remains intact)
DB_PAGE_SIZE=size
When the value of the TABLE_ORG option is ROW, use the DB_PAGE_SIZE option to set the page size in bytes:
  • 4 K, 8 K, 16 K (the default), or 32 K
  • 4096, 8192, 16384, or 32768
When the value of the TABLE_ORG option is COLUMN, the only values that are allowed for DB_PAGE_SIZE are 32 K (the default) or 32768.
DB_TERRITORY=territory

This option specifies the territory identifier. The default value is US. For the complete set of values, see the territory identifiers in the descriptions of the tables in Supported territory codes and code pages.

You can change the value of this option only if you use the docker run or podman run command in the following two cases:
  • If you are deploying Db2 Warehouse for the first time
  • If you are redeploying Db2 Warehouse and do not remove the container first
Changing the value of this option does not take effect if you use the docker run or podman run command in the following two cases:
  • If you are updating Db2 Warehouse
  • If you remove the container before issuing the docker run or podman run command (so your data remains intact)
ENABLE_ORACLE_COMPATIBILITY=NO|YES

By default, Oracle compatibility is not enabled. To enable applications that were written for an Oracle database to use Db2 Warehouse without having to be a rewritten, set this option to YES.

Setting this option to YES takes effect only if you use the docker run or podman run command in the following two cases:
  • If you are deploying Db2 Warehouse for the first time
  • If you are redeploying Db2 Warehouse and do not remove the container first
Setting this option to YES does not take effect if you use the docker run or podman run command in the following two cases:
  • If you are updating Db2 Warehouse
  • If you remove the container before issuing the docker run or podman run command (so your data remains intact)

If you change the value of this option to YES, you cannot change the value back to NO.

For more information about Oracle compatibility, see Compatibility features for Oracle.
TABLE_ORG=ROW|COLUMN

By default, this option is set to COLUMN, which means that tables in the Db2 Warehouse database use column-organized storage. Column-organized storage is best for analytic workloads. If you prefer to use row-organized storage, set this option to ROW when deploying Db2 Warehouse. Row-organized of storage is best for OLTP workloads.

The following restrictions apply:
  • You can change the value of this option only when you first deploy Db2 Warehouse.
  • If this option is set to COLUMN, the value of the DB_COLLATION_SEQUENCE option must be IDENTITY, which is the default. Also, the value of the DB_CODESET option must be UTF-8 (the default) or ISO8859-1.
RUNTIME_ENV=LOCAL|CLOUD
The type of runtime environment:
LOCAL
The high availability capability provided by Db2 Warehouse is used. Specify this option when the underlying database is located on local hardware, not in a cloud environment.
CLOUD
The high availability capability provided by Db2 Warehouse is de-activated, and the high availability capability provided by the data repository (for example, AWS, GCP, or Kubernetes) is used instead. Specify this option when the underlying database is located in the cloud.

Configuration options that can be set during or after deployment

Table 2. Configuration options that can be set during or after deployment
DISABLE_SPARK=NO|YES

The Db2 Warehouse product contains an integrated Apache Spark environment. Spark is disabled by default.

If you want to use Spark with Db2 Warehouse, enable Spark by setting the DISABLE_SPARK option to NO. When Spark is enabled, the amount of system memory that is reserved for Spark applications depends on the total amount of system memory:

  • If system memory is < 128 GB, 10% is reserved for Spark applications.
  • If system memory is ≥ 128 GB and < 256 GB, 15% is reserved for Spark applications.
  • If system memory is ≥ 256 GB, 20% is reserved for Spark applications.
GUARDIUM_INFO=collector_IPaddr_or_hostname[:collector_port]

IBM® Security Guardium® software helps provide comprehensive data protection. You can use this option to specify a Guardium collector. For the collector, specify either the IP address or host name, optionally followed by a colon and the port number of the collector. If you do not specify a port number, port 16018 if is used if TLS can be used to communicate with the collector; otherwise, port 16016 is used for plain-text communication.
SSL_CERT_CA_FILE=path_to_file

This option can be set only from version v11.5.4.0-CN2.

The certificate authority (CA) certificate that signs the SSL certificate that is to be used by Db2 SSL connections. The path_to_file must be in the persistent host volume and specified from the perspective of the container. For example, if you place the file at host_volume/scratch/customCA.pem, specify SSL_CERT_CA_FILE=/mnt/bludata0/scratch/customCA.pem. If you specify this option, either the SSL_CERT_FILE and SSL_CERT_KEY_FILE options, or the SSL_CERT_DB_FILE option are also required.
SSL_CERT_FILE=path_to_file

This option can be set only from version v11.5.4.0-CN2.

The public key certificate that is to be used for Db2 SSL connections. This certificate should be signed by the certificate that is specified through SSL_CERT_CA_FILE. The path_to_file must be in the persistent host volume and specified from the perspective of the container. For example, if you place the file at host_volume/scratch/customCert.pem, specify SSL_CERT_FILE=/mnt/bludata0/scratch/customCert.pem. If you specify this option, the SSL_CERT_KEY_FILE and SSL_CERT_CA_FILE options are also required.
SSL_CERT_KEY_FILE=path_to_file

This option can be set only from version v11.5.4.0-CN2.

The private key that is to be used for Db2 SSL connections. The path_to_file must be in the persistent host volume and specified from the perspective of the container. For example, if you place the file at host_volume/scratch/customKey.key, specify SSL_CERT_KEY_FILE=/mnt/bludata0/scratch/customKey.key. If you specify this option, the SSL_CERT_FILE and SSL_CERT_CA_FILE options are also required.
SSL_CERT_DB_FILE=path_to_file

This option can be set only from version v11.5.4.0-CN2.

A Public Key Cryptography Standards (PKCS) file that contains the public key certificate and the private key to be used for Db2 SSL connections. The path_to_file must be in the persistent host volume and specified from the perspective of the container. For example, if you place the file at host_volume/scratch/customCert.p12, specify SSL_CERT_DB_FILE=/mnt/bludata0/scratch/customCert.p12. If you specify this option, the SSL_CERT_CA_FILE and SSL_CERT_PASSWD_FILE options are also required.
SSL_CERT_PASSWD_FILE=path_to_file

This option can be set only from version v11.5.4.0-CN2.

A file that contains the password of the key file or PCKS database. The file is required if the private key is encrypted, or if a .p12 is specified. The path_to_file must be in the persistent host volume and specified from the perspective of the container. For example, if you place the file at host_volume/scratch/customCertPwd, specify SSL_CERT_PASSWD_FILE=/mnt/bludata0/scratch/customCertPwd.
SSL_CERT_DB_LABEL=string

This option can be set only from version v11.5.4.0-CN2.

The label of the certificate that is to be used inside the .p12 file. If the PCKS file contains more than one friendly name, specify this label to ensure that the right certificate is used.
TIMEZONE=new_timezone
By default, the time zone for Db2 Warehouse is Coordinated Universal Time (UTC). You can use this option to specify a different time zone. To retrieve a list of supported time zones, issue the following command: 
timedatectl list-timezones
PRUNE_LOGS_SCHEDULE
By default on a new deployment, the container schedule will be set to every 4 hours. On upgrades, this setting will not be set. To enable it, you will need to pass the following in your Docker or Podman run command to turn this behavior on in the log pruning schedule. 
-e PRUNE_LOGS_SCHEDULE=“*/4”