configuration-parameters.html 13 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. ### Key configuration parameters
  2. Name | Default value | Description | Modifiable?
  3. --------------------------------------------|---------------------------|-----------------------------------------------------------------------|--------------
  4. `cluster` | `quickstart` | The current cluster. | Yes
  5. `cluster_replica` | | The target cluster replica for `SELECT` queries. | Yes
  6. `database` | `materialize` | The current database. | Yes
  7. `search_path` | `public` | The schema search order for names that are not schema-qualified. | Yes
  8. `transaction_isolation` | `strict serializable` | The transaction isolation level. For more information, see [Consistency guarantees](/overview/isolation-level/). <br/><br/> Accepts values: `serializable`, `strict serializable`. | Yes
  9. ### Other configuration parameters
  10. Name | Default value | Description | Modifiable?
  11. --------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------
  12. `allowed_cluster_replica_sizes` | *Varies* | The allowed sizes when creating a new cluster replica. | [Contact support]
  13. `application_name` | | The application name to be reported in statistics and logs. This parameter is typically set by an application upon connection to Materialize (e.g. `psql`). | Yes
  14. `auto_route_catalog_queries` | `true` | Boolean flag indicating whether to force queries that depend only on system tables to run on the `mz_catalog_server` cluster for improved performance. | Yes
  15. `client_encoding` | `UTF8` | The client's character set encoding. The only supported value is `UTF-8`. | Yes
  16. `client_min_messages` | `notice` | The message levels that are sent to the client. <br/><br/> Accepts values: `debug5`, `debug4`, `debug3`, `debug2`, `debug1`, `log`, `notice`, `warning`, `error`. Each level includes all the levels that follow it. | Yes
  17. `datestyle` | `ISO, MDY` | The display format for date and time values. The only supported value is `ISO, MDY`. | Yes
  18. `emit_introspection_query_notice` | `true` | Whether to print a notice when querying replica introspection relations. | Yes
  19. `emit_timestamp_notice` | `false` | Boolean flag indicating whether to send a `notice` specifying query timestamps. | Yes
  20. `emit_trace_id_notice` | `false` | Boolean flag indicating whether to send a `notice` specifying the trace ID, when available. | Yes
  21. `enable_rbac_checks` | `true` | Boolean flag indicating whether to apply RBAC checks before executing statements. | Yes
  22. `enable_session_rbac_checks` | `false` | Boolean flag indicating whether RBAC is enabled for the current session. | No
  23. `extra_float_digits` | `3` | Boolean flag indicating whether to adjust the number of digits displayed for floating-point values. | Yes
  24. `failpoints` | | Allows failpoints to be dynamically activated. | No
  25. `idle_in_transaction_session_timeout` | `120s` | The maximum allowed duration that a session can sit idle in a transaction before being terminated. If this value is specified without units, it is taken as milliseconds (`ms`). A value of zero disables the timeout. | Yes
  26. `integer_datetimes` | `true` | Boolean flag indicating whether the server uses 64-bit-integer dates and times. | No
  27. `intervalstyle` | `postgres` | The display format for interval values. The only supported value is `postgres`. | Yes
  28. `is_superuser` | | Reports whether the current session is a _superuser_ with admin privileges. | No
  29. `max_aws_privatelink_connections` | `0` | The maximum number of AWS PrivateLink connections in the region, across all schemas. | [Contact support]
  30. `max_clusters` | `10` | The maximum number of clusters in the region | [Contact support]
  31. `max_connections` | `5000` | The maximum number of concurrent connections in the region | [Contact support]
  32. `max_credit_consumption_rate` | `1024` | The maximum rate of credit consumption in a region. Credits are consumed based on the size of cluster replicas in use. | [Contact support]
  33. `max_databases` | `1000` | The maximum number of databases in the region. | [Contact support]
  34. `max_identifier_length` | `255` | The maximum length in bytes of object identifiers. | No
  35. `max_kafka_connections` | `1000` | The maximum number of Kafka connections in the region, across all schemas. | [Contact support]
  36. `max_mysql_connections` | `1000` | The maximum number of MySQL connections in the region, across all schemas. | [Contact support]
  37. `max_objects_per_schema` | `1000` | The maximum number of objects in a schema. | [Contact support]
  38. `max_postgres_connections` | `1000` | The maximum number of PostgreSQL connections in the region, across all schemas. | [Contact support]
  39. `max_query_result_size` | `1073741824` | The maximum size in bytes for a single query's result. | Yes
  40. `max_replicas_per_cluster` | `5` | The maximum number of replicas of a single cluster | [Contact support]
  41. `max_result_size` | `1 GiB` | The maximum size in bytes for a single query's result. | [Contact support]
  42. `max_roles` | `1000` | The maximum number of roles in the region. | [Contact support]
  43. `max_schemas_per_database` | `1000` | The maximum number of schemas in a database. | [Contact support]
  44. `max_secrets` | `100` | The maximum number of secrets in the region, across all schemas. | [Contact support]
  45. `max_sinks` | `25` | The maximum number of sinks in the region, across all schemas. | [Contact support]
  46. `max_sources` | `25` | The maximum number of sources in the region, across all schemas. | [Contact support]
  47. `max_tables` | `200` | The maximum number of tables in the region, across all schemas | [Contact support]
  48. `mz_version` | Version-dependent | Shows the Materialize server version. | No
  49. `network_policy` | `default` | The default network policy for the region. | Yes
  50. `real_time_recency` | `false` | Boolean flag indicating whether [real-time recency](/get-started/isolation-level/#real-time-recency) is enabled for the current session. | [Contact support]
  51. `real_time_recency_timeout` | `10s` | Sets the maximum allowed duration of `SELECT` statements that actively use [real-time recency](/get-started/isolation-level/#real-time-recency). If this value is specified without units, it is taken as milliseconds (`ms`). | Yes
  52. `server_version_num` | Version-dependent | The PostgreSQL compatible server version as an integer. | No
  53. `server_version` | Version-dependent | The PostgreSQL compatible server version. | No
  54. `sql_safe_updates` | `false` | Boolean flag indicating whether to prohibit SQL statements that may be overly destructive. | Yes
  55. `standard_conforming_strings` | `true` | Boolean flag indicating whether ordinary string literals (`'...'`) should treat backslashes literally. The only supported value is `true`. | Yes
  56. `statement_timeout` | `10s` | The maximum allowed duration of the read portion of write operations; i.e., the `SELECT` portion of `INSERT INTO ... (SELECT ...)`; the `WHERE` portion of `UPDATE ... WHERE ...` and `DELETE FROM ... WHERE ...`. If this value is specified without units, it is taken as milliseconds (`ms`). | Yes
  57. `timezone` | `UTC` | The time zone for displaying and interpreting timestamps. The only supported value is `UTC`. | Yes
  58. [Contact support]: /support