Cluster Setting Scopes with Cluster Virtualization enabled

When cluster virtualization is enabled, each cluster setting has a scope, which may be a virtual cluster or the system virtual cluster. This page categorizes each public cluster setting by scope. For descriptions and details about each public cluster setting, refer to Cluster Settings.

• When a cluster setting is scoped to a virtual cluster, it affects only a virtual cluster and not the system virtual cluster. To configure a cluster setting that is scoped to a virtual cluster, you must have the admin role on it, and you must connect to it before configuring the setting. The majority of cluster settings are scoped to a virtual cluster and are visible only when connected to it.
• When a cluster setting is scoped to the system virtual cluster, it affects the entire CockroachDB cluster. To configure a cluster setting that is scoped to the system virtual cluster, you must have the admin role on the system virtual cluster, and you must connect to the system virtual cluster before configuring the setting. For example, the cluster setting admission.disk_bandwidth_tokens.elastic.enabled is scoped to the system virtual cluster.
• When a cluster setting is system-visible, it can be set only from the system virtual cluster but can be queried from any virtual cluster. For example, a virtual cluster can query a system-visible cluster setting's value, such as storage.max_sync_duration, to help adapt to the CockroachDB cluster's configuration.

Cluster settings scoped to a virtual cluster

• admission.epoch_lifo.enabled
• admission.epoch_lifo.epoch_closing_delta_duration
• admission.epoch_lifo.epoch_duration
• admission.epoch_lifo.queue_delay_threshold_to_switch_to_lifo
• admission.sql_kv_response.enabled
• admission.sql_sql_response.enabled
• bulkio.backup.deprecated_full_backup_with_subdir.enabled
• bulkio.backup.file_size
• bulkio.backup.read_timeout
• bulkio.backup.read_with_priority_after
• changefeed.aggregator.flush_jitter
• changefeed.backfill.concurrent_scan_requests
• changefeed.backfill.scan_request_size
• changefeed.batch_reduction_retry.enabled
• changefeed.default_range_distribution_strategy
• changefeed.event_consumer_worker_queue_size
• changefeed.event_consumer_workers
• changefeed.fast_gzip.enabled
• changefeed.frontier_highwater_lag_checkpoint_threshold
• changefeed.memory.per_changefeed_limit
• changefeed.min_highwater_advance
• changefeed.node_throttle_config
• changefeed.protect_timestamp.max_age
• changefeed.protect_timestamp_interval
• changefeed.schema_feed.read_with_priority_after
• changefeed.sink_io_workers
• cloudstorage.azure.concurrent_upload_buffers
• cloudstorage.http.custom_ca
• cloudstorage.timeout
• cluster.auto_upgrade.enabled
• cluster.preserve_downgrade_option
• diagnostics.forced_sql_stat_reset.interval
• diagnostics.reporting.enabled
• diagnostics.reporting.interval
• external.graphite.endpoint
• external.graphite.interval
• feature.backup.enabled
• feature.changefeed.enabled
• feature.export.enabled
• feature.import.enabled
• feature.restore.enabled
• feature.schema_change.enabled
• feature.stats.enabled
• jobs.retention_time
• kv.rangefeed.client.stream_startup_rate
• kv.rangefeed.range_stuck_threshold
• kv.transaction.max_intents_bytes
• kv.transaction.max_refresh_spans_bytes
• kv.transaction.reject_over_max_intents_budget.enabled
• schedules.backup.gc_protection.enabled
• security.ocsp.mode
• security.ocsp.timeout
• server.auth_log.sql_connections.enabled
• server.auth_log.sql_sessions.enabled
• server.authentication_cache.enabled
• server.child_metrics.enabled
• server.client_cert_expiration_cache.capacity
• server.clock.forward_jump_check.enabled
• server.clock.persist_upper_bound_interval
• server.eventlog.enabled
• server.eventlog.ttl
• server.host_based_authentication.configuration
• server.hot_ranges_request.node.timeout
• server.hsts.enabled
• server.http.base_path
• server.identity_map.configuration
• server.log_gc.max_deletions_per_cycle
• server.log_gc.period
• server.max_connections_per_gateway
• server.oidc_authentication.autologin.enabled
• server.oidc_authentication.button_text
• server.oidc_authentication.claim_json_key
• server.oidc_authentication.client_id
• server.oidc_authentication.client_secret
• server.oidc_authentication.enabled
• server.oidc_authentication.principal_regex
• server.oidc_authentication.provider_url
• server.oidc_authentication.redirect_url
• server.oidc_authentication.scopes
• server.shutdown.connections.timeout
• server.shutdown.initial_wait
• server.shutdown.jobs.timeout
• server.shutdown.transactions.timeout
• server.time_until_store_dead
• server.user_login.cert_password_method.auto_scram_promotion.enabled
• server.user_login.downgrade_scram_stored_passwords_to_bcrypt.enabled
• server.user_login.min_password_length
• server.user_login.password_encryption
• server.user_login.password_hashes.default_cost.crdb_bcrypt
• server.user_login.password_hashes.default_cost.scram_sha_256
• server.user_login.rehash_scram_stored_passwords_on_cost_change.enabled
• server.user_login.timeout
• server.user_login.upgrade_bcrypt_stored_passwords_to_scram.enabled
• server.web_session.purge.ttl
• server.web_session.timeout
• sql.auth.change_own_password.enabled
• sql.auth.public_schema_create_privilege.enabled
• sql.auth.resolve_membership_single_scan.enabled
• sql.closed_session_cache.capacity
• sql.closed_session_cache.time_to_live
• sql.contention.event_store.capacity
• sql.contention.event_store.duration_threshold
• sql.contention.txn_id_cache.max_size
• sql.cross_db_fks.enabled
• sql.cross_db_sequence_owners.enabled
• sql.cross_db_sequence_references.enabled
• sql.cross_db_views.enabled
• sql.defaults.cost_scans_with_default_col_size.enabled
• sql.defaults.datestyle
• sql.defaults.default_hash_sharded_index_bucket_count
• sql.defaults.default_int_size
• sql.defaults.disallow_full_table_scans.enabled
• sql.defaults.distsql
• sql.defaults.experimental_alter_column_type.enabled
• sql.defaults.experimental_distsql_planning
• sql.defaults.experimental_enable_unique_without_index_constraints.enabled
• sql.defaults.experimental_implicit_column_partitioning.enabled
• sql.defaults.experimental_temporary_tables.enabled
• sql.defaults.foreign_key_cascades_limit
• sql.defaults.idle_in_session_timeout
• sql.defaults.idle_in_transaction_session_timeout
• sql.defaults.implicit_select_for_update.enabled
• sql.defaults.insert_fast_path.enabled
• sql.defaults.intervalstyle
• sql.defaults.large_full_scan_rows
• sql.defaults.locality_optimized_partitioned_index_scan.enabled
• sql.defaults.lock_timeout
• sql.defaults.on_update_rehome_row.enabled
• sql.defaults.optimizer_use_histograms.enabled
• sql.defaults.optimizer_use_multicol_stats.enabled
• sql.defaults.override_alter_primary_region_in_super_region.enabled
• sql.defaults.override_multi_region_zone_config.enabled
• sql.defaults.prefer_lookup_joins_for_fks.enabled
• sql.defaults.primary_region
• sql.defaults.reorder_joins_limit
• sql.defaults.require_explicit_primary_keys.enabled
• sql.defaults.results_buffer.size
• sql.defaults.serial_normalization
• sql.defaults.statement_timeout
• sql.defaults.stub_catalog_tables.enabled
• sql.defaults.super_regions.enabled
• sql.defaults.transaction_rows_read_err
• sql.defaults.transaction_rows_read_log
• sql.defaults.transaction_rows_written_err
• sql.defaults.transaction_rows_written_log
• sql.defaults.use_declarative_schema_changer
• sql.defaults.vectorize
• sql.defaults.zigzag_join.enabled
• sql.distsql.temp_storage.workmem
• sql.guardrails.max_row_size_err
• sql.guardrails.max_row_size_log
• sql.hash_sharded_range_pre_split.max
• sql.insights.anomaly_detection.enabled
• sql.insights.anomaly_detection.latency_threshold
• sql.insights.anomaly_detection.memory_limit
• sql.insights.execution_insights_capacity
• sql.insights.high_retry_count.threshold
• sql.insights.latency_threshold
• sql.log.slow_query.experimental_full_table_scans.enabled
• sql.log.slow_query.internal_queries.enabled
• sql.log.slow_query.latency_threshold
• sql.log.user_audit
• sql.log.user_audit.reduced_config.enabled
• sql.metrics.index_usage_stats.enabled
• sql.metrics.max_mem_reported_stmt_fingerprints
• sql.metrics.max_mem_reported_txn_fingerprints
• sql.metrics.max_mem_stmt_fingerprints
• sql.metrics.max_mem_txn_fingerprints
• sql.metrics.statement_details.dump_to_logs.enabled
• sql.metrics.statement_details.enabled
• sql.metrics.statement_details.gateway_node.enabled
• sql.metrics.statement_details.index_recommendation_collection.enabled
• sql.metrics.statement_details.max_mem_reported_idx_recommendations
• sql.metrics.statement_details.plan_collection.enabled
• sql.metrics.statement_details.plan_collection.period
• sql.metrics.statement_details.threshold
• sql.metrics.transaction_details.enabled
• sql.multiple_modifications_of_table.enabled
• sql.multiregion.drop_primary_region.enabled
• sql.notices.enabled
• sql.optimizer.uniqueness_checks_for_gen_random_uuid.enabled
• sql.show_ranges_deprecated_behavior.enabled
• sql.spatial.experimental_box2d_comparison_operators.enabled
• sql.stats.activity.persisted_rows.max
• sql.stats.automatic_collection.enabled
• sql.stats.automatic_collection.fraction_stale_rows
• sql.stats.automatic_collection.min_stale_rows
• sql.stats.cleanup.recurrence
• sql.stats.flush.enabled
• sql.stats.flush.interval
• sql.stats.forecasts.enabled
• sql.stats.histogram_buckets.count
• sql.stats.histogram_collection.enabled
• sql.stats.histogram_samples.count
• sql.stats.multi_column_collection.enabled
• sql.stats.non_default_columns.min_retention_period
• sql.stats.persisted_rows.max
• sql.stats.post_events.enabled
• sql.stats.response.max
• sql.stats.response.show_internal.enabled
• sql.stats.system_tables.enabled
• sql.stats.system_tables_autostats.enabled
• sql.telemetry.query_sampling.enabled
• sql.telemetry.query_sampling.internal.enabled
• sql.telemetry.query_sampling.max_event_frequency
• sql.temp_object_cleaner.cleanup_interval
• sql.temp_object_cleaner.wait_interval
• sql.log.all_statements.enabled
• sql.trace.session_eventlog.enabled
• sql.trace.stmt.enable_threshold
• sql.trace.txn.enable_threshold
• sql.ttl.default_delete_batch_size
• sql.ttl.default_delete_rate_limit
• sql.ttl.default_select_batch_size
• sql.ttl.default_select_rate_limit
• sql.ttl.job.enabled
• sql.txn.read_committed_isolation.enabled
• sql.txn_fingerprint_id_cache.capacity
• storage.max_sync_duration.fatal.enabled
• storage.value_blocks.enabled
• trace.debug_http_endpoint.enabled
• trace.opentelemetry.collector
• trace.snapshot.rate
• trace.span_registry.enabled
• trace.zipkin.collector
• ui.display_timezone
• version

Cluster settings scoped to the system virtual cluster

• admission.disk_bandwidth_tokens.elastic.enabled
• admission.kv.enabled
• physical_replication.consumer.minimum_flush_interval
• kv.allocator.lease_rebalance_threshold
• kv.allocator.load_based_lease_rebalancing.enabled
• kv.allocator.load_based_rebalancing
• kv.allocator.load_based_rebalancing.objective
• kv.allocator.load_based_rebalancing_interval
• kv.allocator.qps_rebalance_threshold
• kv.allocator.range_rebalance_threshold
• kv.allocator.store_cpu_rebalance_threshold
• kv.bulk_io_write.max_rate
• kv.bulk_sst.max_allowed_overage
• kv.log_range_and_node_events.enabled
• kv.range_split.by_load.enabled
• kv.range_split.load_cpu_threshold
• kv.range_split.load_qps_threshold
• kv.replica_circuit_breaker.slow_replication_threshold
• kv.replica_stats.addsst_request_size_factor
• kv.replication_reports.interval
• kv.snapshot_rebalance.max_rate
• kv.snapshot_receiver.excise.enabled
• kvadmission.store.provisioned_bandwidth
• server.consistency_check.max_rate
• server.rangelog.ttl
• server.shutdown.lease_transfer_iteration.timeout
• spanconfig.bounds.enabled
• spanconfig.range_coalescing.system.enabled
• spanconfig.range_coalescing.application.enabled
• storage.experimental.eventually_file_only_snapshots.enabled
• storage.ingest_split.enabled
• timeseries.storage.enabled

System-visible cluster settings

• cluster.organization
• diagnostics.active_query_dumps.enabled
• diagnostics.memory_monitoring_dumps.enabled
• enterprise.license
• kv.bulk_sst.target_size
• kv.closed_timestamp.follower_reads.enabled
• kv.closed_timestamp.lead_for_global_reads_override
• kv.closed_timestamp.side_transport_interval
• kv.closed_timestamp.target_duration
• kv.protectedts.reconciliation.interval
• kv.rangefeed.closed_timestamp_refresh_interval
• kv.rangefeed.enabled
• sql.schema.telemetry.recurrence
• storage.max_sync_duration
• timeseries.storage.resolution_10s.ttl
• timeseries.storage.resolution_30m.ttl

See also

• Cluster Virtualization Overview
• Cluster Metric Scopes with Cluster Virtualization Enabled
• Physical Cluster Replication