For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.databases.patch_config(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    body={
        "config": {...},
    },
)

Description

To update the configuration for an existing database cluster, send a PATCH request to /v2/databases/{database_cluster_uuid}/config.

Parameters

database_cluster_uuid string required

A unique identifier for a database cluster.

config object optional

Show child properties

backup_hour integer optional

Example: 3

The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed.

Min: 0

Max: 23

backup_minute integer optional

Example: 30

The minute of the backup hour when backup for the service starts. New backup is only started if previous backup has already completed.

Min: 0

Max: 59

sql_mode string optional

Example: ANSI,TRADITIONAL

Global SQL mode. If empty, uses MySQL server defaults. Must only include uppercase alphabetic characters, underscores, and commas.

Max length: 1024

connect_timeout integer optional

Example: 10

The number of seconds that the mysqld server waits for a connect packet before responding with bad handshake.

Min: 2

Max: 3600

default_time_zone string optional

Example: +03:00

Default server time zone, in the form of an offset from UTC (from -12:00 to +12:00), a time zone name (EST), or 'SYSTEM' to use the MySQL server default.

Min length: 2

Max length: 100

group_concat_max_len integer optional

Example: 1024

The maximum permitted result length, in bytes, for the GROUP_CONCAT() function.

Min: 4

Max: 18446744073709552000

information_schema_stats_expiry integer optional

Example: 86400

The time, in seconds, before cached statistics expire.

Min: 900

Max: 31536000

innodb_ft_min_token_size integer optional

Example: 3

The minimum length of words that an InnoDB FULLTEXT index stores.

Min: 0

Max: 16

innodb_ft_server_stopword_table string optional

Example: db_name/table_name

The InnoDB FULLTEXT index stopword list for all InnoDB tables.

Max length: 1024

innodb_lock_wait_timeout integer optional

Example: 50

The time, in seconds, that an InnoDB transaction waits for a row lock. before giving up.

Min: 1

Max: 3600

innodb_log_buffer_size integer optional

Example: 16777216

The size of the buffer, in bytes, that InnoDB uses to write to the log files. on disk.

Min: 1048576

Max: 4294967295

innodb_online_alter_log_max_size integer optional

Example: 134217728

The upper limit, in bytes, of the size of the temporary log files used during online DDL operations for InnoDB tables.

Min: 65536

Max: 1099511627776

innodb_print_all_deadlocks boolean optional

Example: True

When enabled, records information about all deadlocks in InnoDB user transactions in the error log. Disabled by default.

innodb_rollback_on_timeout boolean optional

Example: True

When enabled, transaction timeouts cause InnoDB to abort and roll back the entire transaction.

interactive_timeout integer optional

Example: 3600

The time, in seconds, the server waits for activity on an interactive. connection before closing it.

Min: 30

Max: 604800

internal_tmp_mem_storage_engine string optional

The storage engine for in-memory internal temporary tables.

One of: TempTable, MEMORY

net_read_timeout integer optional

Example: 30

The time, in seconds, to wait for more data from an existing connection. aborting the read.

Min: 1

Max: 3600

net_write_timeout integer optional

Example: 30

The number of seconds to wait for a block to be written to a connection before aborting the write.

Min: 1

Max: 3600

sql_require_primary_key boolean optional

Example: True

Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.

wait_timeout integer optional

Example: 28800

The number of seconds the server waits for activity on a noninteractive connection before closing it.

Min: 1

Max: 2147483

max_allowed_packet integer optional

Example: 67108864

The size of the largest message, in bytes, that can be received by the server. Default is 67108864 (64M).

Min: 102400

Max: 1073741824

max_heap_table_size integer optional

Example: 16777216

The maximum size, in bytes, of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)

Min: 1048576

Max: 1073741824

sort_buffer_size integer optional

Example: 262144

The sort buffer size, in bytes, for ORDER BY optimization. Default is 262144. (256K).

Min: 32768

Max: 1073741824

tmp_table_size integer optional

Example: 16777216

The maximum size, in bytes, of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M).

Min: 1048576

Max: 1073741824

slow_query_log boolean optional

Example: True

When enabled, captures slow queries. When disabled, also truncates the mysql.slow_log table. Default is false.

long_query_time number optional

Example: 10

The time, in seconds, for a query to take to execute before being captured by slow_query_logs. Default is 10 seconds.

Min: 0

Max: 3600

binlog_retention_period number optional

Example: 600

The minimum amount of time, in seconds, to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector.

Min: 600

Max: 604800

innodb_change_buffer_max_size integer optional

Example: 25

Specifies the maximum size of the InnoDB change buffer as a percentage of the buffer pool.

Min: 0

Max: 50

innodb_flush_neighbors integer optional

Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent.
- 0 — disables this functionality, dirty pages in the same extent are not flushed.
- 1 — flushes contiguous dirty pages in the same extent.
- 2 — flushes dirty pages in the same extent.

One of: 0, 1, 2

innodb_read_io_threads integer optional

Example: 16

The number of I/O threads for read operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service.

Min: 1

Max: 64

innodb_write_io_threads integer optional

Example: 16

The number of I/O threads for write operations in InnoDB. Changing this parameter will lead to a restart of the MySQL service.

Min: 1

Max: 64

innodb_thread_concurrency integer optional

Example: 0

Defines the maximum number of threads permitted inside of InnoDB. A value of 0 (the default) is interpreted as infinite concurrency (no limit). This variable is intended for performance tuning on high concurrency systems.

Min: 0

Max: 1000

net_buffer_length integer optional

Example: 4096

Start sizes of connection buffer and result buffer, must be multiple of 1024. Changing this parameter will lead to a restart of the MySQL service.

Min: 1024

Max: 1048576

log_output string optional

Defines the destination for logs. Can be INSIGHTS, TABLE, or both (INSIGHTS,TABLE), or NONE to disable logs. To specify both destinations, use INSIGHTS,TABLE (order matters). Default is NONE.

One of: INSIGHTS, TABLE, INSIGHTS,TABLE, NONE

Default: NONE

mysql_incremental_backup object optional

MySQL Incremental Backup configuration settings

Show child properties

enabled boolean optional

Enable periodic incremental backups. When enabled, full_backup_week_schedule must be set. Incremental backups only store changes since the last backup, making them faster and more storage-efficient than full backups. This is particularly useful for large databases where daily full backups would be too time-consuming or expensive.

full_backup_week_schedule string optional

Example: mon,thu

Comma-separated list of days of the week when full backups should be created. Valid values: mon, tue, wed, thu, fri, sat, sun. Default is null. Example : "mon,fri,sun".

autovacuum_freeze_max_age integer optional

Example: 200000000

Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.

Min: 200000000

Max: 1500000000

autovacuum_max_workers integer optional

Example: 5

Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.

Min: 1

Max: 20

autovacuum_naptime integer optional

Example: 43200

Specifies the minimum delay, in seconds, between autovacuum runs on any given database. The default is one minute.

Min: 0

Max: 86400

autovacuum_vacuum_threshold integer optional

Example: 50

Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.

Min: 0

Max: 2147483647

autovacuum_analyze_threshold integer optional

Example: 50

Specifies the minimum number of inserted, updated, or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.

Min: 0

Max: 2147483647

autovacuum_vacuum_scale_factor number optional

Example: 0.2

Specifies a fraction, in a decimal value, of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).

Min: 0

Max: 1

autovacuum_analyze_scale_factor number optional

Example: 0.2

Specifies a fraction, in a decimal value, of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).

Min: 0

Max: 1

autovacuum_vacuum_cost_delay integer optional

Example: 20

Specifies the cost delay value, in milliseconds, that will be used in automatic VACUUM operations. If -1, uses the regular vacuum_cost_delay value, which is 20 milliseconds.

Min: -1

Max: 100

autovacuum_vacuum_cost_limit integer optional

Example: -1

Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.

Min: -1

Max: 10000

bgwriter_delay integer optional

Example: 200

Specifies the delay, in milliseconds, between activity rounds for the background writer. Default is 200 ms.

Min: 10

Max: 10000

bgwriter_flush_after integer optional

Example: 512

The amount of kilobytes that need to be written by the background writer before attempting to force the OS to issue these writes to underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.

Min: 0

Max: 2048

bgwriter_lru_maxpages integer optional

Example: 100

The maximum number of buffers that the background writer can write. Setting this to zero disables background writing. Default is 100.

Min: 0

Max: 1073741823

bgwriter_lru_multiplier number optional

Example: 2

The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.

Min: 0

Max: 10

deadlock_timeout integer optional

Example: 1000

The amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.

Min: 500

Max: 1800000

default_toast_compression string optional

Specifies the default TOAST compression method for values of compressible columns (the default is lz4).

One of: lz4, pglz

idle_in_transaction_session_timeout integer optional

Example: 10000

Time out sessions with open transactions after this number of milliseconds

Min: 0

Max: 604800000

jit boolean optional

Example: True

Activates, in a boolean, the system-wide use of Just-in-Time Compilation (JIT).

log_autovacuum_min_duration integer optional

Example: -1

Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.

Min: -1

Max: 2147483647

log_error_verbosity string optional

Controls the amount of detail written in the server log for each message that is logged.

One of: TERSE, DEFAULT, VERBOSE

log_line_prefix string optional

Selects one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze, etc.

One of: pid=%p,user=%u,db=%d,app=%a,client=%h, %m [%p] %q[user=%u,db=%d,app=%a], %t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h

log_min_duration_statement integer optional

Example: -1

Log statements that take more than this number of milliseconds to run. If -1, disables.

Min: -1

Max: 86400000

max_files_per_process integer optional

Example: 2048

PostgreSQL maximum number of files that can be open per process.

Min: 1000

Max: 4096

max_prepared_transactions integer optional

Example: 20

PostgreSQL maximum prepared transactions. Once increased, this parameter cannot be lowered from its set value.

Min: 0

Max: 10000

max_pred_locks_per_transaction integer optional

Example: 128

PostgreSQL maximum predicate locks per transaction.

Min: 64

Max: 640

max_locks_per_transaction integer optional

Example: 128

PostgreSQL maximum locks per transaction. Once increased, this parameter cannot be lowered from its set value.

Min: 64

Max: 6400

max_stack_depth integer optional

Example: 2097152

Maximum depth of the stack in bytes.

Min: 2097152

Max: 6291456

max_standby_archive_delay integer optional

Example: 43200

Max standby archive delay in milliseconds.

Min: 1

Max: 43200000

max_standby_streaming_delay integer optional

Example: 43200

Max standby streaming delay in milliseconds.

Min: 1

Max: 43200000

max_replication_slots integer optional

Example: 16

PostgreSQL maximum replication slots.

Min: 8

Max: 64

max_logical_replication_workers integer optional

Example: 16

PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers).

Min: 4

Max: 64

max_parallel_workers integer optional

Example: 12

Sets the maximum number of workers that the system can support for parallel queries.

Min: 0

Max: 96

max_parallel_workers_per_gather integer optional

Example: 16

Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.

Min: 0

Max: 96

max_worker_processes integer optional

Example: 16

Sets the maximum number of background processes that the system can support. Once increased, this parameter cannot be lowered from its set value.

Min: 8

Max: 96

pg_partman_bgw.role string optional

Example: myrolename

Controls which role to use for pg_partman's scheduled background tasks. Must consist of alpha-numeric characters, dots, underscores, or dashes. May not start with dash or dot. Maximum of 64 characters.

Max length: 64

pg_partman_bgw.interval integer optional

Example: 3600

Sets the time interval to run pg_partman's scheduled tasks.

Min: 3600

Max: 604800

pg_stat_statements.track string optional

Controls which statements are counted. Specify 'top' to track top-level statements (those issued directly by clients), 'all' to also track nested statements (such as statements invoked within functions), or 'none' to disable statement statistics collection. The default value is top.

One of: all, top, none

temp_file_limit integer optional

Example: 5000000

PostgreSQL temporary file limit in KiB. If -1, sets to unlimited.

Min: -1

Max: 2147483647

timezone string optional

Example: Europe/Helsinki

PostgreSQL service timezone

Max length: 64

track_activity_query_size integer optional

Example: 1024

Specifies the number of bytes reserved to track the currently executing command for each active session.

Min: 1024

Max: 10240

track_commit_timestamp string optional

Record commit time of transactions.

One of: off, on

track_functions string optional

Enables tracking of function call counts and time used.

One of: all, pl, none

track_io_timing string optional

Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.

One of: off, on

max_wal_senders integer optional

Example: 32

PostgreSQL maximum WAL senders. Once increased, this parameter cannot be lowered from its set value.

Min: 20

Max: 64

wal_sender_timeout integer optional

Example: 60000

Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout. Must be either 0 or between 5000 and 10800000.

Min: 0

Max: 10800000

wal_writer_delay integer optional

Example: 50

WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance

Min: 10

Max: 200

shared_buffers_percentage number optional

Example: 41.5

Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.

Min: 20

Max: 60

pgbouncer object optional

PGBouncer connection pooling settings

Show child properties

server_reset_query_always boolean optional

Example: False

Run server_reset_query (DISCARD ALL) in all pooling modes.

ignore_startup_parameters array of strings optional

Example: ['extra_float_digits', 'search_path']

List of parameters to ignore when given in startup packet.

min_pool_size integer optional

Example: 1

If current server connections are below this number, adds more. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size.

Min: 0

Max: 10000

server_lifetime integer optional

Example: 3600

The pooler closes any unused server connection that has been connected longer than this amount of seconds.

Min: 60

Max: 86400

server_idle_timeout integer optional

Example: 600

Drops server connections if they have been idle more than this many seconds. If 0, timeout is disabled.

Min: 0

Max: 86400

autodb_pool_size integer optional

Example: 1

If non-zero, automatically creates a pool of that size per user when a pool doesn't exist.

Min: 0

Max: 10000

autodb_pool_mode string optional

PGBouncer pool mode

One of: session, transaction, statement

autodb_max_db_connections integer optional

Example: 1

Only allows a maximum this many server connections per database (regardless of user). If 0, allows unlimited connections.

Min: 0

Max: 2147483647

autodb_idle_timeout integer optional

Example: 3600

If the automatically-created database pools have been unused this many seconds, they are freed. If 0, timeout is disabled.

Min: 0

Max: 86400

work_mem integer optional

Example: 4

The maximum amount of memory, in MB, used by a query operation (such as a sort or hash table) before writing to temporary disk files. Default is 1MB + 0.075% of total RAM (up to 32MB).

Min: 1

Max: 1024

timescaledb object optional

TimescaleDB extension configuration values

Show child properties

max_background_workers integer optional

Example: 8

The number of background workers for timescaledb operations. Set to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.

Min: 1

Max: 4096

synchronous_replication string optional

Synchronous replication type. Note that the service plan also needs to support synchronous replication.

One of: off, quorum

stat_monitor_enable boolean optional

Example: False

Enable the pg_stat_monitor extension. <b>Enabling this extension will cause the cluster to be restarted.</b> When this extension is enabled, pg_stat_statements results for utility commands are unreliable.

max_failover_replication_time_lag integer optional

Example: 50

Number of seconds of master unavailability before triggering database failover to standby. The default value is 60.

Min: 10

Max: 9223372036854776000

max_connections integer optional

Example: 75

Sets the PostgreSQL maximum number of concurrent connections to the database server. This is a limited-release parameter. Contact your account team to confirm your eligibility. You cannot decrease this parameter value when set. For services with a read replica, first increase the read replica's value. After the change is applied to the replica, you can increase the primary service's value. Changing this parameter causes a service restart.

Min: 25

max_slot_wal_keep_size integer optional

Example: 100

PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.

Min: -1

Max: 2147483647

redis_maxmemory_policy string optional

A string specifying the desired eviction policy for the Caching cluster.

- noeviction: Don't evict any data, returns error when memory limit is reached.
- allkeys-lru: Evict any key, least recently used (LRU) first.
- allkeys-random: Evict keys in a random order.
- volatile-lru: Evict keys with expiration only, least recently used (LRU) first.
- volatile-random: Evict keys with expiration only in a random order.
- volatile-ttl: Evict keys with expiration only, shortest time-to-live (TTL) first.

One of: noeviction, allkeys-lru, allkeys-random, volatile-lru, volatile-random, volatile-ttl

redis_pubsub_client_output_buffer_limit integer optional

Example: 64

Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.

Min: 32

Max: 512

redis_number_of_databases integer optional

Example: 16

Set number of redis databases. Changing this will cause a restart of redis service.

Min: 1

Max: 128

redis_io_threads integer optional

Example: 1

Caching IO thread count

Min: 1

Max: 32

redis_lfu_log_factor integer optional

Example: 10

Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies

Min: 0

Max: 100

Default: 10

redis_lfu_decay_time integer optional

Example: 1

LFU maxmemory-policy counter decay time in minutes

Min: 1

Max: 120

Default: 1

redis_ssl boolean optional

Example: True

Require SSL to access Caching.
- When enabled, Caching accepts only SSL connections on port 25061.
- When disabled, port 25060 is opened for non-SSL connections, while port 25061 remains available for SSL connections.

Default: True

redis_timeout integer optional

Example: 300

Caching idle connection timeout in seconds

Min: 0

Max: 31536000

Default: 300

redis_notify_keyspace_events string optional

Example: K

Set notify-keyspace-events option. Requires at least K or E and accepts any combination of the following options. Setting the parameter to "" disables notifications.
- K — Keyspace events
- E — Keyevent events
- g — Generic commands (e.g. DEL, EXPIRE, RENAME, ...)
- $ — String commands
- l — List commands
- s — Set commands
- h — Hash commands
- z — Sorted set commands
- t — Stream commands
- d — Module key type events
- x — Expired events
- e — Evicted events
- m — Key miss events
- n — New key events
- A — Alias for "g$lshztxed"

Max length: 32

redis_persistence string optional

Creates an RDB dump of the database every 10 minutes that can be used to recover data after a node crash. The database does not create the dump if no keys have changed since the last dump. When set to off, the database cannot fork services, and data can be lost if a service is restarted or powered off. DigitalOcean Managed Caching databases do not support the Append Only File (AOF) persistence method.

One of: off, rdb

redis_acl_channels_default string optional

Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Caching configuration acl-pubsub-default.

One of: allchannels, resetchannels

valkey_maxmemory_policy string optional

A string specifying the desired eviction policy for a Caching or Valkey cluster.

- noeviction: Don't evict any data, returns error when memory limit is reached.
- allkeys_lru: Evict any key, least recently used (LRU) first.
- allkeys_random: Evict keys in a random order.
- volatile_lru: Evict keys with expiration only, least recently used (LRU) first.
- volatile_random: Evict keys with expiration only in a random order.
- volatile_ttl: Evict keys with expiration only, shortest time-to-live (TTL) first.

One of: noeviction, allkeys_lru, allkeys_random, volatile_lru, volatile_random, volatile_ttl

valkey_pubsub_client_output_buffer_limit integer optional

Example: 64

Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.

Min: 32

Max: 512

valkey_number_of_databases integer optional

Example: 16

Set number of valkey databases. Changing this will cause a restart of valkey service.

Min: 1

Max: 128

valkey_io_threads integer optional

Example: 1

Valkey IO thread count

Min: 1

Max: 32

valkey_lfu_log_factor integer optional

Example: 10

Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies

Min: 0

Max: 100

Default: 10

valkey_lfu_decay_time integer optional

Example: 1

LFU maxmemory-policy counter decay time in minutes

Min: 1

Max: 120

Default: 1

valkey_ssl boolean optional

Example: True

Require SSL to access Valkey

Default: True

valkey_timeout integer optional

Example: 300

Valkey idle connection timeout in seconds

Min: 0

Max: 31536000

Default: 300

valkey_notify_keyspace_events string optional

Example: K

Set notify-keyspace-events option. Requires at least K or E and accepts any combination of the following options. Setting the parameter to "" disables notifications.
- K — Keyspace events
- E — Keyevent events
- g — Generic commands (e.g. DEL, EXPIRE, RENAME, ...)
- $ — String commands
- l — List commands
- s — Set commands
- h — Hash commands
- z — Sorted set commands
- t — Stream commands
- d — Module key type events
- x — Expired events
- e — Evicted events
- m — Key miss events
- n — New key events
- A — Alias for "g$lshztxed"

Max length: 32

valkey_persistence string optional

When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked.

One of: off, rdb

valkey_acl_channels_default string optional

Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default.

One of: allchannels, resetchannels

frequent_snapshots boolean optional

Example: True

Frequent RDB snapshots
When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off.

Default: True

valkey_active_expire_effort integer optional

Example: 1

Active expire effort
Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency.

Min: 1

Max: 10

Default: 1

default_read_concern string optional

Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more here.

One of: local, available, majority

Default: local

default_write_concern string optional

Example: majority

Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either majority or a number 0...n which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. Setting to 0 will request no acknowledgement of the write operation. Learn more here.

Default: majority

transaction_lifetime_limit_seconds integer optional

Example: 100

Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs every transactionLifetimeLimitSeconds/2 seconds or at least once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more here.

Min: 1

Default: 60

slow_op_threshold_ms integer optional

Example: 200

Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more here.

Min: 0

Default: 100

verbosity integer optional

Example: 3

The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. 0 includes informational messages while 1...5 increases the level to include debug messages. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more here.

Min: 0

Max: 5

Default: 0

compression_type string optional

Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer.

One of: gzip, snappy, lz4, zstd, uncompressed, producer

group_initial_rebalance_delay_ms integer optional

Example: 3000

The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time.

Min: 0

Max: 300000

group_min_session_timeout_ms integer optional

Example: 6000

The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.

Min: 0

Max: 60000

group_max_session_timeout_ms integer optional

Example: 1800000

The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.

Min: 0

Max: 1800000

connections_max_idle_ms integer optional

Example: 540000

Idle connections timeout: the server socket processor threads close the connections that idle for longer than this.

Min: 1000

Max: 3600000

max_incremental_fetch_session_cache_slots integer optional

Example: 1000

The maximum number of incremental fetch sessions that the broker will maintain.

Min: 1000

Max: 10000

message_max_bytes integer optional

Example: 1048588

The maximum size of message that the server can receive.

Min: 0

Max: 100001200

offsets_retention_minutes integer optional

Example: 10080

Log retention window in minutes for offsets topic

Min: 1

Max: 2147483647

log_cleaner_delete_retention_ms integer optional

Example: 86400000

How long are delete records retained?

Min: 0

Max: 315569260000

log_cleaner_min_cleanable_ratio number optional

Example: 0.5

Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log_cleaner_max_compaction_lag_ms to enforce compactions sooner, instead of setting a very high value for this option.

Min: 0.2

Max: 0.9

log_cleaner_max_compaction_lag_ms integer optional

Example: 60000

The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted

Min: 30000

Max: 9223372036854776000

log_cleaner_min_compaction_lag_ms integer optional

Example: 100000

The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.

Min: 0

Max: 9223372036854776000

log_cleanup_policy string optional

The default cleanup policy for segments beyond the retention window

One of: delete, compact, compact,delete

log_flush_interval_messages integer optional

Example: 9223372036854776000

The number of messages accumulated on a log partition before messages are flushed to disk

Min: 1

Max: 9223372036854776000

log_flush_interval_ms integer optional

Example: 1000000

The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used

Min: 0

Max: 9223372036854776000

log_index_interval_bytes integer optional

Example: 4096

The interval with which Kafka adds an entry to the offset index

Min: 0

Max: 104857600

log_index_size_max_bytes integer optional

Example: 10485760

The maximum size in bytes of the offset index

Min: 1048576

Max: 104857600

log_message_downconversion_enable boolean optional

Example: True

This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests.

log_message_timestamp_type string optional

Define whether the timestamp in the message is message create time or log append time.

One of: CreateTime, LogAppendTime

log_message_timestamp_difference_max_ms integer optional

Example: 1000000

The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message

Min: 0

Max: 9223372036854776000

log_preallocate boolean optional

Example: False

Controls whether to preallocate a file when creating a new segment

log_retention_bytes integer optional

Example: 1000000

The maximum size of the log before deleting messages

Min: -1

Max: 9223372036854776000

log_retention_hours integer optional

Example: 1000000

The number of hours to keep a log file before deleting it

Min: -1

Max: 2147483647

log_retention_ms integer optional

Example: 100000000

The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied.

Min: -1

Max: 9223372036854776000

log_roll_jitter_ms integer optional

Example: 10000000

The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used

Min: 0

Max: 9223372036854776000

log_roll_ms integer optional

Example: 1000000

The maximum time before a new log segment is rolled out (in milliseconds).

Min: 1

Max: 9223372036854776000

log_segment_bytes integer optional

Example: 100000000

The maximum size of a single log file

Min: 10485760

Max: 1073741824

log_segment_delete_delay_ms integer optional

Example: 60000

The amount of time to wait before deleting a file from the filesystem

Min: 0

Max: 3600000

auto_create_topics_enable boolean optional

Example: True

Enable auto creation of topics

Default: False

min_insync_replicas integer optional

Example: 1

When a producer sets acks to 'all' (or '-1'), min_insync_replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

Min: 1

Max: 7

num_partitions integer optional

Example: 10

Number of partitions for autocreated topics

Min: 1

Max: 1000

default_replication_factor integer optional

Example: 2

Replication factor for autocreated topics

Min: 1

Max: 10

replica_fetch_max_bytes integer optional

Example: 2097152

The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made.

Min: 1048576

Max: 104857600

replica_fetch_response_max_bytes integer optional

Example: 20971520

Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum.

Min: 10485760

Max: 1048576000

max_connections_per_ip integer optional

Example: 512

The maximum number of connections allowed from each ip address (defaults to 2147483647).

Min: 256

Max: 2147483647

producer_purgatory_purge_interval_requests integer optional

Example: 100

The purge interval (in number of requests) of the producer request purgatory (defaults to 1000).

Min: 10

Max: 10000

socket_request_max_bytes integer optional

Example: 20971520

The maximum number of bytes in a socket request (defaults to 104857600).

Min: 10485760

Max: 209715200

transaction_state_log_segment_bytes integer optional

Example: 104857600

The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)).

Min: 1048576

Max: 2147483647

transaction_remove_expired_transaction_cleanup_interval_ms integer optional

Example: 3600000

The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)).

Min: 600000

Max: 3600000

schema_registry boolean optional

Example: True

Enable creation of schema registry for the Kafka cluster. Schema_registry only works with General Purpose - Dedicated CPU plans.

Default: False

http_max_content_length_bytes integer optional

Example: 100000000

Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

Min: 1

Max: 2147483647

Default: 100000000

http_max_header_size_bytes integer optional

Example: 8192

Maximum size of allowed headers, in bytes.

Min: 1024

Max: 262144

Default: 8192

http_max_initial_line_length_bytes integer optional

Example: 4096

Maximum length of an HTTP URL, in bytes.

Min: 1024

Max: 65536

Default: 4096

indices_query_bool_max_clause_count integer optional

Example: 1024

Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues.

Min: 64

Max: 4096

Default: 1024

indices_fielddata_cache_size_percentage integer optional

Example: 3

Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.

Min: 3

Max: 100

indices_memory_index_buffer_size_percentage integer optional

Example: 10

Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

Min: 3

Max: 40

Default: 10

indices_memory_min_index_buffer_size_mb integer optional

Example: 48

Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced.

Min: 3

Max: 2048

Default: 48

indices_memory_max_index_buffer_size_mb integer optional

Example: 48

Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.

Min: 3

Max: 2048

indices_queries_cache_size_percentage integer optional

Example: 10

Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality.

Min: 3

Max: 40

Default: 10

indices_recovery_max_mb_per_sec integer optional

Example: 40

Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot).

Min: 40

Max: 400

Default: 40

indices_recovery_max_concurrent_file_chunks integer optional

Example: 2

Maximum number of file chunks sent in parallel for each recovery.

Min: 2

Max: 5

Default: 2

thread_pool_search_size integer optional

Example: 1

Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

Min: 1

Max: 128

thread_pool_search_throttled_size integer optional

Example: 1

Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

Min: 1

Max: 128

thread_pool_get_size integer optional

Example: 1

Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

Min: 1

Max: 128

thread_pool_analyze_size integer optional

Example: 1

Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

Min: 1

Max: 128

thread_pool_write_size integer optional

Example: 1

Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

Min: 1

Max: 128

thread_pool_force_merge_size integer optional

Example: 1

Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

Min: 1

Max: 128

thread_pool_search_queue_size integer optional

Example: 10

Size of queue for operations in the search thread pool.

Min: 10

Max: 2000

thread_pool_search_throttled_queue_size integer optional

Example: 10

Size of queue for operations in the search throttled thread pool.

Min: 10

Max: 2000

thread_pool_get_queue_size integer optional

Example: 10

Size of queue for operations in the get thread pool.

Min: 10

Max: 2000

thread_pool_analyze_queue_size integer optional

Example: 10

Size of queue for operations in the analyze thread pool.

Min: 10

Max: 2000

thread_pool_write_queue_size integer optional

Example: 10

Size of queue for operations in the write thread pool.

Min: 10

Max: 2000

ism_enabled boolean optional

Example: True

Specifies whether ISM is enabled or not.

Default: True

ism_history_enabled boolean optional

Example: True

Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.

Default: True

ism_history_max_age_hours integer optional

Example: 24

Maximum age before rolling over the audit history index, in hours.

Min: 1

Max: 2147483647

Default: 24

ism_history_max_docs integer optional

Example: 2500000

Maximum number of documents before rolling over the audit history index.

Min: 1

Max: 9223372036854776000

Default: 2500000

ism_history_rollover_check_period_hours integer optional

Example: 8

The time between rollover checks for the audit history index, in hours.

Min: 1

Max: 2147483647

Default: 8

ism_history_rollover_retention_period_days integer optional

Example: 30

Length of time long audit history indices are kept, in days.

Min: 1

Max: 2147483647

Default: 30

search_max_buckets integer optional

Example: 10000

Maximum number of aggregation buckets allowed in a single response.

Min: 1

Max: 1000000

Default: 10000

action_auto_create_index_enabled boolean optional

Example: True

Specifices whether to allow automatic creation of indices.

Default: True

enable_security_audit boolean optional

Example: False

Specifies whether to allow security audit logging.

Default: False

action_destructive_requires_name boolean optional

Example: False

Specifies whether to require explicit index names when deleting indices.

cluster_max_shards_per_node integer optional

Example: 100

Maximum number of shards allowed per data node.

Min: 100

Max: 10000

override_main_response_version boolean optional

Example: False

Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work.

Default: False

script_max_compilations_rate string optional

Example: 75/5m

Limits the number of inline script compilations within a period of time. Default is use-context

Default: use-context

cluster_routing_allocation_node_concurrent_recoveries integer optional

Example: 2

Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node .

Min: 2

Max: 16

Default: 2

reindex_remote_whitelist array of strings optional

Example: ['255.255.223.233:9200', '222.33.222.222:6300']

Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

plugins_alerting_filter_by_backend_roles_enabled boolean optional

Example: False

Enable or disable filtering of alerting by backend roles.

Default: False

knn_memory_circuit_breaker_enabled boolean optional

Example: True

Enable or disable KNN memory circuit breaker.

Default: True

knn_memory_circuit_breaker_limit integer optional

Example: 60

Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches.

Min: 0

Max: 100

Default: 50

keep_index_refresh_interval boolean optional

Example: True

DigitalOcean automatically resets the index.refresh_interval to the default value (once per second) to ensure that new documents are quickly available for search queries. If you are setting your own refresh intervals, you can disable this by setting this field to true.

Default: False

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.databases.patch_config(database_cluster_uuid="a7aba9d")

More Information

See /v2/databases/{database_cluster_uuid}/config in the API reference for additional detail on responses, headers, parameters, and more.