From 5ba4b7273c55219a14411186daf5fb30ff6b8571 Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Wed, 6 Nov 2024 16:46:20 -0500 Subject: [PATCH] Backport changes from cockroachdb/docs#19001 Addresses DOC-10665, DOC-11674 Summary of changes: - Backport changes from cockroachdb/docs#19001; a few manual edits were required due to a few patches that didn't merge automagically --- .../releases/v23.1/v23.1.0-alpha.8.md | 2 +- .../v23.1/cdc/sql-cluster-settings-example.md | 4 +- .../v23.1/misc/install-next-steps.html | 2 +- .../prod-deployment/secure-start-nodes.md | 4 +- .../v23.2/cdc/examples-license-workload.md | 2 +- .../v23.2/cdc/sql-cluster-settings-example.md | 4 +- .../v23.2/misc/install-next-steps.html | 2 +- .../prod-deployment/secure-start-nodes.md | 4 +- .../v24.1/cdc/examples-license-workload.md | 2 +- .../v24.1/cdc/sql-cluster-settings-example.md | 4 +- .../_includes/v24.1/essential-alerts.md | 2 +- .../v24.1/misc/install-next-steps.html | 2 +- .../prod-deployment/secure-start-nodes.md | 4 +- .../v24.2/cdc/examples-license-workload.md | 2 +- .../v24.2/cdc/sql-cluster-settings-example.md | 4 +- .../_includes/v24.2/essential-alerts.md | 2 +- .../v24.2/misc/install-next-steps.html | 2 +- .../prod-deployment/secure-start-nodes.md | 4 +- src/current/v23.1/alter-backup-schedule.md | 6 --- src/current/v23.1/alter-database.md | 20 ++++----- src/current/v23.1/alter-index.md | 4 +- src/current/v23.1/alter-table.md | 2 +- src/current/v23.1/authentication.md | 4 +- .../v23.1/backup-and-restore-overview.md | 16 ++++---- src/current/v23.1/backup-validation.md | 4 -- src/current/v23.1/backup.md | 3 +- src/current/v23.1/changefeed-examples.md | 22 +++------- src/current/v23.1/changefeed-for.md | 4 -- ...ngefeeds-on-tables-with-column-families.md | 8 +--- .../v23.1/cockroach-start-single-node.md | 2 +- src/current/v23.1/cockroach-start.md | 2 +- .../v23.1/configure-replication-zones.md | 10 ++--- src/current/v23.1/create-changefeed.md | 4 -- src/current/v23.1/create-index.md | 2 +- .../v23.1/create-schedule-for-backup.md | 14 ++----- src/current/v23.1/create-table.md | 4 +- src/current/v23.1/create-user.md | 2 +- .../v23.1/demo-automatic-cloud-migration.md | 2 +- .../demo-fault-tolerance-and-recovery.md | 2 +- src/current/v23.1/demo-json-support.md | 2 +- .../v23.1/demo-replication-and-rebalancing.md | 2 +- src/current/v23.1/demo-serializable.md | 2 +- .../v23.1/deploy-cockroachdb-on-aws.md | 2 +- .../deploy-cockroachdb-with-kubernetes.md | 2 +- src/current/v23.1/drop-schedules.md | 2 +- src/current/v23.1/enable-node-map.md | 3 +- src/current/v23.1/enterprise-licensing.md | 2 - src/current/v23.1/follower-reads.md | 1 - .../v23.1/frequently-asked-questions.md | 2 +- .../get-started-with-enterprise-trial.md | 4 +- src/current/v23.1/learn-cockroachdb-sql.md | 2 +- src/current/v23.1/licensing-faqs.md | 17 +------- src/current/v23.1/manage-a-backup-schedule.md | 2 +- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v23.1/partitioning.md | 19 --------- src/current/v23.1/restore.md | 2 +- .../v23.1/security-reference/encryption.md | 2 +- .../security-reference/security-overview.md | 29 +------------ src/current/v23.1/sql-statements.md | 14 +++---- src/current/v23.1/sso-db-console.md | 2 +- src/current/v23.1/sso-sql.md | 2 +- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- .../take-and-restore-encrypted-backups.md | 4 -- ...take-and-restore-locality-aware-backups.md | 4 -- ...istory-and-restore-from-a-point-in-time.md | 4 -- .../take-full-and-incremental-backups.md | 14 +------ src/current/v23.1/ui-cluster-overview-page.md | 10 ++--- src/current/v23.1/ui-overview.md | 6 +-- src/current/v23.2/alter-backup-schedule.md | 6 --- src/current/v23.2/alter-database.md | 20 ++++----- src/current/v23.2/alter-index.md | 4 +- src/current/v23.2/alter-table.md | 2 +- src/current/v23.2/authentication.md | 4 +- .../v23.2/backup-and-restore-overview.md | 41 ------------------- src/current/v23.2/backup-validation.md | 4 -- src/current/v23.2/backup.md | 3 +- src/current/v23.2/changefeed-examples.md | 24 ++--------- src/current/v23.2/changefeed-for.md | 4 -- ...ngefeeds-on-tables-with-column-families.md | 8 +--- .../v23.2/cockroach-start-single-node.md | 2 +- src/current/v23.2/cockroach-start.md | 2 +- src/current/v23.2/column-level-encryption.md | 4 +- .../v23.2/configure-replication-zones.md | 10 ++--- src/current/v23.2/create-changefeed.md | 4 -- src/current/v23.2/create-index.md | 2 +- .../v23.2/create-schedule-for-backup.md | 14 ++----- src/current/v23.2/create-table.md | 4 +- src/current/v23.2/create-user.md | 2 +- .../v23.2/demo-automatic-cloud-migration.md | 2 +- .../demo-fault-tolerance-and-recovery.md | 2 +- src/current/v23.2/demo-json-support.md | 2 +- .../v23.2/demo-replication-and-rebalancing.md | 2 +- src/current/v23.2/demo-serializable.md | 2 +- .../v23.2/deploy-cockroachdb-on-aws.md | 2 +- .../deploy-cockroachdb-with-kubernetes.md | 2 +- .../v23.2/disaster-recovery-planning.md | 6 +-- src/current/v23.2/drop-schedules.md | 2 +- src/current/v23.2/enable-node-map.md | 3 +- src/current/v23.2/enterprise-licensing.md | 2 - src/current/v23.2/follower-reads.md | 1 - .../v23.2/frequently-asked-questions.md | 2 +- .../get-started-with-enterprise-trial.md | 4 +- src/current/v23.2/learn-cockroachdb-sql.md | 2 +- src/current/v23.2/licensing-faqs.md | 17 +------- src/current/v23.2/manage-a-backup-schedule.md | 2 +- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v23.2/partitioning.md | 19 --------- .../physical-cluster-replication-overview.md | 2 +- src/current/v23.2/restore.md | 2 +- .../v23.2/security-reference/encryption.md | 2 +- .../security-reference/security-overview.md | 29 +------------ .../set-up-physical-cluster-replication.md | 2 +- src/current/v23.2/sql-statements.md | 14 +++---- src/current/v23.2/sso-db-console.md | 2 +- src/current/v23.2/sso-sql.md | 2 +- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- .../take-and-restore-encrypted-backups.md | 4 -- ...take-and-restore-locality-aware-backups.md | 4 -- ...istory-and-restore-from-a-point-in-time.md | 4 -- .../take-full-and-incremental-backups.md | 14 +------ src/current/v23.2/ui-cluster-overview-page.md | 10 ++--- src/current/v23.2/ui-overview.md | 6 +-- src/current/v24.1/alter-backup-schedule.md | 6 --- src/current/v24.1/alter-database.md | 20 ++++----- src/current/v24.1/alter-index.md | 4 +- src/current/v24.1/alter-table.md | 2 +- src/current/v24.1/authentication.md | 4 +- .../v24.1/backup-and-restore-overview.md | 41 ------------------- src/current/v24.1/backup-validation.md | 4 -- src/current/v24.1/backup.md | 3 +- ...entication-using-the-x509-subject-field.md | 2 +- src/current/v24.1/changefeed-examples.md | 24 ++--------- src/current/v24.1/changefeed-for.md | 4 -- ...ngefeeds-on-tables-with-column-families.md | 8 +--- .../v24.1/cockroach-start-single-node.md | 2 +- src/current/v24.1/cockroach-start.md | 4 +- src/current/v24.1/column-level-encryption.md | 4 +- .../v24.1/configure-replication-zones.md | 10 ++--- src/current/v24.1/create-changefeed.md | 4 -- src/current/v24.1/create-index.md | 2 +- .../v24.1/create-schedule-for-backup.md | 14 ++----- src/current/v24.1/create-table.md | 4 +- src/current/v24.1/create-user.md | 2 +- .../v24.1/demo-automatic-cloud-migration.md | 2 +- .../demo-fault-tolerance-and-recovery.md | 2 +- src/current/v24.1/demo-json-support.md | 2 +- .../v24.1/demo-replication-and-rebalancing.md | 2 +- src/current/v24.1/demo-serializable.md | 2 +- .../v24.1/deploy-cockroachdb-on-aws.md | 2 +- .../deploy-cockroachdb-with-kubernetes.md | 2 +- .../v24.1/disaster-recovery-planning.md | 6 +-- src/current/v24.1/drop-schedules.md | 2 +- src/current/v24.1/enable-node-map.md | 3 +- src/current/v24.1/enterprise-licensing.md | 2 - src/current/v24.1/follower-reads.md | 1 - .../v24.1/frequently-asked-questions.md | 2 +- .../get-started-with-enterprise-trial.md | 4 +- src/current/v24.1/learn-cockroachdb-sql.md | 2 +- src/current/v24.1/licensing-faqs.md | 17 +------- src/current/v24.1/manage-a-backup-schedule.md | 2 +- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v24.1/partitioning.md | 19 --------- .../physical-cluster-replication-overview.md | 2 +- src/current/v24.1/restore.md | 2 +- .../v24.1/security-reference/encryption.md | 2 +- .../security-reference/security-overview.md | 29 +------------ .../set-up-physical-cluster-replication.md | 6 +-- src/current/v24.1/sql-statements.md | 14 +++---- src/current/v24.1/sso-db-console.md | 2 +- src/current/v24.1/sso-sql.md | 2 +- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- .../take-and-restore-encrypted-backups.md | 4 -- ...take-and-restore-locality-aware-backups.md | 4 -- ...istory-and-restore-from-a-point-in-time.md | 4 -- .../take-full-and-incremental-backups.md | 14 +------ src/current/v24.1/ui-cluster-overview-page.md | 10 ++--- src/current/v24.1/ui-overview.md | 6 +-- src/current/v24.2/alter-backup-schedule.md | 6 --- src/current/v24.2/alter-database.md | 20 ++++----- src/current/v24.2/alter-index.md | 4 +- src/current/v24.2/alter-table.md | 2 +- src/current/v24.2/authentication.md | 4 +- .../v24.2/backup-and-restore-overview.md | 41 ------------------- src/current/v24.2/backup-validation.md | 4 -- src/current/v24.2/backup.md | 3 +- ...entication-using-the-x509-subject-field.md | 2 +- src/current/v24.2/changefeed-examples.md | 24 ++--------- src/current/v24.2/changefeed-for.md | 4 -- ...ngefeeds-on-tables-with-column-families.md | 8 +--- .../v24.2/cockroach-start-single-node.md | 2 +- src/current/v24.2/cockroach-start.md | 4 +- src/current/v24.2/column-level-encryption.md | 4 +- .../v24.2/configure-replication-zones.md | 10 ++--- src/current/v24.2/cost-based-optimizer.md | 2 +- src/current/v24.2/create-changefeed.md | 4 -- src/current/v24.2/create-index.md | 2 +- .../v24.2/create-schedule-for-backup.md | 14 ++----- src/current/v24.2/create-table.md | 4 +- src/current/v24.2/create-user.md | 2 +- .../v24.2/demo-automatic-cloud-migration.md | 2 +- src/current/v24.2/demo-json-support.md | 2 +- .../v24.2/demo-replication-and-rebalancing.md | 2 +- src/current/v24.2/demo-serializable.md | 2 +- .../v24.2/deploy-cockroachdb-on-aws.md | 2 +- .../deploy-cockroachdb-with-kubernetes.md | 2 +- .../v24.2/disaster-recovery-planning.md | 6 +-- src/current/v24.2/drop-schedules.md | 2 +- src/current/v24.2/enable-node-map.md | 3 +- src/current/v24.2/enterprise-licensing.md | 2 - src/current/v24.2/follower-reads.md | 1 - .../v24.2/frequently-asked-questions.md | 2 +- .../get-started-with-enterprise-trial.md | 4 +- src/current/v24.2/learn-cockroachdb-sql.md | 2 +- src/current/v24.2/licensing-faqs.md | 17 +------- src/current/v24.2/manage-a-backup-schedule.md | 2 +- ...-local-cluster-with-kubernetes-insecure.md | 2 +- ...estrate-a-local-cluster-with-kubernetes.md | 2 +- src/current/v24.2/partitioning.md | 19 --------- .../physical-cluster-replication-overview.md | 2 +- src/current/v24.2/restore.md | 2 +- .../v24.2/security-reference/encryption.md | 2 +- .../security-reference/security-overview.md | 29 +------------ .../set-up-physical-cluster-replication.md | 6 +-- src/current/v24.2/sql-statements.md | 14 +++---- src/current/v24.2/sso-db-console.md | 2 +- src/current/v24.2/sso-sql.md | 2 +- ...feed-to-a-confluent-cloud-kafka-cluster.md | 2 +- ...m-a-changefeed-to-amazon-msk-serverless.md | 2 +- .../take-and-restore-encrypted-backups.md | 4 -- ...take-and-restore-locality-aware-backups.md | 4 -- ...istory-and-restore-from-a-point-in-time.md | 4 -- .../take-full-and-incremental-backups.md | 14 +------ src/current/v24.2/ui-cluster-overview-page.md | 10 ++--- src/current/v24.2/ui-overview.md | 6 +-- 237 files changed, 372 insertions(+), 1021 deletions(-) diff --git a/src/current/_includes/releases/v23.1/v23.1.0-alpha.8.md b/src/current/_includes/releases/v23.1/v23.1.0-alpha.8.md index 32750185403..4a845172b7b 100644 --- a/src/current/_includes/releases/v23.1/v23.1.0-alpha.8.md +++ b/src/current/_includes/releases/v23.1/v23.1.0-alpha.8.md @@ -17,7 +17,7 @@ Release Date: March 27, 2023 - The MuxRangefeed client, which is enabled with the `changefeed.mux_rangefeed.enabled` [cluster setting]({% link v23.1/cluster-settings.md %}), is now more efficient when running against large-scale workloads. [#97957][#97957] - The `server.oidc_authentication.claim_json_key` [cluster setting]({% link v23.1/cluster-settings.md %}) for DB Console SSO now accepts list-valued token claims. [#98522][#98522] - Added the `WITH` key_column option to override the message metadata key for [changefeeds]({% link v23.1/changefeed-examples.md %}). This changes the key hashed to determine Kafka partitions. It does not affect the output of `key_in_value` or the domain of the per-key ordering guarantee. [#98806][#98806] -- The [Node Map]({% link v23.1/ui-cluster-overview-page.md %}#node-map-enterprise) now shows normalized CPU usage. [#98225][#98225] +- The [Node Map]({% link v23.1/ui-cluster-overview-page.md %}#node-map) now shows normalized CPU usage. [#98225][#98225]

SQL language changes

diff --git a/src/current/_includes/v23.1/cdc/sql-cluster-settings-example.md b/src/current/_includes/v23.1/cdc/sql-cluster-settings-example.md index f8e0ca4a809..fa2887967a1 100644 --- a/src/current/_includes/v23.1/cdc/sql-cluster-settings-example.md +++ b/src/current/_includes/v23.1/cdc/sql-cluster-settings-example.md @@ -5,7 +5,7 @@ $ cockroach sql --insecure ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~ sql @@ -24,4 +24,4 @@ > SET CLUSTER SETTING kv.rangefeed.enabled = true; ~~~ - {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} \ No newline at end of file + {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} diff --git a/src/current/_includes/v23.1/misc/install-next-steps.html b/src/current/_includes/v23.1/misc/install-next-steps.html index bb7a9ebc388..3783b5fccb0 100644 --- a/src/current/_includes/v23.1/misc/install-next-steps.html +++ b/src/current/_includes/v23.1/misc/install-next-steps.html @@ -4,7 +4,7 @@
  • Start a cluster locally and talk to it via the built-in SQL client
  • Learn more about CockroachDB SQL
  • Build a simple application with CockroachDB using PostgreSQL-compatible client drivers and ORMs
    • -
  • Explore core CockroachDB features like automatic replication, rebalancing, and fault tolerance
    • +
  • Explore CockroachDB features like automatic replication, rebalancing, and fault tolerance
  • If you're ready to run CockroachDB in production: diff --git a/src/current/_includes/v23.1/prod-deployment/secure-start-nodes.md b/src/current/_includes/v23.1/prod-deployment/secure-start-nodes.md index 78e975874c6..8eb2eb6e9c2 100644 --- a/src/current/_includes/v23.1/prod-deployment/secure-start-nodes.md +++ b/src/current/_includes/v23.1/prod-deployment/secure-start-nodes.md @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the `--cache`
    `--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size). `--background` | Starts the node in the background so you gain control of the terminal to issue more commands. - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the {% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %} - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). diff --git a/src/current/_includes/v23.2/cdc/examples-license-workload.md b/src/current/_includes/v23.2/cdc/examples-license-workload.md index 9e1c4580ef3..32d395aaed8 100644 --- a/src/current/_includes/v23.2/cdc/examples-license-workload.md +++ b/src/current/_includes/v23.2/cdc/examples-license-workload.md @@ -1,4 +1,4 @@ -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/_includes/v23.2/cdc/sql-cluster-settings-example.md b/src/current/_includes/v23.2/cdc/sql-cluster-settings-example.md index f8e0ca4a809..fa2887967a1 100644 --- a/src/current/_includes/v23.2/cdc/sql-cluster-settings-example.md +++ b/src/current/_includes/v23.2/cdc/sql-cluster-settings-example.md @@ -5,7 +5,7 @@ $ cockroach sql --insecure ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~ sql @@ -24,4 +24,4 @@ > SET CLUSTER SETTING kv.rangefeed.enabled = true; ~~~ - {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} \ No newline at end of file + {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} diff --git a/src/current/_includes/v23.2/misc/install-next-steps.html b/src/current/_includes/v23.2/misc/install-next-steps.html index bb7a9ebc388..3783b5fccb0 100644 --- a/src/current/_includes/v23.2/misc/install-next-steps.html +++ b/src/current/_includes/v23.2/misc/install-next-steps.html @@ -4,7 +4,7 @@
  • Start a cluster locally and talk to it via the built-in SQL client
  • Learn more about CockroachDB SQL
  • Build a simple application with CockroachDB using PostgreSQL-compatible client drivers and ORMs
    • -
  • Explore core CockroachDB features like automatic replication, rebalancing, and fault tolerance
    • +
  • Explore CockroachDB features like automatic replication, rebalancing, and fault tolerance
  • If you're ready to run CockroachDB in production: diff --git a/src/current/_includes/v23.2/prod-deployment/secure-start-nodes.md b/src/current/_includes/v23.2/prod-deployment/secure-start-nodes.md index 0af2606b90b..41f9dcb62d2 100644 --- a/src/current/_includes/v23.2/prod-deployment/secure-start-nodes.md +++ b/src/current/_includes/v23.2/prod-deployment/secure-start-nodes.md @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the `--cache`
    `--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size). `--background` | Starts the node in the background so you gain control of the terminal to issue more commands. - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the {% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %} - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). diff --git a/src/current/_includes/v24.1/cdc/examples-license-workload.md b/src/current/_includes/v24.1/cdc/examples-license-workload.md index 9e1c4580ef3..32d395aaed8 100644 --- a/src/current/_includes/v24.1/cdc/examples-license-workload.md +++ b/src/current/_includes/v24.1/cdc/examples-license-workload.md @@ -1,4 +1,4 @@ -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/_includes/v24.1/cdc/sql-cluster-settings-example.md b/src/current/_includes/v24.1/cdc/sql-cluster-settings-example.md index f8e0ca4a809..fa2887967a1 100644 --- a/src/current/_includes/v24.1/cdc/sql-cluster-settings-example.md +++ b/src/current/_includes/v24.1/cdc/sql-cluster-settings-example.md @@ -5,7 +5,7 @@ $ cockroach sql --insecure ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~ sql @@ -24,4 +24,4 @@ > SET CLUSTER SETTING kv.rangefeed.enabled = true; ~~~ - {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} \ No newline at end of file + {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} diff --git a/src/current/_includes/v24.1/essential-alerts.md b/src/current/_includes/v24.1/essential-alerts.md index d4132dce9cb..578e28d9aa8 100644 --- a/src/current/_includes/v24.1/essential-alerts.md +++ b/src/current/_includes/v24.1/essential-alerts.md @@ -180,7 +180,7 @@ CockroachDB uses the [Pebble]({% link {{ page.version.version }}/architecture/st ### Enterprise license expiration -Avoid [enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) expiration to avoid any disruption to feature access. +Avoid [license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) expiration to avoid any disruption to feature access. **Metric**
    [`seconds.until.enterprise.license.expiry`]({% link {{ page.version.version }}/essential-metrics-{{ include.deployment }}.md %}#seconds-until-enterprise-license-expiry) diff --git a/src/current/_includes/v24.1/misc/install-next-steps.html b/src/current/_includes/v24.1/misc/install-next-steps.html index bb7a9ebc388..3783b5fccb0 100644 --- a/src/current/_includes/v24.1/misc/install-next-steps.html +++ b/src/current/_includes/v24.1/misc/install-next-steps.html @@ -4,7 +4,7 @@
  • Start a cluster locally and talk to it via the built-in SQL client
  • Learn more about CockroachDB SQL
  • Build a simple application with CockroachDB using PostgreSQL-compatible client drivers and ORMs
    • -
  • Explore core CockroachDB features like automatic replication, rebalancing, and fault tolerance
    • +
  • Explore CockroachDB features like automatic replication, rebalancing, and fault tolerance
  • If you're ready to run CockroachDB in production: diff --git a/src/current/_includes/v24.1/prod-deployment/secure-start-nodes.md b/src/current/_includes/v24.1/prod-deployment/secure-start-nodes.md index b9ee8bb0935..f3c554f4f19 100644 --- a/src/current/_includes/v24.1/prod-deployment/secure-start-nodes.md +++ b/src/current/_includes/v24.1/prod-deployment/secure-start-nodes.md @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the `--cache`
    `--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size). `--background` | Starts the node in the background so you gain control of the terminal to issue more commands. - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the {% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %} - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). diff --git a/src/current/_includes/v24.2/cdc/examples-license-workload.md b/src/current/_includes/v24.2/cdc/examples-license-workload.md index 9e1c4580ef3..32d395aaed8 100644 --- a/src/current/_includes/v24.2/cdc/examples-license-workload.md +++ b/src/current/_includes/v24.2/cdc/examples-license-workload.md @@ -1,4 +1,4 @@ -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/_includes/v24.2/cdc/sql-cluster-settings-example.md b/src/current/_includes/v24.2/cdc/sql-cluster-settings-example.md index f8e0ca4a809..fa2887967a1 100644 --- a/src/current/_includes/v24.2/cdc/sql-cluster-settings-example.md +++ b/src/current/_includes/v24.2/cdc/sql-cluster-settings-example.md @@ -5,7 +5,7 @@ $ cockroach sql --insecure ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~ sql @@ -24,4 +24,4 @@ > SET CLUSTER SETTING kv.rangefeed.enabled = true; ~~~ - {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} \ No newline at end of file + {% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %} diff --git a/src/current/_includes/v24.2/essential-alerts.md b/src/current/_includes/v24.2/essential-alerts.md index d4132dce9cb..578e28d9aa8 100644 --- a/src/current/_includes/v24.2/essential-alerts.md +++ b/src/current/_includes/v24.2/essential-alerts.md @@ -180,7 +180,7 @@ CockroachDB uses the [Pebble]({% link {{ page.version.version }}/architecture/st ### Enterprise license expiration -Avoid [enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) expiration to avoid any disruption to feature access. +Avoid [license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) expiration to avoid any disruption to feature access. **Metric**
    [`seconds.until.enterprise.license.expiry`]({% link {{ page.version.version }}/essential-metrics-{{ include.deployment }}.md %}#seconds-until-enterprise-license-expiry) diff --git a/src/current/_includes/v24.2/misc/install-next-steps.html b/src/current/_includes/v24.2/misc/install-next-steps.html index bb7a9ebc388..3783b5fccb0 100644 --- a/src/current/_includes/v24.2/misc/install-next-steps.html +++ b/src/current/_includes/v24.2/misc/install-next-steps.html @@ -4,7 +4,7 @@
  • Start a cluster locally and talk to it via the built-in SQL client
  • Learn more about CockroachDB SQL
  • Build a simple application with CockroachDB using PostgreSQL-compatible client drivers and ORMs
    • -
  • Explore core CockroachDB features like automatic replication, rebalancing, and fault tolerance
    • +
  • Explore CockroachDB features like automatic replication, rebalancing, and fault tolerance
  • If you're ready to run CockroachDB in production: diff --git a/src/current/_includes/v24.2/prod-deployment/secure-start-nodes.md b/src/current/_includes/v24.2/prod-deployment/secure-start-nodes.md index b9ee8bb0935..f3c554f4f19 100644 --- a/src/current/_includes/v24.2/prod-deployment/secure-start-nodes.md +++ b/src/current/_includes/v24.2/prod-deployment/secure-start-nodes.md @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the `--cache`
    `--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size). `--background` | Starts the node in the background so you gain control of the terminal to issue more commands. - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the {% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %} - When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). + When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality). For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}). diff --git a/src/current/v23.1/alter-backup-schedule.md b/src/current/v23.1/alter-backup-schedule.md index a0d11752048..b7a091220f5 100644 --- a/src/current/v23.1/alter-backup-schedule.md +++ b/src/current/v23.1/alter-backup-schedule.md @@ -5,12 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - The `ALTER BACKUP SCHEDULE` statement modifies an existing [backup schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). You can use `ALTER BACKUP SCHEDULE` to do the following: - Set a different name for a backup schedule. diff --git a/src/current/v23.1/alter-database.md b/src/current/v23.1/alter-database.md index 0cf5d457111..3232718eecd 100644 --- a/src/current/v23.1/alter-database.md +++ b/src/current/v23.1/alter-database.md @@ -33,21 +33,21 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description -----------|------------ -[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`ALTER LOCALITY`](#alter-locality) | Persistently modify the configuration generated by the standard [multi-region SQL abstractions]({% link {{ page.version.version }}/multiregion-overview.md %}) on a per-region basis. For advanced users who want to customize their multi-region setup using [Zone Config Extensions]({% link {{ page.version.version }}/zone-config-extensions.md %}), a persistent, composable alternative to low-level [zone configs]({% link {{ page.version.version }}/configure-replication-zones.md %}). -[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for a database. -[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). [`OWNER TO`](#owner-to) | Change the owner of a database. [`PLACEMENT`](#placement) | Configure the replica placement policy for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). [`RENAME TO`](#rename-to) | Change the name of a database. [`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). [`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). -[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. [`SURVIVE {ZONE,REGION} FAILURE`](#survive-zone-region-failure) | Add a survival goal to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ### `ADD REGION` @@ -282,7 +282,7 @@ For usage, see [Synopsis](#synopsis). ### `PLACEMENT` -`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. +`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. `ALTER DATABASE ... PLACEMENT RESTRICTED` constrains the voting and non-voting replica placement for the database's tables to the [home regions]({% link {{ page.version.version }}/alter-table.md %}#crdb_region) associated with those tables. This is a way of opting out of [non-voting replicas]({% link {{ page.version.version }}/architecture/replication-layer.md %}#non-voting-replicas) for [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) to accomplish one or more of the following goals: @@ -779,7 +779,7 @@ ALTER DATABASE movr ADD REGION "europe-west1"; #### Override specific fields of a schema object's zone configs -In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. +In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences`. diff --git a/src/current/v23.1/alter-index.md b/src/current/v23.1/alter-index.md index 3653b53898e..c0f47d781b7 100644 --- a/src/current/v23.1/alter-index.md +++ b/src/current/v23.1/alter-index.md @@ -35,8 +35,8 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description | -----------|-------------| -[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. | +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. [`RENAME TO`](#rename-to) | Change the name of an index. [`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the index. [`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the index. diff --git a/src/current/v23.1/alter-table.md b/src/current/v23.1/alter-table.md index 6002120ce2c..9f6dd99f04d 100644 --- a/src/current/v23.1/alter-table.md +++ b/src/current/v23.1/alter-table.md @@ -54,7 +54,7 @@ Subcommand | Description | Can combine with other subcommands? [`DROP CONSTRAINT`](#drop-constraint) | Remove constraints from columns. | Yes [`EXPERIMENTAL_AUDIT`](#experimental_audit) | Enable per-table audit logs, for security purposes. | Yes [`OWNER TO`](#owner-to) | Change the owner of the table. | No -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | Yes +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. | Yes [`RENAME COLUMN`](#rename-column) | Change the names of columns. | Yes [`RENAME CONSTRAINT`](#rename-constraint) | Change constraints columns. | Yes [`RENAME TO`](#rename-to) | Change the names of tables. | No diff --git a/src/current/v23.1/authentication.md b/src/current/v23.1/authentication.md index 188e29b38a0..fbb7b8fb5eb 100644 --- a/src/current/v23.1/authentication.md +++ b/src/current/v23.1/authentication.md @@ -101,9 +101,9 @@ CockroachDB offers the following methods for client authentication: Enter password: ~~~ -- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}). -- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}). ### Using `cockroach cert` or `openssl` commands diff --git a/src/current/v23.1/backup-and-restore-overview.md b/src/current/v23.1/backup-and-restore-overview.md index db4657866f3..6bdeaf7919d 100644 --- a/src/current/v23.1/backup-and-restore-overview.md +++ b/src/current/v23.1/backup-and-restore-overview.md @@ -27,14 +27,14 @@ This table outlines the level of product support for backup and restore features Backup / Restore | Description | Product Support ------------------+--------------+----------------- -[Full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) | An un-replicated copy of your cluster, database, or table's data. A full backup is the base for any further backups. |
    • All products (Enterprise license not required)
        • -[Incremental backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) | A copy of the changes in your data since the specified base backup (either a full backup or a full backup plus an incremental backup). |
        • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
        • CockroachDB {{ site.data.products.advanced }} — managed backups and self-managed backups
        • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
            • -[Scheduled backup]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}) | A schedule for periodic backups. |
            • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
            • CockroachDB {{ site.data.products.advanced }} — self-managed backups
            • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
                • -[Backups with revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) | A backup with revision history allows you to back up every change made within the garbage collection period leading up to and including the given timestamp. |
                • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
                    • -[Point-in-time restore]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) | A restore from an arbitrary point in time within the revision history of a backup. |
                    • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                    • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                    • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
                        • -[Encrypted backup and restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | An encrypted backup using a KMS or passphrase. |
                        • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                        • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                        • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
                            • -[Locality-aware backup and restore]({% link {{ page.version.version }}/take-and-restore-locality-aware-backups.md %}) | A backup where each node writes files to the backup destination that matches the node locality configured at node startup. |
                            • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                            • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                            • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
                                • -[Locality-restricted backup execution]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) | A backup with the `EXECUTION LOCALITY` option restricts the nodes that can execute a backup job with a defined locality filter. |
                                • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                • CockroachDB {{ site.data.products.core }} with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %})
                                    • +[Full backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) | An un-replicated copy of your cluster, database, or table's data. A full backup is the base for any further backups. |
                                    • All products
                                        • +[Incremental backup]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) | A copy of the changes in your data since the specified base backup (either a full backup or a full backup plus an incremental backup). |
                                        • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                        • CockroachDB {{ site.data.products.advanced }} — managed backups and self-managed backups
                                        • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                            • +[Scheduled backup]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}) | A schedule for periodic backups. |
                                            • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                            • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                            • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                                • +[Backups with revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) | A backup with revision history allows you to back up every change made within the garbage collection period leading up to and including the given timestamp. |
                                                • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                                • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                                • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                                    • +[Point-in-time restore]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) | A restore from an arbitrary point in time within the revision history of a backup. |
                                                    • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                                    • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                                    • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                                        • +[Encrypted backup and restore]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}) | An encrypted backup using a KMS or passphrase. |
                                                        • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                                        • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                                        • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                                            • +[Locality-aware backup and restore]({% link {{ page.version.version }}/take-and-restore-locality-aware-backups.md %}) | A backup where each node writes files to the backup destination that matches the node locality configured at node startup. |
                                                            • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                                            • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                                            • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                                                • +[Locality-restricted backup execution]({% link {{ page.version.version }}/take-locality-restricted-backups.md %}) | A backup with the `EXECUTION LOCALITY` option restricts the nodes that can execute a backup job with a defined locality filter. |
                                                                • CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} — self-managed backups
                                                                • CockroachDB {{ site.data.products.advanced }} — self-managed backups
                                                                • CockroachDB with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses)
                                                                    • ### Additional backup and restore features diff --git a/src/current/v23.1/backup-validation.md b/src/current/v23.1/backup-validation.md index aa5e38e7b6d..7b09a27c835 100644 --- a/src/current/v23.1/backup-validation.md +++ b/src/current/v23.1/backup-validation.md @@ -15,10 +15,6 @@ You can validate a backup of a [cluster]({% link {{ page.version.version }}/back The options that give the most validation coverage will increase the runtime of the check. That is, `verify_backup_table_data` will take a longer time to validate a backup compared to `check_files` or `schema_only` alone. Despite that, each of these validation options provide a quicker way to validate a backup over running a "regular" restore. -{{site.data.alerts.callout_info}} -You do **not** need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to run any of the backup validation tools described on this page. -{{site.data.alerts.end}} - ## Recommendations Cockroach Labs recommends implementing the following validation plan to test your backups: diff --git a/src/current/v23.1/backup.md b/src/current/v23.1/backup.md index f35a8fad719..89952b9b73b 100644 --- a/src/current/v23.1/backup.md +++ b/src/current/v23.1/backup.md @@ -32,8 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -- [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. +- [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes a license, the license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. - Exclude a table's row data from a backup using the [`exclude_data_from_backup`]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#exclude-a-tables-data-from-backups) parameter. diff --git a/src/current/v23.1/changefeed-examples.md b/src/current/v23.1/changefeed-examples.md index 68c1e67195f..04a931a17e9 100644 --- a/src/current/v23.1/changefeed-examples.md +++ b/src/current/v23.1/changefeed-examples.md @@ -5,7 +5,7 @@ toc: true docs_area: stream_data --- -This page provides step-by-step examples for using Core and {{ site.data.products.enterprise }} changefeeds. Creating {{ site.data.products.enterprise }} changefeeds is available on CockroachDB {{ site.data.products.standard }}, {{ site.data.products.advanced }}, {{ site.data.products.basic }}, and with an [{{ site.data.products.enterprise }} license](enterprise-licensing.html) on CockroachDB {{ site.data.products.core }} clusters. Core changefeeds are available in all products. +This page provides step-by-step examples for using Core and {{ site.data.products.enterprise }} changefeeds. Creating {{ site.data.products.enterprise }} changefeeds is available on CockroachDB {{ site.data.products.standard }}, {{ site.data.products.advanced }}, {{ site.data.products.basic }}, and with an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on CockroachDB {{ site.data.products.core }} clusters. Core changefeeds are available in all products. For a comparative summary of all Core and {{ site.data.products.enterprise }} changefeed features, refer to the [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page. @@ -39,13 +39,9 @@ You can set up a changefeed that uses [change data capture queries]({% link {{ p ## Create a changefeed connected to Kafka -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -184,13 +180,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to Kafka using Avro -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed-using-avro). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink and emits [Avro](https://avro.apache.org/docs/1.8.2/spec.html) records. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -341,7 +333,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co You'll need access to a [Google Cloud Project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to set up a Pub/Sub sink. In this example, the [Google Cloud CLI](https://cloud.google.com/sdk/docs/install-sdk) (`gcloud`) is used, but you can also complete each of these steps within your [Google Cloud Console](https://cloud.google.com/storage/docs/cloud-console). -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -484,13 +476,9 @@ You'll need access to a [Google Cloud Project](https://cloud.google.com/resource ## Create a changefeed connected to a cloud storage sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to an AWS S3 sink. The changefeed watches two tables. Note that you can set up changefeeds for any of [these cloud storage providers]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink). -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/v23.1/changefeed-for.md b/src/current/v23.1/changefeed-for.md index 62e882c6e18..6c23e259bfc 100644 --- a/src/current/v23.1/changefeed-for.md +++ b/src/current/v23.1/changefeed-for.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`EXPERIMENTAL CHANGEFEED FOR` is the core implementation of changefeeds. For the [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) version, see [`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}). -{{site.data.alerts.end}} - The `EXPERIMENTAL CHANGEFEED FOR` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new core changefeed, which streams row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. A core changefeed can watch one table or multiple tables in a comma-separated list. For more information, see [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}). diff --git a/src/current/v23.1/changefeeds-on-tables-with-column-families.md b/src/current/v23.1/changefeeds-on-tables-with-column-families.md index 91e115557fe..069242510ae 100644 --- a/src/current/v23.1/changefeeds-on-tables-with-column-families.md +++ b/src/current/v23.1/changefeeds-on-tables-with-column-families.md @@ -94,13 +94,9 @@ For examples of starting changefeeds on tables with column families, see the fol ## Create a changefeed on a table with column families -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example]({% link {{ page.version.version }}/changefeeds-on-tables-with-column-families.md %}?filters=core#create-a-core-changefeed-on-a-table-with-column-families). -{{site.data.alerts.end}} - In this example, you'll set up changefeeds on two tables that have [column families]({% link {{ page.version.version }}/column-families.md %}). You'll use a single-node cluster sending changes to a webhook sink for this example, but you can use any [changefeed sink]({% link {{ page.version.version }}/changefeed-sinks.md %}) to work with tables that include column families. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -116,7 +112,7 @@ In this example, you'll set up changefeeds on two tables that have [column famil cockroach sql --insecure ~~~ -1. Set your organization and [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization and license key: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v23.1/cockroach-start-single-node.md b/src/current/v23.1/cockroach-start-single-node.md index 699869b8859..ac6f5b93c0e 100644 --- a/src/current/v23.1/cockroach-start-single-node.md +++ b/src/current/v23.1/cockroach-start-single-node.md @@ -69,7 +69,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                    Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                    **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                    **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                    This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                    Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                    This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). ### Store diff --git a/src/current/v23.1/cockroach-start.md b/src/current/v23.1/cockroach-start.md index 41b9c4b7f44..666ebbe28b7 100644 --- a/src/current/v23.1/cockroach-start.md +++ b/src/current/v23.1/cockroach-start.md @@ -101,7 +101,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                    Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                    **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                    **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                    This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                    Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                    This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). `--external-io-disable-http` | This optional flag disables external HTTP(S) access (as well as custom HTTP(S) endpoints) when performing bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %}), [`IMPORT`]({% link {{ page.version.version }}/import.md %}), etc.). This can be used in environments where you cannot run a full proxy server.

                                                                    If you want to run a proxy server, you can start CockroachDB while specifying the `HTTP(S)_PROXY` environment variable. `--external-io-disable-implicit-credentials` | This optional flag disables the use of implicit credentials when accessing external cloud storage services for bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %}), [`IMPORT`]({% link {{ page.version.version }}/import.md %}), etc.). diff --git a/src/current/v23.1/configure-replication-zones.md b/src/current/v23.1/configure-replication-zones.md index aeba9db689e..1a61cf26308 100644 --- a/src/current/v23.1/configure-replication-zones.md +++ b/src/current/v23.1/configure-replication-zones.md @@ -10,8 +10,8 @@ Replication zones give you the power to control what data goes where in your Coc - Databases - Tables -- Rows ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) -- Indexes ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) +- Rows +- Indexes - All data in the cluster, including internal system data ([via the default replication zone](#view-the-default-replication-zone)) For each of these objects you can control: @@ -37,7 +37,7 @@ When a cluster starts, there are two categories of replication zone: 1. Pre-configured replication zones that apply to internal system data. 1. A single default replication zone that applies to the rest of the cluster. -You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. Note that adding zones for rows and secondary indexes is [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. For example, you might rely on the [default zone](#view-the-default-replication-zone) to spread most of a cluster's data across all of your availability zones, but [create a custom replication zone for a specific database](#create-a-replication-zone-for-a-database) to make sure its data is only stored in certain availability zones and/or geographies. @@ -50,8 +50,8 @@ Level | Description Cluster | CockroachDB comes with a pre-configured `default` replication zone that applies to all table data in the cluster not constrained by a database, table, or row-specific replication zone. This zone can be adjusted but not removed. See [View the Default Replication Zone](#view-the-default-replication-zone) and [Edit the Default Replication Zone](#edit-the-default-replication-zone) for more details. Database | You can add replication zones for specific databases. See [Create a Replication Zone for a Database](#create-a-replication-zone-for-a-database) for more details. Table | You can add replication zones for specific tables. See [Create a Replication Zone for a Table](#create-a-replication-zone-for-a-table). -Index ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. -Row ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. +Index | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. +Row | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. ### For system data diff --git a/src/current/v23.1/create-changefeed.md b/src/current/v23.1/create-changefeed.md index 7941dda926b..d5effa0f6eb 100644 --- a/src/current/v23.1/create-changefeed.md +++ b/src/current/v23.1/create-changefeed.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`CREATE CHANGEFEED` is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the core version, see [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}). -{{site.data.alerts.end}} - The `CREATE CHANGEFEED` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new {{ site.data.products.enterprise }} changefeed, which targets an allowlist of tables called "watched rows". Every change to a watched row is emitted as a record in a configurable format (`JSON` or Avro) to a [configurable sink]({% link {{ page.version.version }}/changefeed-sinks.md %}). `CREATE CHANGEFEED` also supports [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that allow you to filter and transform change data before emitting changefeed messages. You can [create](#examples), [pause](#pause-a-changefeed), [resume](#resume-a-paused-changefeed), [alter]({% link {{ page.version.version }}/alter-changefeed.md %}), or [cancel](#cancel-a-changefeed) an {{ site.data.products.enterprise }} changefeed. To get started with changefeeds, refer to the [Create and Configure Changefeeds]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}) page for important usage considerations. For detail on how changefeeds emit messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page. diff --git a/src/current/v23.1/create-index.md b/src/current/v23.1/create-index.md index 04e69b30671..4d065a3a2cd 100644 --- a/src/current/v23.1/create-index.md +++ b/src/current/v23.1/create-index.md @@ -51,7 +51,7 @@ Parameter | Description `name` | The name of the column you want to index. For [multi-region tables]({% link {{ page.version.version }}/multiregion-overview.md %}#table-localities), you can use the `crdb_region` column within the index in the event the original index may contain non-unique entries across multiple, unique regions. `ASC` or `DESC`| Sort the column in ascending (`ASC`) or descending (`DESC`) order in the index. How columns are sorted affects query results, particularly when using `LIMIT`.

                                                                    __Default:__ `ASC` `STORING ...`| Store (but do not sort) each column whose name you include.

                                                                    For information on when to use `STORING`, see [Store Columns](#store-columns). Note that columns that are part of a table's [`PRIMARY KEY`]({% link {{ page.version.version }}/primary-key.md %}) cannot be specified as `STORING` columns in secondary indexes on the table.

                                                                    `COVERING` and `INCLUDE` are aliases for `STORING` and work identically. -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. +`opt_partition_by` | An option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE` or `NOT VISIBLE` clause that indicates whether an index is visible to the [cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If `NOT VISIBLE`, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For an example, see [Set an index to be not visible]({% link {{ page.version.version }}/alter-index.md %}#set-an-index-to-be-not-visible).

                                                                    Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations](alter-index.html#not-visible). `USING HASH` | Creates a [hash-sharded index]({% link {{ page.version.version }}/hash-sharded-indexes.md %}). diff --git a/src/current/v23.1/create-schedule-for-backup.md b/src/current/v23.1/create-schedule-for-backup.md index bb3ce2ce4e3..0557691ab51 100644 --- a/src/current/v23.1/create-schedule-for-backup.md +++ b/src/current/v23.1/create-schedule-for-backup.md @@ -9,12 +9,6 @@ docs_area: reference.sql For more information about creating, managing, monitoring, and restoring from a scheduled backup, see [Manage a Backup Schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups](#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## Required privileges {% include {{ page.version.version }}/backups/updated-backup-privileges.md %} @@ -59,7 +53,7 @@ Targets: `location` | The URI where you want to store the backup. The backup files will be stored in year > month > day subdirectories. The location can be [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}), or `nodelocal`.

                                                                    Note: If you want to schedule a backup using temporary credentials, we recommend that you use `implicit` authentication; otherwise, you'll need to drop and then recreate schedules each time you need to update the credentials. `backup_options` | Control the backup behavior with a comma-separated list of [options](#backup-options). `RECURRING crontab` | Specifies when the backup should be taken. A separate schedule may be created automatically to write full backups at a regular cadence, depending on the frequency of the incremental backups. You can likewise modify this separate schedule with [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}). The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron). All times in UTC.

                                                                    Example: `'@daily'` (run daily at midnight) -`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                    If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                    **Note:** If you do not have an Enterprise license then you can only take full backups. `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                    If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                    • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                    • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                    • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                    +`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                    If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                    `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                    If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                    • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                    • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                    • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                    `WITH SCHEDULE OPTIONS schedule_option` | Control the schedule behavior with a comma-separated list of [these options](#schedule-options). {{site.data.alerts.callout_info}} @@ -126,9 +120,9 @@ You can also visit the [**Jobs** page]({% link {{ page.version.version }}/ui-job ## Examples -### Create a schedule for full backups only (core) +### Create a schedule for full backups only -Core users can only use backup scheduling for full backups of clusters, databases, or tables. Full backups are taken with the `FULL BACKUP ALWAYS` clause, for example: +To schedule full backups of clusters, databases, or tables, use the `FULL BACKUP ALWAYS` clause, for example: {% include_cached copy-clipboard.html %} ~~~ sql @@ -145,8 +139,6 @@ Core users can only use backup scheduling for full backups of clusters, database (1 row) ~~~ -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - ### Create a scheduled backup for a cluster This example creates a schedule for a cluster backup with revision history that's taken every day at midnight: diff --git a/src/current/v23.1/create-table.md b/src/current/v23.1/create-table.md index 31c58d8a463..0976255a0d8 100644 --- a/src/current/v23.1/create-table.md +++ b/src/current/v23.1/create-table.md @@ -106,8 +106,8 @@ Parameter | Description `family_def` | An optional, comma-separated list of [column family definitions]({% link {{ page.version.version }}/column-families.md %}). Column family names must be unique within the table but can have the same name as columns, constraints, or indexes.

                                                                    A column family is a group of columns that are stored as a single key-value pair in the underlying key-value store. CockroachDB automatically groups columns into families to ensure efficient storage and performance. However, there are cases when you may want to manually assign columns to families. For more details, see [Column Families]({% link {{ page.version.version }}/column-families.md %}). `table_constraint` | An optional, comma-separated list of [table-level constraints]({% link {{ page.version.version }}/constraints.md %}). Constraint names must be unique within the table but can have the same name as columns, column families, or indexes. `LIKE table_name like_table_option_list` | Create a new table based on the schema of an existing table, using supported specifiers. For details, see [Create a table like an existing table](#create-a-table-like-an-existing-table). For examples, see [Create a new table from an existing one](#create-a-new-table-from-an-existing-one). -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. -`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).

                                                                    Note that multi-region features require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`opt_partition_by` | An option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. +`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE` or `NOT VISIBLE` clause that indicates whether an index is visible to the [cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If `NOT VISIBLE`, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For an example, see [Set an index to be not visible]({% link {{ page.version.version }}/alter-index.md %}#set-an-index-to-be-not-visible).

                                                                    Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations]({% link {{ page.version.version }}/alter-index.md %}#not-visible). `opt_with_storage_parameter_list` | A comma-separated list of [spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). Supported parameters include `fillfactor`, `s2_max_level`, `s2_level_mod`, `s2_max_cells`, `geometry_min_x`, `geometry_max_x`, `geometry_min_y`, and `geometry_max_y`. The `fillfactor` parameter is a no-op, allowed for PostgreSQL-compatibility.

                                                                    For details, see [Spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). For an example, see [Create a spatial index that uses all of the tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#create-a-spatial-index-that-uses-all-of-the-tuning-parameters). diff --git a/src/current/v23.1/create-user.md b/src/current/v23.1/create-user.md index 3f2248cd8fd..e1d1982e0b4 100644 --- a/src/current/v23.1/create-user.md +++ b/src/current/v23.1/create-user.md @@ -58,7 +58,7 @@ Secure clusters require users to authenticate their access to databases and tabl Password creation is supported only in secure clusters. -- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}). ## Examples diff --git a/src/current/v23.1/demo-automatic-cloud-migration.md b/src/current/v23.1/demo-automatic-cloud-migration.md index 84658adc327..641b8db5047 100644 --- a/src/current/v23.1/demo-automatic-cloud-migration.md +++ b/src/current/v23.1/demo-automatic-cloud-migration.md @@ -261,7 +261,7 @@ $ rm -rf cloud1node1 cloud1node2 cloud1node3 cloud2node4 cloud2node5 cloud2node6 ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/demo-fault-tolerance-and-recovery.md b/src/current/v23.1/demo-fault-tolerance-and-recovery.md index f18a97ef179..8216f67d48f 100644 --- a/src/current/v23.1/demo-fault-tolerance-and-recovery.md +++ b/src/current/v23.1/demo-fault-tolerance-and-recovery.md @@ -376,6 +376,6 @@ kill -TERM {process IDs} ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/demo-json-support.md b/src/current/v23.1/demo-json-support.md index 82a99bbc671..7ca369eb7b1 100644 --- a/src/current/v23.1/demo-json-support.md +++ b/src/current/v23.1/demo-json-support.md @@ -284,7 +284,7 @@ $ rm -rf json-test ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/demo-replication-and-rebalancing.md b/src/current/v23.1/demo-replication-and-rebalancing.md index 40fee59a5a9..94ce2ac7d0b 100644 --- a/src/current/v23.1/demo-replication-and-rebalancing.md +++ b/src/current/v23.1/demo-replication-and-rebalancing.md @@ -303,6 +303,6 @@ At first, the replica count will be lower for nodes 4 and 5. Very soon, however, ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/demo-serializable.md b/src/current/v23.1/demo-serializable.md index 3c28f432056..d2efa3c2f09 100644 --- a/src/current/v23.1/demo-serializable.md +++ b/src/current/v23.1/demo-serializable.md @@ -539,7 +539,7 @@ When you repeat the scenario on CockroachDB, you'll see that the anomaly is prev ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/deploy-cockroachdb-on-aws.md b/src/current/v23.1/deploy-cockroachdb-on-aws.md index f79cef2ba6e..4b1efef77aa 100644 --- a/src/current/v23.1/deploy-cockroachdb-on-aws.md +++ b/src/current/v23.1/deploy-cockroachdb-on-aws.md @@ -18,7 +18,7 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne {% include cockroachcloud/use-cockroachcloud-instead.md %} {{site.data.alerts.callout_info}} -If you need a license to use [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}), obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. +You need a license to use CockroachDB; obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. {{site.data.alerts.end}} ## Before you begin diff --git a/src/current/v23.1/deploy-cockroachdb-with-kubernetes.md b/src/current/v23.1/deploy-cockroachdb-with-kubernetes.md index 71dc9df4ce2..1f5f62d140a 100644 --- a/src/current/v23.1/deploy-cockroachdb-with-kubernetes.md +++ b/src/current/v23.1/deploy-cockroachdb-with-kubernetes.md @@ -39,7 +39,7 @@ Choose how you want to deploy and maintain the CockroachDB cluster. {{site.data.alerts.callout_info}} The [CockroachDB Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator) eases CockroachDB cluster creation and management on a single Kubernetes cluster. -The Operator does not provision or apply an Enterprise license key. To use [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. +The Operator does not provision or apply an Enterprise license key. To use CockroachDB with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. {{site.data.alerts.end}}
                                                                    diff --git a/src/current/v23.1/drop-schedules.md b/src/current/v23.1/drop-schedules.md index 59de7e9f71b..532308045c6 100644 --- a/src/current/v23.1/drop-schedules.md +++ b/src/current/v23.1/drop-schedules.md @@ -7,7 +7,7 @@ docs_area: reference.sql The `DROP SCHEDULES` [statement]({% link {{ page.version.version }}/sql-statements.md %}) can be used to remove [backup schedules]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) or [changefeed schedules]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}). -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v23.1/enable-node-map.md b/src/current/v23.1/enable-node-map.md index 901525e19e3..c3ae2b1f8ed 100644 --- a/src/current/v23.1/enable-node-map.md +++ b/src/current/v23.1/enable-node-map.md @@ -107,7 +107,7 @@ The following page is displayed: ### Step 2. Set the Enterprise license and refresh the DB Console -After [setting the Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), the Node Map should now be displaying the highest-level localities you defined: +The Node Map should now be displaying the highest-level localities you defined: DB Console @@ -160,7 +160,6 @@ To navigate to Node 2, which is in datacenter `us-east-1a` in the `us-east-1` re ### Node Map not displayed -- The Node Map requires an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - All nodes in the cluster must be assigned [localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality). - Localities must be [assigned a corresponding latitude and longitude](#step-3-set-the-latitudes-and-longitudes-for-the-localities). diff --git a/src/current/v23.1/enterprise-licensing.md b/src/current/v23.1/enterprise-licensing.md index c23bcf7bd30..62e861e2b59 100644 --- a/src/current/v23.1/enterprise-licensing.md +++ b/src/current/v23.1/enterprise-licensing.md @@ -5,8 +5,6 @@ toc: true docs_area: --- -CockroachDB distributes a single binary that contains both core and Enterprise features. You can use core features without any license key. However, to use the Enterprise features, you need either a trial or an Enterprise license key. - This page lists Enterprise features. For information on how to obtain and set trial and Enterprise license keys for CockroachDB, see the [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). {{site.data.alerts.callout_info}} diff --git a/src/current/v23.1/follower-reads.md b/src/current/v23.1/follower-reads.md index 2fa3dbe85d1..2ed98906c6b 100644 --- a/src/current/v23.1/follower-reads.md +++ b/src/current/v23.1/follower-reads.md @@ -269,4 +269,3 @@ For an example showing how to successfully perform a bounded staleness read, see - [Cluster Settings Overview]({% link {{ page.version.version }}/cluster-settings.md %}) - [Load-Based Splitting]({% link {{ page.version.version }}/load-based-splitting.md %}) - [Network Latency Page]({% link {{ page.version.version }}/ui-network-latency-page.md %}) -- [Enterprise Features]({% link {{ page.version.version }}/enterprise-licensing.md %}) diff --git a/src/current/v23.1/frequently-asked-questions.md b/src/current/v23.1/frequently-asked-questions.md index fe8a055f3b4..8e42e9d0e4e 100644 --- a/src/current/v23.1/frequently-asked-questions.md +++ b/src/current/v23.1/frequently-asked-questions.md @@ -39,7 +39,7 @@ There are four ways to use and deploy CockroachDB: - **CockroachDB {{ site.data.products.basic }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.basic }} provides highly available database clusters that scale instantly and automatically for small production and dev/test workloads. - **CockroachDB {{ site.data.products.standard }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.standard }} allows you to consolidate a variety of production workloads while optimizing cost. - **CockroachDB {{ site.data.products.advanced }}**: A single tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.advanced }} provides dedicated hardware to support stringent regulatory requirements and enhanced compliance, targeting production workloads with advanced Enterprise requirements. -- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment and require [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment. ## About the database diff --git a/src/current/v23.1/get-started-with-enterprise-trial.md b/src/current/v23.1/get-started-with-enterprise-trial.md index 79bab2847b3..7820a1bb3a3 100644 --- a/src/current/v23.1/get-started-with-enterprise-trial.md +++ b/src/current/v23.1/get-started-with-enterprise-trial.md @@ -6,7 +6,7 @@ license: true docs_area: --- -Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's core capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also our Enterprise-only features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). +Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). ## Install CockroachDB @@ -25,7 +25,7 @@ You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }} ## Use Enterprise features -Your cluster now has access to all of CockroachDB's Enterprise features for the length of the trial: +Your cluster now has access to all of CockroachDB's features for the length of the trial: {% include {{ page.version.version }}/misc/enterprise-features.md %} diff --git a/src/current/v23.1/learn-cockroachdb-sql.md b/src/current/v23.1/learn-cockroachdb-sql.md index 45c5a7ed8de..6b4fc2d82ac 100644 --- a/src/current/v23.1/learn-cockroachdb-sql.md +++ b/src/current/v23.1/learn-cockroachdb-sql.md @@ -356,4 +356,4 @@ When you no longer need a table, use [`DROP TABLE`]({% link {{ page.version.vers - Explore all [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}) - [Use the built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}) to execute statements from a shell or directly from the command line - [Install the client driver]({% link {{ page.version.version }}/install-client-drivers.md %}) for your preferred language and [build an app]({% link {{ page.version.version }}/example-apps.md %}) -- [Explore core CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance +- [Explore CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance diff --git a/src/current/v23.1/licensing-faqs.md b/src/current/v23.1/licensing-faqs.md index de18f77bfeb..bd174fac96f 100644 --- a/src/current/v23.1/licensing-faqs.md +++ b/src/current/v23.1/licensing-faqs.md @@ -1,6 +1,6 @@ --- title: Licensing FAQs -summary: Frequently asked questions about CockroachDB Enterprise and core licensing. +summary: Frequently asked questions about CockroachDB Enterprise licensing. toc: true docs_area: get_started --- @@ -9,20 +9,7 @@ docs_area: get_started {% include common/license/evolving.md %} {{site.data.alerts.end}} -CockroachDB code is primarily licensed in two ways: - -- [Business Source License (BSL)](#bsl) -- [Cockroach Community License (CCL)](#ccl) - -CockroachDB core is free to use. Most [core features](#feature-licensing) are licensed under the BSL, but some core features are subject to the CCL or third-party licenses. - -Non-CCL core features from version 19.1 and earlier are licensed under [Apache 2.0](#apache); however, some features remain under third-party licenses. Beginning in version 19.2, these non-CCL features are licensed under the BSL for three years before [converting](#license-conversion-timeline) to the Apache 2.0 license. - -CockroachDB [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) require a [paid license](#obtain-a-license) from Cockroach and are licensed under the Cockroach Community License. - -{{site.data.alerts.callout_info}} -You can find any feature's license by checking the code's file header in the [CockroachDB repository](https://github.com/cockroachdb/cockroach). -{{site.data.alerts.end}} +CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). ## Types of licenses diff --git a/src/current/v23.1/manage-a-backup-schedule.md b/src/current/v23.1/manage-a-backup-schedule.md index 4f3aa66ed7d..2e03bca52bf 100644 --- a/src/current/v23.1/manage-a-backup-schedule.md +++ b/src/current/v23.1/manage-a-backup-schedule.md @@ -147,7 +147,7 @@ Or nest a [`SELECT` clause]({% link {{ page.version.version }}/select-clause.md > DROP SCHEDULES WITH x AS (SHOW SCHEDULES) SELECT id FROM x WHERE label = 'schedule_database'; ~~~~ -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 01e41b4462e..ecf3338051d 100644 --- a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -146,7 +146,7 @@ To start your CockroachDB cluster, you can either use our StatefulSet configurat ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md index 3420bd25430..a65e86c19e6 100644 --- a/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v23.1/orchestrate-a-local-cluster-with-kubernetes.md @@ -90,7 +90,7 @@ Choose a way to deploy and maintain the CockroachDB cluster: ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.1/partitioning.md b/src/current/v23.1/partitioning.md index 4adcde7b412..1399e2f6267 100644 --- a/src/current/v23.1/partitioning.md +++ b/src/current/v23.1/partitioning.md @@ -23,7 +23,6 @@ Table partitioning helps you reduce latency and cost: Table partitioning involves a combination of CockroachDB features: - [Node attributes](#node-attributes) -- [Enterprise license](#enterprise-license) - [Table creation](#table-creation) - [Replication zones](#replication-zones) @@ -37,24 +36,6 @@ To store partitions in specific locations (e.g., geo-partitioning), or on machin For more details about these flags, see the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) documentation. -### Enterprise license - -You must have a valid Enterprise license to use table partitioning features. For details about requesting and setting a trial or full Enterprise license, see [Enterprise Licensing]({% link {{ page.version.version }}/enterprise-licensing.md %}). - -The following features do not work with an **expired license**: - -- Creating new table partitions or adding new zone configurations for partitions -- Changing the partitioning scheme on any table or index -- Changing the zone config for a partition - -However, the following features continue to work even with an expired Enterprise license: - -- Querying a partitioned table (for example, `SELECT foo PARTITION`) -- Inserting or updating data in a partitioned table -- Dropping a partitioned table -- Unpartitioning a partitioned table -- Making non-partitioning changes to a partitioned table (for example, adding a column/index/foreign key/check constraint) - ### Table creation You can define partitions and subpartitions over one or more columns of a table. During [table creation]({% link {{ page.version.version }}/create-table.md %}), you declare which values belong to each partition in one of two ways: diff --git a/src/current/v23.1/restore.md b/src/current/v23.1/restore.md index f696577398a..5a05592ccbf 100644 --- a/src/current/v23.1/restore.md +++ b/src/current/v23.1/restore.md @@ -180,7 +180,7 @@ Also, consider that: - When the cluster is in a mixed-version state during an [upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}), a full cluster restore will fail. To perform a full cluster restore, it is necessary to first [finalize the upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#step-3-decide-how-the-upgrade-will-be-finalized). {{site.data.alerts.callout_info}} -When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. +When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. {{site.data.alerts.end}} ### Databases diff --git a/src/current/v23.1/security-reference/encryption.md b/src/current/v23.1/security-reference/encryption.md index f988d7e16cd..7a0b747ca70 100644 --- a/src/current/v23.1/security-reference/encryption.md +++ b/src/current/v23.1/security-reference/encryption.md @@ -32,7 +32,7 @@ When CMEK is enabled, the **Encryption** option appears to be disabled in the [D When selecting a deployment environment for a CockroachDB {{ site.data.products.core }} cluster, we recommend that you select a cloud provider such as Google Cloud Platform (GCP) or Amazon Web Services (AWS), which automatically provide industry-standard encryption for cloud storage resources. You can learn more about [GCP persistent disk encryption](https://cloud.google.com/compute/docs/disks#pd_encryption) or [AWS Elastic Block Storage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). -In addition, the [Encryption at Rest (Enterprise) feature]({% link {{ page.version.version }}/enterprise-licensing.md %}) provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. +In addition, the Encryption at Rest feature provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. Encryption is performed in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}) and configured per store. All files used by the store, regardless of contents, are encrypted with the desired algorithm. diff --git a/src/current/v23.1/security-reference/security-overview.md b/src/current/v23.1/security-reference/security-overview.md index 3523609c519..afc0bdda2f7 100644 --- a/src/current/v23.1/security-reference/security-overview.md +++ b/src/current/v23.1/security-reference/security-overview.md @@ -20,15 +20,11 @@ Learn more: [Integrate CockroachDB {{ site.data.products.advanced }} with Satori ### Self-Hosted -Cockroach Labs maintains CockroachDB as an open-source core, which is available to operate under a number of different licensing options, including several free options. - CockroachDB {{ site.data.products.core }} here refers to the situation of a user deploying and operating their own cluster. -{{ site.data.products.enterprise }} refers to an ongoing paid license relationship with Cockroach Labs. This license unlocks advanced features (see below). In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of the Cockroach Labs's {{ site.data.products.enterprise }} Support staff. +{{ site.data.products.enterprise }} refers to an ongoing license relationship with Cockroach Labs. In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of Cockroach Labs' {{ site.data.products.enterprise }} Support staff. -- See the [list of {{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}) -- Read the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [Contact our sales team](mailto:sales@cockroachlabs.com) for further questions about {{ site.data.products.enterprise }} +For more information, see the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) ## Comparison of security features @@ -39,7 +35,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user {{ site.data.products.basic }} {{ site.data.products.standard }} {{ site.data.products.advanced }} - {{ site.data.products.core }} {{ site.data.products.core }} {{ site.data.products.enterprise }} Feature @@ -51,7 +46,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Inter-node and node identity authentication using TLS 1.3 @@ -59,7 +53,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Client identity authentication using username/password @@ -67,7 +60,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SASL/SCRAM-SHA-256 secure password-based authentication @@ -75,7 +67,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user     ✓ - ✓ SQL client identity authentication using TLS 1.2/1.3 @@ -83,14 +74,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Web console authentication with third-party Single Sign-on (SSO) using OpenID Connect OIDC       -   ✓ Client identity authentication with GSSAPI and Kerberos @@ -98,7 +87,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ HTTP API access using login tokens @@ -106,7 +94,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ OCSP certificate revocation protocol @@ -116,7 +103,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Encryption in transit using TLS 1.3 @@ -124,7 +110,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for AWS clusters are encrypted at rest using AWS S3’s server-side encryption @@ -132,7 +117,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for GCP clusters are encrypted at rest using Google-managed server-side encryption keys @@ -140,14 +124,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Industry-standard encryption at rest is provided at the infrastructure level by your chosen deployment environment, such as Google Cloud Platform (GCP), Amazon Web Services (AWS), or Microsoft Azure. You can learn more about GCP persistent disk encryption, AWS Elastic Block Storage, or Azure managed disk encryption.       -   ✓ Cockroach Labs's proprietary storage-level {{ site.data.products.enterprise }} Encryption At Rest service implementing the Advanced Encryption Standard (AES) @@ -157,7 +139,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Users and privileges @@ -165,7 +146,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Role-based access control (RBAC) @@ -174,7 +154,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL-level configuration allowed authentication attempts by IP address @@ -182,7 +161,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Network-level Configuration of allowed IP addresses @@ -190,7 +168,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ GCP Private Service Connect (PSC) (Preview) or VPC Peering for GCP clusters and AWS PrivateLink for AWS clusters @@ -199,7 +176,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL Audit Logging @@ -208,7 +184,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ CockroachDB, as a distributed SQL database, is uniquely resilient by nature. A cluster can tolerate node failures as long as the majority of nodes remain functional. See Disaster Recovery. diff --git a/src/current/v23.1/sql-statements.md b/src/current/v23.1/sql-statements.md index c7a4979e09c..aa450f7f0f3 100644 --- a/src/current/v23.1/sql-statements.md +++ b/src/current/v23.1/sql-statements.md @@ -17,7 +17,7 @@ Statement | Usage [`ALTER DEFAULT PRIVILEGES`]({% link {{ page.version.version }}/alter-default-privileges.md %}) | Change the default [privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#privileges) for objects created by specific roles/users in the current database. [`ALTER FUNCTION`]({% link {{ page.version.version }}/alter-function.md %}) | Modify a [user-defined function]({% link {{ page.version.version }}/user-defined-functions.md %}). [`ALTER INDEX`]({% link {{ page.version.version }}/alter-index.md %}) | Apply a schema change to an index. -[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [`ALTER RANGE`]({% link {{ page.version.version }}/alter-range.md %}) | Configure the replication zone for a system range. [`ALTER SCHEMA`]({% link {{ page.version.version }}/alter-schema.md %}) | Alter a user-defined schema. [`ALTER SEQUENCE`]({% link {{ page.version.version }}/alter-sequence.md %}) | Apply a schema change to a sequence. @@ -54,7 +54,7 @@ Statement | Usage [`SHOW FULL TABLE SCANS`]({% link {{ page.version.version }}/show-full-table-scans.md %}) | List recent queries that used a full table scan. [`SHOW INDEX`]({% link {{ page.version.version }}/show-index.md %}) | View index information for a table or database. [`SHOW LOCALITY`]({% link {{ page.version.version }}/show-locality.md %}) | View the locality of the current node. -[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [`SHOW REGIONS`]({% link {{ page.version.version }}/show-regions.md %}) | List the [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) or [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SUPER REGIONS`]({% link {{ page.version.version }}/show-super-regions.md %}) | List the [super regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) associated with a database in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SCHEMAS`]({% link {{ page.version.version }}/show-schemas.md %}) | List the schemas in a database. @@ -172,13 +172,13 @@ Statement | Usage [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) | Create disaster recovery backups of clusters, databases, and tables. [`RESTORE`]({% link {{ page.version.version }}/restore.md %}) | Restore clusters, databases, and tables using your backups. [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}) | List the contents of a backup. -[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. Core users can only use backup scheduling for full backups of clusters, databases, or tables. To use the other backup features, you need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) | Modify an existing backup schedule. [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) | View information on backup schedules. [`PAUSE SCHEDULES`]({% link {{ page.version.version }}/pause-schedules.md %}) | Pause backup schedules. [`RESUME SCHEDULES`]({% link {{ page.version.version }}/resume-schedules.md %}) | Resume paused backup schedules. [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}) | Drop backup schedules. -[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. Adding new KMS encryption keys requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. ## Changefeed statements @@ -186,10 +186,10 @@ Statement | Usage Statement | Usage ----------|------------ -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). -[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}) | (Core) Create a new changefeed to stream row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. -[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Modify an existing changefeed. +[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | Modify an existing changefeed. ## External resource statements diff --git a/src/current/v23.1/sso-db-console.md b/src/current/v23.1/sso-db-console.md index 67c1b77dda6..941b09c36eb 100644 --- a/src/current/v23.1/sso-db-console.md +++ b/src/current/v23.1/sso-db-console.md @@ -27,7 +27,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **IdP:** You must have access to an OAuth 2.0 identity provider and client. The process of provisioning one with Google Cloud Platform is described on this page in the [Provision an OAuth client using Google Cloud Platform (GCP)](#provision-an-oauth-client-using-google-cloud-platform-gcp) section. - **CockroachDB cluster**: you must have access to one of the following: - - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). + - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). diff --git a/src/current/v23.1/sso-sql.md b/src/current/v23.1/sso-sql.md index d9f133e3171..1479e03608c 100644 --- a/src/current/v23.1/sso-sql.md +++ b/src/current/v23.1/sso-sql.md @@ -14,7 +14,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.advanced }} clusters can provision their users with Java Web Tokens (JWTs) via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.enterprise }} and {{ site.data.products.advanced }} clusters. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). +Cluster single sign-on for the DB Console is supported on CockroachDB [{{ site.data.products.enterprise }}]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) and {{ site.data.products.advanced }} clusters. CockroachDB {{ site.data.products.standard }} and {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: diff --git a/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 0dcf262649b..2c72fd1f74b 100644 --- a/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v23.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -248,7 +248,7 @@ To create your changefeed, you'll prepare your CockroachDB cluster with the `mov cockroach sql --url {"CONNECTION STRING"} ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~sql diff --git a/src/current/v23.1/take-and-restore-encrypted-backups.md b/src/current/v23.1/take-and-restore-encrypted-backups.md index 93806d67c73..d07c8e258f5 100644 --- a/src/current/v23.1/take-and-restore-encrypted-backups.md +++ b/src/current/v23.1/take-and-restore-encrypted-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Encrypted [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This doc provides information about how to take and restore encrypted backups in the following ways: - [Using AWS Key Management Service (KMS)](#aws-kms-uri-format) diff --git a/src/current/v23.1/take-and-restore-locality-aware-backups.md b/src/current/v23.1/take-and-restore-locality-aware-backups.md index 926ee503630..6ac3dea234e 100644 --- a/src/current/v23.1/take-and-restore-locality-aware-backups.md +++ b/src/current/v23.1/take-and-restore-locality-aware-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Locality-aware [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - Locality-aware backups allow you to partition and store backup data in a way that is optimized for locality. When you run a locality-aware backup, nodes write backup data to the [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}) bucket that is closest to the node locality configured at [node startup]({% link {{ page.version.version }}/cockroach-start.md %}). {{site.data.alerts.callout_danger}} diff --git a/src/current/v23.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md b/src/current/v23.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md index 371c40a0fdf..4904d50f203 100644 --- a/src/current/v23.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md +++ b/src/current/v23.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -[`BACKUP`]({% link {{ page.version.version }}/backup.md %}) with revision history is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take backups with revision history and restore from a point-in-time. You can create full or incremental backups [with revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history): diff --git a/src/current/v23.1/take-full-and-incremental-backups.md b/src/current/v23.1/take-full-and-incremental-backups.md index cbb7de63d73..4d9b5ef36d4 100644 --- a/src/current/v23.1/take-full-and-incremental-backups.md +++ b/src/current/v23.1/take-full-and-incremental-backups.md @@ -88,8 +88,6 @@ In the examples on this page, `{collectionURI}` is a placeholder for the storage ## Full backups -Full backups are now available to both core and Enterprise users. - Full backups contain an un-replicated copy of your data and can always be used to restore your cluster. These files are roughly the size of your data and require greater resources to produce than incremental backups. You can take full backups as of a given timestamp. Optionally, you can include the available [revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) in the backup. In most cases, **it's recommended to take nightly full backups of your cluster**. A cluster backup allows you to do the following: @@ -98,7 +96,7 @@ In most cases, **it's recommended to take nightly full backups of your cluster** - Restore database(s) from the cluster - Restore a full cluster -[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. +[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. {% include {{ page.version.version }}/backups/file-size-setting.md %} @@ -149,10 +147,6 @@ To view the available backup subdirectories, use [`SHOW BACKUPS`]({% link {{ pag ## Incremental backups -{{site.data.alerts.callout_info}} -To take incremental backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - If your cluster grows too large for daily [full backups](#full-backups), you can take less frequent full backups (e.g., weekly) with daily incremental backups. Incremental backups are storage efficient and faster than full backups for larger clusters. If you are taking backups on a regular cadence, we recommend [creating a schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) for your backups. @@ -271,7 +265,7 @@ For details on cloud storage URLs, see [Use Cloud Storage]({% link {{ page.versi ### Scheduled backups -You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. To create a schedule that includes incremental backups, you must have an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. Include the `FULL BACKUP ALWAYS` clause for a schedule to take only full backups. For example, to create a schedule for taking full cluster backups: @@ -383,10 +377,6 @@ To create a table with `exclude_data_from_backup`, see [Create a table with data {% include {{ page.version.version }}/backups/advanced-examples-list.md %} -{{site.data.alerts.callout_info}} -To take incremental backups, backups with revision history, locality-aware backups, and encrypted backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## See also - [`BACKUP`][backup] diff --git a/src/current/v23.1/ui-cluster-overview-page.md b/src/current/v23.1/ui-cluster-overview-page.md index 9cf9175e7bd..28db159a022 100644 --- a/src/current/v23.1/ui-cluster-overview-page.md +++ b/src/current/v23.1/ui-cluster-overview-page.md @@ -12,7 +12,7 @@ The **Cluster Overview** page of the DB Console displays key metrics about your - Uptime - Hardware usage -If you have an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), you can enable the [Node Map](#node-map-enterprise) view for a visual representation of your cluster's geographic layout. +Enable the [Node Map](#node-map) view for a visual representation of your cluster's geographic layout. ## Cluster Overview panel @@ -28,7 +28,7 @@ Replication Status |
                                                                    • The total number ### Capacity metrics -The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map-enterprise) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. +The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. Usable disk space is constrained by the following: @@ -50,7 +50,7 @@ If a node is currently unavailable, the last-known capacity usage will be shown, The **Node List** groups nodes by locality. The lowest-level locality tier is used to organize the Node List. Hover over a locality to see all localities for the group of nodes. {{site.data.alerts.callout_success}} -We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map-enterprise). +We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map). {{site.data.alerts.end}} ### Node status @@ -104,9 +104,9 @@ You can see the full history of decommissioned nodes by clicking **View all deco For details about the decommissioning process, see [Node Shutdown](node-shutdown.html?filters=decommission#node-shutdown-sequence). {{site.data.alerts.end}} -## Node Map (Enterprise) +## Node Map -The **Node Map** is an [enterprise]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature that visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. +The **Node Map** visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. For guidance on enabling and configuring the node map, see [Enable the Node Map]({% link {{ page.version.version }}/enable-node-map.md %}). diff --git a/src/current/v23.1/ui-overview.md b/src/current/v23.1/ui-overview.md index df8fa01a287..e1798f3c5ee 100644 --- a/src/current/v23.1/ui-overview.md +++ b/src/current/v23.1/ui-overview.md @@ -16,7 +16,7 @@ Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console ## Authentication -The DB Console supports username/password login, as well as single sign-on (SSO) ({{ site.data.products.advanced }} and {{ site.data.products.core }} {{ site.data.products.enterprise }} clusters only). +The DB Console supports username/password login and single sign-on (SSO) for {{ site.data.products.advanced }} and {{ site.data.products.enterprise }} clusters. The DB Console login page can also be used to provision authentication tokens for SQL client access. @@ -32,8 +32,8 @@ Refer to: The Overview page provides a cluster overview and node list and map. - [Cluster Overview]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}) has essential metrics about the cluster and nodes, including liveness status, replication status, uptime, and hardware usage. -- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) has a list of cluster metrics at the locality and node levels. -- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. +- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) has a list of cluster metrics at the locality and node levels. +- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. ### Metrics diff --git a/src/current/v23.2/alter-backup-schedule.md b/src/current/v23.2/alter-backup-schedule.md index a0d11752048..b7a091220f5 100644 --- a/src/current/v23.2/alter-backup-schedule.md +++ b/src/current/v23.2/alter-backup-schedule.md @@ -5,12 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - The `ALTER BACKUP SCHEDULE` statement modifies an existing [backup schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). You can use `ALTER BACKUP SCHEDULE` to do the following: - Set a different name for a backup schedule. diff --git a/src/current/v23.2/alter-database.md b/src/current/v23.2/alter-database.md index 0cf5d457111..3232718eecd 100644 --- a/src/current/v23.2/alter-database.md +++ b/src/current/v23.2/alter-database.md @@ -33,21 +33,21 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description -----------|------------ -[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`ALTER LOCALITY`](#alter-locality) | Persistently modify the configuration generated by the standard [multi-region SQL abstractions]({% link {{ page.version.version }}/multiregion-overview.md %}) on a per-region basis. For advanced users who want to customize their multi-region setup using [Zone Config Extensions]({% link {{ page.version.version }}/zone-config-extensions.md %}), a persistent, composable alternative to low-level [zone configs]({% link {{ page.version.version }}/configure-replication-zones.md %}). -[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for a database. -[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). [`OWNER TO`](#owner-to) | Change the owner of a database. [`PLACEMENT`](#placement) | Configure the replica placement policy for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). [`RENAME TO`](#rename-to) | Change the name of a database. [`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). [`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). -[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. [`SURVIVE {ZONE,REGION} FAILURE`](#survive-zone-region-failure) | Add a survival goal to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ### `ADD REGION` @@ -282,7 +282,7 @@ For usage, see [Synopsis](#synopsis). ### `PLACEMENT` -`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. +`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. `ALTER DATABASE ... PLACEMENT RESTRICTED` constrains the voting and non-voting replica placement for the database's tables to the [home regions]({% link {{ page.version.version }}/alter-table.md %}#crdb_region) associated with those tables. This is a way of opting out of [non-voting replicas]({% link {{ page.version.version }}/architecture/replication-layer.md %}#non-voting-replicas) for [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) to accomplish one or more of the following goals: @@ -779,7 +779,7 @@ ALTER DATABASE movr ADD REGION "europe-west1"; #### Override specific fields of a schema object's zone configs -In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. +In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences`. diff --git a/src/current/v23.2/alter-index.md b/src/current/v23.2/alter-index.md index 4b0bd12e0fb..63cfd3fe34b 100644 --- a/src/current/v23.2/alter-index.md +++ b/src/current/v23.2/alter-index.md @@ -35,8 +35,8 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description | -----------|-------------| -[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. | +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. [`RENAME TO`](#rename-to) | Change the name of an index. [`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the index. [`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the index. diff --git a/src/current/v23.2/alter-table.md b/src/current/v23.2/alter-table.md index 6002120ce2c..9f6dd99f04d 100644 --- a/src/current/v23.2/alter-table.md +++ b/src/current/v23.2/alter-table.md @@ -54,7 +54,7 @@ Subcommand | Description | Can combine with other subcommands? [`DROP CONSTRAINT`](#drop-constraint) | Remove constraints from columns. | Yes [`EXPERIMENTAL_AUDIT`](#experimental_audit) | Enable per-table audit logs, for security purposes. | Yes [`OWNER TO`](#owner-to) | Change the owner of the table. | No -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | Yes +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. | Yes [`RENAME COLUMN`](#rename-column) | Change the names of columns. | Yes [`RENAME CONSTRAINT`](#rename-constraint) | Change constraints columns. | Yes [`RENAME TO`](#rename-to) | Change the names of tables. | No diff --git a/src/current/v23.2/authentication.md b/src/current/v23.2/authentication.md index 188e29b38a0..fbb7b8fb5eb 100644 --- a/src/current/v23.2/authentication.md +++ b/src/current/v23.2/authentication.md @@ -101,9 +101,9 @@ CockroachDB offers the following methods for client authentication: Enter password: ~~~ -- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}). -- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}). ### Using `cockroach cert` or `openssl` commands diff --git a/src/current/v23.2/backup-and-restore-overview.md b/src/current/v23.2/backup-and-restore-overview.md index b419188923a..b267ddbbfcf 100644 --- a/src/current/v23.2/backup-and-restore-overview.md +++ b/src/current/v23.2/backup-and-restore-overview.md @@ -25,7 +25,6 @@ This table outlines the level of product support for backup and restore features Backup / Restore Description - Self-hosted support @@ -34,88 +33,48 @@ This table outlines the level of product support for backup and restore features Full backup An un-replicated copy of your cluster, database, or table's data. A full backup is the base for any further backups. - -
                                                                        -
                                                                      • Enterprise license not required
                                                                        • -
                                                                      - Incremental backup A copy of the changes in your data since the specified base backup (either a full backup or a full backup plus an incremental backup). - - - Scheduled backup A schedule for periodic backups. - - - Backups with revision history A backup with revision history allows you to back up every change made within the garbage collection period leading up to and including the given timestamp. - - - Point-in-time restore A restore from an arbitrary point in time within the revision history of a backup. - - - Encrypted backup and restore An encrypted backup using a KMS or passphrase. - - - Locality-aware backup and restore A backup where each node writes files to the backup destination that matches the node locality configured at node startup. - - - Locality-restricted backup execution A backup with the EXECUTION LOCALITY option restricts the nodes that can execute a backup job with a defined locality filter. - - - diff --git a/src/current/v23.2/backup-validation.md b/src/current/v23.2/backup-validation.md index 3c29767e7f3..a4f00b7754a 100644 --- a/src/current/v23.2/backup-validation.md +++ b/src/current/v23.2/backup-validation.md @@ -15,10 +15,6 @@ You can validate a backup of a [cluster]({% link {{ page.version.version }}/back The options that give the most validation coverage will increase the runtime of the check. That is, `verify_backup_table_data` will take a longer time to validate a backup compared to `check_files` or `schema_only` alone. Despite that, each of these validation options provide a quicker way to validate a backup over running a "regular" restore. -{{site.data.alerts.callout_info}} -You do **not** need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to run any of the backup validation tools described on this page. -{{site.data.alerts.end}} - ## Recommendations Cockroach Labs recommends implementing the following validation plan to test your backups: diff --git a/src/current/v23.2/backup.md b/src/current/v23.2/backup.md index 76f238cc8cd..03d40f604e2 100644 --- a/src/current/v23.2/backup.md +++ b/src/current/v23.2/backup.md @@ -32,8 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -- [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. +- [Full cluster backups](#back-up-a-cluster) include [license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes a license, the license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. - Exclude a table's row data from a backup using the [`exclude_data_from_backup`]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#exclude-a-tables-data-from-backups) parameter. diff --git a/src/current/v23.2/changefeed-examples.md b/src/current/v23.2/changefeed-examples.md index 50b7d04a139..426bf2dd421 100644 --- a/src/current/v23.2/changefeed-examples.md +++ b/src/current/v23.2/changefeed-examples.md @@ -37,13 +37,9 @@ Before you run the examples, verify that you have the `CHANGEFEED` privilege in ## Create a changefeed connected to Kafka -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -182,13 +178,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to Kafka using Avro -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed-using-avro). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink and emits [Avro](https://avro.apache.org/docs/1.8.2/spec.html) records. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -493,13 +485,9 @@ You'll need access to a [Google Cloud Project](https://cloud.google.com/resource ## Create a changefeed connected to a cloud storage sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to an AWS S3 sink. The changefeed watches two tables. Note that you can set up changefeeds for any of [these cloud storage providers]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink). -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -559,13 +547,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to a webhook sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a local HTTP server via a webhook. For this example, you'll use an [example HTTP server](https://github.com/cockroachlabs/cdc-webhook-sink-test-server/tree/master/go-https-server) to test out the webhook sink. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/v23.2/changefeed-for.md b/src/current/v23.2/changefeed-for.md index 6ad02a9d82d..5d95c6c5d04 100644 --- a/src/current/v23.2/changefeed-for.md +++ b/src/current/v23.2/changefeed-for.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`EXPERIMENTAL CHANGEFEED FOR` is the core implementation of changefeeds. For the [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) version, see [`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}). -{{site.data.alerts.end}} - The `EXPERIMENTAL CHANGEFEED FOR` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new core changefeed, which streams row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. A core changefeed can watch one table or multiple tables in a comma-separated list. For more information, see [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}). diff --git a/src/current/v23.2/changefeeds-on-tables-with-column-families.md b/src/current/v23.2/changefeeds-on-tables-with-column-families.md index 91e115557fe..069242510ae 100644 --- a/src/current/v23.2/changefeeds-on-tables-with-column-families.md +++ b/src/current/v23.2/changefeeds-on-tables-with-column-families.md @@ -94,13 +94,9 @@ For examples of starting changefeeds on tables with column families, see the fol ## Create a changefeed on a table with column families -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example]({% link {{ page.version.version }}/changefeeds-on-tables-with-column-families.md %}?filters=core#create-a-core-changefeed-on-a-table-with-column-families). -{{site.data.alerts.end}} - In this example, you'll set up changefeeds on two tables that have [column families]({% link {{ page.version.version }}/column-families.md %}). You'll use a single-node cluster sending changes to a webhook sink for this example, but you can use any [changefeed sink]({% link {{ page.version.version }}/changefeed-sinks.md %}) to work with tables that include column families. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -116,7 +112,7 @@ In this example, you'll set up changefeeds on two tables that have [column famil cockroach sql --insecure ~~~ -1. Set your organization and [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization and license key: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v23.2/cockroach-start-single-node.md b/src/current/v23.2/cockroach-start-single-node.md index 21d1ba322d6..4104b847b79 100644 --- a/src/current/v23.2/cockroach-start-single-node.md +++ b/src/current/v23.2/cockroach-start-single-node.md @@ -69,7 +69,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                      Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                      **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                      **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                      This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                      Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                      This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). ### Store diff --git a/src/current/v23.2/cockroach-start.md b/src/current/v23.2/cockroach-start.md index 3538431e6c3..549efb9f724 100644 --- a/src/current/v23.2/cockroach-start.md +++ b/src/current/v23.2/cockroach-start.md @@ -101,7 +101,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                      Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                      **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                      **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                      This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                      Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                      This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). `--external-io-disable-http` | This optional flag disables external HTTP(S) access (as well as custom HTTP(S) endpoints) when performing bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %}), [`IMPORT`]({% link {{ page.version.version }}/import.md %}), etc.). This can be used in environments where you cannot run a full proxy server.

                                                                      If you want to run a proxy server, you can start CockroachDB while specifying the `HTTP(S)_PROXY` environment variable. `--external-io-disable-implicit-credentials` | This optional flag disables the use of implicit credentials when accessing external cloud storage services for bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %}), [`IMPORT`]({% link {{ page.version.version }}/import.md %}), etc.). diff --git a/src/current/v23.2/column-level-encryption.md b/src/current/v23.2/column-level-encryption.md index 7947e478d15..eeaae912c98 100644 --- a/src/current/v23.2/column-level-encryption.md +++ b/src/current/v23.2/column-level-encryption.md @@ -28,7 +28,7 @@ For usage examples, see: - [Encrypt using the `encrypt` function](#encrypt-using-the-encrypt-function). - [Encrypt using the `encrypt_iv` function](#encrypt-using-the-encrypt_iv-function). -These functions require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). If you do not have an Enterprise license, you will see an error message like the following if you try to use them: +If you do not have a [license]({% link {{ page.version.version }}/licensing-faqs.md %}), you will see an error message like the following if you try to use them: ~~~ ERROR: encrypt(): use of this cryptographic function (https://www.cockroachlabs.com/docs/stable/functions-and-operators#cryptographic-functions) requires an enterprise license. see https://cockroachlabs.com/pricing for details on how to enable enterprise features @@ -47,7 +47,7 @@ For usage examples, see: - [Decrypt using the `decrypt` function](#decrypt-using-the-decrypt-function). - [Decrypt using the `decrypt_iv` function](#decrypt-using-the-decrypt_iv-function). -These functions require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). If you do not have an Enterprise license, you will see an error message like the following if you try to use them: +If you do not have a [license]({% link {{ page.version.version }}/licensing-faqs.md %}), you will see an error message like the following if you try to use them: ~~~ ERROR: decrypt(): use of this cryptographic function (https://www.cockroachlabs.com/docs/stable/functions-and-operators#cryptographic-functions) requires an enterprise license. see https://cockroachlabs.com/pricing for details on how to enable enterprise features diff --git a/src/current/v23.2/configure-replication-zones.md b/src/current/v23.2/configure-replication-zones.md index aeba9db689e..1a61cf26308 100644 --- a/src/current/v23.2/configure-replication-zones.md +++ b/src/current/v23.2/configure-replication-zones.md @@ -10,8 +10,8 @@ Replication zones give you the power to control what data goes where in your Coc - Databases - Tables -- Rows ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) -- Indexes ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) +- Rows +- Indexes - All data in the cluster, including internal system data ([via the default replication zone](#view-the-default-replication-zone)) For each of these objects you can control: @@ -37,7 +37,7 @@ When a cluster starts, there are two categories of replication zone: 1. Pre-configured replication zones that apply to internal system data. 1. A single default replication zone that applies to the rest of the cluster. -You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. Note that adding zones for rows and secondary indexes is [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. For example, you might rely on the [default zone](#view-the-default-replication-zone) to spread most of a cluster's data across all of your availability zones, but [create a custom replication zone for a specific database](#create-a-replication-zone-for-a-database) to make sure its data is only stored in certain availability zones and/or geographies. @@ -50,8 +50,8 @@ Level | Description Cluster | CockroachDB comes with a pre-configured `default` replication zone that applies to all table data in the cluster not constrained by a database, table, or row-specific replication zone. This zone can be adjusted but not removed. See [View the Default Replication Zone](#view-the-default-replication-zone) and [Edit the Default Replication Zone](#edit-the-default-replication-zone) for more details. Database | You can add replication zones for specific databases. See [Create a Replication Zone for a Database](#create-a-replication-zone-for-a-database) for more details. Table | You can add replication zones for specific tables. See [Create a Replication Zone for a Table](#create-a-replication-zone-for-a-table). -Index ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. -Row ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. +Index | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. +Row | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. ### For system data diff --git a/src/current/v23.2/create-changefeed.md b/src/current/v23.2/create-changefeed.md index eae173c2124..e8faa4f769d 100644 --- a/src/current/v23.2/create-changefeed.md +++ b/src/current/v23.2/create-changefeed.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`CREATE CHANGEFEED` is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the core version, see [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}). -{{site.data.alerts.end}} - The `CREATE CHANGEFEED` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new {{ site.data.products.enterprise }} changefeed, which targets an allowlist of tables called "watched rows". Every change to a watched row is emitted as a record in a configurable format (`JSON` or Avro) to a configurable sink ([Kafka](https://kafka.apache.org/), [Google Cloud Pub/Sub](https://cloud.google.com/pubsub), a [cloud storage sink]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink), or a [webhook sink]({% link {{ page.version.version }}/changefeed-sinks.md %}#webhook-sink)). You can [create](#examples), [pause](#pause-a-changefeed), [resume](#resume-a-paused-changefeed), [alter]({% link {{ page.version.version }}/alter-changefeed.md %}), or [cancel](#cancel-a-changefeed) an {{ site.data.products.enterprise }} changefeed. To get started with changefeeds, refer to the [Create and Configure Changefeeds]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}) page for important usage considerations. For detail on how changefeeds emit messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page. diff --git a/src/current/v23.2/create-index.md b/src/current/v23.2/create-index.md index 7800bac033f..76c522bdb4f 100644 --- a/src/current/v23.2/create-index.md +++ b/src/current/v23.2/create-index.md @@ -51,7 +51,7 @@ Parameter | Description `name` | The name of the column you want to index. For [multi-region tables]({% link {{ page.version.version }}/multiregion-overview.md %}#table-localities), you can use the `crdb_region` column within the index in the event the original index may contain non-unique entries across multiple, unique regions. `ASC` or `DESC`| Sort the column in ascending (`ASC`) or descending (`DESC`) order in the index. How columns are sorted affects query results, particularly when using `LIMIT`.

                                                                      __Default:__ `ASC` `STORING ...`| Store (but do not sort) each column whose name you include.

                                                                      For information on when to use `STORING`, see [Store Columns](#store-columns). Note that columns that are part of a table's [`PRIMARY KEY`]({% link {{ page.version.version }}/primary-key.md %}) cannot be specified as `STORING` columns in secondary indexes on the table.

                                                                      `COVERING` and `INCLUDE` are aliases for `STORING` and work identically. -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. +`opt_partition_by` | An option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE`, `NOT VISIBLE`, or `VISIBILITY` clause that indicates that an [index is visible, not visible, or partially visible to the cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If not visible, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For examples, refer to [Set index visibility]({% link {{ page.version.version }}/alter-index.md %}#set-index-visibility).

                                                                      Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, refer to [Index visibility considerations](alter-index.html#not-visible). `USING HASH` | Creates a [hash-sharded index]({% link {{ page.version.version }}/hash-sharded-indexes.md %}). diff --git a/src/current/v23.2/create-schedule-for-backup.md b/src/current/v23.2/create-schedule-for-backup.md index 2c44fdeeb5d..f2fc83cdfa3 100644 --- a/src/current/v23.2/create-schedule-for-backup.md +++ b/src/current/v23.2/create-schedule-for-backup.md @@ -9,12 +9,6 @@ docs_area: reference.sql For more information about creating, managing, monitoring, and restoring from a scheduled backup, see [Manage a Backup Schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups](#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## Required privileges {% include {{ page.version.version }}/backups/updated-backup-privileges.md %} @@ -59,7 +53,7 @@ Targets: `location` | The URI where you want to store the backup. The backup files will be stored in year > month > day subdirectories. The location can be [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}), or `nodelocal`.

                                                                      Note: If you want to schedule a backup using temporary credentials, we recommend that you use `implicit` authentication; otherwise, you'll need to drop and then recreate schedules each time you need to update the credentials. `backup_options` | Control the backup behavior with a comma-separated list of [options](#backup-options). `RECURRING crontab` | Specifies when the backup should be taken. A separate schedule may be created automatically to write full backups at a regular cadence, depending on the frequency of the incremental backups. You can likewise modify this separate schedule with [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}). The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron). All times in UTC.

                                                                      Example: `'@daily'` (run daily at midnight) -`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                      If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                      **Note:** If you do not have an Enterprise license then you can only take full backups. `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                      If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                      • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                      • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                      • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                      +`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                      If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                      `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                      If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                      • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                      • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                      • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                      `WITH SCHEDULE OPTIONS schedule_option` | Control the schedule behavior with a comma-separated list of [these options](#schedule-options). {{site.data.alerts.callout_info}} @@ -126,9 +120,9 @@ You can also visit the [**Jobs** page]({% link {{ page.version.version }}/ui-job ## Examples -### Create a schedule for full backups only (core) +### Create a schedule for full backups only -Core users can only use backup scheduling for full backups of clusters, databases, or tables. Full backups are taken with the `FULL BACKUP ALWAYS` clause, for example: +To schedule full backups of clusters, databases, or tables, use the `FULL BACKUP ALWAYS` clause, for example: {% include_cached copy-clipboard.html %} ~~~ sql @@ -145,8 +139,6 @@ Core users can only use backup scheduling for full backups of clusters, database (1 row) ~~~ -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - ### Create a scheduled backup for a cluster This example creates a schedule for a cluster backup with revision history that's taken every day at midnight: diff --git a/src/current/v23.2/create-table.md b/src/current/v23.2/create-table.md index 31c58d8a463..0976255a0d8 100644 --- a/src/current/v23.2/create-table.md +++ b/src/current/v23.2/create-table.md @@ -106,8 +106,8 @@ Parameter | Description `family_def` | An optional, comma-separated list of [column family definitions]({% link {{ page.version.version }}/column-families.md %}). Column family names must be unique within the table but can have the same name as columns, constraints, or indexes.

                                                                      A column family is a group of columns that are stored as a single key-value pair in the underlying key-value store. CockroachDB automatically groups columns into families to ensure efficient storage and performance. However, there are cases when you may want to manually assign columns to families. For more details, see [Column Families]({% link {{ page.version.version }}/column-families.md %}). `table_constraint` | An optional, comma-separated list of [table-level constraints]({% link {{ page.version.version }}/constraints.md %}). Constraint names must be unique within the table but can have the same name as columns, column families, or indexes. `LIKE table_name like_table_option_list` | Create a new table based on the schema of an existing table, using supported specifiers. For details, see [Create a table like an existing table](#create-a-table-like-an-existing-table). For examples, see [Create a new table from an existing one](#create-a-new-table-from-an-existing-one). -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. -`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).

                                                                      Note that multi-region features require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`opt_partition_by` | An option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. +`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE` or `NOT VISIBLE` clause that indicates whether an index is visible to the [cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If `NOT VISIBLE`, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For an example, see [Set an index to be not visible]({% link {{ page.version.version }}/alter-index.md %}#set-an-index-to-be-not-visible).

                                                                      Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations]({% link {{ page.version.version }}/alter-index.md %}#not-visible). `opt_with_storage_parameter_list` | A comma-separated list of [spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). Supported parameters include `fillfactor`, `s2_max_level`, `s2_level_mod`, `s2_max_cells`, `geometry_min_x`, `geometry_max_x`, `geometry_min_y`, and `geometry_max_y`. The `fillfactor` parameter is a no-op, allowed for PostgreSQL-compatibility.

                                                                      For details, see [Spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). For an example, see [Create a spatial index that uses all of the tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#create-a-spatial-index-that-uses-all-of-the-tuning-parameters). diff --git a/src/current/v23.2/create-user.md b/src/current/v23.2/create-user.md index 3f2248cd8fd..e1d1982e0b4 100644 --- a/src/current/v23.2/create-user.md +++ b/src/current/v23.2/create-user.md @@ -58,7 +58,7 @@ Secure clusters require users to authenticate their access to databases and tabl Password creation is supported only in secure clusters. -- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}). ## Examples diff --git a/src/current/v23.2/demo-automatic-cloud-migration.md b/src/current/v23.2/demo-automatic-cloud-migration.md index d8b67468989..748b81feec2 100644 --- a/src/current/v23.2/demo-automatic-cloud-migration.md +++ b/src/current/v23.2/demo-automatic-cloud-migration.md @@ -261,7 +261,7 @@ $ rm -rf cloud1node1 cloud1node2 cloud1node3 cloud2node4 cloud2node5 cloud2node6 ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/demo-fault-tolerance-and-recovery.md b/src/current/v23.2/demo-fault-tolerance-and-recovery.md index fadb69eaeab..91eceba887f 100644 --- a/src/current/v23.2/demo-fault-tolerance-and-recovery.md +++ b/src/current/v23.2/demo-fault-tolerance-and-recovery.md @@ -376,6 +376,6 @@ kill -TERM {process IDs} ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/demo-json-support.md b/src/current/v23.2/demo-json-support.md index 7607143ebca..9678a98a162 100644 --- a/src/current/v23.2/demo-json-support.md +++ b/src/current/v23.2/demo-json-support.md @@ -284,7 +284,7 @@ $ rm -rf json-test ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/demo-replication-and-rebalancing.md b/src/current/v23.2/demo-replication-and-rebalancing.md index 40fee59a5a9..94ce2ac7d0b 100644 --- a/src/current/v23.2/demo-replication-and-rebalancing.md +++ b/src/current/v23.2/demo-replication-and-rebalancing.md @@ -303,6 +303,6 @@ At first, the replica count will be lower for nodes 4 and 5. Very soon, however, ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/demo-serializable.md b/src/current/v23.2/demo-serializable.md index 050cfcaeb14..1681f1def90 100644 --- a/src/current/v23.2/demo-serializable.md +++ b/src/current/v23.2/demo-serializable.md @@ -538,7 +538,7 @@ When you repeat the scenario on CockroachDB, you'll see that the anomaly is prev ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/deploy-cockroachdb-on-aws.md b/src/current/v23.2/deploy-cockroachdb-on-aws.md index ff161024a36..1311657ae82 100644 --- a/src/current/v23.2/deploy-cockroachdb-on-aws.md +++ b/src/current/v23.2/deploy-cockroachdb-on-aws.md @@ -18,7 +18,7 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne {% include cockroachcloud/use-cockroachcloud-instead.md %} {{site.data.alerts.callout_info}} -If you need a license to use [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}), obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. +You need a license to use CockroachDB; obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. {{site.data.alerts.end}} ## Before you begin diff --git a/src/current/v23.2/deploy-cockroachdb-with-kubernetes.md b/src/current/v23.2/deploy-cockroachdb-with-kubernetes.md index 71dc9df4ce2..1f5f62d140a 100644 --- a/src/current/v23.2/deploy-cockroachdb-with-kubernetes.md +++ b/src/current/v23.2/deploy-cockroachdb-with-kubernetes.md @@ -39,7 +39,7 @@ Choose how you want to deploy and maintain the CockroachDB cluster. {{site.data.alerts.callout_info}} The [CockroachDB Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator) eases CockroachDB cluster creation and management on a single Kubernetes cluster. -The Operator does not provision or apply an Enterprise license key. To use [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. +The Operator does not provision or apply an Enterprise license key. To use CockroachDB with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. {{site.data.alerts.end}}
                                                                      diff --git a/src/current/v23.2/disaster-recovery-planning.md b/src/current/v23.2/disaster-recovery-planning.md index 001813ef43c..69eaf1fac32 100644 --- a/src/current/v23.2/disaster-recovery-planning.md +++ b/src/current/v23.2/disaster-recovery-planning.md @@ -308,15 +308,13 @@ If you are outside of the garbage collection window, you will need to use a [bac ### Restore to a point in time -- If you are a core user, use a [backup]({% link {{ page.version.version }}/backup.md %}) that was taken with [`AS OF SYSTEM TIME`]({% link {{ page.version.version }}/as-of-system-time.md %}) to restore to a specific point. -- If you are an {{ site.data.products.enterprise }} user, use your [backup]({% link {{ page.version.version }}/backup.md %}) file to [restore to a point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) where you are certain there was no corruption. Note that the backup must have been taken with [revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history). +- Use your [backup]({% link {{ page.version.version }}/backup.md %}) file to [restore to a point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) where you are certain there was no corruption. Note that the backup must have been taken with [revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history). ### Create a new backup If your cluster is running, you do not have a backup that encapsulates the time you want to [restore]({% link {{ page.version.version }}/restore.md %}) to, and the data you want to recover is still in the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds), there are two actions you can take: -- If you are a core user, trigger a [backup]({% link {{ page.version.version }}/backup.md %}) using [`AS OF SYSTEM TIME`]({% link {{ page.version.version }}/as-of-system-time.md %}) to create a new backup that encapsulates the specific time. The `AS OF SYSTEM TIME` must be within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). -- If you are an {{ site.data.products.enterprise }} user, trigger a new [backup `with_revision_history`]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) and you will have a backup you can use to restore to the desired point in time within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). +- Trigger a new [backup `with_revision_history`]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) and you will have a backup you can use to restore to the desired point in time within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). ### Recover from corrupted data in a database or table diff --git a/src/current/v23.2/drop-schedules.md b/src/current/v23.2/drop-schedules.md index 59de7e9f71b..532308045c6 100644 --- a/src/current/v23.2/drop-schedules.md +++ b/src/current/v23.2/drop-schedules.md @@ -7,7 +7,7 @@ docs_area: reference.sql The `DROP SCHEDULES` [statement]({% link {{ page.version.version }}/sql-statements.md %}) can be used to remove [backup schedules]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) or [changefeed schedules]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}). -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v23.2/enable-node-map.md b/src/current/v23.2/enable-node-map.md index 9d3a927fc2c..2743f50d4f1 100644 --- a/src/current/v23.2/enable-node-map.md +++ b/src/current/v23.2/enable-node-map.md @@ -107,7 +107,7 @@ The following page is displayed: ### Step 2. Set the Enterprise license and refresh the DB Console -After [setting the Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), the Node Map should now be displaying the highest-level localities you defined: +The Node Map should now be displaying the highest-level localities you defined: DB Console @@ -160,7 +160,6 @@ To navigate to Node 2, which is in datacenter `us-east-1a` in the `us-east-1` re ### Node Map not displayed -- The Node Map requires an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - All nodes in the cluster must be assigned [localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality). - Localities must be [assigned a corresponding latitude and longitude](#step-3-set-the-latitudes-and-longitudes-for-the-localities). diff --git a/src/current/v23.2/enterprise-licensing.md b/src/current/v23.2/enterprise-licensing.md index c23bcf7bd30..62e861e2b59 100644 --- a/src/current/v23.2/enterprise-licensing.md +++ b/src/current/v23.2/enterprise-licensing.md @@ -5,8 +5,6 @@ toc: true docs_area: --- -CockroachDB distributes a single binary that contains both core and Enterprise features. You can use core features without any license key. However, to use the Enterprise features, you need either a trial or an Enterprise license key. - This page lists Enterprise features. For information on how to obtain and set trial and Enterprise license keys for CockroachDB, see the [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). {{site.data.alerts.callout_info}} diff --git a/src/current/v23.2/follower-reads.md b/src/current/v23.2/follower-reads.md index 95ca4651122..3ee858978ee 100644 --- a/src/current/v23.2/follower-reads.md +++ b/src/current/v23.2/follower-reads.md @@ -269,4 +269,3 @@ For an example showing how to successfully perform a bounded staleness read, see - [Cluster Settings Overview]({% link {{ page.version.version }}/cluster-settings.md %}) - [Load-Based Splitting]({% link {{ page.version.version }}/load-based-splitting.md %}) - [Network Latency Page]({% link {{ page.version.version }}/ui-network-latency-page.md %}) -- [Enterprise Features]({% link {{ page.version.version }}/enterprise-licensing.md %}) diff --git a/src/current/v23.2/frequently-asked-questions.md b/src/current/v23.2/frequently-asked-questions.md index 69a549a69de..9493e09c764 100644 --- a/src/current/v23.2/frequently-asked-questions.md +++ b/src/current/v23.2/frequently-asked-questions.md @@ -39,7 +39,7 @@ There are four ways to use and deploy CockroachDB: - **CockroachDB {{ site.data.products.basic }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.basic }} provides highly available database clusters that scale instantly and automatically for small production and dev/test workloads. - **CockroachDB {{ site.data.products.standard }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.standard }} allows you to consolidate a variety of production workloads while optimizing cost. - **CockroachDB {{ site.data.products.advanced }}**: A single tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.advanced }} provides dedicated hardware to support stringent regulatory requirements and enhanced compliance, targeting production workloads with advanced Enterprise requirements. -- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment and require [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment. ## About the database diff --git a/src/current/v23.2/get-started-with-enterprise-trial.md b/src/current/v23.2/get-started-with-enterprise-trial.md index 79bab2847b3..7820a1bb3a3 100644 --- a/src/current/v23.2/get-started-with-enterprise-trial.md +++ b/src/current/v23.2/get-started-with-enterprise-trial.md @@ -6,7 +6,7 @@ license: true docs_area: --- -Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's core capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also our Enterprise-only features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). +Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). ## Install CockroachDB @@ -25,7 +25,7 @@ You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }} ## Use Enterprise features -Your cluster now has access to all of CockroachDB's Enterprise features for the length of the trial: +Your cluster now has access to all of CockroachDB's features for the length of the trial: {% include {{ page.version.version }}/misc/enterprise-features.md %} diff --git a/src/current/v23.2/learn-cockroachdb-sql.md b/src/current/v23.2/learn-cockroachdb-sql.md index 45c5a7ed8de..6b4fc2d82ac 100644 --- a/src/current/v23.2/learn-cockroachdb-sql.md +++ b/src/current/v23.2/learn-cockroachdb-sql.md @@ -356,4 +356,4 @@ When you no longer need a table, use [`DROP TABLE`]({% link {{ page.version.vers - Explore all [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}) - [Use the built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}) to execute statements from a shell or directly from the command line - [Install the client driver]({% link {{ page.version.version }}/install-client-drivers.md %}) for your preferred language and [build an app]({% link {{ page.version.version }}/example-apps.md %}) -- [Explore core CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance +- [Explore CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance diff --git a/src/current/v23.2/licensing-faqs.md b/src/current/v23.2/licensing-faqs.md index 554cbec247c..c6b781c00b8 100644 --- a/src/current/v23.2/licensing-faqs.md +++ b/src/current/v23.2/licensing-faqs.md @@ -1,6 +1,6 @@ --- title: Licensing FAQs -summary: Frequently asked questions about CockroachDB Enterprise and core licensing. +summary: Frequently asked questions about CockroachDB Enterprise licensing. toc: true docs_area: get_started --- @@ -9,20 +9,7 @@ docs_area: get_started {% include common/license/evolving.md %} {{site.data.alerts.end}} -CockroachDB code is primarily licensed in two ways: - -- [Business Source License (BSL)](#bsl) -- [Cockroach Community License (CCL)](#ccl) - -CockroachDB core is free to use. Most [core features](#feature-licensing) are licensed under the BSL, but some core features are subject to the CCL or third-party licenses. - -Non-CCL core features from version 19.1 and earlier are licensed under [Apache 2.0](#apache); however, some features remain under third-party licenses. Beginning in version 19.2, these non-CCL features are licensed under the BSL for three years before [converting](#license-conversion-timeline) to the Apache 2.0 license. - -CockroachDB [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) require a [paid license](#obtain-a-license) from Cockroach and are licensed under the Cockroach Community License. - -{{site.data.alerts.callout_info}} -You can find any feature's license by checking the code's file header in the [CockroachDB repository](https://github.com/cockroachdb/cockroach). -{{site.data.alerts.end}} +CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). ## Types of licenses diff --git a/src/current/v23.2/manage-a-backup-schedule.md b/src/current/v23.2/manage-a-backup-schedule.md index eabe7064568..6ad27edd5a9 100644 --- a/src/current/v23.2/manage-a-backup-schedule.md +++ b/src/current/v23.2/manage-a-backup-schedule.md @@ -145,7 +145,7 @@ Or nest a [`SELECT` clause]({% link {{ page.version.version }}/select-clause.md > DROP SCHEDULES WITH x AS (SHOW SCHEDULES) SELECT id FROM x WHERE label = 'schedule_database'; ~~~~ -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 7bf7e7c4620..af4613543aa 100644 --- a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -145,7 +145,7 @@ To start your CockroachDB cluster, you can either use our StatefulSet configurat ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md index 3420bd25430..a65e86c19e6 100644 --- a/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v23.2/orchestrate-a-local-cluster-with-kubernetes.md @@ -90,7 +90,7 @@ Choose a way to deploy and maintain the CockroachDB cluster: ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v23.2/partitioning.md b/src/current/v23.2/partitioning.md index 4adcde7b412..1399e2f6267 100644 --- a/src/current/v23.2/partitioning.md +++ b/src/current/v23.2/partitioning.md @@ -23,7 +23,6 @@ Table partitioning helps you reduce latency and cost: Table partitioning involves a combination of CockroachDB features: - [Node attributes](#node-attributes) -- [Enterprise license](#enterprise-license) - [Table creation](#table-creation) - [Replication zones](#replication-zones) @@ -37,24 +36,6 @@ To store partitions in specific locations (e.g., geo-partitioning), or on machin For more details about these flags, see the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) documentation. -### Enterprise license - -You must have a valid Enterprise license to use table partitioning features. For details about requesting and setting a trial or full Enterprise license, see [Enterprise Licensing]({% link {{ page.version.version }}/enterprise-licensing.md %}). - -The following features do not work with an **expired license**: - -- Creating new table partitions or adding new zone configurations for partitions -- Changing the partitioning scheme on any table or index -- Changing the zone config for a partition - -However, the following features continue to work even with an expired Enterprise license: - -- Querying a partitioned table (for example, `SELECT foo PARTITION`) -- Inserting or updating data in a partitioned table -- Dropping a partitioned table -- Unpartitioning a partitioned table -- Making non-partitioning changes to a partitioned table (for example, adding a column/index/foreign key/check constraint) - ### Table creation You can define partitions and subpartitions over one or more columns of a table. During [table creation]({% link {{ page.version.version }}/create-table.md %}), you declare which values belong to each partition in one of two ways: diff --git a/src/current/v23.2/physical-cluster-replication-overview.md b/src/current/v23.2/physical-cluster-replication-overview.md index 0a064d4d184..5aea121b233 100644 --- a/src/current/v23.2/physical-cluster-replication-overview.md +++ b/src/current/v23.2/physical-cluster-replication-overview.md @@ -106,7 +106,7 @@ To connect to a virtualized cluster using the SQL shell: ~~~ {{site.data.alerts.callout_info}} -Physical cluster replication requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) on the primary and standby clusters. You must set {{ site.data.products.enterprise }} licenses from the system virtual cluster. +Physical cluster replication requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on the primary and standby clusters. You must set {{ site.data.products.enterprise }} licenses from the system virtual cluster. {{site.data.alerts.end}} To connect to the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) and view the **Physical Cluster Replication** dashboard, the user must have the correct privileges. Refer to [Create a user for the standby cluster]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#create-a-user-for-the-standby-cluster). diff --git a/src/current/v23.2/restore.md b/src/current/v23.2/restore.md index fd5f1d3295f..889237f773a 100644 --- a/src/current/v23.2/restore.md +++ b/src/current/v23.2/restore.md @@ -180,7 +180,7 @@ Also, consider that: - When the cluster is in a mixed-version state during an [upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}), a full cluster restore will fail. To perform a full cluster restore, it is necessary to first [finalize the upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#step-3-decide-how-the-upgrade-will-be-finalized). {{site.data.alerts.callout_info}} -When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. +When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. {{site.data.alerts.end}} ### Databases diff --git a/src/current/v23.2/security-reference/encryption.md b/src/current/v23.2/security-reference/encryption.md index f988d7e16cd..7a0b747ca70 100644 --- a/src/current/v23.2/security-reference/encryption.md +++ b/src/current/v23.2/security-reference/encryption.md @@ -32,7 +32,7 @@ When CMEK is enabled, the **Encryption** option appears to be disabled in the [D When selecting a deployment environment for a CockroachDB {{ site.data.products.core }} cluster, we recommend that you select a cloud provider such as Google Cloud Platform (GCP) or Amazon Web Services (AWS), which automatically provide industry-standard encryption for cloud storage resources. You can learn more about [GCP persistent disk encryption](https://cloud.google.com/compute/docs/disks#pd_encryption) or [AWS Elastic Block Storage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). -In addition, the [Encryption at Rest (Enterprise) feature]({% link {{ page.version.version }}/enterprise-licensing.md %}) provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. +In addition, the Encryption at Rest feature provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. Encryption is performed in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}) and configured per store. All files used by the store, regardless of contents, are encrypted with the desired algorithm. diff --git a/src/current/v23.2/security-reference/security-overview.md b/src/current/v23.2/security-reference/security-overview.md index 3523609c519..afc0bdda2f7 100644 --- a/src/current/v23.2/security-reference/security-overview.md +++ b/src/current/v23.2/security-reference/security-overview.md @@ -20,15 +20,11 @@ Learn more: [Integrate CockroachDB {{ site.data.products.advanced }} with Satori ### Self-Hosted -Cockroach Labs maintains CockroachDB as an open-source core, which is available to operate under a number of different licensing options, including several free options. - CockroachDB {{ site.data.products.core }} here refers to the situation of a user deploying and operating their own cluster. -{{ site.data.products.enterprise }} refers to an ongoing paid license relationship with Cockroach Labs. This license unlocks advanced features (see below). In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of the Cockroach Labs's {{ site.data.products.enterprise }} Support staff. +{{ site.data.products.enterprise }} refers to an ongoing license relationship with Cockroach Labs. In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of Cockroach Labs' {{ site.data.products.enterprise }} Support staff. -- See the [list of {{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}) -- Read the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [Contact our sales team](mailto:sales@cockroachlabs.com) for further questions about {{ site.data.products.enterprise }} +For more information, see the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) ## Comparison of security features @@ -39,7 +35,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user {{ site.data.products.basic }} {{ site.data.products.standard }} {{ site.data.products.advanced }} - {{ site.data.products.core }} {{ site.data.products.core }} {{ site.data.products.enterprise }} Feature @@ -51,7 +46,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Inter-node and node identity authentication using TLS 1.3 @@ -59,7 +53,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Client identity authentication using username/password @@ -67,7 +60,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SASL/SCRAM-SHA-256 secure password-based authentication @@ -75,7 +67,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user     ✓ - ✓ SQL client identity authentication using TLS 1.2/1.3 @@ -83,14 +74,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Web console authentication with third-party Single Sign-on (SSO) using OpenID Connect OIDC       -   ✓ Client identity authentication with GSSAPI and Kerberos @@ -98,7 +87,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ HTTP API access using login tokens @@ -106,7 +94,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ OCSP certificate revocation protocol @@ -116,7 +103,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Encryption in transit using TLS 1.3 @@ -124,7 +110,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for AWS clusters are encrypted at rest using AWS S3’s server-side encryption @@ -132,7 +117,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for GCP clusters are encrypted at rest using Google-managed server-side encryption keys @@ -140,14 +124,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Industry-standard encryption at rest is provided at the infrastructure level by your chosen deployment environment, such as Google Cloud Platform (GCP), Amazon Web Services (AWS), or Microsoft Azure. You can learn more about GCP persistent disk encryption, AWS Elastic Block Storage, or Azure managed disk encryption.       -   ✓ Cockroach Labs's proprietary storage-level {{ site.data.products.enterprise }} Encryption At Rest service implementing the Advanced Encryption Standard (AES) @@ -157,7 +139,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Users and privileges @@ -165,7 +146,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Role-based access control (RBAC) @@ -174,7 +154,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL-level configuration allowed authentication attempts by IP address @@ -182,7 +161,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Network-level Configuration of allowed IP addresses @@ -190,7 +168,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ GCP Private Service Connect (PSC) (Preview) or VPC Peering for GCP clusters and AWS PrivateLink for AWS clusters @@ -199,7 +176,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL Audit Logging @@ -208,7 +184,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ CockroachDB, as a distributed SQL database, is uniquely resilient by nature. A cluster can tolerate node failures as long as the majority of nodes remain functional. See Disaster Recovery. diff --git a/src/current/v23.2/set-up-physical-cluster-replication.md b/src/current/v23.2/set-up-physical-cluster-replication.md index 1ecf1b44a36..57946405282 100644 --- a/src/current/v23.2/set-up-physical-cluster-replication.md +++ b/src/current/v23.2/set-up-physical-cluster-replication.md @@ -37,7 +37,7 @@ The high-level steps in this tutorial are: - To set up each cluster, you can follow [Deploy CockroachDB on Premises]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}). When you start each node in your cluster with the `cockroach start` command, you **must** pass the `--config-profile` flag with a `replication` value. Refer to cluster creation steps for the [primary cluster](#start-the-primary-cluster) and for the [standby cluster](#start-the-standby-cluster) for details. - The [Deploy CockroachDB on Premises]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}) tutorial creates a self-signed certificate for each {{ site.data.products.core }} cluster. To create certificates signed by an external certificate authority, refer to [Create Security Certificates using OpenSSL]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}). - All nodes in each cluster will need access to the Certificate Authority for the other cluster. Refer to [Copy certificates](#step-3-copy-certificates). -- An [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) on the primary **and** standby clusters. You must use the system virtual cluster on the primary and standby clusters to enable your {{ site.data.products.enterprise }} license. +- An [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on the primary **and** standby clusters. You must use the system virtual cluster on the primary and standby clusters to enable your {{ site.data.products.enterprise }} license. - The primary and standby clusters **must have the same [region topology]({% link {{ page.version.version }}/topology-patterns.md %})**. For example, replicating a multi-region primary cluster to a single-region standby cluster is not supported. Mismatching regions between a multi-region primary and standby cluster is also not supported. ## Step 1. Create the primary cluster diff --git a/src/current/v23.2/sql-statements.md b/src/current/v23.2/sql-statements.md index c7a4979e09c..aa450f7f0f3 100644 --- a/src/current/v23.2/sql-statements.md +++ b/src/current/v23.2/sql-statements.md @@ -17,7 +17,7 @@ Statement | Usage [`ALTER DEFAULT PRIVILEGES`]({% link {{ page.version.version }}/alter-default-privileges.md %}) | Change the default [privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#privileges) for objects created by specific roles/users in the current database. [`ALTER FUNCTION`]({% link {{ page.version.version }}/alter-function.md %}) | Modify a [user-defined function]({% link {{ page.version.version }}/user-defined-functions.md %}). [`ALTER INDEX`]({% link {{ page.version.version }}/alter-index.md %}) | Apply a schema change to an index. -[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [`ALTER RANGE`]({% link {{ page.version.version }}/alter-range.md %}) | Configure the replication zone for a system range. [`ALTER SCHEMA`]({% link {{ page.version.version }}/alter-schema.md %}) | Alter a user-defined schema. [`ALTER SEQUENCE`]({% link {{ page.version.version }}/alter-sequence.md %}) | Apply a schema change to a sequence. @@ -54,7 +54,7 @@ Statement | Usage [`SHOW FULL TABLE SCANS`]({% link {{ page.version.version }}/show-full-table-scans.md %}) | List recent queries that used a full table scan. [`SHOW INDEX`]({% link {{ page.version.version }}/show-index.md %}) | View index information for a table or database. [`SHOW LOCALITY`]({% link {{ page.version.version }}/show-locality.md %}) | View the locality of the current node. -[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [`SHOW REGIONS`]({% link {{ page.version.version }}/show-regions.md %}) | List the [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) or [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SUPER REGIONS`]({% link {{ page.version.version }}/show-super-regions.md %}) | List the [super regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) associated with a database in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SCHEMAS`]({% link {{ page.version.version }}/show-schemas.md %}) | List the schemas in a database. @@ -172,13 +172,13 @@ Statement | Usage [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) | Create disaster recovery backups of clusters, databases, and tables. [`RESTORE`]({% link {{ page.version.version }}/restore.md %}) | Restore clusters, databases, and tables using your backups. [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}) | List the contents of a backup. -[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. Core users can only use backup scheduling for full backups of clusters, databases, or tables. To use the other backup features, you need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) | Modify an existing backup schedule. [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) | View information on backup schedules. [`PAUSE SCHEDULES`]({% link {{ page.version.version }}/pause-schedules.md %}) | Pause backup schedules. [`RESUME SCHEDULES`]({% link {{ page.version.version }}/resume-schedules.md %}) | Resume paused backup schedules. [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}) | Drop backup schedules. -[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. Adding new KMS encryption keys requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. ## Changefeed statements @@ -186,10 +186,10 @@ Statement | Usage Statement | Usage ----------|------------ -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). -[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}) | (Core) Create a new changefeed to stream row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. -[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Modify an existing changefeed. +[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | Modify an existing changefeed. ## External resource statements diff --git a/src/current/v23.2/sso-db-console.md b/src/current/v23.2/sso-db-console.md index 99db24bfdf5..e3e1e3e27b7 100644 --- a/src/current/v23.2/sso-db-console.md +++ b/src/current/v23.2/sso-db-console.md @@ -27,7 +27,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **IdP:** You must have access to an OAuth 2.0 identity provider and client. The process of provisioning one with Google Cloud Platform is described on this page in the [Provision an OAuth client using Google Cloud Platform (GCP)](#provision-an-oauth-client-using-google-cloud-platform-gcp) section. - **CockroachDB cluster**: you must have access to one of the following: - - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). + - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). diff --git a/src/current/v23.2/sso-sql.md b/src/current/v23.2/sso-sql.md index d9f133e3171..1479e03608c 100644 --- a/src/current/v23.2/sso-sql.md +++ b/src/current/v23.2/sso-sql.md @@ -14,7 +14,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.advanced }} clusters can provision their users with Java Web Tokens (JWTs) via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.enterprise }} and {{ site.data.products.advanced }} clusters. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). +Cluster single sign-on for the DB Console is supported on CockroachDB [{{ site.data.products.enterprise }}]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) and {{ site.data.products.advanced }} clusters. CockroachDB {{ site.data.products.standard }} and {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: diff --git a/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 71577a74550..d7fd08773d8 100644 --- a/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v23.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -248,7 +248,7 @@ To create your changefeed, you'll prepare your CockroachDB cluster with the `mov cockroach sql --url {"CONNECTION STRING"} ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~sql diff --git a/src/current/v23.2/take-and-restore-encrypted-backups.md b/src/current/v23.2/take-and-restore-encrypted-backups.md index 8646bc8b72a..fc30a66f2df 100644 --- a/src/current/v23.2/take-and-restore-encrypted-backups.md +++ b/src/current/v23.2/take-and-restore-encrypted-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Encrypted [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take and restore encrypted backups in the following ways: - [Using AWS Key Management Service (KMS)](#aws-kms-uri-format) diff --git a/src/current/v23.2/take-and-restore-locality-aware-backups.md b/src/current/v23.2/take-and-restore-locality-aware-backups.md index 926ee503630..6ac3dea234e 100644 --- a/src/current/v23.2/take-and-restore-locality-aware-backups.md +++ b/src/current/v23.2/take-and-restore-locality-aware-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Locality-aware [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - Locality-aware backups allow you to partition and store backup data in a way that is optimized for locality. When you run a locality-aware backup, nodes write backup data to the [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}) bucket that is closest to the node locality configured at [node startup]({% link {{ page.version.version }}/cockroach-start.md %}). {{site.data.alerts.callout_danger}} diff --git a/src/current/v23.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md b/src/current/v23.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md index 371c40a0fdf..4904d50f203 100644 --- a/src/current/v23.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md +++ b/src/current/v23.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -[`BACKUP`]({% link {{ page.version.version }}/backup.md %}) with revision history is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take backups with revision history and restore from a point-in-time. You can create full or incremental backups [with revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history): diff --git a/src/current/v23.2/take-full-and-incremental-backups.md b/src/current/v23.2/take-full-and-incremental-backups.md index 650bf1269cd..97f55aa4e4c 100644 --- a/src/current/v23.2/take-full-and-incremental-backups.md +++ b/src/current/v23.2/take-full-and-incremental-backups.md @@ -88,8 +88,6 @@ In the examples on this page, `{collectionURI}` is a placeholder for the storage ## Full backups -Full backups are now available to both core and Enterprise users. - Full backups contain an un-replicated copy of your data and can always be used to restore your cluster. These files are roughly the size of your data and require greater resources to produce than incremental backups. You can take full backups as of a given timestamp. Optionally, you can include the available [revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) in the backup. In most cases, **it's recommended to take nightly full backups of your cluster**. A cluster backup allows you to do the following: @@ -98,7 +96,7 @@ In most cases, **it's recommended to take nightly full backups of your cluster** - Restore database(s) from the cluster - Restore a full cluster -[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. +[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. {% include {{ page.version.version }}/backups/file-size-setting.md %} @@ -149,10 +147,6 @@ To view the available backup subdirectories, use [`SHOW BACKUPS`]({% link {{ pag ## Incremental backups -{{site.data.alerts.callout_info}} -To take incremental backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - If your cluster grows too large for daily [full backups](#full-backups), you can take less frequent full backups (e.g., weekly) with daily incremental backups. Incremental backups are storage efficient and faster than full backups for larger clusters. If you are taking backups on a regular cadence, we recommend [creating a schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) for your backups. @@ -271,7 +265,7 @@ For details on cloud storage URLs, see [Use Cloud Storage]({% link {{ page.versi ### Scheduled backups -You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. To create a schedule that includes incremental backups, you must have an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. Include the `FULL BACKUP ALWAYS` clause for a schedule to take only full backups. For example, to create a schedule for taking full cluster backups: @@ -383,10 +377,6 @@ To create a table with `exclude_data_from_backup`, see [Create a table with data {% include {{ page.version.version }}/backups/advanced-examples-list.md %} -{{site.data.alerts.callout_info}} -To take incremental backups, backups with revision history, locality-aware backups, and encrypted backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## See also - [`BACKUP`][backup] diff --git a/src/current/v23.2/ui-cluster-overview-page.md b/src/current/v23.2/ui-cluster-overview-page.md index 9e2049c02cd..b8788dcad21 100644 --- a/src/current/v23.2/ui-cluster-overview-page.md +++ b/src/current/v23.2/ui-cluster-overview-page.md @@ -12,7 +12,7 @@ The **Cluster Overview** page of the DB Console displays key metrics about your - Uptime - Hardware usage -If you have an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), you can enable the [Node Map](#node-map-enterprise) view for a visual representation of your cluster's geographic layout. +Enable the [Node Map](#node-map) view for a visual representation of your cluster's geographic layout. ## Cluster Overview panel @@ -28,7 +28,7 @@ Replication Status |
                                                                      • The total number ### Capacity metrics -The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map-enterprise) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. +The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. Usable disk space is constrained by the following: @@ -50,7 +50,7 @@ If a node is currently unavailable, the last-known capacity usage will be shown, The **Node List** groups nodes by locality. The lowest-level locality tier is used to organize the Node List. Hover over a locality to see all localities for the group of nodes. {{site.data.alerts.callout_success}} -We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map-enterprise). +We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map). {{site.data.alerts.end}} ### Node status @@ -104,9 +104,9 @@ You can see the full history of decommissioned nodes by clicking **View all deco For details about the decommissioning process, see [Node Shutdown](node-shutdown.html?filters=decommission#node-shutdown-sequence). {{site.data.alerts.end}} -## Node Map (Enterprise) +## Node Map -The **Node Map** is an [enterprise]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature that visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. +The **Node Map** visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. For guidance on enabling and configuring the node map, see [Enable the Node Map]({% link {{ page.version.version }}/enable-node-map.md %}). diff --git a/src/current/v23.2/ui-overview.md b/src/current/v23.2/ui-overview.md index f78b095b7e2..8755f23e4d9 100644 --- a/src/current/v23.2/ui-overview.md +++ b/src/current/v23.2/ui-overview.md @@ -16,7 +16,7 @@ Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console ## Authentication -The DB Console supports username/password login, as well as single sign-on (SSO) ({{ site.data.products.advanced }} and {{ site.data.products.core }} {{ site.data.products.enterprise }} clusters only). +The DB Console supports username/password login and single sign-on (SSO) for ({{ site.data.products.advanced }} and {{ site.data.products.enterprise }} clusters). The DB Console sign-on page can also be used to provision authentication tokens for SQL client access. @@ -32,8 +32,8 @@ Refer to: The Overview page provides a cluster overview and node list and map. - [Cluster Overview]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}) has essential metrics about the cluster and nodes, including liveness status, replication status, uptime, and hardware usage. -- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) has a list of cluster metrics at the locality and node levels. -- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. +- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) has a list of cluster metrics at the locality and node levels. +- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. ### Metrics diff --git a/src/current/v24.1/alter-backup-schedule.md b/src/current/v24.1/alter-backup-schedule.md index c77e82990bf..ee739781f2a 100644 --- a/src/current/v24.1/alter-backup-schedule.md +++ b/src/current/v24.1/alter-backup-schedule.md @@ -5,12 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - The `ALTER BACKUP SCHEDULE` statement modifies an existing [backup schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). You can use `ALTER BACKUP SCHEDULE` to do the following: - Set a different name for a backup schedule. diff --git a/src/current/v24.1/alter-database.md b/src/current/v24.1/alter-database.md index 635984ca4f0..673c64296f3 100644 --- a/src/current/v24.1/alter-database.md +++ b/src/current/v24.1/alter-database.md @@ -33,21 +33,21 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description -----------|------------ -[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`ALTER LOCALITY`](#alter-locality) | Persistently modify the configuration generated by the standard [multi-region SQL abstractions]({% link {{ page.version.version }}/multiregion-overview.md %}) on a per-region basis. For advanced users who want to customize their multi-region setup using [Zone Config Extensions]({% link {{ page.version.version }}/zone-config-extensions.md %}), a persistent, composable alternative to low-level [zone configs]({% link {{ page.version.version }}/configure-replication-zones.md %}). -[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for a database. -[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). [`OWNER TO`](#owner-to) | Change the owner of a database. [`PLACEMENT`](#placement) | Configure the replica placement policy for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). [`RENAME TO`](#rename-to) | Change the name of a database. [`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). [`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). -[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. [`SURVIVE {ZONE,REGION} FAILURE`](#survive-zone-region-failure) | Add a survival goal to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ### `ADD REGION` @@ -282,7 +282,7 @@ For usage, see [Synopsis](#synopsis). ### `PLACEMENT` -`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. +`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. `ALTER DATABASE ... PLACEMENT RESTRICTED` constrains the voting and non-voting replica placement for the database's tables to the [home regions]({% link {{ page.version.version }}/alter-table.md %}#crdb_region) associated with those tables. This is a way of opting out of [non-voting replicas]({% link {{ page.version.version }}/architecture/replication-layer.md %}#non-voting-replicas) for [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) to accomplish one or more of the following goals: @@ -783,7 +783,7 @@ ALTER DATABASE movr ADD REGION "europe-west1"; #### Override specific fields of a schema object's zone configs -In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. +In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences`. diff --git a/src/current/v24.1/alter-index.md b/src/current/v24.1/alter-index.md index ec229099688..843513a44c5 100644 --- a/src/current/v24.1/alter-index.md +++ b/src/current/v24.1/alter-index.md @@ -35,8 +35,8 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description | -----------|-------------| -[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. | +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. [`RENAME TO`](#rename-to) | Change the name of an index. [`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the index. [`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the index. diff --git a/src/current/v24.1/alter-table.md b/src/current/v24.1/alter-table.md index 21ee3d85292..90bda6651af 100644 --- a/src/current/v24.1/alter-table.md +++ b/src/current/v24.1/alter-table.md @@ -54,7 +54,7 @@ Subcommand | Description | Can combine with other subcommands? [`DROP CONSTRAINT`](#drop-constraint) | Remove constraints from columns. | Yes [`EXPERIMENTAL_AUDIT`](#experimental_audit) | Enable per-table audit logs, for security purposes. | Yes [`OWNER TO`](#owner-to) | Change the owner of the table. | No -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | Yes +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. | Yes [`RENAME COLUMN`](#rename-column) | Change the names of columns. | Yes [`RENAME CONSTRAINT`](#rename-constraint) | Change constraints columns. | Yes [`RENAME TO`](#rename-to) | Change the names of tables. | No diff --git a/src/current/v24.1/authentication.md b/src/current/v24.1/authentication.md index f2d16478568..96aed954bb8 100644 --- a/src/current/v24.1/authentication.md +++ b/src/current/v24.1/authentication.md @@ -105,9 +105,9 @@ CockroachDB offers the following methods for client authentication: Enter password: ~~~ -- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}). -- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}). ### Using `cockroach cert` or `openssl` commands diff --git a/src/current/v24.1/backup-and-restore-overview.md b/src/current/v24.1/backup-and-restore-overview.md index b419188923a..b267ddbbfcf 100644 --- a/src/current/v24.1/backup-and-restore-overview.md +++ b/src/current/v24.1/backup-and-restore-overview.md @@ -25,7 +25,6 @@ This table outlines the level of product support for backup and restore features Backup / Restore Description - Self-hosted support @@ -34,88 +33,48 @@ This table outlines the level of product support for backup and restore features Full backup An un-replicated copy of your cluster, database, or table's data. A full backup is the base for any further backups. - -
                                                                          -
                                                                        • Enterprise license not required
                                                                          • -
                                                                        - Incremental backup A copy of the changes in your data since the specified base backup (either a full backup or a full backup plus an incremental backup). - - - Scheduled backup A schedule for periodic backups. - - - Backups with revision history A backup with revision history allows you to back up every change made within the garbage collection period leading up to and including the given timestamp. - - - Point-in-time restore A restore from an arbitrary point in time within the revision history of a backup. - - - Encrypted backup and restore An encrypted backup using a KMS or passphrase. - - - Locality-aware backup and restore A backup where each node writes files to the backup destination that matches the node locality configured at node startup. - - - Locality-restricted backup execution A backup with the EXECUTION LOCALITY option restricts the nodes that can execute a backup job with a defined locality filter. - - - diff --git a/src/current/v24.1/backup-validation.md b/src/current/v24.1/backup-validation.md index 3c29767e7f3..a4f00b7754a 100644 --- a/src/current/v24.1/backup-validation.md +++ b/src/current/v24.1/backup-validation.md @@ -15,10 +15,6 @@ You can validate a backup of a [cluster]({% link {{ page.version.version }}/back The options that give the most validation coverage will increase the runtime of the check. That is, `verify_backup_table_data` will take a longer time to validate a backup compared to `check_files` or `schema_only` alone. Despite that, each of these validation options provide a quicker way to validate a backup over running a "regular" restore. -{{site.data.alerts.callout_info}} -You do **not** need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to run any of the backup validation tools described on this page. -{{site.data.alerts.end}} - ## Recommendations Cockroach Labs recommends implementing the following validation plan to test your backups: diff --git a/src/current/v24.1/backup.md b/src/current/v24.1/backup.md index d7f872ebb0b..575cd0aec1d 100644 --- a/src/current/v24.1/backup.md +++ b/src/current/v24.1/backup.md @@ -32,8 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.standard }} {{ site.data.products.advanced }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup) to set the frequency and retention of managed backups. -- [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. +- [Full cluster backups](#back-up-a-cluster) include [license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes a license, the license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. - Exclude a table's row data from a backup using the [`exclude_data_from_backup`]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#exclude-a-tables-data-from-backups) parameter. diff --git a/src/current/v24.1/certificate-based-authentication-using-the-x509-subject-field.md b/src/current/v24.1/certificate-based-authentication-using-the-x509-subject-field.md index aae25e2c814..17c88a4aa04 100644 --- a/src/current/v24.1/certificate-based-authentication-using-the-x509-subject-field.md +++ b/src/current/v24.1/certificate-based-authentication-using-the-x509-subject-field.md @@ -89,7 +89,7 @@ ERROR: role "root" cannot have a SUBJECT%!(EXTRA string=use the --%s CLI flag to SQLSTATE: 22023 ~~~ -If you do not have an [enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), the following error is signaled: +If you do not have an [enterprise license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses), the following error is signaled: {% include_cached copy-clipboard.html %} ~~~ diff --git a/src/current/v24.1/changefeed-examples.md b/src/current/v24.1/changefeed-examples.md index f953a4de8c6..b4d6aba574a 100644 --- a/src/current/v24.1/changefeed-examples.md +++ b/src/current/v24.1/changefeed-examples.md @@ -39,13 +39,9 @@ Before you run the examples, verify that you have the `CHANGEFEED` privilege in ## Create a changefeed connected to Kafka -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -184,13 +180,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to Kafka using Avro -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed-using-avro). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink and emits [Avro](https://avro.apache.org/docs/1.8.2/spec.html) records. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -491,13 +483,9 @@ You'll need access to a [Google Cloud Project](https://cloud.google.com/resource ## Create a changefeed connected to a cloud storage sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to an AWS S3 sink. The changefeed watches two tables. Note that you can set up changefeeds for any of [these cloud storage providers]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink). -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -613,13 +601,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to a webhook sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a local HTTP server via a webhook. For this example, you'll use an [example HTTP server](https://github.com/cockroachlabs/cdc-webhook-sink-test-server/tree/master/go-https-server) to test out the webhook sink. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/v24.1/changefeed-for.md b/src/current/v24.1/changefeed-for.md index 569c8bb2e26..3db74ac6e1d 100644 --- a/src/current/v24.1/changefeed-for.md +++ b/src/current/v24.1/changefeed-for.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`EXPERIMENTAL CHANGEFEED FOR` is the core implementation of changefeeds. For the [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) version, see [`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}). -{{site.data.alerts.end}} - The `EXPERIMENTAL CHANGEFEED FOR` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new core changefeed, which streams row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. A core changefeed can watch one table or multiple tables in a comma-separated list. For more information, see [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}). diff --git a/src/current/v24.1/changefeeds-on-tables-with-column-families.md b/src/current/v24.1/changefeeds-on-tables-with-column-families.md index 91e115557fe..069242510ae 100644 --- a/src/current/v24.1/changefeeds-on-tables-with-column-families.md +++ b/src/current/v24.1/changefeeds-on-tables-with-column-families.md @@ -94,13 +94,9 @@ For examples of starting changefeeds on tables with column families, see the fol ## Create a changefeed on a table with column families -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example]({% link {{ page.version.version }}/changefeeds-on-tables-with-column-families.md %}?filters=core#create-a-core-changefeed-on-a-table-with-column-families). -{{site.data.alerts.end}} - In this example, you'll set up changefeeds on two tables that have [column families]({% link {{ page.version.version }}/column-families.md %}). You'll use a single-node cluster sending changes to a webhook sink for this example, but you can use any [changefeed sink]({% link {{ page.version.version }}/changefeed-sinks.md %}) to work with tables that include column families. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -116,7 +112,7 @@ In this example, you'll set up changefeeds on two tables that have [column famil cockroach sql --insecure ~~~ -1. Set your organization and [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization and license key: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v24.1/cockroach-start-single-node.md b/src/current/v24.1/cockroach-start-single-node.md index 21d1ba322d6..4104b847b79 100644 --- a/src/current/v24.1/cockroach-start-single-node.md +++ b/src/current/v24.1/cockroach-start-single-node.md @@ -69,7 +69,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                        Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                        **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                        **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                        This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                        Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                        This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). ### Store diff --git a/src/current/v24.1/cockroach-start.md b/src/current/v24.1/cockroach-start.md index ac403af266f..2041806cd2a 100644 --- a/src/current/v24.1/cockroach-start.md +++ b/src/current/v24.1/cockroach-start.md @@ -102,7 +102,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                        Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                        **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                        **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                        This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                        Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                        This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). `--external-io-disable-http` | This optional flag disables external HTTP(S) access (as well as custom HTTP(S) endpoints) when performing bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %})). This can be used in environments where you cannot run a full proxy server.

                                                                        If you want to run a proxy server, you can start CockroachDB while specifying the `HTTP(S)_PROXY` environment variable. `--external-io-disable-implicit-credentials` | This optional flag disables the use of implicit credentials when accessing external cloud storage services for bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %})). `--node-cert-distinguished-name` | A string with a comma separated list of distinguished name (DN) mappings in `{attribute-type}={attribute-value}` format in accordance with [RFC4514](https://www.rfc-editor.org/rfc/rfc4514) for the [`node` user]({% link {{ page.version.version }}/security-reference/authorization.md %}#node-user). If this flag is set, this needs to be an exact match with the DN subject in the client certificate provided for the `node` user. By exact match, we mean that the order of attributes in the argument to this flag must match the order of attributes in the DN subject in the certificate. For more information, see [Certificate-based authentication using multiple values from the X.509 Subject field]({% link {{ page.version.version }}/certificate-based-authentication-using-the-x509-subject-field.md %}). @@ -245,8 +245,6 @@ When WAL failover is enabled, CockroachDB will take the the following actions: {{site.data.alerts.callout_info}} {% include feature-phases/preview.md %} - -When this feature exits preview status and is generally available (GA), it will be an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). {{site.data.alerts.end}} ##### Enable WAL failover diff --git a/src/current/v24.1/column-level-encryption.md b/src/current/v24.1/column-level-encryption.md index e5fd1ce3904..354b55d053b 100644 --- a/src/current/v24.1/column-level-encryption.md +++ b/src/current/v24.1/column-level-encryption.md @@ -28,7 +28,7 @@ For usage examples, see: - [Encrypt using the `encrypt` function](#encrypt-using-the-encrypt-function). - [Encrypt using the `encrypt_iv` function](#encrypt-using-the-encrypt_iv-function). -These functions require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). If you do not have an Enterprise license, you will see an error message like the following if you try to use them: +If you do not have a [license]({% link {{ page.version.version }}/licensing-faqs.md %}), you will see an error message like the following if you try to use them: ~~~ ERROR: encrypt(): use of this cryptographic function (https://www.cockroachlabs.com/docs/stable/functions-and-operators#cryptographic-functions) requires an enterprise license. see https://cockroachlabs.com/pricing for details on how to enable enterprise features @@ -47,7 +47,7 @@ For usage examples, see: - [Decrypt using the `decrypt` function](#decrypt-using-the-decrypt-function). - [Decrypt using the `decrypt_iv` function](#decrypt-using-the-decrypt_iv-function). -These functions require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). If you do not have an Enterprise license, you will see an error message like the following if you try to use them: +If you do not have a [license]({% link {{ page.version.version }}/licensing-faqs.md %}), you will see an error message like the following if you try to use them: ~~~ ERROR: decrypt(): use of this cryptographic function (https://www.cockroachlabs.com/docs/stable/functions-and-operators#cryptographic-functions) requires an enterprise license. see https://cockroachlabs.com/pricing for details on how to enable enterprise features diff --git a/src/current/v24.1/configure-replication-zones.md b/src/current/v24.1/configure-replication-zones.md index aeba9db689e..1a61cf26308 100644 --- a/src/current/v24.1/configure-replication-zones.md +++ b/src/current/v24.1/configure-replication-zones.md @@ -10,8 +10,8 @@ Replication zones give you the power to control what data goes where in your Coc - Databases - Tables -- Rows ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) -- Indexes ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) +- Rows +- Indexes - All data in the cluster, including internal system data ([via the default replication zone](#view-the-default-replication-zone)) For each of these objects you can control: @@ -37,7 +37,7 @@ When a cluster starts, there are two categories of replication zone: 1. Pre-configured replication zones that apply to internal system data. 1. A single default replication zone that applies to the rest of the cluster. -You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. Note that adding zones for rows and secondary indexes is [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. For example, you might rely on the [default zone](#view-the-default-replication-zone) to spread most of a cluster's data across all of your availability zones, but [create a custom replication zone for a specific database](#create-a-replication-zone-for-a-database) to make sure its data is only stored in certain availability zones and/or geographies. @@ -50,8 +50,8 @@ Level | Description Cluster | CockroachDB comes with a pre-configured `default` replication zone that applies to all table data in the cluster not constrained by a database, table, or row-specific replication zone. This zone can be adjusted but not removed. See [View the Default Replication Zone](#view-the-default-replication-zone) and [Edit the Default Replication Zone](#edit-the-default-replication-zone) for more details. Database | You can add replication zones for specific databases. See [Create a Replication Zone for a Database](#create-a-replication-zone-for-a-database) for more details. Table | You can add replication zones for specific tables. See [Create a Replication Zone for a Table](#create-a-replication-zone-for-a-table). -Index ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. -Row ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. +Index | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. +Row | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. ### For system data diff --git a/src/current/v24.1/create-changefeed.md b/src/current/v24.1/create-changefeed.md index bc244659ba1..751c7d13be9 100644 --- a/src/current/v24.1/create-changefeed.md +++ b/src/current/v24.1/create-changefeed.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`CREATE CHANGEFEED` is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the core version, see [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}). -{{site.data.alerts.end}} - The `CREATE CHANGEFEED` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new {{ site.data.products.enterprise }} changefeed, which targets an allowlist of tables called "watched rows". Every change to a watched row is emitted as a record in a configurable format (`JSON` or Avro) to a configurable sink ([Kafka](https://kafka.apache.org/), [Google Cloud Pub/Sub](https://cloud.google.com/pubsub), a [cloud storage sink]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink), or a [webhook sink]({% link {{ page.version.version }}/changefeed-sinks.md %}#webhook-sink)). You can [create](#examples), [pause](#pause-a-changefeed), [resume](#resume-a-paused-changefeed), [alter]({% link {{ page.version.version }}/alter-changefeed.md %}), or [cancel](#cancel-a-changefeed) an {{ site.data.products.enterprise }} changefeed. To get started with changefeeds, refer to the [Create and Configure Changefeeds]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}) page for important usage considerations. For detail on how changefeeds emit messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page. diff --git a/src/current/v24.1/create-index.md b/src/current/v24.1/create-index.md index 1818314ac31..02b37679901 100644 --- a/src/current/v24.1/create-index.md +++ b/src/current/v24.1/create-index.md @@ -51,7 +51,7 @@ Parameter | Description `name` | The name of the column you want to index. For [multi-region tables]({% link {{ page.version.version }}/multiregion-overview.md %}#table-localities), you can use the `crdb_region` column within the index in the event the original index may contain non-unique entries across multiple, unique regions. `ASC` or `DESC`| Sort the column in ascending (`ASC`) or descending (`DESC`) order in the index. How columns are sorted affects query results, particularly when using `LIMIT`.

                                                                        __Default:__ `ASC` `STORING ...`| Store (but do not sort) each column whose name you include.

                                                                        For information on when to use `STORING`, see [Store Columns](#store-columns). Note that columns that are part of a table's [`PRIMARY KEY`]({% link {{ page.version.version }}/primary-key.md %}) cannot be specified as `STORING` columns in secondary indexes on the table.

                                                                        `COVERING` and `INCLUDE` are aliases for `STORING` and work identically. -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. +`opt_partition_by` | An option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE`, `NOT VISIBLE`, or `VISIBILITY` clause that indicates that an [index is visible, not visible, or partially visible to the cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If not visible, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For examples, see [Set index visibility]({% link {{ page.version.version }}/alter-index.md %}#set-index-visibility).

                                                                        Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations](alter-index.html#not-visible). `USING HASH` | Creates a [hash-sharded index]({% link {{ page.version.version }}/hash-sharded-indexes.md %}). diff --git a/src/current/v24.1/create-schedule-for-backup.md b/src/current/v24.1/create-schedule-for-backup.md index a72ad8e90f6..b78f5170f9c 100644 --- a/src/current/v24.1/create-schedule-for-backup.md +++ b/src/current/v24.1/create-schedule-for-backup.md @@ -9,12 +9,6 @@ docs_area: reference.sql For more information about creating, managing, monitoring, and restoring from a scheduled backup, see [Manage a Backup Schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups](#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## Required privileges {% include {{ page.version.version }}/backups/updated-backup-privileges.md %} @@ -59,7 +53,7 @@ Targets: `location` | The URI where you want to store the backup. The backup files will be stored in year > month > day subdirectories. The location can be [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}), or `nodelocal`.

                                                                        Note: If you want to schedule a backup using temporary credentials, we recommend that you use `implicit` authentication; otherwise, you'll need to drop and then recreate schedules each time you need to update the credentials. `backup_options` | Control the backup behavior with a comma-separated list of [options](#backup-options). `RECURRING crontab` | Specifies when the backup should be taken. A separate schedule may be created automatically to write full backups at a regular cadence, depending on the frequency of the incremental backups. You can likewise modify this separate schedule with [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}). The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron). All times in UTC.

                                                                        Example: `'@daily'` (run daily at midnight) -`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                        If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                        **Note:** If you do not have an Enterprise license then you can only take full backups. `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                        If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                        • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                        • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                        • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                        +`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                        If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                        `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                        If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                        • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                        • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                        • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                        `WITH SCHEDULE OPTIONS schedule_option` | Control the schedule behavior with a comma-separated list of [these options](#schedule-options). {{site.data.alerts.callout_info}} @@ -126,9 +120,9 @@ You can also visit the [**Jobs** page]({% link {{ page.version.version }}/ui-job ## Examples -### Create a schedule for full backups only (core) +### Create a schedule for full backups only -Core users can only use backup scheduling for full backups of clusters, databases, or tables. Full backups are taken with the `FULL BACKUP ALWAYS` clause, for example: +To schedule full backups of clusters, databases, or tables, use the `FULL BACKUP ALWAYS` clause, for example: {% include_cached copy-clipboard.html %} ~~~ sql @@ -145,8 +139,6 @@ Core users can only use backup scheduling for full backups of clusters, database (1 row) ~~~ -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - ### Create a scheduled backup for a cluster This example creates a schedule for a cluster backup with revision history that's taken every day at midnight: diff --git a/src/current/v24.1/create-table.md b/src/current/v24.1/create-table.md index 88c4883d59e..d1a4c389267 100644 --- a/src/current/v24.1/create-table.md +++ b/src/current/v24.1/create-table.md @@ -106,8 +106,8 @@ Parameter | Description `family_def` | An optional, comma-separated list of [column family definitions]({% link {{ page.version.version }}/column-families.md %}). Column family names must be unique within the table but can have the same name as columns, constraints, or indexes.

                                                                        A column family is a group of columns that are stored as a single key-value pair in the underlying key-value store. CockroachDB automatically groups columns into families to ensure efficient storage and performance. However, there are cases when you may want to manually assign columns to families. For more details, see [Column Families]({% link {{ page.version.version }}/column-families.md %}). `table_constraint` | An optional, comma-separated list of [table-level constraints]({% link {{ page.version.version }}/constraints.md %}). Constraint names must be unique within the table but can have the same name as columns, column families, or indexes. `LIKE table_name like_table_option_list` | Create a new table based on the schema of an existing table, using supported specifiers. For details, see [Create a table like an existing table](#create-a-table-like-an-existing-table). For examples, see [Create a new table from an existing one](#create-a-new-table-from-an-existing-one). -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. -`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).

                                                                        Note that multi-region features require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`opt_partition_by` | An option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. +`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE` or `NOT VISIBLE` clause that indicates whether an index is visible to the [cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If `NOT VISIBLE`, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For an example, see [Set an index to be not visible]({% link {{ page.version.version }}/alter-index.md %}#set-an-index-to-be-not-visible).

                                                                        Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations]({% link {{ page.version.version }}/alter-index.md %}#not-visible). `opt_with_storage_parameter_list` | A comma-separated list of [spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). Supported parameters include `fillfactor`, `s2_max_level`, `s2_level_mod`, `s2_max_cells`, `geometry_min_x`, `geometry_max_x`, `geometry_min_y`, and `geometry_max_y`. The `fillfactor` parameter is a no-op, allowed for PostgreSQL-compatibility.

                                                                        For details, see [Spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). For an example, see [Create a spatial index that uses all of the tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#create-a-spatial-index-that-uses-all-of-the-tuning-parameters). diff --git a/src/current/v24.1/create-user.md b/src/current/v24.1/create-user.md index 3f2248cd8fd..e1d1982e0b4 100644 --- a/src/current/v24.1/create-user.md +++ b/src/current/v24.1/create-user.md @@ -58,7 +58,7 @@ Secure clusters require users to authenticate their access to databases and tabl Password creation is supported only in secure clusters. -- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}). ## Examples diff --git a/src/current/v24.1/demo-automatic-cloud-migration.md b/src/current/v24.1/demo-automatic-cloud-migration.md index 9bebc18b9c0..1bac33c419d 100644 --- a/src/current/v24.1/demo-automatic-cloud-migration.md +++ b/src/current/v24.1/demo-automatic-cloud-migration.md @@ -261,7 +261,7 @@ $ rm -rf cloud1node1 cloud1node2 cloud1node3 cloud2node4 cloud2node5 cloud2node6 ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/demo-fault-tolerance-and-recovery.md b/src/current/v24.1/demo-fault-tolerance-and-recovery.md index af9d018c111..c4a32f9e762 100644 --- a/src/current/v24.1/demo-fault-tolerance-and-recovery.md +++ b/src/current/v24.1/demo-fault-tolerance-and-recovery.md @@ -376,6 +376,6 @@ kill -TERM {process IDs} ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/demo-json-support.md b/src/current/v24.1/demo-json-support.md index 7607143ebca..9678a98a162 100644 --- a/src/current/v24.1/demo-json-support.md +++ b/src/current/v24.1/demo-json-support.md @@ -284,7 +284,7 @@ $ rm -rf json-test ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/demo-replication-and-rebalancing.md b/src/current/v24.1/demo-replication-and-rebalancing.md index 40fee59a5a9..94ce2ac7d0b 100644 --- a/src/current/v24.1/demo-replication-and-rebalancing.md +++ b/src/current/v24.1/demo-replication-and-rebalancing.md @@ -303,6 +303,6 @@ At first, the replica count will be lower for nodes 4 and 5. Very soon, however, ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/demo-serializable.md b/src/current/v24.1/demo-serializable.md index 9304eaa7e85..1fecbfe5088 100644 --- a/src/current/v24.1/demo-serializable.md +++ b/src/current/v24.1/demo-serializable.md @@ -538,7 +538,7 @@ When you repeat the scenario on CockroachDB, you'll see that the anomaly is prev ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/deploy-cockroachdb-on-aws.md b/src/current/v24.1/deploy-cockroachdb-on-aws.md index 4ae7ae8ee9d..abd0e224206 100644 --- a/src/current/v24.1/deploy-cockroachdb-on-aws.md +++ b/src/current/v24.1/deploy-cockroachdb-on-aws.md @@ -18,7 +18,7 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne {% include cockroachcloud/use-cockroachcloud-instead.md %} {{site.data.alerts.callout_info}} -If you need a license to use [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}), obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. +You need a license to use CockroachDB; obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. {{site.data.alerts.end}} ## Before you begin diff --git a/src/current/v24.1/deploy-cockroachdb-with-kubernetes.md b/src/current/v24.1/deploy-cockroachdb-with-kubernetes.md index 57d63b734b2..2220b2f21f6 100644 --- a/src/current/v24.1/deploy-cockroachdb-with-kubernetes.md +++ b/src/current/v24.1/deploy-cockroachdb-with-kubernetes.md @@ -38,7 +38,7 @@ Choose how you want to deploy and maintain the CockroachDB cluster. {{site.data.alerts.callout_info}} The [CockroachDB Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator) eases CockroachDB cluster creation and management on a single Kubernetes cluster. -The Operator does not provision or apply an Enterprise license key. To use [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. +The Operator does not provision or apply an Enterprise license key. To use CockroachDB with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. {{site.data.alerts.end}}
                                                                        diff --git a/src/current/v24.1/disaster-recovery-planning.md b/src/current/v24.1/disaster-recovery-planning.md index 001813ef43c..69eaf1fac32 100644 --- a/src/current/v24.1/disaster-recovery-planning.md +++ b/src/current/v24.1/disaster-recovery-planning.md @@ -308,15 +308,13 @@ If you are outside of the garbage collection window, you will need to use a [bac ### Restore to a point in time -- If you are a core user, use a [backup]({% link {{ page.version.version }}/backup.md %}) that was taken with [`AS OF SYSTEM TIME`]({% link {{ page.version.version }}/as-of-system-time.md %}) to restore to a specific point. -- If you are an {{ site.data.products.enterprise }} user, use your [backup]({% link {{ page.version.version }}/backup.md %}) file to [restore to a point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) where you are certain there was no corruption. Note that the backup must have been taken with [revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history). +- Use your [backup]({% link {{ page.version.version }}/backup.md %}) file to [restore to a point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) where you are certain there was no corruption. Note that the backup must have been taken with [revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history). ### Create a new backup If your cluster is running, you do not have a backup that encapsulates the time you want to [restore]({% link {{ page.version.version }}/restore.md %}) to, and the data you want to recover is still in the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds), there are two actions you can take: -- If you are a core user, trigger a [backup]({% link {{ page.version.version }}/backup.md %}) using [`AS OF SYSTEM TIME`]({% link {{ page.version.version }}/as-of-system-time.md %}) to create a new backup that encapsulates the specific time. The `AS OF SYSTEM TIME` must be within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). -- If you are an {{ site.data.products.enterprise }} user, trigger a new [backup `with_revision_history`]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) and you will have a backup you can use to restore to the desired point in time within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). +- Trigger a new [backup `with_revision_history`]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) and you will have a backup you can use to restore to the desired point in time within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). ### Recover from corrupted data in a database or table diff --git a/src/current/v24.1/drop-schedules.md b/src/current/v24.1/drop-schedules.md index 59de7e9f71b..532308045c6 100644 --- a/src/current/v24.1/drop-schedules.md +++ b/src/current/v24.1/drop-schedules.md @@ -7,7 +7,7 @@ docs_area: reference.sql The `DROP SCHEDULES` [statement]({% link {{ page.version.version }}/sql-statements.md %}) can be used to remove [backup schedules]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) or [changefeed schedules]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}). -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v24.1/enable-node-map.md b/src/current/v24.1/enable-node-map.md index 3d69a5eb6b8..bfc5fafc51c 100644 --- a/src/current/v24.1/enable-node-map.md +++ b/src/current/v24.1/enable-node-map.md @@ -107,7 +107,7 @@ The following page is displayed: ### Step 2. Set the Enterprise license and refresh the DB Console -After [setting the Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), the Node Map should now be displaying the highest-level localities you defined: +The Node Map should now be displaying the highest-level localities you defined: DB Console @@ -160,7 +160,6 @@ To navigate to Node 2, which is in datacenter `us-east-1a` in the `us-east-1` re ### Node Map not displayed -- The Node Map requires an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - All nodes in the cluster must be assigned [localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality). - Localities must be [assigned a corresponding latitude and longitude](#step-3-set-the-latitudes-and-longitudes-for-the-localities). diff --git a/src/current/v24.1/enterprise-licensing.md b/src/current/v24.1/enterprise-licensing.md index c23bcf7bd30..62e861e2b59 100644 --- a/src/current/v24.1/enterprise-licensing.md +++ b/src/current/v24.1/enterprise-licensing.md @@ -5,8 +5,6 @@ toc: true docs_area: --- -CockroachDB distributes a single binary that contains both core and Enterprise features. You can use core features without any license key. However, to use the Enterprise features, you need either a trial or an Enterprise license key. - This page lists Enterprise features. For information on how to obtain and set trial and Enterprise license keys for CockroachDB, see the [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). {{site.data.alerts.callout_info}} diff --git a/src/current/v24.1/follower-reads.md b/src/current/v24.1/follower-reads.md index ec35e46fe7c..6f9d0f0aac5 100644 --- a/src/current/v24.1/follower-reads.md +++ b/src/current/v24.1/follower-reads.md @@ -199,4 +199,3 @@ For further details, see [An Epic Read on Follower Reads](https://www.cockroachl - [Cluster Settings Overview]({% link {{ page.version.version }}/cluster-settings.md %}) - [Load-Based Splitting]({% link {{ page.version.version }}/load-based-splitting.md %}) - [Network Latency Page]({% link {{ page.version.version }}/ui-network-latency-page.md %}) -- [Enterprise Features]({% link {{ page.version.version }}/enterprise-licensing.md %}) diff --git a/src/current/v24.1/frequently-asked-questions.md b/src/current/v24.1/frequently-asked-questions.md index 4e9026c6980..f456d28f78e 100644 --- a/src/current/v24.1/frequently-asked-questions.md +++ b/src/current/v24.1/frequently-asked-questions.md @@ -39,7 +39,7 @@ There are four ways to use and deploy CockroachDB: - **CockroachDB {{ site.data.products.basic }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.basic }} provides highly available database clusters that scale instantly and automatically for small production and dev/test workloads. - **CockroachDB {{ site.data.products.standard }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.standard }} allows you to consolidate a variety of production workloads while optimizing cost. - **CockroachDB {{ site.data.products.advanced }}**: A single tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.advanced }} provides dedicated hardware to support stringent regulatory requirements and enhanced compliance, targeting production workloads with advanced Enterprise requirements. -- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment and require [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment. ## About the database diff --git a/src/current/v24.1/get-started-with-enterprise-trial.md b/src/current/v24.1/get-started-with-enterprise-trial.md index 79bab2847b3..7820a1bb3a3 100644 --- a/src/current/v24.1/get-started-with-enterprise-trial.md +++ b/src/current/v24.1/get-started-with-enterprise-trial.md @@ -6,7 +6,7 @@ license: true docs_area: --- -Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's core capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also our Enterprise-only features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). +Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). ## Install CockroachDB @@ -25,7 +25,7 @@ You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }} ## Use Enterprise features -Your cluster now has access to all of CockroachDB's Enterprise features for the length of the trial: +Your cluster now has access to all of CockroachDB's features for the length of the trial: {% include {{ page.version.version }}/misc/enterprise-features.md %} diff --git a/src/current/v24.1/learn-cockroachdb-sql.md b/src/current/v24.1/learn-cockroachdb-sql.md index 45c5a7ed8de..6b4fc2d82ac 100644 --- a/src/current/v24.1/learn-cockroachdb-sql.md +++ b/src/current/v24.1/learn-cockroachdb-sql.md @@ -356,4 +356,4 @@ When you no longer need a table, use [`DROP TABLE`]({% link {{ page.version.vers - Explore all [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}) - [Use the built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}) to execute statements from a shell or directly from the command line - [Install the client driver]({% link {{ page.version.version }}/install-client-drivers.md %}) for your preferred language and [build an app]({% link {{ page.version.version }}/example-apps.md %}) -- [Explore core CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance +- [Explore CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance diff --git a/src/current/v24.1/licensing-faqs.md b/src/current/v24.1/licensing-faqs.md index 20fae864383..4971b930de0 100644 --- a/src/current/v24.1/licensing-faqs.md +++ b/src/current/v24.1/licensing-faqs.md @@ -1,6 +1,6 @@ --- title: Licensing FAQs -summary: Frequently asked questions about CockroachDB Enterprise and core licensing. +summary: Frequently asked questions about CockroachDB Enterprise licensing. toc: true docs_area: get_started --- @@ -9,20 +9,7 @@ docs_area: get_started {% include common/license/evolving.md %} {{site.data.alerts.end}} -CockroachDB code is primarily licensed in two ways: - -- [Business Source License (BSL)](#bsl) -- [Cockroach Community License (CCL)](#ccl) - -CockroachDB core is free to use. Most [core features](#feature-licensing) are licensed under the BSL, but some core features are subject to the CCL or third-party licenses. - -Non-CCL core features from version 19.1 and earlier are licensed under [Apache 2.0](#apache); however, some features remain under third-party licenses. Beginning in version 19.2, these non-CCL features are licensed under the BSL for three years before [converting](#license-conversion-timeline) to the Apache 2.0 license. - -CockroachDB [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) require a [paid license](#obtain-a-license) from Cockroach and are licensed under the Cockroach Community License. - -{{site.data.alerts.callout_info}} -You can find any feature's license by checking the code's file header in the [CockroachDB repository](https://github.com/cockroachdb/cockroach). -{{site.data.alerts.end}} +CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). ## Types of licenses diff --git a/src/current/v24.1/manage-a-backup-schedule.md b/src/current/v24.1/manage-a-backup-schedule.md index fd6590c08ec..9667aad28ba 100644 --- a/src/current/v24.1/manage-a-backup-schedule.md +++ b/src/current/v24.1/manage-a-backup-schedule.md @@ -145,7 +145,7 @@ Or nest a [`SELECT` clause]({% link {{ page.version.version }}/select-clause.md > DROP SCHEDULES WITH x AS (SHOW SCHEDULES) SELECT id FROM x WHERE label = 'schedule_database'; ~~~~ -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 570e3615d41..0c0c10276c5 100644 --- a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -145,7 +145,7 @@ To start your CockroachDB cluster, you can either use our StatefulSet configurat ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md index 45bd838e61f..b8746775bdf 100644 --- a/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v24.1/orchestrate-a-local-cluster-with-kubernetes.md @@ -91,7 +91,7 @@ Choose a way to deploy and maintain the CockroachDB cluster: ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.1/partitioning.md b/src/current/v24.1/partitioning.md index 4adcde7b412..1399e2f6267 100644 --- a/src/current/v24.1/partitioning.md +++ b/src/current/v24.1/partitioning.md @@ -23,7 +23,6 @@ Table partitioning helps you reduce latency and cost: Table partitioning involves a combination of CockroachDB features: - [Node attributes](#node-attributes) -- [Enterprise license](#enterprise-license) - [Table creation](#table-creation) - [Replication zones](#replication-zones) @@ -37,24 +36,6 @@ To store partitions in specific locations (e.g., geo-partitioning), or on machin For more details about these flags, see the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) documentation. -### Enterprise license - -You must have a valid Enterprise license to use table partitioning features. For details about requesting and setting a trial or full Enterprise license, see [Enterprise Licensing]({% link {{ page.version.version }}/enterprise-licensing.md %}). - -The following features do not work with an **expired license**: - -- Creating new table partitions or adding new zone configurations for partitions -- Changing the partitioning scheme on any table or index -- Changing the zone config for a partition - -However, the following features continue to work even with an expired Enterprise license: - -- Querying a partitioned table (for example, `SELECT foo PARTITION`) -- Inserting or updating data in a partitioned table -- Dropping a partitioned table -- Unpartitioning a partitioned table -- Making non-partitioning changes to a partitioned table (for example, adding a column/index/foreign key/check constraint) - ### Table creation You can define partitions and subpartitions over one or more columns of a table. During [table creation]({% link {{ page.version.version }}/create-table.md %}), you declare which values belong to each partition in one of two ways: diff --git a/src/current/v24.1/physical-cluster-replication-overview.md b/src/current/v24.1/physical-cluster-replication-overview.md index 8a83417cfe9..729f142e4b7 100644 --- a/src/current/v24.1/physical-cluster-replication-overview.md +++ b/src/current/v24.1/physical-cluster-replication-overview.md @@ -117,7 +117,7 @@ To connect to a virtualized cluster using the SQL shell: ~~~ {{site.data.alerts.callout_info}} -PCR requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) on the primary and standby clusters. You must set {{ site.data.products.enterprise }} licenses from the system virtual cluster. +PCR requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on the primary and standby clusters. You must set {{ site.data.products.enterprise }} licenses from the system virtual cluster. {{site.data.alerts.end}} To connect to the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) and view the **Physical Cluster Replication** dashboard, the user must have the correct privileges. Refer to [Create a user for the standby cluster]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#create-a-user-for-the-standby-cluster). diff --git a/src/current/v24.1/restore.md b/src/current/v24.1/restore.md index 20074af2171..9f35d22c67a 100644 --- a/src/current/v24.1/restore.md +++ b/src/current/v24.1/restore.md @@ -180,7 +180,7 @@ Also, consider that: - When the cluster is in a mixed-version state during an [upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}), a full cluster restore will fail. To perform a full cluster restore, it is necessary to first [finalize the upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#step-3-decide-how-the-upgrade-will-be-finalized). {{site.data.alerts.callout_info}} -When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. +When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. {{site.data.alerts.end}} ### Databases diff --git a/src/current/v24.1/security-reference/encryption.md b/src/current/v24.1/security-reference/encryption.md index 011c7abf5da..6156b365f7b 100644 --- a/src/current/v24.1/security-reference/encryption.md +++ b/src/current/v24.1/security-reference/encryption.md @@ -32,7 +32,7 @@ When CMEK is enabled, the **Encryption** option appears to be disabled in the [D When selecting a deployment environment for a CockroachDB {{ site.data.products.core }} cluster, we recommend that you select a cloud provider such as Google Cloud Platform (GCP) or Amazon Web Services (AWS), which automatically provide industry-standard encryption for cloud storage resources. You can learn more about [GCP persistent disk encryption](https://cloud.google.com/compute/docs/disks#pd_encryption) or [AWS Elastic Block Storage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). -In addition, the [Encryption at Rest (Enterprise) feature]({% link {{ page.version.version }}/enterprise-licensing.md %}) provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. +In addition, the Encryption at Rest feature provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. Encryption is performed in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}) and configured per store. All files used by the store, regardless of contents, are encrypted with the desired algorithm. diff --git a/src/current/v24.1/security-reference/security-overview.md b/src/current/v24.1/security-reference/security-overview.md index 3523609c519..afc0bdda2f7 100644 --- a/src/current/v24.1/security-reference/security-overview.md +++ b/src/current/v24.1/security-reference/security-overview.md @@ -20,15 +20,11 @@ Learn more: [Integrate CockroachDB {{ site.data.products.advanced }} with Satori ### Self-Hosted -Cockroach Labs maintains CockroachDB as an open-source core, which is available to operate under a number of different licensing options, including several free options. - CockroachDB {{ site.data.products.core }} here refers to the situation of a user deploying and operating their own cluster. -{{ site.data.products.enterprise }} refers to an ongoing paid license relationship with Cockroach Labs. This license unlocks advanced features (see below). In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of the Cockroach Labs's {{ site.data.products.enterprise }} Support staff. +{{ site.data.products.enterprise }} refers to an ongoing license relationship with Cockroach Labs. In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of Cockroach Labs' {{ site.data.products.enterprise }} Support staff. -- See the [list of {{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}) -- Read the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [Contact our sales team](mailto:sales@cockroachlabs.com) for further questions about {{ site.data.products.enterprise }} +For more information, see the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) ## Comparison of security features @@ -39,7 +35,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user {{ site.data.products.basic }} {{ site.data.products.standard }} {{ site.data.products.advanced }} - {{ site.data.products.core }} {{ site.data.products.core }} {{ site.data.products.enterprise }} Feature @@ -51,7 +46,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Inter-node and node identity authentication using TLS 1.3 @@ -59,7 +53,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Client identity authentication using username/password @@ -67,7 +60,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SASL/SCRAM-SHA-256 secure password-based authentication @@ -75,7 +67,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user     ✓ - ✓ SQL client identity authentication using TLS 1.2/1.3 @@ -83,14 +74,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Web console authentication with third-party Single Sign-on (SSO) using OpenID Connect OIDC       -   ✓ Client identity authentication with GSSAPI and Kerberos @@ -98,7 +87,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ HTTP API access using login tokens @@ -106,7 +94,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ OCSP certificate revocation protocol @@ -116,7 +103,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Encryption in transit using TLS 1.3 @@ -124,7 +110,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for AWS clusters are encrypted at rest using AWS S3’s server-side encryption @@ -132,7 +117,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for GCP clusters are encrypted at rest using Google-managed server-side encryption keys @@ -140,14 +124,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Industry-standard encryption at rest is provided at the infrastructure level by your chosen deployment environment, such as Google Cloud Platform (GCP), Amazon Web Services (AWS), or Microsoft Azure. You can learn more about GCP persistent disk encryption, AWS Elastic Block Storage, or Azure managed disk encryption.       -   ✓ Cockroach Labs's proprietary storage-level {{ site.data.products.enterprise }} Encryption At Rest service implementing the Advanced Encryption Standard (AES) @@ -157,7 +139,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Users and privileges @@ -165,7 +146,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Role-based access control (RBAC) @@ -174,7 +154,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL-level configuration allowed authentication attempts by IP address @@ -182,7 +161,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Network-level Configuration of allowed IP addresses @@ -190,7 +168,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ GCP Private Service Connect (PSC) (Preview) or VPC Peering for GCP clusters and AWS PrivateLink for AWS clusters @@ -199,7 +176,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL Audit Logging @@ -208,7 +184,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ CockroachDB, as a distributed SQL database, is uniquely resilient by nature. A cluster can tolerate node failures as long as the majority of nodes remain functional. See Disaster Recovery. diff --git a/src/current/v24.1/set-up-physical-cluster-replication.md b/src/current/v24.1/set-up-physical-cluster-replication.md index 93decec2c01..cfc0b44a366 100644 --- a/src/current/v24.1/set-up-physical-cluster-replication.md +++ b/src/current/v24.1/set-up-physical-cluster-replication.md @@ -33,7 +33,7 @@ The high-level steps in this tutorial are: - To set up each cluster, you can follow [Deploy CockroachDB on Premises]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}). When you initialize the cluster with the [`cockroach init`]({% link {{ page.version.version }}/cockroach-init.md %}) command, you **must** pass the `--virtualized` or `--virtualized-empty` flag. Refer to the cluster creation steps for the [primary cluster](#initialize-the-primary-cluster) and for the [standby cluster](#initialize-the-standby-cluster) for details. - The [Deploy CockroachDB on Premises]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}) tutorial creates a self-signed certificate for each {{ site.data.products.core }} cluster. To create certificates signed by an external certificate authority, refer to [Create Security Certificates using OpenSSL]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}). - All nodes in each cluster will need access to the Certificate Authority for the other cluster. Refer to [Manage the cluster certificates](#step-3-manage-the-cluster-certificates). -- An [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) on the primary **and** standby clusters. You must use the system virtual cluster on the primary and standby clusters to enable your {{ site.data.products.enterprise }} license. +- An [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on the primary **and** standby clusters. You must use the system virtual cluster on the primary and standby clusters to enable your {{ site.data.products.enterprise }} license. - The primary and standby clusters **must have the same [region topology]({% link {{ page.version.version }}/topology-patterns.md %})**. For example, replicating a multi-region primary cluster to a single-region standby cluster is not supported. Mismatching regions between a multi-region primary and standby cluster is also not supported. {{site.data.alerts.callout_info}} @@ -76,7 +76,7 @@ Connect to your primary cluster's system virtual cluster using [`cockroach sql`] You should only connect to the system virtual cluster for cluster administration. To work with databases, tables, or workloads, connect to a virtual cluster. {{site.data.alerts.end}} -1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to the cluster: +1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) to the cluster: {% include_cached copy-clipboard.html %} ~~~ sql @@ -210,7 +210,7 @@ Connect to your standby cluster's system virtual cluster using [`cockroach sql`] --certs-dir "certs" ~~~ -1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to the cluster: +1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) to the cluster: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v24.1/sql-statements.md b/src/current/v24.1/sql-statements.md index 68e942a4577..5a74658cb01 100644 --- a/src/current/v24.1/sql-statements.md +++ b/src/current/v24.1/sql-statements.md @@ -17,7 +17,7 @@ Statement | Usage [`ALTER DEFAULT PRIVILEGES`]({% link {{ page.version.version }}/alter-default-privileges.md %}) | Change the default [privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#privileges) for objects created by specific roles/users in the current database. [`ALTER FUNCTION`]({% link {{ page.version.version }}/alter-function.md %}) | Modify a [user-defined function]({% link {{ page.version.version }}/user-defined-functions.md %}). [`ALTER INDEX`]({% link {{ page.version.version }}/alter-index.md %}) | Apply a schema change to an index. -[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [`ALTER RANGE`]({% link {{ page.version.version }}/alter-range.md %}) | Configure the replication zone for a system range. [`ALTER SCHEMA`]({% link {{ page.version.version }}/alter-schema.md %}) | Alter a user-defined schema. [`ALTER SEQUENCE`]({% link {{ page.version.version }}/alter-sequence.md %}) | Apply a schema change to a sequence. @@ -55,7 +55,7 @@ Statement | Usage [`SHOW FULL TABLE SCANS`]({% link {{ page.version.version }}/show-full-table-scans.md %}) | List recent queries that used a full table scan. [`SHOW INDEX`]({% link {{ page.version.version }}/show-index.md %}) | View index information for a table or database. [`SHOW LOCALITY`]({% link {{ page.version.version }}/show-locality.md %}) | View the locality of the current node. -[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [`SHOW REGIONS`]({% link {{ page.version.version }}/show-regions.md %}) | List the [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) or [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SUPER REGIONS`]({% link {{ page.version.version }}/show-super-regions.md %}) | List the [super regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) associated with a database in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SCHEMAS`]({% link {{ page.version.version }}/show-schemas.md %}) | List the schemas in a database. @@ -172,13 +172,13 @@ Statement | Usage [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) | Create disaster recovery backups of clusters, databases, and tables. [`RESTORE`]({% link {{ page.version.version }}/restore.md %}) | Restore clusters, databases, and tables using your backups. [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}) | List the contents of a backup. -[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. Core users can only use backup scheduling for full backups of clusters, databases, or tables. To use the other backup features, you need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) | Modify an existing backup schedule. [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) | View information on backup schedules. [`PAUSE SCHEDULES`]({% link {{ page.version.version }}/pause-schedules.md %}) | Pause backup schedules. [`RESUME SCHEDULES`]({% link {{ page.version.version }}/resume-schedules.md %}) | Resume paused backup schedules. [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}) | Drop backup schedules. -[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. Adding new KMS encryption keys requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. ## Changefeed statements @@ -186,10 +186,10 @@ Statement | Usage Statement | Usage ----------|------------ -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). -[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}) | (Core) Create a new changefeed to stream row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. -[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Modify an existing changefeed. +[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | Modify an existing changefeed. ## External resource statements diff --git a/src/current/v24.1/sso-db-console.md b/src/current/v24.1/sso-db-console.md index d747c1f5005..1a57dc2cb47 100644 --- a/src/current/v24.1/sso-db-console.md +++ b/src/current/v24.1/sso-db-console.md @@ -27,7 +27,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **IdP:** You must have access to an OAuth 2.0 identity provider and client. The process of provisioning one with Google Cloud Platform is described on this page in the [Provision an OAuth client using Google Cloud Platform (GCP)](#provision-an-oauth-client-using-google-cloud-platform-gcp) section. - **CockroachDB cluster**: you must have access to one of the following: - - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). + - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). diff --git a/src/current/v24.1/sso-sql.md b/src/current/v24.1/sso-sql.md index 1fe80d1f0bb..c87effa6b37 100644 --- a/src/current/v24.1/sso-sql.md +++ b/src/current/v24.1/sso-sql.md @@ -14,7 +14,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.advanced }} clusters can provision their users with Java Web Tokens (JWTs) via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.enterprise }} and {{ site.data.products.advanced }} clusters. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). +Cluster single sign-on for the DB Console is supported on CockroachDB [{{ site.data.products.enterprise }}]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) and {{ site.data.products.advanced }} clusters. CockroachDB {{ site.data.products.standard }} and {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: diff --git a/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 4149f152ed9..ac5af110d65 100644 --- a/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v24.1/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -248,7 +248,7 @@ To create your changefeed, you'll prepare your CockroachDB cluster with the `mov cockroach sql --url {"CONNECTION STRING"} ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~sql diff --git a/src/current/v24.1/take-and-restore-encrypted-backups.md b/src/current/v24.1/take-and-restore-encrypted-backups.md index 96682769988..46fd37bba1b 100644 --- a/src/current/v24.1/take-and-restore-encrypted-backups.md +++ b/src/current/v24.1/take-and-restore-encrypted-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Encrypted [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take and restore encrypted backups in the following ways: - [Using AWS Key Management Service (KMS)](#aws-kms-uri-format) diff --git a/src/current/v24.1/take-and-restore-locality-aware-backups.md b/src/current/v24.1/take-and-restore-locality-aware-backups.md index 788903957d0..460af9597f9 100644 --- a/src/current/v24.1/take-and-restore-locality-aware-backups.md +++ b/src/current/v24.1/take-and-restore-locality-aware-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Locality-aware [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - Locality-aware backups allow you to partition and store backup data in a way that is optimized for locality. When you run a locality-aware backup, nodes write backup data to the [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}) bucket that is closest to the node locality configured at [node startup]({% link {{ page.version.version }}/cockroach-start.md %}). {{site.data.alerts.callout_danger}} diff --git a/src/current/v24.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md b/src/current/v24.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md index 9e00badc0d8..ae85761f4d4 100644 --- a/src/current/v24.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md +++ b/src/current/v24.1/take-backups-with-revision-history-and-restore-from-a-point-in-time.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -[`BACKUP`]({% link {{ page.version.version }}/backup.md %}) with revision history is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take backups with revision history and restore from a point-in-time. You can create full or incremental backups [with revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history): diff --git a/src/current/v24.1/take-full-and-incremental-backups.md b/src/current/v24.1/take-full-and-incremental-backups.md index 563e9d73085..89afa7d088f 100644 --- a/src/current/v24.1/take-full-and-incremental-backups.md +++ b/src/current/v24.1/take-full-and-incremental-backups.md @@ -88,8 +88,6 @@ In the examples on this page, `{collectionURI}` is a placeholder for the storage ## Full backups -Full backups are now available to both core and Enterprise users. - Full backups contain an un-replicated copy of your data and can always be used to restore your cluster. These files are roughly the size of your data and require greater resources to produce than incremental backups. You can take full backups as of a given timestamp. Optionally, you can include the available [revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) in the backup. In most cases, **it's recommended to take nightly full backups of your cluster**. A cluster backup allows you to do the following: @@ -98,7 +96,7 @@ In most cases, **it's recommended to take nightly full backups of your cluster** - Restore database(s) from the cluster - Restore a full cluster -[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes Enterprise license, the Enterprise license is also restored. +[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes Enterprise license, the Enterprise license is also restored. {% include {{ page.version.version }}/backups/file-size-setting.md %} @@ -149,10 +147,6 @@ To view the available backup subdirectories, use [`SHOW BACKUPS`]({% link {{ pag ## Incremental backups -{{site.data.alerts.callout_info}} -To take incremental backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - If your cluster grows too large for daily [full backups](#full-backups), you can take less frequent full backups (e.g., weekly) with daily incremental backups. Incremental backups are storage efficient and faster than full backups for larger clusters. If you are taking backups on a regular cadence, we recommend [creating a schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) for your backups. @@ -271,7 +265,7 @@ For details on cloud storage URLs, see [Use Cloud Storage]({% link {{ page.versi ### Scheduled backups -You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. To create a schedule that includes incremental backups, you must have an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. Include the `FULL BACKUP ALWAYS` clause for a schedule to take only full backups. For example, to create a schedule for taking full cluster backups: @@ -383,10 +377,6 @@ To create a table with `exclude_data_from_backup`, see [Create a table with data {% include {{ page.version.version }}/backups/advanced-examples-list.md %} -{{site.data.alerts.callout_info}} -To take incremental backups, backups with revision history, locality-aware backups, and encrypted backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## See also - [`BACKUP`][backup] diff --git a/src/current/v24.1/ui-cluster-overview-page.md b/src/current/v24.1/ui-cluster-overview-page.md index 28cc8e87ce6..33a7a00922f 100644 --- a/src/current/v24.1/ui-cluster-overview-page.md +++ b/src/current/v24.1/ui-cluster-overview-page.md @@ -12,7 +12,7 @@ The **Cluster Overview** page of the DB Console displays key metrics about your - Uptime - Hardware usage -If you have an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), you can enable the [Node Map](#node-map-enterprise) view for a visual representation of your cluster's geographic layout. +Enable the [Node Map](#node-map) view for a visual representation of your cluster's geographic layout. ## Cluster Overview panel @@ -28,7 +28,7 @@ Replication Status |
                                                                        • The total number ### Capacity metrics -The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map-enterprise) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. +The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. Usable disk space is constrained by the following: @@ -50,7 +50,7 @@ If a node is currently unavailable, the last-known capacity usage will be shown, The **Node List** groups nodes by locality. The lowest-level locality tier is used to organize the Node List. Hover over a locality to see all localities for the group of nodes. {{site.data.alerts.callout_success}} -We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map-enterprise). +We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map). {{site.data.alerts.end}} ### Node status @@ -104,9 +104,9 @@ You can see the full history of decommissioned nodes by clicking **View all deco For details about the decommissioning process, see [Node Shutdown](node-shutdown.html?filters=decommission#node-shutdown-sequence). {{site.data.alerts.end}} -## Node Map (Enterprise) +## Node Map -The **Node Map** is an [enterprise]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature that visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. +The **Node Map** visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. For guidance on enabling and configuring the node map, see [Enable the Node Map]({% link {{ page.version.version }}/enable-node-map.md %}). diff --git a/src/current/v24.1/ui-overview.md b/src/current/v24.1/ui-overview.md index 1930147952c..5ee81fe9fc3 100644 --- a/src/current/v24.1/ui-overview.md +++ b/src/current/v24.1/ui-overview.md @@ -16,7 +16,7 @@ Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console ## Authentication -The DB Console supports username/password login, as well single sign-on (SSO) ({{ site.data.products.dedicated }} and {{ site.data.products.core }} {{ site.data.products.enterprise }} clusters only). +The DB Console supports username/password login and single sign-on (SSO) for {{ site.data.products.advanced }} and {{ site.data.products.enterprise }} clusters. The DB Console sign-on page can also be used to provision authentication tokens for SQL client access. @@ -32,8 +32,8 @@ Refer to: The Overview page provides a cluster overview and node list and map. - [Cluster Overview]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}) has essential metrics about the cluster and nodes, including liveness status, replication status, uptime, and hardware usage. -- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) has a list of cluster metrics at the locality and node levels. -- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. +- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) has a list of cluster metrics at the locality and node levels. +- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. ### Metrics diff --git a/src/current/v24.2/alter-backup-schedule.md b/src/current/v24.2/alter-backup-schedule.md index ccebab197ea..1c573a4f0e6 100644 --- a/src/current/v24.2/alter-backup-schedule.md +++ b/src/current/v24.2/alter-backup-schedule.md @@ -5,12 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - The `ALTER BACKUP SCHEDULE` statement modifies an existing [backup schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). You can use `ALTER BACKUP SCHEDULE` to do the following: - Set a different name for a backup schedule. diff --git a/src/current/v24.2/alter-database.md b/src/current/v24.2/alter-database.md index 635984ca4f0..673c64296f3 100644 --- a/src/current/v24.2/alter-database.md +++ b/src/current/v24.2/alter-database.md @@ -33,21 +33,21 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description -----------|------------ -[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`ALTER LOCALITY`](#alter-locality) | Persistently modify the configuration generated by the standard [multi-region SQL abstractions]({% link {{ page.version.version }}/multiregion-overview.md %}) on a per-region basis. For advanced users who want to customize their multi-region setup using [Zone Config Extensions]({% link {{ page.version.version }}/zone-config-extensions.md %}), a persistent, composable alternative to low-level [zone configs]({% link {{ page.version.version }}/configure-replication-zones.md %}). -[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. [`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for a database. -[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). [`OWNER TO`](#owner-to) | Change the owner of a database. [`PLACEMENT`](#placement) | Configure the replica placement policy for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). [`RENAME TO`](#rename-to) | Change the name of a database. [`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). [`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}). -[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) -[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). +[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. [`SURVIVE {ZONE,REGION} FAILURE`](#survive-zone-region-failure) | Add a survival goal to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ### `ADD REGION` @@ -282,7 +282,7 @@ For usage, see [Synopsis](#synopsis). ### `PLACEMENT` -`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. +`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities. `ALTER DATABASE ... PLACEMENT RESTRICTED` constrains the voting and non-voting replica placement for the database's tables to the [home regions]({% link {{ page.version.version }}/alter-table.md %}#crdb_region) associated with those tables. This is a way of opting out of [non-voting replicas]({% link {{ page.version.version }}/architecture/replication-layer.md %}#non-voting-replicas) for [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) to accomplish one or more of the following goals: @@ -783,7 +783,7 @@ ALTER DATABASE movr ADD REGION "europe-west1"; #### Override specific fields of a schema object's zone configs -In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. +In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field. Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences`. diff --git a/src/current/v24.2/alter-index.md b/src/current/v24.2/alter-index.md index 4b0bd12e0fb..63cfd3fe34b 100644 --- a/src/current/v24.2/alter-index.md +++ b/src/current/v24.2/alter-index.md @@ -35,8 +35,8 @@ Additional parameters are documented for the respective [subcommands](#subcomman Subcommand | Description | -----------|-------------| -[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) +[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. | +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. [`RENAME TO`](#rename-to) | Change the name of an index. [`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the index. [`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the index. diff --git a/src/current/v24.2/alter-table.md b/src/current/v24.2/alter-table.md index 21ee3d85292..90bda6651af 100644 --- a/src/current/v24.2/alter-table.md +++ b/src/current/v24.2/alter-table.md @@ -54,7 +54,7 @@ Subcommand | Description | Can combine with other subcommands? [`DROP CONSTRAINT`](#drop-constraint) | Remove constraints from columns. | Yes [`EXPERIMENTAL_AUDIT`](#experimental_audit) | Enable per-table audit logs, for security purposes. | Yes [`OWNER TO`](#owner-to) | Change the owner of the table. | No -[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | Yes +[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. | Yes [`RENAME COLUMN`](#rename-column) | Change the names of columns. | Yes [`RENAME CONSTRAINT`](#rename-constraint) | Change constraints columns. | Yes [`RENAME TO`](#rename-to) | Change the names of tables. | No diff --git a/src/current/v24.2/authentication.md b/src/current/v24.2/authentication.md index f2d16478568..96aed954bb8 100644 --- a/src/current/v24.2/authentication.md +++ b/src/current/v24.2/authentication.md @@ -105,9 +105,9 @@ CockroachDB offers the following methods for client authentication: Enter password: ~~~ -- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}). -- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}). ### Using `cockroach cert` or `openssl` commands diff --git a/src/current/v24.2/backup-and-restore-overview.md b/src/current/v24.2/backup-and-restore-overview.md index d9d6f92e1a5..139cb1269cd 100644 --- a/src/current/v24.2/backup-and-restore-overview.md +++ b/src/current/v24.2/backup-and-restore-overview.md @@ -25,7 +25,6 @@ This table outlines the level of product support for backup and restore features Backup / Restore Description - Self-hosted support @@ -34,88 +33,48 @@ This table outlines the level of product support for backup and restore features Full backup An un-replicated copy of your cluster, database, or table's data. A full backup is the base for any further backups. - -
                                                                            -
                                                                          • Enterprise license not required
                                                                            • -
                                                                          - Incremental backup A copy of the changes in your data since the specified base backup (either a full backup or a full backup plus an incremental backup). - - - Scheduled backup A schedule for periodic backups. - - - Backups with revision history A backup with revision history allows you to back up every change made within the garbage collection period leading up to and including the given timestamp. - - - Point-in-time restore A restore from an arbitrary point in time within the revision history of a backup. - - - Encrypted backup and restore An encrypted backup using a KMS or passphrase. - - - Locality-aware backup and restore A backup where each node writes files to the backup destination that matches the node locality configured at node startup. - - - Locality-restricted backup execution A backup with the EXECUTION LOCALITY option restricts the nodes that can execute a backup job with a defined locality filter. - - - diff --git a/src/current/v24.2/backup-validation.md b/src/current/v24.2/backup-validation.md index 3c29767e7f3..a4f00b7754a 100644 --- a/src/current/v24.2/backup-validation.md +++ b/src/current/v24.2/backup-validation.md @@ -15,10 +15,6 @@ You can validate a backup of a [cluster]({% link {{ page.version.version }}/back The options that give the most validation coverage will increase the runtime of the check. That is, `verify_backup_table_data` will take a longer time to validate a backup compared to `check_files` or `schema_only` alone. Despite that, each of these validation options provide a quicker way to validate a backup over running a "regular" restore. -{{site.data.alerts.callout_info}} -You do **not** need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to run any of the backup validation tools described on this page. -{{site.data.alerts.end}} - ## Recommendations Cockroach Labs recommends implementing the following validation plan to test your backups: diff --git a/src/current/v24.2/backup.md b/src/current/v24.2/backup.md index e27e9999689..b5b6f8cceef 100644 --- a/src/current/v24.2/backup.md +++ b/src/current/v24.2/backup.md @@ -32,8 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ## Considerations -- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.advanced }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/managed-backups.md %}). -- [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored. +- [Full cluster backups](#back-up-a-cluster) include [license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes a license, the license is also restored. - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone). - You cannot restore a backup of a multi-region database into a single-region database. - Exclude a table's row data from a backup using the [`exclude_data_from_backup`]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#exclude-a-tables-data-from-backups) parameter. diff --git a/src/current/v24.2/certificate-based-authentication-using-the-x509-subject-field.md b/src/current/v24.2/certificate-based-authentication-using-the-x509-subject-field.md index 03747db7ac8..511eb63d599 100644 --- a/src/current/v24.2/certificate-based-authentication-using-the-x509-subject-field.md +++ b/src/current/v24.2/certificate-based-authentication-using-the-x509-subject-field.md @@ -89,7 +89,7 @@ ERROR: role "root" cannot have a SUBJECT%!(EXTRA string=use the --%s CLI flag to SQLSTATE: 22023 ~~~ -If you do not have an [enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), the following error is signaled: +If you do not have an [enterprise license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses), the following error is signaled: {% include_cached copy-clipboard.html %} ~~~ diff --git a/src/current/v24.2/changefeed-examples.md b/src/current/v24.2/changefeed-examples.md index 8edd12354eb..35a4528539c 100644 --- a/src/current/v24.2/changefeed-examples.md +++ b/src/current/v24.2/changefeed-examples.md @@ -39,13 +39,9 @@ Before you run the examples, verify that you have the `CHANGEFEED` privilege in ## Create a changefeed connected to Kafka -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -184,13 +180,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to Kafka using Avro -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed-using-avro). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink and emits [Avro](https://avro.apache.org/docs/1.8.2/spec.html) records. The changefeed will watch two tables. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -491,13 +483,9 @@ You'll need access to a [Google Cloud Project](https://cloud.google.com/resource ## Create a changefeed connected to a cloud storage sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to an AWS S3 sink. The changefeed watches two tables. Note that you can set up changefeeds for any of [these cloud storage providers]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink). -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -613,13 +601,9 @@ In this example, you'll set up a changefeed for a single-node cluster that is co ## Create a changefeed connected to a webhook sink -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example](#create-a-core-changefeed). -{{site.data.alerts.end}} - In this example, you'll set up a changefeed for a single-node cluster that is connected to a local HTTP server via a webhook. For this example, you'll use an [example HTTP server](https://github.com/cockroachlabs/cdc-webhook-sink-test-server/tree/master/go-https-server) to test out the webhook sink. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: diff --git a/src/current/v24.2/changefeed-for.md b/src/current/v24.2/changefeed-for.md index 569c8bb2e26..3db74ac6e1d 100644 --- a/src/current/v24.2/changefeed-for.md +++ b/src/current/v24.2/changefeed-for.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`EXPERIMENTAL CHANGEFEED FOR` is the core implementation of changefeeds. For the [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) version, see [`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}). -{{site.data.alerts.end}} - The `EXPERIMENTAL CHANGEFEED FOR` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new core changefeed, which streams row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. A core changefeed can watch one table or multiple tables in a comma-separated list. For more information, see [Change Data Capture Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}). diff --git a/src/current/v24.2/changefeeds-on-tables-with-column-families.md b/src/current/v24.2/changefeeds-on-tables-with-column-families.md index 91e115557fe..069242510ae 100644 --- a/src/current/v24.2/changefeeds-on-tables-with-column-families.md +++ b/src/current/v24.2/changefeeds-on-tables-with-column-families.md @@ -94,13 +94,9 @@ For examples of starting changefeeds on tables with column families, see the fol ## Create a changefeed on a table with column families -{{site.data.alerts.callout_info}} -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) is an [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the Core version, see [the `CHANGEFEED FOR` example]({% link {{ page.version.version }}/changefeeds-on-tables-with-column-families.md %}?filters=core#create-a-core-changefeed-on-a-table-with-column-families). -{{site.data.alerts.end}} - In this example, you'll set up changefeeds on two tables that have [column families]({% link {{ page.version.version }}/column-families.md %}). You'll use a single-node cluster sending changes to a webhook sink for this example, but you can use any [changefeed sink]({% link {{ page.version.version }}/changefeed-sinks.md %}) to work with tables that include column families. -1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -116,7 +112,7 @@ In this example, you'll set up changefeeds on two tables that have [column famil cockroach sql --insecure ~~~ -1. Set your organization and [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization and license key: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v24.2/cockroach-start-single-node.md b/src/current/v24.2/cockroach-start-single-node.md index 21d1ba322d6..4104b847b79 100644 --- a/src/current/v24.2/cockroach-start-single-node.md +++ b/src/current/v24.2/cockroach-start-single-node.md @@ -69,7 +69,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                          Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                          **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                          **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                          This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                          Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                          This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). ### Store diff --git a/src/current/v24.2/cockroach-start.md b/src/current/v24.2/cockroach-start.md index ea0d9a11c19..1473f38157d 100644 --- a/src/current/v24.2/cockroach-start.md +++ b/src/current/v24.2/cockroach-start.md @@ -102,7 +102,7 @@ Flag | Description `--insecure` | **Note:** The `--insecure` flag is intended for **non-production testing only**.

                                                                          Run in insecure mode, skipping all TLS encryption and authentication. If this flag is not set, the `--certs-dir` flag must point to valid certificates.

                                                                          **Note the following risks:** An insecure cluster is open to any client that can access any node's IP addresses; client connections must also be made insecurely; any user, even `root`, can log in without providing a password; any user, connecting as `root`, can read or write any data in your cluster; there is no network encryption or authentication, and thus no confidentiality.

                                                                          **Default:** `false` `--accept-sql-without-tls` | This flag (in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %})) allows you to connect to the cluster using a SQL user's password without [validating the client's certificate]({% link {{ page.version.version }}/authentication.md %}#client-authentication). When connecting using the built-in SQL client, [use the `--insecure` flag with the `cockroach sql` command]({% link {{ page.version.version }}/cockroach-sql.md %}#client-connection). `--cert-principal-map` | A comma-separated list of `cert-principal:db-principal` mappings used to map the certificate principals to IP addresses, DNS names, and SQL users. This allows the use of certificates generated by Certificate Authorities that place restrictions on the contents of the `commonName` field. For usage information, see [Create Security Certificates using Openssl]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}#examples). -`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                          This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}).

                                                                          Note that this is an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`--enterprise-encryption` | This optional flag specifies the encryption options for one of the stores on the node. If multiple stores exist, the flag must be specified for each store.

                                                                          This flag takes a number of options. For a complete list of options, and usage instructions, see [Encryption at Rest]({% link {{ page.version.version }}/encryption.md %}). `--external-io-disable-http` | This optional flag disables external HTTP(S) access (as well as custom HTTP(S) endpoints) when performing bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %})). This can be used in environments where you cannot run a full proxy server.

                                                                          If you want to run a proxy server, you can start CockroachDB while specifying the `HTTP(S)_PROXY` environment variable. `--external-io-disable-implicit-credentials` | This optional flag disables the use of implicit credentials when accessing external cloud storage services for bulk operations (e.g, [`BACKUP`]({% link {{ page.version.version }}/backup.md %})). `--node-cert-distinguished-name` | A string with a comma separated list of distinguished name (DN) mappings in `{attribute-type}={attribute-value}` format in accordance with [RFC4514](https://www.rfc-editor.org/rfc/rfc4514) for the [`node` user]({% link {{ page.version.version }}/security-reference/authorization.md %}#node-user). If this flag is set, this needs to be an exact match with the DN subject in the client certificate provided for the `node` user. By exact match, we mean that the order of attributes in the argument to this flag must match the order of attributes in the DN subject in the certificate. For more information, see [Certificate-based authentication using multiple values from the X.509 Subject field]({% link {{ page.version.version }}/certificate-based-authentication-using-the-x509-subject-field.md %}). @@ -245,8 +245,6 @@ When WAL failover is enabled, CockroachDB will take the the following actions: {{site.data.alerts.callout_info}} {% include feature-phases/preview.md %} - -When this feature exits preview status and is generally available (GA), it will be an [Enterprise feature]({% link {{ page.version.version }}/enterprise-licensing.md %}). {{site.data.alerts.end}} ##### Enable WAL failover diff --git a/src/current/v24.2/column-level-encryption.md b/src/current/v24.2/column-level-encryption.md index e5fd1ce3904..354b55d053b 100644 --- a/src/current/v24.2/column-level-encryption.md +++ b/src/current/v24.2/column-level-encryption.md @@ -28,7 +28,7 @@ For usage examples, see: - [Encrypt using the `encrypt` function](#encrypt-using-the-encrypt-function). - [Encrypt using the `encrypt_iv` function](#encrypt-using-the-encrypt_iv-function). -These functions require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). If you do not have an Enterprise license, you will see an error message like the following if you try to use them: +If you do not have a [license]({% link {{ page.version.version }}/licensing-faqs.md %}), you will see an error message like the following if you try to use them: ~~~ ERROR: encrypt(): use of this cryptographic function (https://www.cockroachlabs.com/docs/stable/functions-and-operators#cryptographic-functions) requires an enterprise license. see https://cockroachlabs.com/pricing for details on how to enable enterprise features @@ -47,7 +47,7 @@ For usage examples, see: - [Decrypt using the `decrypt` function](#decrypt-using-the-decrypt-function). - [Decrypt using the `decrypt_iv` function](#decrypt-using-the-decrypt_iv-function). -These functions require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). If you do not have an Enterprise license, you will see an error message like the following if you try to use them: +If you do not have a [license]({% link {{ page.version.version }}/licensing-faqs.md %}), you will see an error message like the following if you try to use them: ~~~ ERROR: decrypt(): use of this cryptographic function (https://www.cockroachlabs.com/docs/stable/functions-and-operators#cryptographic-functions) requires an enterprise license. see https://cockroachlabs.com/pricing for details on how to enable enterprise features diff --git a/src/current/v24.2/configure-replication-zones.md b/src/current/v24.2/configure-replication-zones.md index aeba9db689e..1a61cf26308 100644 --- a/src/current/v24.2/configure-replication-zones.md +++ b/src/current/v24.2/configure-replication-zones.md @@ -10,8 +10,8 @@ Replication zones give you the power to control what data goes where in your Coc - Databases - Tables -- Rows ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) -- Indexes ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) +- Rows +- Indexes - All data in the cluster, including internal system data ([via the default replication zone](#view-the-default-replication-zone)) For each of these objects you can control: @@ -37,7 +37,7 @@ When a cluster starts, there are two categories of replication zone: 1. Pre-configured replication zones that apply to internal system data. 1. A single default replication zone that applies to the rest of the cluster. -You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. Note that adding zones for rows and secondary indexes is [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can adjust these pre-configured zones as well as add zones for individual databases, tables, rows, and secondary indexes as needed. For example, you might rely on the [default zone](#view-the-default-replication-zone) to spread most of a cluster's data across all of your availability zones, but [create a custom replication zone for a specific database](#create-a-replication-zone-for-a-database) to make sure its data is only stored in certain availability zones and/or geographies. @@ -50,8 +50,8 @@ Level | Description Cluster | CockroachDB comes with a pre-configured `default` replication zone that applies to all table data in the cluster not constrained by a database, table, or row-specific replication zone. This zone can be adjusted but not removed. See [View the Default Replication Zone](#view-the-default-replication-zone) and [Edit the Default Replication Zone](#edit-the-default-replication-zone) for more details. Database | You can add replication zones for specific databases. See [Create a Replication Zone for a Database](#create-a-replication-zone-for-a-database) for more details. Table | You can add replication zones for specific tables. See [Create a Replication Zone for a Table](#create-a-replication-zone-for-a-table). -Index ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. -Row ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %})) | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. +Index | The [secondary indexes]({% link {{ page.version.version }}/indexes.md %}) on a table will automatically use the replication zone for the table. However, with an Enterprise license, you can add distinct replication zones for secondary indexes. See [Create a Replication Zone for a Secondary Index](#create-a-replication-zone-for-a-secondary-index) for more details. +Row | You can add replication zones for specific rows in a table or secondary index by [defining table partitions]({% link {{ page.version.version }}/partitioning.md %}). See [Create a Replication Zone for a Table Partition](#create-a-replication-zone-for-a-partition) for more details. ### For system data diff --git a/src/current/v24.2/cost-based-optimizer.md b/src/current/v24.2/cost-based-optimizer.md index 6467f86a6a9..5e5b9bc4571 100644 --- a/src/current/v24.2/cost-based-optimizer.md +++ b/src/current/v24.2/cost-based-optimizer.md @@ -302,7 +302,7 @@ The following types of plans can be cached: - *Custom* query plans are generated for a given query structure and optimized for specific placeholder values, and are re-optimized on subsequent executions. By default, the optimizer uses custom plans. - {% include_cached new-in.html version="v24.2" %} *Generic* query plans are generated and optimized once without considering specific placeholder values, and are **not** regenerated on subsequent executions, unless the plan becomes stale due to [schema changes]({% link {{ page.version.version }}/online-schema-changes.md %}) or new [table statistics](#table-statistics) and must be re-optimized. This approach eliminates most of the query latency attributed to planning. - Generic query plans require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). This feature is in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}) and is subject to change. + This feature is in [preview]({% link {{ page.version.version }}/cockroachdb-feature-availability.md %}) and is subject to change. {{site.data.alerts.callout_success}} Generic query plans will only benefit workloads that use prepared statements, which are issued via explicit `PREPARE` statements or by client libraries using the [PostgreSQL extended wire protocol](https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-EXT-QUERY). Generic query plans are most beneficial for queries with high planning times, such as queries with many [joins]({% link {{ page.version.version }}/joins.md %}). For more information on reducing planning time for such queries, refer to [Reduce planning time for queries with many joins](#reduce-planning-time-for-queries-with-many-joins). diff --git a/src/current/v24.2/create-changefeed.md b/src/current/v24.2/create-changefeed.md index 728799c45df..ea240456986 100644 --- a/src/current/v24.2/create-changefeed.md +++ b/src/current/v24.2/create-changefeed.md @@ -5,10 +5,6 @@ toc: true docs_area: reference.sql --- -{{site.data.alerts.callout_info}} -`CREATE CHANGEFEED` is an [{{ site.data.products.enterprise }}-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. For the core version, see [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}). -{{site.data.alerts.end}} - The `CREATE CHANGEFEED` [statement]({% link {{ page.version.version }}/sql-statements.md %}) creates a new {{ site.data.products.enterprise }} changefeed, which targets an allowlist of tables called "watched rows". Every change to a watched row is emitted as a record in a configurable format (`JSON` or Avro) to a configurable sink ([Kafka](https://kafka.apache.org/), [Google Cloud Pub/Sub](https://cloud.google.com/pubsub), a [cloud storage sink]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink), or a [webhook sink]({% link {{ page.version.version }}/changefeed-sinks.md %}#webhook-sink)). You can [create](#examples), [pause](#pause-a-changefeed), [resume](#resume-a-paused-changefeed), [alter]({% link {{ page.version.version }}/alter-changefeed.md %}), or [cancel](#cancel-a-changefeed) an {{ site.data.products.enterprise }} changefeed. To get started with changefeeds, refer to the [Create and Configure Changefeeds]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}) page for important usage considerations. For detail on how changefeeds emit messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page. diff --git a/src/current/v24.2/create-index.md b/src/current/v24.2/create-index.md index 1818314ac31..02b37679901 100644 --- a/src/current/v24.2/create-index.md +++ b/src/current/v24.2/create-index.md @@ -51,7 +51,7 @@ Parameter | Description `name` | The name of the column you want to index. For [multi-region tables]({% link {{ page.version.version }}/multiregion-overview.md %}#table-localities), you can use the `crdb_region` column within the index in the event the original index may contain non-unique entries across multiple, unique regions. `ASC` or `DESC`| Sort the column in ascending (`ASC`) or descending (`DESC`) order in the index. How columns are sorted affects query results, particularly when using `LIMIT`.

                                                                          __Default:__ `ASC` `STORING ...`| Store (but do not sort) each column whose name you include.

                                                                          For information on when to use `STORING`, see [Store Columns](#store-columns). Note that columns that are part of a table's [`PRIMARY KEY`]({% link {{ page.version.version }}/primary-key.md %}) cannot be specified as `STORING` columns in secondary indexes on the table.

                                                                          `COVERING` and `INCLUDE` are aliases for `STORING` and work identically. -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. +`opt_partition_by` | An option that lets you [define index partitions at the row level]({% link {{ page.version.version }}/partitioning.md %}). As of CockroachDB v21.1 and later, most users should use [`REGIONAL BY ROW` tables]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables). Indexes against regional by row tables are automatically partitioned, so explicit index partitioning is not required. `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE`, `NOT VISIBLE`, or `VISIBILITY` clause that indicates that an [index is visible, not visible, or partially visible to the cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If not visible, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For examples, see [Set index visibility]({% link {{ page.version.version }}/alter-index.md %}#set-index-visibility).

                                                                          Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations](alter-index.html#not-visible). `USING HASH` | Creates a [hash-sharded index]({% link {{ page.version.version }}/hash-sharded-indexes.md %}). diff --git a/src/current/v24.2/create-schedule-for-backup.md b/src/current/v24.2/create-schedule-for-backup.md index a72ad8e90f6..b78f5170f9c 100644 --- a/src/current/v24.2/create-schedule-for-backup.md +++ b/src/current/v24.2/create-schedule-for-backup.md @@ -9,12 +9,6 @@ docs_area: reference.sql For more information about creating, managing, monitoring, and restoring from a scheduled backup, see [Manage a Backup Schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). -{{site.data.alerts.callout_info}} -Core users can only use backup scheduling for [full backups](#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups. - -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## Required privileges {% include {{ page.version.version }}/backups/updated-backup-privileges.md %} @@ -59,7 +53,7 @@ Targets: `location` | The URI where you want to store the backup. The backup files will be stored in year > month > day subdirectories. The location can be [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}), or `nodelocal`.

                                                                          Note: If you want to schedule a backup using temporary credentials, we recommend that you use `implicit` authentication; otherwise, you'll need to drop and then recreate schedules each time you need to update the credentials. `backup_options` | Control the backup behavior with a comma-separated list of [options](#backup-options). `RECURRING crontab` | Specifies when the backup should be taken. A separate schedule may be created automatically to write full backups at a regular cadence, depending on the frequency of the incremental backups. You can likewise modify this separate schedule with [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}). The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron). All times in UTC.

                                                                          Example: `'@daily'` (run daily at midnight) -`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                          If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                          **Note:** If you do not have an Enterprise license then you can only take full backups. `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                          If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                          • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                          • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                          • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                          +`FULL BACKUP crontab` | Specifies when to take a new full backup. The schedule is specified as a [`STRING`]({% link {{ page.version.version }}/string.md %}) in [crontab format](https://wikipedia.org/wiki/Cron) or as `ALWAYS`.

                                                                          If `FULL BACKUP ALWAYS` is specified, then the backups triggered by the `RECURRING` clause will always be full backups.
                                                                          `ALWAYS` is the only accepted value of `FULL BACKUP`.

                                                                          If the `FULL BACKUP` clause is omitted, CockroachDB will default to the following full backup schedule:
                                                                          • `RECURRING` <= 1 hour: Default to `FULL BACKUP '@daily'`
                                                                          • `RECURRING` <= 1 day: Default to `FULL BACKUP '@weekly'`
                                                                          • Otherwise: Default to `FULL BACKUP ALWAYS`
                                                                          `WITH SCHEDULE OPTIONS schedule_option` | Control the schedule behavior with a comma-separated list of [these options](#schedule-options). {{site.data.alerts.callout_info}} @@ -126,9 +120,9 @@ You can also visit the [**Jobs** page]({% link {{ page.version.version }}/ui-job ## Examples -### Create a schedule for full backups only (core) +### Create a schedule for full backups only -Core users can only use backup scheduling for full backups of clusters, databases, or tables. Full backups are taken with the `FULL BACKUP ALWAYS` clause, for example: +To schedule full backups of clusters, databases, or tables, use the `FULL BACKUP ALWAYS` clause, for example: {% include_cached copy-clipboard.html %} ~~~ sql @@ -145,8 +139,6 @@ Core users can only use backup scheduling for full backups of clusters, database (1 row) ~~~ -To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - ### Create a scheduled backup for a cluster This example creates a schedule for a cluster backup with revision history that's taken every day at midnight: diff --git a/src/current/v24.2/create-table.md b/src/current/v24.2/create-table.md index 88c4883d59e..d1a4c389267 100644 --- a/src/current/v24.2/create-table.md +++ b/src/current/v24.2/create-table.md @@ -106,8 +106,8 @@ Parameter | Description `family_def` | An optional, comma-separated list of [column family definitions]({% link {{ page.version.version }}/column-families.md %}). Column family names must be unique within the table but can have the same name as columns, constraints, or indexes.

                                                                          A column family is a group of columns that are stored as a single key-value pair in the underlying key-value store. CockroachDB automatically groups columns into families to ensure efficient storage and performance. However, there are cases when you may want to manually assign columns to families. For more details, see [Column Families]({% link {{ page.version.version }}/column-families.md %}). `table_constraint` | An optional, comma-separated list of [table-level constraints]({% link {{ page.version.version }}/constraints.md %}). Constraint names must be unique within the table but can have the same name as columns, column families, or indexes. `LIKE table_name like_table_option_list` | Create a new table based on the schema of an existing table, using supported specifiers. For details, see [Create a table like an existing table](#create-a-table-like-an-existing-table). For examples, see [Create a new table from an existing one](#create-a-new-table-from-an-existing-one). -`opt_partition_by` | An [Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. -`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).

                                                                          Note that multi-region features require an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +`opt_partition_by` | An option that lets you define table partitions at the row level. You can define table partitions by list or by range. See [Define Table Partitions]({% link {{ page.version.version }}/partitioning.md %}) for more information. +`opt_locality` | Specify a [locality]({% link {{ page.version.version }}/multiregion-overview.md %}#table-locality) for the table. In order to set a locality, the table must belong to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). `opt_where_clause` | An optional `WHERE` clause that defines the predicate boolean expression of a [partial index]({% link {{ page.version.version }}/partial-indexes.md %}). `opt_index_visible` | An optional `VISIBLE` or `NOT VISIBLE` clause that indicates whether an index is visible to the [cost-based optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}#control-whether-the-optimizer-uses-an-index). If `NOT VISIBLE`, the index will not be used in queries unless it is specifically selected with an [index hint]({% link {{ page.version.version }}/indexes.md %}#selection) or the property is overridden with the [`optimizer_use_not_visible_indexes` session variable]({% link {{ page.version.version }}/set-vars.md %}#optimizer-use-not-visible-indexes). For an example, see [Set an index to be not visible]({% link {{ page.version.version }}/alter-index.md %}#set-an-index-to-be-not-visible).

                                                                          Indexes that are not visible are still used to enforce `UNIQUE` and `FOREIGN KEY` [constraints]({% link {{ page.version.version }}/constraints.md %}). For more considerations, see [Index visibility considerations]({% link {{ page.version.version }}/alter-index.md %}#not-visible). `opt_with_storage_parameter_list` | A comma-separated list of [spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). Supported parameters include `fillfactor`, `s2_max_level`, `s2_level_mod`, `s2_max_cells`, `geometry_min_x`, `geometry_max_x`, `geometry_min_y`, and `geometry_max_y`. The `fillfactor` parameter is a no-op, allowed for PostgreSQL-compatibility.

                                                                          For details, see [Spatial index tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#index-tuning-parameters). For an example, see [Create a spatial index that uses all of the tuning parameters]({% link {{ page.version.version }}/spatial-indexes.md %}#create-a-spatial-index-that-uses-all-of-the-tuning-parameters). diff --git a/src/current/v24.2/create-user.md b/src/current/v24.2/create-user.md index 3f2248cd8fd..e1d1982e0b4 100644 --- a/src/current/v24.2/create-user.md +++ b/src/current/v24.2/create-user.md @@ -58,7 +58,7 @@ Secure clusters require users to authenticate their access to databases and tabl Password creation is supported only in secure clusters. -- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- [GSSAPI authentication]({% link {{ page.version.version }}/gssapi_authentication.md %}). ## Examples diff --git a/src/current/v24.2/demo-automatic-cloud-migration.md b/src/current/v24.2/demo-automatic-cloud-migration.md index 2ebb007ed3c..c3003bd87e8 100644 --- a/src/current/v24.2/demo-automatic-cloud-migration.md +++ b/src/current/v24.2/demo-automatic-cloud-migration.md @@ -261,7 +261,7 @@ $ rm -rf cloud1node1 cloud1node2 cloud1node3 cloud2node4 cloud2node5 cloud2node6 ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.2/demo-json-support.md b/src/current/v24.2/demo-json-support.md index 7607143ebca..9678a98a162 100644 --- a/src/current/v24.2/demo-json-support.md +++ b/src/current/v24.2/demo-json-support.md @@ -284,7 +284,7 @@ $ rm -rf json-test ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.2/demo-replication-and-rebalancing.md b/src/current/v24.2/demo-replication-and-rebalancing.md index 40fee59a5a9..94ce2ac7d0b 100644 --- a/src/current/v24.2/demo-replication-and-rebalancing.md +++ b/src/current/v24.2/demo-replication-and-rebalancing.md @@ -303,6 +303,6 @@ At first, the replica count will be lower for nodes 4 and 5. Very soon, however, ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.2/demo-serializable.md b/src/current/v24.2/demo-serializable.md index 4f55f124730..f867f225b6a 100644 --- a/src/current/v24.2/demo-serializable.md +++ b/src/current/v24.2/demo-serializable.md @@ -538,7 +538,7 @@ When you repeat the scenario on CockroachDB, you'll see that the anomaly is prev ## What's next? -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.2/deploy-cockroachdb-on-aws.md b/src/current/v24.2/deploy-cockroachdb-on-aws.md index 8e7febed51d..2acc789f23a 100644 --- a/src/current/v24.2/deploy-cockroachdb-on-aws.md +++ b/src/current/v24.2/deploy-cockroachdb-on-aws.md @@ -18,7 +18,7 @@ If you are only testing CockroachDB, or you are not concerned with protecting ne {% include cockroachcloud/use-cockroachcloud-instead.md %} {{site.data.alerts.callout_info}} -If you need a license to use [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}), obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. +You need a license to use CockroachDB; obtain a private offer link on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-ph5bx6fhm4nlq) or see [CockroachDB Pricing](https://www.cockroachlabs.com/pricing/) to learn about custom pricing. {{site.data.alerts.end}} ## Before you begin diff --git a/src/current/v24.2/deploy-cockroachdb-with-kubernetes.md b/src/current/v24.2/deploy-cockroachdb-with-kubernetes.md index 57d63b734b2..2220b2f21f6 100644 --- a/src/current/v24.2/deploy-cockroachdb-with-kubernetes.md +++ b/src/current/v24.2/deploy-cockroachdb-with-kubernetes.md @@ -38,7 +38,7 @@ Choose how you want to deploy and maintain the CockroachDB cluster. {{site.data.alerts.callout_info}} The [CockroachDB Kubernetes Operator](https://github.com/cockroachdb/cockroach-operator) eases CockroachDB cluster creation and management on a single Kubernetes cluster. -The Operator does not provision or apply an Enterprise license key. To use [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. +The Operator does not provision or apply an Enterprise license key. To use CockroachDB with the Operator, [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) in the SQL shell. {{site.data.alerts.end}}
                                                                          diff --git a/src/current/v24.2/disaster-recovery-planning.md b/src/current/v24.2/disaster-recovery-planning.md index df10dfa37fd..ae6bdbc5f1b 100644 --- a/src/current/v24.2/disaster-recovery-planning.md +++ b/src/current/v24.2/disaster-recovery-planning.md @@ -308,15 +308,13 @@ If you are outside of the garbage collection window, you will need to use a [bac ### Restore to a point in time -- If you are a core user, use a [backup]({% link {{ page.version.version }}/backup.md %}) that was taken with [`AS OF SYSTEM TIME`]({% link {{ page.version.version }}/as-of-system-time.md %}) to restore to a specific point. -- If you are an {{ site.data.products.enterprise }} user, use your [backup]({% link {{ page.version.version }}/backup.md %}) file to [restore to a point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) where you are certain there was no corruption. Note that the backup must have been taken with [revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history). +- Use your [backup]({% link {{ page.version.version }}/backup.md %}) file to [restore to a point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) where you are certain there was no corruption. Note that the backup must have been taken with [revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history). ### Create a new backup If your cluster is running, you do not have a backup that encapsulates the time you want to [restore]({% link {{ page.version.version }}/restore.md %}) to, and the data you want to recover is still in the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds), there are two actions you can take: -- If you are a core user, trigger a [backup]({% link {{ page.version.version }}/backup.md %}) using [`AS OF SYSTEM TIME`]({% link {{ page.version.version }}/as-of-system-time.md %}) to create a new backup that encapsulates the specific time. The `AS OF SYSTEM TIME` must be within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). -- If you are an {{ site.data.products.enterprise }} user, trigger a new [backup `with_revision_history`]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) and you will have a backup you can use to restore to the desired point in time within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). +- Trigger a new [backup `with_revision_history`]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) and you will have a backup you can use to restore to the desired point in time within the [garbage collection window]({% link {{ page.version.version }}/configure-replication-zones.md %}#gc-ttlseconds). ### Recover from corrupted data in a database or table diff --git a/src/current/v24.2/drop-schedules.md b/src/current/v24.2/drop-schedules.md index 59de7e9f71b..532308045c6 100644 --- a/src/current/v24.2/drop-schedules.md +++ b/src/current/v24.2/drop-schedules.md @@ -7,7 +7,7 @@ docs_area: reference.sql The `DROP SCHEDULES` [statement]({% link {{ page.version.version }}/sql-statements.md %}) can be used to remove [backup schedules]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) or [changefeed schedules]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}). -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v24.2/enable-node-map.md b/src/current/v24.2/enable-node-map.md index 750938c5dcb..ba549aa29b6 100644 --- a/src/current/v24.2/enable-node-map.md +++ b/src/current/v24.2/enable-node-map.md @@ -107,7 +107,7 @@ The following page is displayed: ### Step 2. Set the Enterprise license and refresh the DB Console -After [setting the Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), the Node Map should now be displaying the highest-level localities you defined: +The Node Map should now be displaying the highest-level localities you defined: DB Console @@ -160,7 +160,6 @@ To navigate to Node 2, which is in datacenter `us-east-1a` in the `us-east-1` re ### Node Map not displayed -- The Node Map requires an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). - All nodes in the cluster must be assigned [localities]({% link {{ page.version.version }}/cockroach-start.md %}#locality). - Localities must be [assigned a corresponding latitude and longitude](#step-3-set-the-latitudes-and-longitudes-for-the-localities). diff --git a/src/current/v24.2/enterprise-licensing.md b/src/current/v24.2/enterprise-licensing.md index c23bcf7bd30..62e861e2b59 100644 --- a/src/current/v24.2/enterprise-licensing.md +++ b/src/current/v24.2/enterprise-licensing.md @@ -5,8 +5,6 @@ toc: true docs_area: --- -CockroachDB distributes a single binary that contains both core and Enterprise features. You can use core features without any license key. However, to use the Enterprise features, you need either a trial or an Enterprise license key. - This page lists Enterprise features. For information on how to obtain and set trial and Enterprise license keys for CockroachDB, see the [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). {{site.data.alerts.callout_info}} diff --git a/src/current/v24.2/follower-reads.md b/src/current/v24.2/follower-reads.md index ec35e46fe7c..6f9d0f0aac5 100644 --- a/src/current/v24.2/follower-reads.md +++ b/src/current/v24.2/follower-reads.md @@ -199,4 +199,3 @@ For further details, see [An Epic Read on Follower Reads](https://www.cockroachl - [Cluster Settings Overview]({% link {{ page.version.version }}/cluster-settings.md %}) - [Load-Based Splitting]({% link {{ page.version.version }}/load-based-splitting.md %}) - [Network Latency Page]({% link {{ page.version.version }}/ui-network-latency-page.md %}) -- [Enterprise Features]({% link {{ page.version.version }}/enterprise-licensing.md %}) diff --git a/src/current/v24.2/frequently-asked-questions.md b/src/current/v24.2/frequently-asked-questions.md index 4e9026c6980..f456d28f78e 100644 --- a/src/current/v24.2/frequently-asked-questions.md +++ b/src/current/v24.2/frequently-asked-questions.md @@ -39,7 +39,7 @@ There are four ways to use and deploy CockroachDB: - **CockroachDB {{ site.data.products.basic }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.basic }} provides highly available database clusters that scale instantly and automatically for small production and dev/test workloads. - **CockroachDB {{ site.data.products.standard }}**: A multi-tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.standard }} allows you to consolidate a variety of production workloads while optimizing cost. - **CockroachDB {{ site.data.products.advanced }}**: A single tenant CockroachDB deployment, managed by Cockroach Labs. CockroachDB {{ site.data.products.advanced }} provides dedicated hardware to support stringent regulatory requirements and enhanced compliance, targeting production workloads with advanced Enterprise requirements. -- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment and require [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}). +- **CockroachDB {{ site.data.products.core }}**: A self-managed CockroachDB deployment, backed by Cockroach Labs Support, for multiple clouds and regions. This deployment option is good if you require complete control over the database environment. ## About the database diff --git a/src/current/v24.2/get-started-with-enterprise-trial.md b/src/current/v24.2/get-started-with-enterprise-trial.md index 79bab2847b3..7820a1bb3a3 100644 --- a/src/current/v24.2/get-started-with-enterprise-trial.md +++ b/src/current/v24.2/get-started-with-enterprise-trial.md @@ -6,7 +6,7 @@ license: true docs_area: --- -Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's core capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also our Enterprise-only features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). +Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's capabilities like [high availability]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-does-cockroachdb-survive-failures) and [`SERIALIZABLE` isolation]({% link {{ page.version.version }}/frequently-asked-questions.md %}#how-is-cockroachdb-strongly-consistent), but also features like distributed [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) & [`RESTORE`]({% link {{ page.version.version }}/restore.md %}), [multi-region capabilities](multiregion-overview.html), and [cluster visualization](enable-node-map.html). ## Install CockroachDB @@ -25,7 +25,7 @@ You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }} ## Use Enterprise features -Your cluster now has access to all of CockroachDB's Enterprise features for the length of the trial: +Your cluster now has access to all of CockroachDB's features for the length of the trial: {% include {{ page.version.version }}/misc/enterprise-features.md %} diff --git a/src/current/v24.2/learn-cockroachdb-sql.md b/src/current/v24.2/learn-cockroachdb-sql.md index 45c5a7ed8de..6b4fc2d82ac 100644 --- a/src/current/v24.2/learn-cockroachdb-sql.md +++ b/src/current/v24.2/learn-cockroachdb-sql.md @@ -356,4 +356,4 @@ When you no longer need a table, use [`DROP TABLE`]({% link {{ page.version.vers - Explore all [SQL Statements]({% link {{ page.version.version }}/sql-statements.md %}) - [Use the built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}) to execute statements from a shell or directly from the command line - [Install the client driver]({% link {{ page.version.version }}/install-client-drivers.md %}) for your preferred language and [build an app]({% link {{ page.version.version }}/example-apps.md %}) -- [Explore core CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance +- [Explore CockroachDB features]({% link {{ page.version.version }}/demo-replication-and-rebalancing.md %}) like automatic replication, rebalancing, and fault tolerance diff --git a/src/current/v24.2/licensing-faqs.md b/src/current/v24.2/licensing-faqs.md index 20fae864383..4971b930de0 100644 --- a/src/current/v24.2/licensing-faqs.md +++ b/src/current/v24.2/licensing-faqs.md @@ -1,6 +1,6 @@ --- title: Licensing FAQs -summary: Frequently asked questions about CockroachDB Enterprise and core licensing. +summary: Frequently asked questions about CockroachDB Enterprise licensing. toc: true docs_area: get_started --- @@ -9,20 +9,7 @@ docs_area: get_started {% include common/license/evolving.md %} {{site.data.alerts.end}} -CockroachDB code is primarily licensed in two ways: - -- [Business Source License (BSL)](#bsl) -- [Cockroach Community License (CCL)](#ccl) - -CockroachDB core is free to use. Most [core features](#feature-licensing) are licensed under the BSL, but some core features are subject to the CCL or third-party licenses. - -Non-CCL core features from version 19.1 and earlier are licensed under [Apache 2.0](#apache); however, some features remain under third-party licenses. Beginning in version 19.2, these non-CCL features are licensed under the BSL for three years before [converting](#license-conversion-timeline) to the Apache 2.0 license. - -CockroachDB [Enterprise features]({% link {{ page.version.version }}/enterprise-licensing.md %}) require a [paid license](#obtain-a-license) from Cockroach and are licensed under the Cockroach Community License. - -{{site.data.alerts.callout_info}} -You can find any feature's license by checking the code's file header in the [CockroachDB repository](https://github.com/cockroachdb/cockroach). -{{site.data.alerts.end}} +CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). ## Types of licenses diff --git a/src/current/v24.2/manage-a-backup-schedule.md b/src/current/v24.2/manage-a-backup-schedule.md index fd6590c08ec..9667aad28ba 100644 --- a/src/current/v24.2/manage-a-backup-schedule.md +++ b/src/current/v24.2/manage-a-backup-schedule.md @@ -145,7 +145,7 @@ Or nest a [`SELECT` clause]({% link {{ page.version.version }}/select-clause.md > DROP SCHEDULES WITH x AS (SHOW SCHEDULES) SELECT id FROM x WHERE label = 'schedule_database'; ~~~~ -When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). +When `DROP SCHEDULES` removes a [full backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only), it removes the associated [incremental backup schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#incremental-backup-schedules), if it exists. For more information, see [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}). {{site.data.alerts.callout_danger}} `DROP SCHEDULE` does **not** cancel any in-progress jobs started by the schedule. Before you drop a schedule, [cancel any in-progress jobs]({% link {{ page.version.version }}/cancel-job.md %}) first, as you will not be able to look up the job ID once the schedule is dropped. diff --git a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md index 570e3615d41..0c0c10276c5 100644 --- a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md +++ b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes-insecure.md @@ -145,7 +145,7 @@ To start your CockroachDB cluster, you can either use our StatefulSet configurat ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md index 45bd838e61f..b8746775bdf 100644 --- a/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md +++ b/src/current/v24.2/orchestrate-a-local-cluster-with-kubernetes.md @@ -91,7 +91,7 @@ Choose a way to deploy and maintain the CockroachDB cluster: ## See also -Explore other core CockroachDB benefits and features: +Explore other CockroachDB benefits and features: {% include {{ page.version.version }}/misc/explore-benefits-see-also.md %} diff --git a/src/current/v24.2/partitioning.md b/src/current/v24.2/partitioning.md index 4adcde7b412..1399e2f6267 100644 --- a/src/current/v24.2/partitioning.md +++ b/src/current/v24.2/partitioning.md @@ -23,7 +23,6 @@ Table partitioning helps you reduce latency and cost: Table partitioning involves a combination of CockroachDB features: - [Node attributes](#node-attributes) -- [Enterprise license](#enterprise-license) - [Table creation](#table-creation) - [Replication zones](#replication-zones) @@ -37,24 +36,6 @@ To store partitions in specific locations (e.g., geo-partitioning), or on machin For more details about these flags, see the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) documentation. -### Enterprise license - -You must have a valid Enterprise license to use table partitioning features. For details about requesting and setting a trial or full Enterprise license, see [Enterprise Licensing]({% link {{ page.version.version }}/enterprise-licensing.md %}). - -The following features do not work with an **expired license**: - -- Creating new table partitions or adding new zone configurations for partitions -- Changing the partitioning scheme on any table or index -- Changing the zone config for a partition - -However, the following features continue to work even with an expired Enterprise license: - -- Querying a partitioned table (for example, `SELECT foo PARTITION`) -- Inserting or updating data in a partitioned table -- Dropping a partitioned table -- Unpartitioning a partitioned table -- Making non-partitioning changes to a partitioned table (for example, adding a column/index/foreign key/check constraint) - ### Table creation You can define partitions and subpartitions over one or more columns of a table. During [table creation]({% link {{ page.version.version }}/create-table.md %}), you declare which values belong to each partition in one of two ways: diff --git a/src/current/v24.2/physical-cluster-replication-overview.md b/src/current/v24.2/physical-cluster-replication-overview.md index 363f41b4cfe..d710c58e959 100644 --- a/src/current/v24.2/physical-cluster-replication-overview.md +++ b/src/current/v24.2/physical-cluster-replication-overview.md @@ -116,7 +116,7 @@ To connect to a virtualized cluster using the SQL shell: ~~~ {{site.data.alerts.callout_info}} -PCR requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) on the primary and standby clusters. You must set {{ site.data.products.enterprise }} licenses from the system virtual cluster. +PCR requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on the primary and standby clusters. You must set {{ site.data.products.enterprise }} licenses from the system virtual cluster. {{site.data.alerts.end}} To connect to the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) and view the **Physical Cluster Replication** dashboard, the user must have the correct privileges. Refer to [Create a user for the standby cluster]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#create-a-user-for-the-standby-cluster). diff --git a/src/current/v24.2/restore.md b/src/current/v24.2/restore.md index 20074af2171..9f35d22c67a 100644 --- a/src/current/v24.2/restore.md +++ b/src/current/v24.2/restore.md @@ -180,7 +180,7 @@ Also, consider that: - When the cluster is in a mixed-version state during an [upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}), a full cluster restore will fail. To perform a full cluster restore, it is necessary to first [finalize the upgrade]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#step-3-decide-how-the-upgrade-will-be-finalized). {{site.data.alerts.callout_info}} -When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. +When you restore a full cluster with an {{ site.data.products.enterprise }} license, it will restore the [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) of the cluster you are restoring from. If you want to use a different license in the new cluster, make sure to [update the license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license) **after** the restore is complete. {{site.data.alerts.end}} ### Databases diff --git a/src/current/v24.2/security-reference/encryption.md b/src/current/v24.2/security-reference/encryption.md index 011c7abf5da..6156b365f7b 100644 --- a/src/current/v24.2/security-reference/encryption.md +++ b/src/current/v24.2/security-reference/encryption.md @@ -32,7 +32,7 @@ When CMEK is enabled, the **Encryption** option appears to be disabled in the [D When selecting a deployment environment for a CockroachDB {{ site.data.products.core }} cluster, we recommend that you select a cloud provider such as Google Cloud Platform (GCP) or Amazon Web Services (AWS), which automatically provide industry-standard encryption for cloud storage resources. You can learn more about [GCP persistent disk encryption](https://cloud.google.com/compute/docs/disks#pd_encryption) or [AWS Elastic Block Storage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html). -In addition, the [Encryption at Rest (Enterprise) feature]({% link {{ page.version.version }}/enterprise-licensing.md %}) provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. +In addition, the Encryption at Rest feature provides transparent encryption of data on cluster disks. It allows encryption of all files on disk using [AES](https://wikipedia.org/wiki/Advanced_Encryption_Standard) in [counter mode](https://wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), with all key sizes allowed. Encryption is performed in the [storage layer]({% link {{ page.version.version }}/architecture/storage-layer.md %}) and configured per store. All files used by the store, regardless of contents, are encrypted with the desired algorithm. diff --git a/src/current/v24.2/security-reference/security-overview.md b/src/current/v24.2/security-reference/security-overview.md index 4d679e154dd..21a1fd2667a 100644 --- a/src/current/v24.2/security-reference/security-overview.md +++ b/src/current/v24.2/security-reference/security-overview.md @@ -20,15 +20,11 @@ Learn more: [Integrate CockroachDB {{ site.data.products.advanced }} with Satori ### Self-Hosted -Cockroach Labs maintains CockroachDB as an open-source core, which is available to operate under a number of different licensing options, including several free options. - CockroachDB {{ site.data.products.core }} here refers to the situation of a user deploying and operating their own cluster. -{{ site.data.products.enterprise }} refers to an ongoing paid license relationship with Cockroach Labs. This license unlocks advanced features (see below). In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of the Cockroach Labs's {{ site.data.products.enterprise }} Support staff. +{{ site.data.products.enterprise }} refers to an ongoing license relationship with Cockroach Labs. In this situation the customer maintains full control over their data, compute, and network resources while benefiting from the expertise of Cockroach Labs' {{ site.data.products.enterprise }} Support staff. -- See the [list of {{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}) -- Read the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [Contact our sales team](mailto:sales@cockroachlabs.com) for further questions about {{ site.data.products.enterprise }} +For more information, see the [licensing FAQ]({% link {{ page.version.version }}/licensing-faqs.md %}) ## Comparison of security features @@ -39,7 +35,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user {{ site.data.products.basic }} {{ site.data.products.standard }} {{ site.data.products.advanced }} - {{ site.data.products.core }} {{ site.data.products.core }} {{ site.data.products.enterprise }} Feature @@ -51,7 +46,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Inter-node and node identity authentication using TLS 1.3 @@ -59,7 +53,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Client identity authentication using username/password @@ -67,7 +60,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SASL/SCRAM-SHA-256 secure password-based authentication @@ -75,7 +67,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user     ✓ - ✓ SQL client identity authentication using TLS 1.2/1.3 @@ -83,14 +74,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Web console authentication with third-party Single Sign-on (SSO) using OpenID Connect OIDC       -   ✓ Client identity authentication with GSSAPI and Kerberos @@ -98,7 +87,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ HTTP API access using login tokens @@ -106,7 +94,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user       -   ✓ OCSP certificate revocation protocol @@ -116,7 +103,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Encryption in transit using TLS 1.3 @@ -124,7 +110,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for AWS clusters are encrypted at rest using AWS S3’s server-side encryption @@ -132,7 +117,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Backups for GCP clusters are encrypted at rest using Google-managed server-side encryption keys @@ -140,14 +124,12 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Industry-standard encryption at rest is provided at the infrastructure level by your chosen deployment environment, such as Google Cloud Platform (GCP), Amazon Web Services (AWS), or Microsoft Azure. You can learn more about GCP persistent disk encryption, AWS Elastic Block Storage, or Azure managed disk encryption.       -   ✓ Cockroach Labs's proprietary storage-level {{ site.data.products.enterprise }} Encryption At Rest service implementing the Advanced Encryption Standard (AES) @@ -157,7 +139,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Users and privileges @@ -165,7 +146,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Role-based access control (RBAC) @@ -174,7 +154,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL-level configuration allowed authentication attempts by IP address @@ -182,7 +161,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ Network-level Configuration of allowed IP addresses @@ -190,7 +168,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ GCP Private Service Connect (PSC) (Preview) or VPC Peering for GCP clusters and AWS PrivateLink for AWS clusters @@ -199,7 +176,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ SQL Audit Logging @@ -208,7 +184,6 @@ CockroachDB {{ site.data.products.core }} here refers to the situation of a user ✓ ✓ ✓ - ✓ CockroachDB, as a distributed SQL database, is uniquely resilient by nature. A cluster can tolerate node failures as long as the majority of nodes remain functional. See Disaster Recovery. diff --git a/src/current/v24.2/set-up-physical-cluster-replication.md b/src/current/v24.2/set-up-physical-cluster-replication.md index 159435f9c85..0275d743d64 100644 --- a/src/current/v24.2/set-up-physical-cluster-replication.md +++ b/src/current/v24.2/set-up-physical-cluster-replication.md @@ -33,7 +33,7 @@ The high-level steps in this tutorial are: - To set up each cluster, you can follow [Deploy CockroachDB on Premises]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}). When you initialize the cluster with the [`cockroach init`]({% link {{ page.version.version }}/cockroach-init.md %}) command, you **must** pass the `--virtualized` or `--virtualized-empty` flag. Refer to the cluster creation steps for the [primary cluster](#initialize-the-primary-cluster) and for the [standby cluster](#initialize-the-standby-cluster) for details. - The [Deploy CockroachDB on Premises]({% link {{ page.version.version }}/deploy-cockroachdb-on-premises.md %}) tutorial creates a self-signed certificate for each {{ site.data.products.core }} cluster. To create certificates signed by an external certificate authority, refer to [Create Security Certificates using OpenSSL]({% link {{ page.version.version }}/create-security-certificates-openssl.md %}). - All nodes in each cluster will need access to the Certificate Authority for the other cluster. Refer to [Manage the cluster certificates](#step-3-manage-the-cluster-certificates). -- An [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) on the primary **and** standby clusters. You must use the system virtual cluster on the primary and standby clusters to enable your {{ site.data.products.enterprise }} license. +- An [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) on the primary **and** standby clusters. You must use the system virtual cluster on the primary and standby clusters to enable your {{ site.data.products.enterprise }} license. - The primary and standby clusters **must have the same [region topology]({% link {{ page.version.version }}/topology-patterns.md %})**. For example, replicating a multi-region primary cluster to a single-region standby cluster is not supported. Mismatching regions between a multi-region primary and standby cluster is also not supported. {{site.data.alerts.callout_info}} @@ -76,7 +76,7 @@ Connect to your primary cluster's system virtual cluster using [`cockroach sql`] You should only connect to the system virtual cluster for cluster administration. To work with databases, tables, or workloads, connect to a virtual cluster. {{site.data.alerts.end}} -1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to the cluster: +1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) to the cluster: {% include_cached copy-clipboard.html %} ~~~ sql @@ -210,7 +210,7 @@ Connect to your standby cluster's system virtual cluster using [`cockroach sql`] --certs-dir "certs" ~~~ -1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) to the cluster: +1. Add your cluster organization and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) to the cluster: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v24.2/sql-statements.md b/src/current/v24.2/sql-statements.md index 68e942a4577..5a74658cb01 100644 --- a/src/current/v24.2/sql-statements.md +++ b/src/current/v24.2/sql-statements.md @@ -17,7 +17,7 @@ Statement | Usage [`ALTER DEFAULT PRIVILEGES`]({% link {{ page.version.version }}/alter-default-privileges.md %}) | Change the default [privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#privileges) for objects created by specific roles/users in the current database. [`ALTER FUNCTION`]({% link {{ page.version.version }}/alter-function.md %}) | Modify a [user-defined function]({% link {{ page.version.version }}/user-defined-functions.md %}). [`ALTER INDEX`]({% link {{ page.version.version }}/alter-index.md %}) | Apply a schema change to an index. -[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER PARTITION`]({% link {{ page.version.version }}/alter-partition.md %}) | Configure the replication zone for a partition. [`ALTER RANGE`]({% link {{ page.version.version }}/alter-range.md %}) | Configure the replication zone for a system range. [`ALTER SCHEMA`]({% link {{ page.version.version }}/alter-schema.md %}) | Alter a user-defined schema. [`ALTER SEQUENCE`]({% link {{ page.version.version }}/alter-sequence.md %}) | Apply a schema change to a sequence. @@ -55,7 +55,7 @@ Statement | Usage [`SHOW FULL TABLE SCANS`]({% link {{ page.version.version }}/show-full-table-scans.md %}) | List recent queries that used a full table scan. [`SHOW INDEX`]({% link {{ page.version.version }}/show-index.md %}) | View index information for a table or database. [`SHOW LOCALITY`]({% link {{ page.version.version }}/show-locality.md %}) | View the locality of the current node. -[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [Partitioning]({% link {{ page.version.version }}/partitioning.md %}) requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`SHOW PARTITIONS`]({% link {{ page.version.version }}/show-partitions.md %}) | List partitions in a database. [`SHOW REGIONS`]({% link {{ page.version.version }}/show-regions.md %}) | List the [cluster regions]({% link {{ page.version.version }}/multiregion-overview.md %}#cluster-regions) or [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SUPER REGIONS`]({% link {{ page.version.version }}/show-super-regions.md %}) | List the [super regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) associated with a database in a [multi-region cluster]({% link {{ page.version.version }}/multiregion-overview.md %}). [`SHOW SCHEMAS`]({% link {{ page.version.version }}/show-schemas.md %}) | List the schemas in a database. @@ -172,13 +172,13 @@ Statement | Usage [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) | Create disaster recovery backups of clusters, databases, and tables. [`RESTORE`]({% link {{ page.version.version }}/restore.md %}) | Restore clusters, databases, and tables using your backups. [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %}) | List the contents of a backup. -[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. Core users can only use backup scheduling for full backups of clusters, databases, or tables. To use the other backup features, you need an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) | Create a schedule for periodic backups. [`ALTER BACKUP SCHEDULE`]({% link {{ page.version.version }}/alter-backup-schedule.md %}) | Modify an existing backup schedule. [`SHOW SCHEDULES`]({% link {{ page.version.version }}/show-schedules.md %}) | View information on backup schedules. [`PAUSE SCHEDULES`]({% link {{ page.version.version }}/pause-schedules.md %}) | Pause backup schedules. [`RESUME SCHEDULES`]({% link {{ page.version.version }}/resume-schedules.md %}) | Resume paused backup schedules. [`DROP SCHEDULES`]({% link {{ page.version.version }}/drop-schedules.md %}) | Drop backup schedules. -[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. Adding new KMS encryption keys requires an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +[`ALTER BACKUP`]({% link {{ page.version.version }}/alter-backup.md %}) | Add a new [KMS encryption key]({% link {{ page.version.version }}/take-and-restore-encrypted-backups.md %}#use-key-management-service) to an encrypted backup. ## Changefeed statements @@ -186,10 +186,10 @@ Statement | Usage Statement | Usage ----------|------------ -[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). -[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) | Create a new changefeed to stream row-level changes in a configurable format to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). +[`CREATE SCHEDULE FOR CHANGEFEED`]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) | Create a scheduled changefeed to export data out of CockroachDB using an initial scan. to a configurable sink (e.g, [Kafka]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka), [cloud storage]({% link {{ page.version.version }}/changefeed-sinks.md %}#cloud-storage-sink)). [`EXPERIMENTAL CHANGEFEED FOR`]({% link {{ page.version.version }}/changefeed-for.md %}) | (Core) Create a new changefeed to stream row-level changes to the client indefinitely until the underlying connection is closed or the changefeed is canceled. -[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | [({{ site.data.products.enterprise }})]({% link {{ page.version.version }}/enterprise-licensing.md %}) Modify an existing changefeed. +[`ALTER CHANGEFEED`]({% link {{ page.version.version }}/alter-changefeed.md %}) | Modify an existing changefeed. ## External resource statements diff --git a/src/current/v24.2/sso-db-console.md b/src/current/v24.2/sso-db-console.md index d747c1f5005..1a57dc2cb47 100644 --- a/src/current/v24.2/sso-db-console.md +++ b/src/current/v24.2/sso-db-console.md @@ -27,7 +27,7 @@ This SSO implementation uses the [authorization code grant type](https://tools.i - **IdP:** You must have access to an OAuth 2.0 identity provider and client. The process of provisioning one with Google Cloud Platform is described on this page in the [Provision an OAuth client using Google Cloud Platform (GCP)](#provision-an-oauth-client-using-google-cloud-platform-gcp) section. - **CockroachDB cluster**: you must have access to one of the following: - - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). + - A {{ site.data.products.core }} cluster enabled with a valid [CockroachDB Enterprise license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses). - A [CockroachDB {{ site.data.products.dedicated }} cluster]({% link cockroachcloud/create-your-cluster.md %}). diff --git a/src/current/v24.2/sso-sql.md b/src/current/v24.2/sso-sql.md index 1fe80d1f0bb..c87effa6b37 100644 --- a/src/current/v24.2/sso-sql.md +++ b/src/current/v24.2/sso-sql.md @@ -14,7 +14,7 @@ Cluster single sign-on (SSO) enables users to access the SQL interface of a Cock {{ site.data.products.advanced }} clusters can provision their users with Java Web Tokens (JWTs) via the DB Console. This allows users to authenticate to a cluster by signing in to their IdP (for example, Okta or Google) with a link embedded in the DB Console. This flow provisions a JWT that a user can copy out of the DB Console UI and use in a SQL connection string to authenticate to the cluster. {{site.data.alerts.callout_info}} -Cluster single sign-on for the DB Console is supported on {{ site.data.products.enterprise }} and {{ site.data.products.advanced }} clusters. {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB Cloud Console]({% link cockroachcloud/cloud-sso-sql.md %}). +Cluster single sign-on for the DB Console is supported on CockroachDB [{{ site.data.products.enterprise }}]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) and {{ site.data.products.advanced }} clusters. CockroachDB {{ site.data.products.standard }} and {{ site.data.products.basic }} clusters do not support cluster single sign-on and do not have access to the DB Console. However, both CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters can use [Cluster Single Sign-on (SSO) to authenticate to the `ccloud` command-line interface and to the CockroachDB {{ site.data.products.cloud }} Console]({% link cockroachcloud/cloud-sso-sql.md %}). {{site.data.alerts.end}} The page describes how to configure a cluster for cluster single sign-on using JWTs and then how users can authenticate using the JWTs. If you're a user ready to sign in to the DB Console with JWTs, you can skip the configuration section: diff --git a/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md b/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md index 98b2075be79..b2ef265d16b 100644 --- a/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md +++ b/src/current/v24.2/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.md @@ -248,7 +248,7 @@ To create your changefeed, you'll prepare your CockroachDB cluster with the `mov cockroach sql --url {"CONNECTION STRING"} ~~~ -1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email: +1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key: {% include_cached copy-clipboard.html %} ~~~sql diff --git a/src/current/v24.2/stream-a-changefeed-to-amazon-msk-serverless.md b/src/current/v24.2/stream-a-changefeed-to-amazon-msk-serverless.md index 50ead73bb38..05ae612b5ee 100644 --- a/src/current/v24.2/stream-a-changefeed-to-amazon-msk-serverless.md +++ b/src/current/v24.2/stream-a-changefeed-to-amazon-msk-serverless.md @@ -162,4 +162,4 @@ For more resources, refer to the following: - [Changefeed Sinks]({% link {{ page.version.version }}/changefeed-sinks.md %}) page for details on parameters that sinks support. - [Configuration for serverless clusters](https://docs.aws.amazon.com/msk/latest/developerguide/serverless-config.html) in the AWS documentation for details on topic-level configuration options. - [Monitoring serverless clusters](https://docs.aws.amazon.com/msk/latest/developerguide/serverless-monitoring.html) in the AWS documentation for details on monitoring the MSK Serverless cluster. -- [Monitor and Debug Changefeeds]({% link {{ page.version.version }}/monitor-and-debug-changefeeds.md %}) for details on monitoring the changefeed job. \ No newline at end of file +- [Monitor and Debug Changefeeds]({% link {{ page.version.version }}/monitor-and-debug-changefeeds.md %}) for details on monitoring the changefeed job. diff --git a/src/current/v24.2/take-and-restore-encrypted-backups.md b/src/current/v24.2/take-and-restore-encrypted-backups.md index 96682769988..46fd37bba1b 100644 --- a/src/current/v24.2/take-and-restore-encrypted-backups.md +++ b/src/current/v24.2/take-and-restore-encrypted-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Encrypted [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take and restore encrypted backups in the following ways: - [Using AWS Key Management Service (KMS)](#aws-kms-uri-format) diff --git a/src/current/v24.2/take-and-restore-locality-aware-backups.md b/src/current/v24.2/take-and-restore-locality-aware-backups.md index b2558b26244..bd921f2674b 100644 --- a/src/current/v24.2/take-and-restore-locality-aware-backups.md +++ b/src/current/v24.2/take-and-restore-locality-aware-backups.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -Locality-aware [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - Locality-aware backups allow you to partition and store backup data in a way that is optimized for locality. When you run a locality-aware backup, nodes write backup data to the [cloud storage]({% link {{ page.version.version }}/use-cloud-storage.md %}) bucket that is closest to the node locality configured at [node startup]({% link {{ page.version.version }}/cockroach-start.md %}). {{site.data.alerts.callout_danger}} diff --git a/src/current/v24.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md b/src/current/v24.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md index 9e00badc0d8..ae85761f4d4 100644 --- a/src/current/v24.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md +++ b/src/current/v24.2/take-backups-with-revision-history-and-restore-from-a-point-in-time.md @@ -5,10 +5,6 @@ toc: true docs_area: manage --- -{{site.data.alerts.callout_info}} -[`BACKUP`]({% link {{ page.version.version }}/backup.md %}) with revision history is an [Enterprise-only](https://www.cockroachlabs.com/product/cockroachdb/) feature. However, you can take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) without an Enterprise license. -{{site.data.alerts.end}} - This page provides information about how to take backups with revision history and restore from a point-in-time. You can create full or incremental backups [with revision history]({% link {{ page.version.version }}/backup.md %}#with-revision-history): diff --git a/src/current/v24.2/take-full-and-incremental-backups.md b/src/current/v24.2/take-full-and-incremental-backups.md index 563e9d73085..89afa7d088f 100644 --- a/src/current/v24.2/take-full-and-incremental-backups.md +++ b/src/current/v24.2/take-full-and-incremental-backups.md @@ -88,8 +88,6 @@ In the examples on this page, `{collectionURI}` is a placeholder for the storage ## Full backups -Full backups are now available to both core and Enterprise users. - Full backups contain an un-replicated copy of your data and can always be used to restore your cluster. These files are roughly the size of your data and require greater resources to produce than incremental backups. You can take full backups as of a given timestamp. Optionally, you can include the available [revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}) in the backup. In most cases, **it's recommended to take nightly full backups of your cluster**. A cluster backup allows you to do the following: @@ -98,7 +96,7 @@ In most cases, **it's recommended to take nightly full backups of your cluster** - Restore database(s) from the cluster - Restore a full cluster -[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes Enterprise license, the Enterprise license is also restored. +[Full cluster backups]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes Enterprise license, the Enterprise license is also restored. {% include {{ page.version.version }}/backups/file-size-setting.md %} @@ -149,10 +147,6 @@ To view the available backup subdirectories, use [`SHOW BACKUPS`]({% link {{ pag ## Incremental backups -{{site.data.alerts.callout_info}} -To take incremental backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - If your cluster grows too large for daily [full backups](#full-backups), you can take less frequent full backups (e.g., weekly) with daily incremental backups. Incremental backups are storage efficient and faster than full backups for larger clusters. If you are taking backups on a regular cadence, we recommend [creating a schedule]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) for your backups. @@ -271,7 +265,7 @@ For details on cloud storage URLs, see [Use Cloud Storage]({% link {{ page.versi ### Scheduled backups -You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. To create a schedule that includes incremental backups, you must have an [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}). +You can use [`CREATE SCHEDULE FOR BACKUP`]({% link {{ page.version.version }}/create-schedule-for-backup.md %}) to set a recurring schedule for full and incremental backups. Include the `FULL BACKUP ALWAYS` clause for a schedule to take only full backups. For example, to create a schedule for taking full cluster backups: @@ -383,10 +377,6 @@ To create a table with `exclude_data_from_backup`, see [Create a table with data {% include {{ page.version.version }}/backups/advanced-examples-list.md %} -{{site.data.alerts.callout_info}} -To take incremental backups, backups with revision history, locality-aware backups, and encrypted backups, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). -{{site.data.alerts.end}} - ## See also - [`BACKUP`][backup] diff --git a/src/current/v24.2/ui-cluster-overview-page.md b/src/current/v24.2/ui-cluster-overview-page.md index 891a87a99c1..57c4c816de9 100644 --- a/src/current/v24.2/ui-cluster-overview-page.md +++ b/src/current/v24.2/ui-cluster-overview-page.md @@ -12,7 +12,7 @@ The **Cluster Overview** page of the DB Console displays key metrics about your - Uptime - Hardware usage -If you have an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}), you can enable the [Node Map](#node-map-enterprise) view for a visual representation of your cluster's geographic layout. +Enable the [Node Map](#node-map) view for a visual representation of your cluster's geographic layout. ## Cluster Overview panel @@ -28,7 +28,7 @@ Replication Status |
                                                                          • The total number ### Capacity metrics -The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map-enterprise) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. +The [Cluster Overview](#cluster-overview-panel), [Node List](#node-list), and [Node Map](#node-map) display **Capacity Usage** by the CockroachDB [store]({% link {{ page.version.version }}/architecture/storage-layer.md %}) (the directory on each node where CockroachDB reads and writes its data) as a percentage of the disk space that is **usable** on the cluster, locality, or node. Usable disk space is constrained by the following: @@ -50,7 +50,7 @@ If a node is currently unavailable, the last-known capacity usage will be shown, The **Node List** groups nodes by locality. The lowest-level locality tier is used to organize the Node List. Hover over a locality to see all localities for the group of nodes. {{site.data.alerts.callout_success}} -We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map-enterprise). +We recommend [defining `--locality` flags when starting nodes]({% link {{ page.version.version }}/cockroach-start.md %}#locality). CockroachDB uses locality to distribute replicas and mitigate [network latency]({% link {{ page.version.version }}/ui-network-latency-page.md %}). Locality is also a prerequisite for enabling the [Node Map](#node-map). {{site.data.alerts.end}} ### Node status @@ -104,9 +104,9 @@ You can see the full history of decommissioned nodes by clicking **View all deco For details about the decommissioning process, see [Node Shutdown](node-shutdown.html?filters=decommission#node-shutdown-sequence). {{site.data.alerts.end}} -## Node Map (Enterprise) +## Node Map -The **Node Map** is an [enterprise]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature that visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. +The **Node Map** visualizes the geographical configuration of your cluster. It requires that [`--locality` flags have been defined]({% link {{ page.version.version }}/cockroach-start.md %}#locality) for your nodes. For guidance on enabling and configuring the node map, see [Enable the Node Map]({% link {{ page.version.version }}/enable-node-map.md %}). diff --git a/src/current/v24.2/ui-overview.md b/src/current/v24.2/ui-overview.md index 1930147952c..5ee81fe9fc3 100644 --- a/src/current/v24.2/ui-overview.md +++ b/src/current/v24.2/ui-overview.md @@ -16,7 +16,7 @@ Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console ## Authentication -The DB Console supports username/password login, as well single sign-on (SSO) ({{ site.data.products.dedicated }} and {{ site.data.products.core }} {{ site.data.products.enterprise }} clusters only). +The DB Console supports username/password login and single sign-on (SSO) for {{ site.data.products.advanced }} and {{ site.data.products.enterprise }} clusters. The DB Console sign-on page can also be used to provision authentication tokens for SQL client access. @@ -32,8 +32,8 @@ Refer to: The Overview page provides a cluster overview and node list and map. - [Cluster Overview]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}) has essential metrics about the cluster and nodes, including liveness status, replication status, uptime, and hardware usage. -- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) has a list of cluster metrics at the locality and node levels. -- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map-enterprise) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. +- [Node List]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) has a list of cluster metrics at the locality and node levels. +- [Node Map]({% link {{ page.version.version }}/ui-cluster-overview-page.md %}#node-map) displays a geographical configuration of your cluster and metrics at the locality and node levels, visualized on a map. ### Metrics