Update a database

Use the influxctl database update command to update a database in your InfluxDB Cloud Dedicated cluster.

1. If you haven’t already, download and install the influxctl CLI.

2. In your terminal, run the influxctl database update command and provide the following:

   • Database name
   • Optional: Database retention period. Default is infinite (0).
   • Optional: Database table (measurement) limit. Default is 500.
   • Optional: Database column limit. Default is 250.

influxctl database update \
  --retention-period 
30d
 \
  --max-tables 
500 \
  --max-columns 250 \
  
DATABASE_NAME

Replace the following in your command:

• DATABASE_NAME: your InfluxDB Cloud Dedicated database

Database attributes

• Retention period syntax
• Database naming restrictions
• InfluxQL DBRP naming convention
• Table and column limits

Retention period syntax (influxctl CLI)

Use the --retention-period flag to define the retention period for the database. The retention period value is a time duration value made up of a numeric value plus a duration unit. For example, 30d means 30 days. A zero duration (for example, 0s or 0d) retention period is infinite and data won’t expire. The retention period value cannot be negative or contain whitespace.

1. In your terminal, use cURL to send a request to the following InfluxDB Cloud Dedicated endpoint:

   POST https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases

   In the URL, provide the following credentials:

   • ACCOUNT_ID: The ID of the account that the cluster belongs to (see how to list cluster details).
   • CLUSTER_ID: The ID of the cluster that you want to manage (see how to list cluster details).
   • DATABASE_NAME: The name of the database that you want to delete (see how to list databases).

   Provide the following request headers:

   • Accept: application/json to ensure the response body is JSON content
   • Content-Type: application/json to indicate the request body is JSON content
   • Authorization: Bearer and a Management API token for your cluster (see how to create a management token for Management API requests).

   In the request body, provide the parameters to update:

   • Optional: Database retention period in nanoseconds. Default is 0 (infinite).
   • Optional: Database table (measurement) limit. Default is 500.
   • Optional: Database column limit. Default is 250.

   Specify the PATCH request method.

The following example shows how to use the Management API to update a database:

curl \
  --location "https://console.influxdata.com/api/v0/accounts/
ACCOUNT_ID
/clusters/
CLUSTER_ID
/databases/
DATABASE_NAME
" \
  --request PATCH \
  --header "Accept: application/json" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer 
MANAGEMENT_TOKEN
" \
  --data '{
    "maxTables": 
500
,
    "maxColumnsPerTable": 
250
,
    "retentionPeriod": 
2592000000000000
  }'

Replace the following in your request:

• ACCOUNT_ID: the ID of the InfluxDB Cloud Dedicated account to create the database for
• CLUSTER_ID: the ID of the InfluxDB Cloud Dedicated cluster to create the database for
• MANAGEMENT TOKEN: a management token for your InfluxDB Cloud Dedicated cluster
• DATABASE_NAME: your InfluxDB Cloud Dedicated database

Database attributes

• Retention period syntax
• Database naming restrictions
• InfluxQL DBRP naming convention
• Table and column limits

Retention period syntax (Management API)

Use the retentionPeriod property to specify the retention period for the database. The retention period value is an integer (<int32>) that represents the number of nanoseconds. For example, 2592000000000 means 30 days. A zero (0) retention period is infinite and data won’t expire. The retention period value cannot be negative or contain whitespace.

Example retention period values

• 0: infinite/none
• 259200000000000: 3 days
• 2592000000000000: 30 days
• 31536000000000000: 1 standard year (365 days)