create_cluster_options.yml 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. columns:
  2. - column: "Field"
  3. - column: "Value"
  4. - column: "Description"
  5. rows:
  6. - Field: "`SIZE`"
  7. Value: "text"
  8. Description: |
  9. The size of the resource allocations for the cluster. See
  10. [Size](/sql/create-cluster#size) for details.
  11. - Field: "`REPLICATION FACTOR`"
  12. Value: "text"
  13. Description: |
  14. The number of replicas to provision for the cluster. See
  15. [Replication factor](/sql/create-cluster#replication-factor) for details.
  16. Default: `1`
  17. - Field: "`INTROSPECTION INTERVAL`"
  18. Value: "interval"
  19. Description: |
  20. The interval at which to collect introspection data. See
  21. [Troubleshooting](/ops/troubleshooting) for details about introspection
  22. data. The special value `0` entirely disables the gathering of
  23. introspection data.
  24. Default: `1s`
  25. - Field: "`INTROSPECTION DEBUGGING`"
  26. Value: "bool"
  27. Description: |
  28. Indicates whether to introspect the gathering of the introspection data.
  29. Default: `FALSE`
  30. - Field: "`MANAGED`"
  31. Value: "bool"
  32. Description: >-
  33. Whether to automatically manage the cluster's replicas based on the
  34. configured size and replication factor.
  35. <a name="unmanaged-clusters"></a>
  36. Specify `FALSE` to create an **unmanaged** cluster. With unmanaged
  37. clusters, you need to manually manage the cluster's replicas using the
  38. the [`CREATE CLUSTER REPLICA`](/sql/create-cluster-replica) and [`DROP
  39. CLUSTER REPLICA`](/sql/drop-cluster-replica) commands. When creating an
  40. unmanaged cluster, you must specify the `REPLICAS` option as well.
  41. {{< tip >}}
  42. When getting started with Materialize, we recommend starting with managed
  43. clusters.
  44. {{</ tip >}}
  45. Default: `TRUE`
  46. - Field: "`SCHEDULE`"
  47. Value: "[`MANUAL`,`ON REFRESH`]"
  48. Description: |
  49. The [scheduling type](/sql/create-cluster/#scheduling) for the cluster.
  50. Default: `MANUAL`