Add Database Parameters

Database parameters control the database's behavior. Default parameters and values are set when you deploy your database. By adding or changing parameters from their default value, you can change the behavior of certain features or functionality.

Database parameters are written as key-value pairs in the format "-parameter":"value".

Modifying database parameters should only be done upon the recommendation of Exasol Support. Support will provide the exact parameter strings and values. If you need assistance, create a case.

The database will not start with invalid database parameters or configuration syntax.

Adding parameters will append the list of parameters with the new parameters and values that you specify.

Prerequisites

The database must be stopped. For more information, see Stop a Database.

Procedure

This procedure can be carried out using the Administration API.

The examples in this procedure are written using Bash on a Linux terminal. You can also use other interfaces and languages to execute the curl commands.

Placeholder values are styled as Bash variables, starting with the dollar sign ($) and using UPPERCASE characters. Replace the placeholders with your own values before executing the curl command.

  1. Get information about the database by sending a GET request to the /api/v1/databases endpoint. For example:

    curl -k -X "GET" \
    "https://$EXASOL_IP/api/v1/databases" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

    The response will include the following:

    • Database ID
    • Database name
    • Database version
    • Provider type
    • Number of clusters in the database
    • Number of clusters running
    • Volumes

    Additional database parameters and hardware details may be included in the response depending on the configuration and platform.

  2. To add parameters, send a PATCH request to the /api/v1/databases/DATABASE_ID/parameters endpoint. Replace the placeholders with the appropriate values according to your environment. Add the parameters you want to add in the payload as key-value pairs in the format "-parameter": "value".For example:

    curl -k -X "PATCH" \
    "https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/parameters" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "parameters": {
        "-forceProtocolEncryption": "1",
        "-oidcProviderClientSecret": "abcd"
      }
    }'

  3. Start the database. For more information, see Start a Database.

Verification

To verify the database is configured with the new properties, send a GET request to the /api/v1/databases/DATABASE_ID/parameters endpoint. For example: 

curl -k -X "GET" \
  "https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/parameters' \
  -H "accept: application/json" \
  -H "Authorization: Basic $AUTH_TOKEN"

See Also