diff --git a/src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md b/src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md index 26ce4e20c40..3e299b6a53d 100644 --- a/src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md +++ b/src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md @@ -15,7 +15,7 @@ Release Date: March 20, 2023

{{ site.data.products.enterprise }} edition changes

-- Sinkless [changefeeds]({% link v23.1/create-changefeed.md %}) that use the [`AS SELECT`]({% link v23.1/selection-queries.md %}) syntax now require an [enterprise license]({% link v23.1/enterprise-licensing.md %}). [#98241][#98241] +- Sinkless [changefeeds]({% link v23.1/create-changefeed.md %}) that use the [`AS SELECT`]({% link v23.1/selection-queries.md %}) syntax now require an enterprise license. [#98241][#98241] - [External connections]({% link v23.1/create-external-connection.md %}) can now be used as the URI value for a Confluent schema registry. For example, `CREATE EXTERNAL CONNECTION reg AS "https://example.cloud?opt=val"; CREATE CHANGEFEED FOR foo WITH format='avro',confluent_schema_registry='external://reg'` [#97140][#97140] - [Backup schedules]({% link v23.1/create-schedule-for-backup.md %}) created or altered to have the option `on_previous_running` will have the full backup schedule created with the user specified option, but will override the incremental backup schedule to always default to `on_previous_running = wait`. This ensures correctness of the backup chains created by the incremental schedule by preventing duplicate incremental jobs from racing against each other. [#98249][#98249] - [Changefeeds]({% link v23.1/changefeed-sinks.md %}#kafka) to a Kafka sink now support the `OAUTHBEARER` `sasl_mechanism`. [#98053][#98053] diff --git a/src/current/_includes/releases/v23.1/v23.1.0.md b/src/current/_includes/releases/v23.1/v23.1.0.md index 5d7f86830bd..d171aec3b9c 100644 --- a/src/current/_includes/releases/v23.1/v23.1.0.md +++ b/src/current/_includes/releases/v23.1/v23.1.0.md @@ -228,10 +228,6 @@ Asyncpg is commonly used with ORM libraries such as SQLAlchemy to provide a simp
Change data capture (Changefeeds)
-{{site.data.alerts.callout_info}} -The following are [enterprise-only]({% link v23.1/enterprise-licensing.md %}) features. [Request a 30-day trial license](https://www.cockroachlabs.com/get-cockroachdb/enterprise/) to try them out. -{{site.data.alerts.end}} - diff --git a/src/current/_includes/releases/v23.2/v23.2.12.md b/src/current/_includes/releases/v23.2/v23.2.12.md index 687e107b74d..81aef686289 100644 --- a/src/current/_includes/releases/v23.2/v23.2.12.md +++ b/src/current/_includes/releases/v23.2/v23.2.12.md @@ -37,7 +37,7 @@ Release Date: September 25, 2024 - The [DB Console]({% link v23.2/ui-overview-dashboard.md %}) time-series graphs now have hover behavior that focuses on individual lines and shows values under the mouse pointer. [cockroachdb/cockroach#128864][#128864] - Users with the [`VIEWACTIVITY` privilege]({% link v23.2/security-reference/authorization.md %}#viewactivity) can download [statement bundles]({% link v23.2/explain-analyze.md %}) from [DB Console]({% link v23.2/ui-overview.md %}). [#129502][#129502] - The [DB Console]({% link v23.2/ui-overview.md %}) now displays an alert message when the [license is expired]({% link v23.2/licensing-faqs.md %}#monitor-for-license-expiry) or if there are fewer than 15 days left before the license expires. [#130509][#130509] -- The [DB Console]({% link v23.2/ui-overview.md %}) will now show a notification alerting customers without an [Enterprise license]({% link v23.2/enterprise-licensing.md %}) to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130509][#130509] +- The [DB Console]({% link v23.2/ui-overview.md %}) will now show a notification alerting customers without an Enterprise license to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130509][#130509]

Bug fixes

diff --git a/src/current/_includes/releases/v23.2/v23.2.13.md b/src/current/_includes/releases/v23.2/v23.2.13.md index 110a5dc9517..28ce188820c 100644 --- a/src/current/_includes/releases/v23.2/v23.2.13.md +++ b/src/current/_includes/releases/v23.2/v23.2.13.md @@ -45,7 +45,7 @@ Release Date: October 17, 2024

DB Console changes

-- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no [Enterprise license]({% link v24.2/enterprise-licensing.md %}) set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130425][#130425] +- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no Enterprise license set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130425][#130425]

Bug fixes

diff --git a/src/current/_includes/releases/v24.1/v24.1.6.md b/src/current/_includes/releases/v24.1/v24.1.6.md index 988d8345f06..b17655bb0bd 100644 --- a/src/current/_includes/releases/v24.1/v24.1.6.md +++ b/src/current/_includes/releases/v24.1/v24.1.6.md @@ -27,7 +27,7 @@ Release Date: October 17, 2024

DB Console changes

-- The [DB Console]({% link v24.1/ui-overview.md %}) will now show a notification alerting customers without an [Enterprise license]({% link v24.1/enterprise-licensing.md %}) to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130426][#130426] +- The [DB Console]({% link v24.1/ui-overview.md %}) will now show a notification alerting customers without an Enterprise license to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130426][#130426]

Bug fixes

diff --git a/src/current/_includes/releases/v24.2/feature-highlights-sql.html b/src/current/_includes/releases/v24.2/feature-highlights-sql.html index 868a2cb285b..4e00d5c9e46 100644 --- a/src/current/_includes/releases/v24.2/feature-highlights-sql.html +++ b/src/current/_includes/releases/v24.2/feature-highlights-sql.html @@ -18,7 +18,7 @@

Users can now store VECTOR - embeddings within CockroachDB with pgvector-compatible semantics to build AI-driven applications. Numerous built-in functions have been added for running similarity search across vectors. Note that vector indexing is not supported in this release. This feature is in Preview and requires an Enterprise license. + embeddings within CockroachDB with pgvector-compatible semantics to build AI-driven applications. Numerous built-in functions have been added for running similarity search across vectors. Note that vector indexing is not supported in this release. This feature is in Preview.

@@ -30,7 +30,7 @@ diff --git a/src/current/_includes/releases/v24.2/v24.2.3.md b/src/current/_includes/releases/v24.2/v24.2.3.md index 923d7cd5762..ab562491df3 100644 --- a/src/current/_includes/releases/v24.2/v24.2.3.md +++ b/src/current/_includes/releases/v24.2/v24.2.3.md @@ -26,7 +26,7 @@ Release Date: September 25, 2024 - Users with the `VIEWACTIVITY` [system privilege]({% link v24.2/security-reference/authorization.md %}#supported-privileges) can now download [statement bundles]({% link v24.2/ui-statements-page.md %}#diagnostics) from the DB Console. [#129504][#129504] - Users with the `VIEWACTIVITY` [system privilege]({% link v24.2/security-reference/authorization.md %}#supported-privileges) can now request, view, and cancel [statement bundles]({% link v24.2/ui-statements-page.md %}#diagnostics) from the DB Console. [#129809][#129809] -- The DB Console now displays a notification to alert customers without an [Enterprise license]({% link v24.2/enterprise-licensing.md %}) to upcoming license changes. [#130511][#130511] +- The DB Console now displays a notification to alert customers without an Enterprise license to upcoming license changes. [#130511][#130511]

Bug fixes

diff --git a/src/current/_includes/releases/v24.2/v24.2.4.md b/src/current/_includes/releases/v24.2/v24.2.4.md index f3c30e54ed6..e3f81a22390 100644 --- a/src/current/_includes/releases/v24.2/v24.2.4.md +++ b/src/current/_includes/releases/v24.2/v24.2.4.md @@ -29,7 +29,7 @@ Release Date: October 17, 2024

DB Console changes

- Streamlined [metric chart]({% link v24.2/ui-overview.md %}#metrics) legends by removing the name of the chart from labels, where it was an identical prefix for all labels on the chart. [#129359][#129359] -- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no [Enterprise license]({% link v24.2/enterprise-licensing.md %}) set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130417][#130417] +- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no Enterprise license set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130417][#130417]

Bug fixes

diff --git a/src/current/_includes/v23.1/misc/set-enterprise-license.md b/src/current/_includes/v23.1/misc/set-enterprise-license.md deleted file mode 100644 index 33baa3baddd..00000000000 --- a/src/current/_includes/v23.1/misc/set-enterprise-license.md +++ /dev/null @@ -1,16 +0,0 @@ -As the CockroachDB `root` user, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) in insecure or secure mode, as per your CockroachDB setup. In the following example, we assume that CockroachDB is running in insecure mode. Then use the [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to set the name of your organization and the license key: - -{% include_cached copy-clipboard.html %} -~~~ shell -$ cockroach sql --insecure -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING cluster.organization = 'Acme Company'; -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx'; -~~~ diff --git a/src/current/_includes/v23.2/misc/set-enterprise-license.md b/src/current/_includes/v23.2/misc/set-enterprise-license.md deleted file mode 100644 index 33baa3baddd..00000000000 --- a/src/current/_includes/v23.2/misc/set-enterprise-license.md +++ /dev/null @@ -1,16 +0,0 @@ -As the CockroachDB `root` user, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) in insecure or secure mode, as per your CockroachDB setup. In the following example, we assume that CockroachDB is running in insecure mode. Then use the [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to set the name of your organization and the license key: - -{% include_cached copy-clipboard.html %} -~~~ shell -$ cockroach sql --insecure -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING cluster.organization = 'Acme Company'; -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx'; -~~~ diff --git a/src/current/_includes/v24.1/misc/set-enterprise-license.md b/src/current/_includes/v24.1/misc/set-enterprise-license.md deleted file mode 100644 index 33baa3baddd..00000000000 --- a/src/current/_includes/v24.1/misc/set-enterprise-license.md +++ /dev/null @@ -1,16 +0,0 @@ -As the CockroachDB `root` user, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) in insecure or secure mode, as per your CockroachDB setup. In the following example, we assume that CockroachDB is running in insecure mode. Then use the [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to set the name of your organization and the license key: - -{% include_cached copy-clipboard.html %} -~~~ shell -$ cockroach sql --insecure -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING cluster.organization = 'Acme Company'; -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx'; -~~~ diff --git a/src/current/_includes/v24.2/misc/set-enterprise-license.md b/src/current/_includes/v24.2/misc/set-enterprise-license.md deleted file mode 100644 index 33baa3baddd..00000000000 --- a/src/current/_includes/v24.2/misc/set-enterprise-license.md +++ /dev/null @@ -1,16 +0,0 @@ -As the CockroachDB `root` user, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) in insecure or secure mode, as per your CockroachDB setup. In the following example, we assume that CockroachDB is running in insecure mode. Then use the [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to set the name of your organization and the license key: - -{% include_cached copy-clipboard.html %} -~~~ shell -$ cockroach sql --insecure -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING cluster.organization = 'Acme Company'; -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx'; -~~~ diff --git a/src/current/v23.1/change-data-capture-overview.md b/src/current/v23.1/change-data-capture-overview.md index 00f4969d0b8..48d0aa1c224 100644 --- a/src/current/v23.1/change-data-capture-overview.md +++ b/src/current/v23.1/change-data-capture-overview.md @@ -74,7 +74,7 @@ CockroachDB has two implementations of changefeeds: - + diff --git a/src/current/v23.1/changefeed-examples.md b/src/current/v23.1/changefeed-examples.md index 7eaf88f3b6d..924deb98f0f 100644 --- a/src/current/v23.1/changefeed-examples.md +++ b/src/current/v23.1/changefeed-examples.md @@ -538,15 +538,11 @@ 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-basic-changefeed). -{{site.data.alerts.end}} - {% include {{ page.version.version }}/cdc/webhook-performance-setting.md %} 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 %}). 1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster: @@ -631,7 +627,7 @@ In this example, you will create a changefeed that filters the change data using For different use case examples and syntax detail, refer to the [Change Data Capture Queries]({% link {{ page.version.version }}/cdc-queries.md %}) page. -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 %}). 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/enterprise-licensing.md b/src/current/v23.1/enterprise-licensing.md deleted file mode 100644 index 62e861e2b59..00000000000 --- a/src/current/v23.1/enterprise-licensing.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Enterprise Features -summary: Learn about CockroachDB features that require an Enterprise license key. -toc: true -docs_area: ---- - -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}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -{% include {{ page.version.version }}/misc/enterprise-features.md %} - -## See also - -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Enterprise Trial –– Get Started]({% link {{ page.version.version }}/get-started-with-enterprise-trial.md %}) diff --git a/src/current/v23.1/get-started-with-enterprise-trial.md b/src/current/v23.1/get-started-with-enterprise-trial.md deleted file mode 100644 index 7820a1bb3a3..00000000000 --- a/src/current/v23.1/get-started-with-enterprise-trial.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Enterprise Trial –– Get Started -summary: Check out this page to get started with your CockroachDB Enterprise Trial -toc: true -license: true -docs_area: ---- - -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 - -If you haven't already, you'll need to [locally install]({% link {{ page.version.version }}/install-cockroachdb.md %}), [remotely deploy]({% link {{ page.version.version }}/manual-deployment.md %}), or [orchestrate]({% link {{ page.version.version }}/kubernetes-overview.md %}) CockroachDB. - -## Enable Enterprise features - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to verify your license: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ - -## Use Enterprise features - -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 %} - -## Getting help - -If you or your team need any help during your trial, our engineers are available on [CockroachDB Community Slack](https://cockroachdb.slack.com), [our forum](https://forum.cockroachlabs.com/), or [GitHub](https://github.com/cockroachdb/cockroach). - -Also consider checking out [Cockroach University](https://university.cockroachlabs.com/) for free online courses that help you get the most out of CockroachDB. - -## See also - -- [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Cockroach University](https://university.cockroachlabs.com/) diff --git a/src/current/v23.1/licensing-faqs.md b/src/current/v23.1/licensing-faqs.md index fef8412bcb7..680cc0e3b7d 100644 --- a/src/current/v23.1/licensing-faqs.md +++ b/src/current/v23.1/licensing-faqs.md @@ -5,152 +5,4 @@ toc: true docs_area: get_started --- -{{site.data.alerts.callout_info}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). - -## Types of licenses - -Type | Description --------------|------------ -**Apache 2.0 License** | Core features under the Apache License are free to use and fully open-source. BSL features convert to this license three years after their release. For license conversion dates, see the [table below](#license-conversion-timeline). -**Business Source License**| BSL features are free to use and the source code is available, but users may not use CockroachDB [as a service](#what-constitutes-hosting-cockroachdb-as-a-service) without an agreement with Cockroach Labs. The BSL is not certified as an open-source license, but most of the [Open Source Initiative](https://wikipedia.org/wiki/Open_Source_Initiative) (OSI) criteria are met. -**Cockroach
Community License** | - -For additional custom licensing options, [contact us](https://support.cockroachlabs.com/hc/en-us). - -For each BSL release all associated alpha, beta, major, and minor (point) releases will become Apache 2.0 on the same day three years after the major release date. Once a release is published under the BSL, the license cannot be changed to prevent code from becoming open-source at the specified change date. The following table lists the current license for non-CCL features for each published release: - -### License conversion timeline - -CockroachDB version | License | Converts to Apache 2.0 ---------------------|---------|---------------------------- -23.1 | Business Source License | May 16, 2026 -22.2 | Business Source License | Dec 6, 2025 -22.1 | Business Source License | May 24, 2025 -21.2 | Business Source License | Nov 16, 2024 -21.1 | Business Source License | May 18, 2024 -20.2 | Business Source License | Nov 10, 2023 -20.1 | Business Source License | May 12, 2023 -19.2 | Apache 2.0 | - -19.1 | Apache 2.0 | - -2.1 | Apache 2.0 | - -2.0 | Apache 2.0 | - - -## Feature licensing - -The table below shows how certain core and Enterprise features are licensed: - -Feature | BSL | CCL (free) | CCL (paid) ------------------|:-----:|:-----------------:|:---------------: -**[Import]({% link {{ page.version.version }}/import.md %})** | ✓ | | -**[Export]({% link {{ page.version.version }}/export.md %})** | ✓ | | -**[Restore]({% link {{ page.version.version }}/restore.md %})** | | ✓ | -**[Full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups)** | | ✓ | -**[Incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups)** | | | ✓ -**[Other advanced backup features]({% link {{ page.version.version }}/backup.md %})** | | | ✓ -**[Basic changefeed](create-and-configure-changefeeds.html?filters=core)** | | ✓ | -**[{{ site.data.products.enterprise }} changefeed]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}#configure-a-changefeed)** | | | ✓ -**[Table-level zone configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#replication-zone-levels)** | ✓ | | -**[Multi-region capabilities]({% link {{ page.version.version }}/multiregion-overview.md %})** | | | ✓ -**[Follower reads]({% link {{ page.version.version }}/follower-reads.md %})** | | | ✓ -**[Bounded staleness reads]({% link {{ page.version.version }}/follower-reads.md %}#bounded-staleness-reads)** | | | ✓ -**[Node map]({% link {{ page.version.version }}/enable-node-map.md %})** | | | ✓ -**[Encryption at rest]({% link {{ page.version.version }}/security-reference/encryption.md %}#encryption-at-rest-enterprise)** | | | ✓ -**[Role-based access management]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles)** | ✓ | | -**[Password and certificate authentication]({% link {{ page.version.version }}/authentication.md %})** | ✓ | | -**[GSSAPI with Kerberos authentication]({% link {{ page.version.version }}/gssapi_authentication.md %})** | | | ✓ -**[All other core features](https://www.cockroachlabs.com/compare/)** | ✓ | | - -{{site.data.alerts.callout_info}} -Individual feature licensing may change with each release of CockroachDB. You can use the dropdown menu at the top of the page to view documentation for other versions of CockroachDB. -{{site.data.alerts.end}} - -## Obtain a license - -All CockroachDB code is included in the same binary. No license key is required to access BSL and CCL (Free) features. To access CCL (Paid) features, users have two options: - -- An **Enterprise license** enables you to use CockroachDB Enterprise features for longer periods (one year or more). To upgrade to an Enterprise license, contact Sales. -- A **Trial license** enables you to try out CockroachDB Enterprise features for 30 days for free. To obtain a Trial license, contact Sales. - -{{site.data.alerts.callout_success}} -For quick local testing of Enterprise features, you can use the [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %}) command, which starts a temporary, in-memory cluster with a SQL shell open and a trial license applied automatically. -{{site.data.alerts.end}} - -{{site.data.alerts.callout_info}} -Cockroach Labs encourages non-commercial academic research involving CockroachDB. For such projects, please [contact us](https://support.cockroachlabs.com/hc/en-us) to discuss a possible licensing arrangement. -{{site.data.alerts.end}} - -## Set a license - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -## Verify a license - -To verify a license, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) command to check the organization name and license key: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ -~~~ - cluster.organization -+----------------------+ - Acme Company -(1 row) -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING enterprise.license; -~~~ -~~~ - enterprise.license -+-------------------------------------------+ - crl-0-ChB1x... -(1 row) -~~~ - -The license setting is also logged in the cockroach.log on the node where the command is run: - -{% include_cached copy-clipboard.html %} -~~~ sql -$ cat cockroach.log | grep license -~~~ -~~~ -I171116 18:11:48.279604 1514 sql/event_log.go:102 [client=[::1]:56357,user=root,n1] Event: "set_cluster_setting", target: 0, info: {SettingName:enterprise.license Value:xxxxxxxxxxxx User:root} -~~~ - -## Monitor for license expiry - -You can monitor the time until your license expires with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}). The `seconds_until_enterprise_license_expiry` metric reports the number of seconds until the Enterprise license on a cluster expires. It will report 0 if there is no license or a negative number if the license has already expired. For more information, see [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). - -## Renew an expired license - -After your license expires, the Enterprise features stop working, but your production setup is unaffected. For example, the backup and restore features would not work until the license is renewed, but you would be able to continue using all other features of CockroachDB without interruption. - -To renew an expired license, contact Sales and then [set](#set-a-license) the new license. - -## FAQs - -### Can I host CockroachDB as a service for internal use at my organization? - -Yes, employees and contractors can use your internal CockroachDB instance as a service, but no people outside of your organization will be able to use it without purchasing a license. Use of Enterprise features will always require a license. - -### What constitutes hosting CockroachDB as a service? - -Hosting CockroachDB as a service means creating an offering that allows third parties (other than your employees and contractors) to operate a database. Specifically, third parties cannot modify table schemas. - -### I would like to reuse a single component from the CockroachDB project in my own software, which uses the AGPL or another open-source license. Is this possible? - -The CockroachDB team is committed to supporting the open-source community and willing to consider extracting specific internal components that are generally useful as a separate project with its own license, for example APL. For more details, feel free to [contact us](https://support.cockroachlabs.com/hc/en-us). - -### Can I fork the CockroachDB project pre-BSL and create my own CockroachDB derivative with a different license? - -You can fork any historical version of CockroachDB in your own project, as allowed by the license available for that version, and modify it for your purpose. Note however that only the copyright holder (Cockroach Labs) can relicense the components that you forked from: your derivative will need to keep the original license at the time of the fork. Any component you copy from a BSL-licensed CockroachDB into your project will make the BSL apply to your project as well. - -### If Cockroach Labs is making available software to me under the Business Source License (BSL), does Cockroach Labs grant me any patent rights? - -The BSL does not explicitly reference patents in the text of the license. However, Cockroach Labs believes that the BSL includes an implied patent license and intends that in this case the BSL include an implied patent license under those patent claims that are licenseable by Cockroach Labs which are necessarily infringed by any permitted use of the BSL licensed software alone. +{% include common/licensing-faqs.md %} diff --git a/src/current/v23.1/ui-overview.md b/src/current/v23.1/ui-overview.md index e1798f3c5ee..33cbd68d698 100644 --- a/src/current/v23.1/ui-overview.md +++ b/src/current/v23.1/ui-overview.md @@ -14,6 +14,8 @@ Authorized CockroachDB {{ site.data.products.advanced }} cluster users can visit Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console]({% link cockroachcloud/network-authorization.md %}#db-console) {{site.data.alerts.end}} + + ## Authentication The DB Console supports username/password login and single sign-on (SSO) for {{ site.data.products.advanced }} and {{ site.data.products.enterprise }} clusters. diff --git a/src/current/v23.2/cockroachdb-feature-availability.md b/src/current/v23.2/cockroachdb-feature-availability.md index 3c4a0a7a603..688c3c2fede 100644 --- a/src/current/v23.2/cockroachdb-feature-availability.md +++ b/src/current/v23.2/cockroachdb-feature-availability.md @@ -248,7 +248,7 @@ The multiple active portals feature of the Postgres wire protocol (pgwire) is av ### Physical Cluster Replication -{% include_cached new-in.html version="v23.2" %}[Physical cluster replication]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}) continuously sends all data at the byte level from a primary cluster to an independent standby cluster. Existing data and ongoing changes on the active primary cluster, which is serving application data, replicate asynchronously to the passive standby cluster. In a disaster recovery scenario, you can cut over from the unavailable primary cluster to the standby cluster. This will stop the replication stream, reset the standby cluster to a point in time where all ingested data is consistent, and mark the standby as ready to accept application traffic. Physical cluster replication is in preview for CockroachDB Self-Hosted, and is an [enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}) feature. To share feedback and/or issues, contact [Support](https://support.cockroachlabs.com/hc). +{% include_cached new-in.html version="v23.2" %}[Physical cluster replication]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}) continuously sends all data at the byte level from a primary cluster to an independent standby cluster. Existing data and ongoing changes on the active primary cluster, which is serving application data, replicate asynchronously to the passive standby cluster. In a disaster recovery scenario, you can cut over from the unavailable primary cluster to the standby cluster. This will stop the replication stream, reset the standby cluster to a point in time where all ingested data is consistent, and mark the standby as ready to accept application traffic. Physical cluster replication is in preview for CockroachDB {{ site.data.products.core }} clusters. ### Super regions diff --git a/src/current/v23.2/enterprise-licensing.md b/src/current/v23.2/enterprise-licensing.md deleted file mode 100644 index 62e861e2b59..00000000000 --- a/src/current/v23.2/enterprise-licensing.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Enterprise Features -summary: Learn about CockroachDB features that require an Enterprise license key. -toc: true -docs_area: ---- - -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}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -{% include {{ page.version.version }}/misc/enterprise-features.md %} - -## See also - -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Enterprise Trial –– Get Started]({% link {{ page.version.version }}/get-started-with-enterprise-trial.md %}) diff --git a/src/current/v23.2/get-started-with-enterprise-trial.md b/src/current/v23.2/get-started-with-enterprise-trial.md deleted file mode 100644 index 7820a1bb3a3..00000000000 --- a/src/current/v23.2/get-started-with-enterprise-trial.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Enterprise Trial –– Get Started -summary: Check out this page to get started with your CockroachDB Enterprise Trial -toc: true -license: true -docs_area: ---- - -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 - -If you haven't already, you'll need to [locally install]({% link {{ page.version.version }}/install-cockroachdb.md %}), [remotely deploy]({% link {{ page.version.version }}/manual-deployment.md %}), or [orchestrate]({% link {{ page.version.version }}/kubernetes-overview.md %}) CockroachDB. - -## Enable Enterprise features - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to verify your license: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ - -## Use Enterprise features - -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 %} - -## Getting help - -If you or your team need any help during your trial, our engineers are available on [CockroachDB Community Slack](https://cockroachdb.slack.com), [our forum](https://forum.cockroachlabs.com/), or [GitHub](https://github.com/cockroachdb/cockroach). - -Also consider checking out [Cockroach University](https://university.cockroachlabs.com/) for free online courses that help you get the most out of CockroachDB. - -## See also - -- [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Cockroach University](https://university.cockroachlabs.com/) diff --git a/src/current/v23.2/licensing-faqs.md b/src/current/v23.2/licensing-faqs.md index eb0367a0a8f..680cc0e3b7d 100644 --- a/src/current/v23.2/licensing-faqs.md +++ b/src/current/v23.2/licensing-faqs.md @@ -5,153 +5,4 @@ toc: true docs_area: get_started --- -{{site.data.alerts.callout_info}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). - -## Types of licenses - -Type | Description --------------|------------ -**Apache 2.0 License** | Core features under the Apache License are free to use and fully open-source. BSL features convert to this license three years after their release. For license conversion dates, see the [table below](#license-conversion-timeline). -**Business Source License**| BSL features are free to use and the source code is available, but users may not use CockroachDB [as a service](#what-constitutes-hosting-cockroachdb-as-a-service) without an agreement with Cockroach Labs. The BSL is not certified as an open-source license, but most of the [Open Source Initiative](https://wikipedia.org/wiki/Open_Source_Initiative) (OSI) criteria are met. -**Cockroach
Community License** | - -For additional custom licensing options, [contact us](https://support.cockroachlabs.com/hc/en-us). - -For each BSL release all associated alpha, beta, major, and minor (point) releases will become Apache 2.0 on the same day three years after the major release date. Once a release is published under the BSL, the license cannot be changed to prevent code from becoming open-source at the specified change date. The following table lists the current license for non-CCL features for each published release: - -### License conversion timeline - -CockroachDB version | License | Converts to Apache 2.0 ---------------------|---------|---------------------------- -23.1 | Business Source License | May 16, 2026 -22.2 | Business Source License | Dec 6, 2025 -22.1 | Business Source License | May 24, 2025 -21.2 | Business Source License | Nov 16, 2024 -21.1 | Business Source License | May 18, 2024 -20.2 | Business Source License | Nov 10, 2023 -20.1 | Business Source License | May 12, 2023 -19.2 | Apache 2.0 | - -19.1 | Apache 2.0 | - -2.1 | Apache 2.0 | - -2.0 | Apache 2.0 | - - -## Feature licensing - -The table below shows how certain core and Enterprise features are licensed: - -Feature | BSL | CCL (free) | CCL (paid) ------------------|:-----:|:-----------------:|:---------------: -**[Import]({% link {{ page.version.version }}/import.md %})** | ✓ | | -**[Export]({% link {{ page.version.version }}/export.md %})** | ✓ | | -**[Restore]({% link {{ page.version.version }}/restore.md %})** | | ✓ | -**[Full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups)** | | ✓ | -**[Incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups)** | | | ✓ -**[Other advanced backup features]({% link {{ page.version.version }}/backup.md %})** | | | ✓ -**[Basic changefeed](create-and-configure-changefeeds.html?filters=core)** | | ✓ | -**[{{ site.data.products.enterprise }} changefeed]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}#configure-a-changefeed)** | | | ✓ -**[Table-level zone configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#replication-zone-levels)** | ✓ | | -**[Multi-region capabilities]({% link {{ page.version.version }}/multiregion-overview.md %})** | | | ✓ -**[Follower reads]({% link {{ page.version.version }}/follower-reads.md %})** | | | ✓ -**[Bounded staleness reads]({% link {{ page.version.version }}/follower-reads.md %}#bounded-staleness-reads)** | | | ✓ -**[PL/pgSQL]({% link {{ page.version.version }}/plpgsql.md %})** | | | ✓ -**[Node map]({% link {{ page.version.version }}/enable-node-map.md %})** | | | ✓ -**[Encryption at rest]({% link {{ page.version.version }}/security-reference/encryption.md %}#encryption-at-rest-enterprise)** | | | ✓ -**[Role-based access management]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles)** | ✓ | | -**[Password and certificate authentication]({% link {{ page.version.version }}/authentication.md %})** | ✓ | | -**[GSSAPI with Kerberos authentication]({% link {{ page.version.version }}/gssapi_authentication.md %})** | | | ✓ -**[All other core features](https://www.cockroachlabs.com/compare/)** | ✓ | | - -{{site.data.alerts.callout_info}} -Individual feature licensing may change with each release of CockroachDB. You can use the dropdown menu at the top of the page to view documentation for other versions of CockroachDB. -{{site.data.alerts.end}} - -## Obtain a license - -All CockroachDB code is included in the same binary. No license key is required to access BSL and CCL (Free) features. To access CCL (Paid) features, users have two options: - -- An **Enterprise license** enables you to use CockroachDB Enterprise features for longer periods (one year or more). To upgrade to an Enterprise license, contact Sales. -- A **Trial license** enables you to try out CockroachDB Enterprise features for 30 days for free. To obtain a Trial license, contact Sales. - -{{site.data.alerts.callout_success}} -For quick local testing of Enterprise features, you can use the [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %}) command, which starts a temporary, in-memory cluster with a SQL shell open and a trial license applied automatically. -{{site.data.alerts.end}} - -{{site.data.alerts.callout_info}} -Cockroach Labs encourages non-commercial academic research involving CockroachDB. For such projects, please [contact us](https://support.cockroachlabs.com/hc/en-us) to discuss a possible licensing arrangement. -{{site.data.alerts.end}} - -## Set a license - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -## Verify a license - -To verify a license, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) command to check the organization name and license key: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ -~~~ - cluster.organization -+----------------------+ - Acme Company -(1 row) -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING enterprise.license; -~~~ -~~~ - enterprise.license -+-------------------------------------------+ - crl-0-ChB1x... -(1 row) -~~~ - -The license setting is also logged in the cockroach.log on the node where the command is run: - -{% include_cached copy-clipboard.html %} -~~~ sql -$ cat cockroach.log | grep license -~~~ -~~~ -I171116 18:11:48.279604 1514 sql/event_log.go:102 [client=[::1]:56357,user=root,n1] Event: "set_cluster_setting", target: 0, info: {SettingName:enterprise.license Value:xxxxxxxxxxxx User:root} -~~~ - -## Monitor for license expiry - -You can monitor the time until your license expires with [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}). The `seconds_until_enterprise_license_expiry` metric reports the number of seconds until the Enterprise license on a cluster expires. It will report 0 if there is no license or a negative number if the license has already expired. For more information, see [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). - -## Renew an expired license - -After your license expires, the Enterprise features stop working, but your production setup is unaffected. For example, the backup and restore features would not work until the license is renewed, but you would be able to continue using all other features of CockroachDB without interruption. - -To renew an expired license, contact Sales and then [set](#set-a-license) the new license. - -## FAQs - -### Can I host CockroachDB as a service for internal use at my organization? - -Yes, employees and contractors can use your internal CockroachDB instance as a service, but no people outside of your organization will be able to use it without purchasing a license. Use of Enterprise features will always require a license. - -### What constitutes hosting CockroachDB as a service? - -Hosting CockroachDB as a service means creating an offering that allows third parties (other than your employees and contractors) to operate a database. Specifically, third parties cannot modify table schemas. - -### I would like to reuse a single component from the CockroachDB project in my own software, which uses the AGPL or another open-source license. Is this possible? - -The CockroachDB team is committed to supporting the open-source community and willing to consider extracting specific internal components that are generally useful as a separate project with its own license, for example APL. For more details, feel free to [contact us](https://support.cockroachlabs.com/hc/en-us). - -### Can I fork the CockroachDB project pre-BSL and create my own CockroachDB derivative with a different license? - -You can fork any historical version of CockroachDB in your own project, as allowed by the license available for that version, and modify it for your purpose. Note however that only the copyright holder (Cockroach Labs) can relicense the components that you forked from: your derivative will need to keep the original license at the time of the fork. Any component you copy from a BSL-licensed CockroachDB into your project will make the BSL apply to your project as well. - -### If Cockroach Labs is making available software to me under the Business Source License (BSL), does Cockroach Labs grant me any patent rights? - -The BSL does not explicitly reference patents in the text of the license. However, Cockroach Labs believes that the BSL includes an implied patent license and intends that in this case the BSL include an implied patent license under those patent claims that are licenseable by Cockroach Labs which are necessarily infringed by any permitted use of the BSL licensed software alone. +{% include common/licensing-faqs.md %} 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 3fe35591bfb..b9d2b75b41a 100644 --- a/src/current/v23.2/set-up-physical-cluster-replication.md +++ b/src/current/v23.2/set-up-physical-cluster-replication.md @@ -86,7 +86,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 the application 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 %}) to the cluster: {% include_cached copy-clipboard.html %} ~~~ sql @@ -223,7 +223,7 @@ Connect to your standby cluster's system virtual cluster using [`cockroach sql`] The prompt will include `system` when you are connected to the system virtual cluster. -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 %}) to the cluster: {% include_cached copy-clipboard.html %} ~~~ sql diff --git a/src/current/v23.2/sql-statements.md b/src/current/v23.2/sql-statements.md index 8860cf1ef58..06a3243212c 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]({% link {{ page.version.version }}/partitioning.md %}). [`ALTER PROCEDURE`]({% link {{ page.version.version }}/alter-procedure.md %}) | Modify a [stored procedure]({% link {{ page.version.version }}/stored-procedures.md %}). [`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. diff --git a/src/current/v23.2/ui-overview.md b/src/current/v23.2/ui-overview.md index 8755f23e4d9..579dc9e9328 100644 --- a/src/current/v23.2/ui-overview.md +++ b/src/current/v23.2/ui-overview.md @@ -14,6 +14,8 @@ Authorized CockroachDB {{ site.data.products.advanced }} cluster users can visit Refer to: [Network Authorization for CockroachDB Cloud Clusters—DB Console]({% link cockroachcloud/network-authorization.md %}#db-console) {{site.data.alerts.end}} + + ## Authentication The DB Console supports username/password login and single sign-on (SSO) for ({{ site.data.products.advanced }} and {{ site.data.products.enterprise }} clusters). diff --git a/src/current/v24.1/enterprise-licensing.md b/src/current/v24.1/enterprise-licensing.md deleted file mode 100644 index 62e861e2b59..00000000000 --- a/src/current/v24.1/enterprise-licensing.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Enterprise Features -summary: Learn about CockroachDB features that require an Enterprise license key. -toc: true -docs_area: ---- - -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}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -{% include {{ page.version.version }}/misc/enterprise-features.md %} - -## See also - -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Enterprise Trial –– Get Started]({% link {{ page.version.version }}/get-started-with-enterprise-trial.md %}) diff --git a/src/current/v24.1/get-started-with-enterprise-trial.md b/src/current/v24.1/get-started-with-enterprise-trial.md deleted file mode 100644 index 7820a1bb3a3..00000000000 --- a/src/current/v24.1/get-started-with-enterprise-trial.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Enterprise Trial –– Get Started -summary: Check out this page to get started with your CockroachDB Enterprise Trial -toc: true -license: true -docs_area: ---- - -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 - -If you haven't already, you'll need to [locally install]({% link {{ page.version.version }}/install-cockroachdb.md %}), [remotely deploy]({% link {{ page.version.version }}/manual-deployment.md %}), or [orchestrate]({% link {{ page.version.version }}/kubernetes-overview.md %}) CockroachDB. - -## Enable Enterprise features - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to verify your license: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ - -## Use Enterprise features - -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 %} - -## Getting help - -If you or your team need any help during your trial, our engineers are available on [CockroachDB Community Slack](https://cockroachdb.slack.com), [our forum](https://forum.cockroachlabs.com/), or [GitHub](https://github.com/cockroachdb/cockroach). - -Also consider checking out [Cockroach University](https://university.cockroachlabs.com/) for free online courses that help you get the most out of CockroachDB. - -## See also - -- [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Cockroach University](https://university.cockroachlabs.com/) diff --git a/src/current/v24.1/licensing-faqs.md b/src/current/v24.1/licensing-faqs.md index 971bc2ba7e9..680cc0e3b7d 100644 --- a/src/current/v24.1/licensing-faqs.md +++ b/src/current/v24.1/licensing-faqs.md @@ -5,158 +5,4 @@ toc: true docs_area: get_started --- -{{site.data.alerts.callout_info}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). - -## Types of licenses - -Type | Description --------------|------------ -**Apache 2.0 License** | Core features under the Apache License are free to use and fully open-source. BSL features convert to this license three years after their release. For license conversion dates, see the [table below](#license-conversion-timeline). -**Business Source License**| BSL features are free to use and the source code is available, but users may not use CockroachDB [as a service](#what-constitutes-hosting-cockroachdb-as-a-service) without an agreement with Cockroach Labs. The BSL is not certified as an open-source license, but most of the [Open Source Initiative](https://wikipedia.org/wiki/Open_Source_Initiative) (OSI) criteria are met. -**Cockroach
Community License** | - -For additional custom licensing options, [contact us](https://support.cockroachlabs.com/hc/en-us). - -For each BSL release all associated alpha, beta, major, and minor (point) releases will become Apache 2.0 on the same day three years after the major release date. Once a release is published under the BSL, the license cannot be changed to prevent code from becoming open-source at the specified change date. The following table lists the current license for non-CCL features for each published release: - -### License conversion timeline - -CockroachDB version | License | Converts to Apache 2.0 ---------------------|---------|---------------------------- -24.1 | Business Source License | May 20, 2027 -23.1 | Business Source License | Feb 5, 2027 -23.1 | Business Source License | May 16, 2026 -22.2 | Business Source License | Dec 6, 2025 -22.1 | Business Source License | May 24, 2025 -21.2 | Business Source License | Nov 16, 2024 -21.1 | Business Source License | May 18, 2024 -20.2 | Business Source License | Nov 10, 2023 -20.1 | Business Source License | May 12, 2023 -19.2 | Apache 2.0 | - -19.1 | Apache 2.0 | - -2.1 | Apache 2.0 | - -2.0 | Apache 2.0 | - - -## Feature licensing - -The table below shows how certain core and Enterprise features are licensed: - -Feature | BSL | CCL (free) | CCL (paid) ------------------|:-----:|:-----------------:|:---------------: -**[Import]({% link {{ page.version.version }}/import-into.md %})** | ✓ | | -**[Export]({% link {{ page.version.version }}/export.md %})** | ✓ | | -**[Restore]({% link {{ page.version.version }}/restore.md %})** | | ✓ | -**[Full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups)** | | ✓ | -**[Incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups)** | | | ✓ -**[Other advanced backup features]({% link {{ page.version.version }}/backup.md %})** | | | ✓ -**[Basic changefeed](create-and-configure-changefeeds.html?filters=core)** | | ✓ | -**[{{ site.data.products.enterprise }} changefeed]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}#configure-a-changefeed)** | | | ✓ -**[Table-level zone configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#replication-zone-levels)** | ✓ | | -**[Multi-region capabilities]({% link {{ page.version.version }}/multiregion-overview.md %})** | | | ✓ -**[Follower reads]({% link {{ page.version.version }}/follower-reads.md %})** | | | ✓ -**[Bounded staleness reads]({% link {{ page.version.version }}/follower-reads.md %}#bounded-staleness-reads)** | | | ✓ -**[PL/pgSQL]({% link {{ page.version.version }}/plpgsql.md %})** | | | ✓ -**[Node map]({% link {{ page.version.version }}/enable-node-map.md %})** | | | ✓ -**[Encryption at rest]({% link {{ page.version.version }}/security-reference/encryption.md %}#encryption-at-rest-enterprise)** | | | ✓ -**[Role-based access management]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles)** | ✓ | | -**[Password and certificate authentication]({% link {{ page.version.version }}/authentication.md %})** | ✓ | | -**[GSSAPI with Kerberos authentication]({% link {{ page.version.version }}/gssapi_authentication.md %})** | | | ✓ -**[All other core features](https://www.cockroachlabs.com/compare/)** | ✓ | | - -{{site.data.alerts.callout_info}} -Individual feature licensing may change with each release of CockroachDB. You can use the dropdown menu at the top of the page to view documentation for other versions of CockroachDB. -{{site.data.alerts.end}} - -## Obtain a license - -All CockroachDB code is included in the same binary. No license key is required to access BSL and CCL (Free) features. To access CCL (Paid) features, users have two options: - -- An **Enterprise license** enables you to use CockroachDB Enterprise features for longer periods (one year or more). To upgrade to an Enterprise license, contact Sales. -- A **Trial license** enables you to try out CockroachDB Enterprise features for 30 days for free. To obtain a Trial license, contact Sales. - -{{site.data.alerts.callout_success}} -For quick local testing of Enterprise features, you can use the [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %}) command, which starts a temporary, in-memory cluster with a SQL shell open and a trial license applied automatically. -{{site.data.alerts.end}} - -{{site.data.alerts.callout_info}} -Cockroach Labs encourages non-commercial academic research involving CockroachDB. For such projects, please [contact us](https://support.cockroachlabs.com/hc/en-us) to discuss a possible licensing arrangement. -{{site.data.alerts.end}} - -## Set a license - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -## Verify a license - -To verify a license, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) command to check the organization name and license key: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ -~~~ - cluster.organization -+----------------------+ - Acme Company -(1 row) -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING enterprise.license; -~~~ -~~~ - enterprise.license -+-------------------------------------------+ - crl-0-ChB1x... -(1 row) -~~~ - -The license setting is also logged in the cockroach.log on the node where the command is run: - -{% include_cached copy-clipboard.html %} -~~~ sql -$ cat cockroach.log | grep license -~~~ -~~~ -I171116 18:11:48.279604 1514 sql/event_log.go:102 [client=[::1]:56357,user=root,n1] Event: "set_cluster_setting", target: 0, info: {SettingName:enterprise.license Value:xxxxxxxxxxxx User:root} -~~~ - -## Monitor for license expiry - -You can monitor the time until your license expires in two ways: - -1. [DB console]({% link {{ page.version.version }}/ui-overview.md %}): The [license expiration message]({% link {{ page.version.version }}/ui-overview.md %}#license-expiration-message) displays the number of days until the expiration date or the days since the expiration date. -1. [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}): The `seconds_until_enterprise_license_expiry` metric reports the number of seconds until the enterprise license on a cluster expires. It will report `0` if there is no license, and a negative number if the license has already expired. For more information, see [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). - -## Renew an expired license - -After your license expires, the Enterprise features stop working, but your production setup is unaffected. For example, the backup and restore features would not work until the license is renewed, but you would be able to continue using all other features of CockroachDB without interruption. - -To renew an expired license, contact Sales and then [set](#set-a-license) the new license. - -## FAQs - -### Can I host CockroachDB as a service for internal use at my organization? - -Yes, employees and contractors can use your internal CockroachDB instance as a service, but no people outside of your organization will be able to use it without purchasing a license. Use of Enterprise features will always require a license. - -### What constitutes hosting CockroachDB as a service? - -Hosting CockroachDB as a service means creating an offering that allows third parties (other than your employees and contractors) to operate a database. Specifically, third parties cannot modify table schemas. - -### I would like to reuse a single component from the CockroachDB project in my own software, which uses the AGPL or another open-source license. Is this possible? - -The CockroachDB team is committed to supporting the open-source community and willing to consider extracting specific internal components that are generally useful as a separate project with its own license, for example APL. For more details, feel free to [contact us](https://support.cockroachlabs.com/hc/en-us). - -### Can I fork the CockroachDB project pre-BSL and create my own CockroachDB derivative with a different license? - -You can fork any historical version of CockroachDB in your own project, as allowed by the license available for that version, and modify it for your purpose. Note however that only the copyright holder (Cockroach Labs) can relicense the components that you forked from: your derivative will need to keep the original license at the time of the fork. Any component you copy from a BSL-licensed CockroachDB into your project will make the BSL apply to your project as well. - -### If Cockroach Labs is making available software to me under the Business Source License (BSL), does Cockroach Labs grant me any patent rights? - -The BSL does not explicitly reference patents in the text of the license. However, Cockroach Labs believes that the BSL includes an implied patent license and intends that in this case the BSL include an implied patent license under those patent claims that are licenseable by Cockroach Labs which are necessarily infringed by any permitted use of the BSL licensed software alone. +{% include common/licensing-faqs.md %} diff --git a/src/current/v24.1/sql-statements.md b/src/current/v24.1/sql-statements.md index 1e94e8f5531..302904cdc91 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]({% link {{ page.version.version }}/partitioning.md %}). [`ALTER PROCEDURE`]({% link {{ page.version.version }}/alter-procedure.md %}) | Modify a [stored procedure]({% link {{ page.version.version }}/stored-procedures.md %}). [`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. diff --git a/src/current/v24.1/ui-overview.md b/src/current/v24.1/ui-overview.md index 9326c48a8a7..64b7bd652cf 100644 --- a/src/current/v24.1/ui-overview.md +++ b/src/current/v24.1/ui-overview.md @@ -151,6 +151,8 @@ By default, the DB Console shares anonymous usage details with Cockroach Labs. F If you have [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license), a license expiration message is displayed at the top-right of the DB Console. While the license is valid, the message will read `License expires in X days`, where `X` is the number of days. If the license is no longer valid, the message will read `License expired X days ago`. Hovering over either message displays a tooltip with the expiration date of the license. +{% include common/license-expiration-messages.md %} + ## See also - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %}) diff --git a/src/current/v24.2/enterprise-licensing.md b/src/current/v24.2/enterprise-licensing.md deleted file mode 100644 index 62e861e2b59..00000000000 --- a/src/current/v24.2/enterprise-licensing.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Enterprise Features -summary: Learn about CockroachDB features that require an Enterprise license key. -toc: true -docs_area: ---- - -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}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -{% include {{ page.version.version }}/misc/enterprise-features.md %} - -## See also - -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Enterprise Trial –– Get Started]({% link {{ page.version.version }}/get-started-with-enterprise-trial.md %}) diff --git a/src/current/v24.2/get-started-with-enterprise-trial.md b/src/current/v24.2/get-started-with-enterprise-trial.md deleted file mode 100644 index 7820a1bb3a3..00000000000 --- a/src/current/v24.2/get-started-with-enterprise-trial.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Enterprise Trial –– Get Started -summary: Check out this page to get started with your CockroachDB Enterprise Trial -toc: true -license: true -docs_area: ---- - -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 - -If you haven't already, you'll need to [locally install]({% link {{ page.version.version }}/install-cockroachdb.md %}), [remotely deploy]({% link {{ page.version.version }}/manual-deployment.md %}), or [orchestrate]({% link {{ page.version.version }}/kubernetes-overview.md %}) CockroachDB. - -## Enable Enterprise features - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -You can then use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) command to verify your license: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ - -## Use Enterprise features - -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 %} - -## Getting help - -If you or your team need any help during your trial, our engineers are available on [CockroachDB Community Slack](https://cockroachdb.slack.com), [our forum](https://forum.cockroachlabs.com/), or [GitHub](https://github.com/cockroachdb/cockroach). - -Also consider checking out [Cockroach University](https://university.cockroachlabs.com/) for free online courses that help you get the most out of CockroachDB. - -## See also - -- [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}) -- [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) -- [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) -- [Cockroach University](https://university.cockroachlabs.com/) diff --git a/src/current/v24.2/licensing-faqs.md b/src/current/v24.2/licensing-faqs.md index 971bc2ba7e9..680cc0e3b7d 100644 --- a/src/current/v24.2/licensing-faqs.md +++ b/src/current/v24.2/licensing-faqs.md @@ -5,158 +5,4 @@ toc: true docs_area: get_started --- -{{site.data.alerts.callout_info}} -{% include common/license/evolving.md %} -{{site.data.alerts.end}} - -CockroachDB is made available under the [CockroachDB Software License](https://www.cockroachlabs.com/cockroachdb-software-license/). - -## Types of licenses - -Type | Description --------------|------------ -**Apache 2.0 License** | Core features under the Apache License are free to use and fully open-source. BSL features convert to this license three years after their release. For license conversion dates, see the [table below](#license-conversion-timeline). -**Business Source License**| BSL features are free to use and the source code is available, but users may not use CockroachDB [as a service](#what-constitutes-hosting-cockroachdb-as-a-service) without an agreement with Cockroach Labs. The BSL is not certified as an open-source license, but most of the [Open Source Initiative](https://wikipedia.org/wiki/Open_Source_Initiative) (OSI) criteria are met. -**Cockroach
Community License** | - -For additional custom licensing options, [contact us](https://support.cockroachlabs.com/hc/en-us). - -For each BSL release all associated alpha, beta, major, and minor (point) releases will become Apache 2.0 on the same day three years after the major release date. Once a release is published under the BSL, the license cannot be changed to prevent code from becoming open-source at the specified change date. The following table lists the current license for non-CCL features for each published release: - -### License conversion timeline - -CockroachDB version | License | Converts to Apache 2.0 ---------------------|---------|---------------------------- -24.1 | Business Source License | May 20, 2027 -23.1 | Business Source License | Feb 5, 2027 -23.1 | Business Source License | May 16, 2026 -22.2 | Business Source License | Dec 6, 2025 -22.1 | Business Source License | May 24, 2025 -21.2 | Business Source License | Nov 16, 2024 -21.1 | Business Source License | May 18, 2024 -20.2 | Business Source License | Nov 10, 2023 -20.1 | Business Source License | May 12, 2023 -19.2 | Apache 2.0 | - -19.1 | Apache 2.0 | - -2.1 | Apache 2.0 | - -2.0 | Apache 2.0 | - - -## Feature licensing - -The table below shows how certain core and Enterprise features are licensed: - -Feature | BSL | CCL (free) | CCL (paid) ------------------|:-----:|:-----------------:|:---------------: -**[Import]({% link {{ page.version.version }}/import-into.md %})** | ✓ | | -**[Export]({% link {{ page.version.version }}/export.md %})** | ✓ | | -**[Restore]({% link {{ page.version.version }}/restore.md %})** | | ✓ | -**[Full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups)** | | ✓ | -**[Incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#incremental-backups)** | | | ✓ -**[Other advanced backup features]({% link {{ page.version.version }}/backup.md %})** | | | ✓ -**[Basic changefeed](create-and-configure-changefeeds.html?filters=core)** | | ✓ | -**[{{ site.data.products.enterprise }} changefeed]({% link {{ page.version.version }}/create-and-configure-changefeeds.md %}#configure-a-changefeed)** | | | ✓ -**[Table-level zone configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#replication-zone-levels)** | ✓ | | -**[Multi-region capabilities]({% link {{ page.version.version }}/multiregion-overview.md %})** | | | ✓ -**[Follower reads]({% link {{ page.version.version }}/follower-reads.md %})** | | | ✓ -**[Bounded staleness reads]({% link {{ page.version.version }}/follower-reads.md %}#bounded-staleness-reads)** | | | ✓ -**[PL/pgSQL]({% link {{ page.version.version }}/plpgsql.md %})** | | | ✓ -**[Node map]({% link {{ page.version.version }}/enable-node-map.md %})** | | | ✓ -**[Encryption at rest]({% link {{ page.version.version }}/security-reference/encryption.md %}#encryption-at-rest-enterprise)** | | | ✓ -**[Role-based access management]({% link {{ page.version.version }}/security-reference/authorization.md %}#roles)** | ✓ | | -**[Password and certificate authentication]({% link {{ page.version.version }}/authentication.md %})** | ✓ | | -**[GSSAPI with Kerberos authentication]({% link {{ page.version.version }}/gssapi_authentication.md %})** | | | ✓ -**[All other core features](https://www.cockroachlabs.com/compare/)** | ✓ | | - -{{site.data.alerts.callout_info}} -Individual feature licensing may change with each release of CockroachDB. You can use the dropdown menu at the top of the page to view documentation for other versions of CockroachDB. -{{site.data.alerts.end}} - -## Obtain a license - -All CockroachDB code is included in the same binary. No license key is required to access BSL and CCL (Free) features. To access CCL (Paid) features, users have two options: - -- An **Enterprise license** enables you to use CockroachDB Enterprise features for longer periods (one year or more). To upgrade to an Enterprise license, contact Sales. -- A **Trial license** enables you to try out CockroachDB Enterprise features for 30 days for free. To obtain a Trial license, contact Sales. - -{{site.data.alerts.callout_success}} -For quick local testing of Enterprise features, you can use the [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %}) command, which starts a temporary, in-memory cluster with a SQL shell open and a trial license applied automatically. -{{site.data.alerts.end}} - -{{site.data.alerts.callout_info}} -Cockroach Labs encourages non-commercial academic research involving CockroachDB. For such projects, please [contact us](https://support.cockroachlabs.com/hc/en-us) to discuss a possible licensing arrangement. -{{site.data.alerts.end}} - -## Set a license - -{% include {{ page.version.version }}/misc/set-enterprise-license.md %} - -## Verify a license - -To verify a license, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) command to check the organization name and license key: - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING cluster.organization; -~~~ -~~~ - cluster.organization -+----------------------+ - Acme Company -(1 row) -~~~ - -{% include_cached copy-clipboard.html %} -~~~ sql -> SHOW CLUSTER SETTING enterprise.license; -~~~ -~~~ - enterprise.license -+-------------------------------------------+ - crl-0-ChB1x... -(1 row) -~~~ - -The license setting is also logged in the cockroach.log on the node where the command is run: - -{% include_cached copy-clipboard.html %} -~~~ sql -$ cat cockroach.log | grep license -~~~ -~~~ -I171116 18:11:48.279604 1514 sql/event_log.go:102 [client=[::1]:56357,user=root,n1] Event: "set_cluster_setting", target: 0, info: {SettingName:enterprise.license Value:xxxxxxxxxxxx User:root} -~~~ - -## Monitor for license expiry - -You can monitor the time until your license expires in two ways: - -1. [DB console]({% link {{ page.version.version }}/ui-overview.md %}): The [license expiration message]({% link {{ page.version.version }}/ui-overview.md %}#license-expiration-message) displays the number of days until the expiration date or the days since the expiration date. -1. [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}): The `seconds_until_enterprise_license_expiry` metric reports the number of seconds until the enterprise license on a cluster expires. It will report `0` if there is no license, and a negative number if the license has already expired. For more information, see [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). - -## Renew an expired license - -After your license expires, the Enterprise features stop working, but your production setup is unaffected. For example, the backup and restore features would not work until the license is renewed, but you would be able to continue using all other features of CockroachDB without interruption. - -To renew an expired license, contact Sales and then [set](#set-a-license) the new license. - -## FAQs - -### Can I host CockroachDB as a service for internal use at my organization? - -Yes, employees and contractors can use your internal CockroachDB instance as a service, but no people outside of your organization will be able to use it without purchasing a license. Use of Enterprise features will always require a license. - -### What constitutes hosting CockroachDB as a service? - -Hosting CockroachDB as a service means creating an offering that allows third parties (other than your employees and contractors) to operate a database. Specifically, third parties cannot modify table schemas. - -### I would like to reuse a single component from the CockroachDB project in my own software, which uses the AGPL or another open-source license. Is this possible? - -The CockroachDB team is committed to supporting the open-source community and willing to consider extracting specific internal components that are generally useful as a separate project with its own license, for example APL. For more details, feel free to [contact us](https://support.cockroachlabs.com/hc/en-us). - -### Can I fork the CockroachDB project pre-BSL and create my own CockroachDB derivative with a different license? - -You can fork any historical version of CockroachDB in your own project, as allowed by the license available for that version, and modify it for your purpose. Note however that only the copyright holder (Cockroach Labs) can relicense the components that you forked from: your derivative will need to keep the original license at the time of the fork. Any component you copy from a BSL-licensed CockroachDB into your project will make the BSL apply to your project as well. - -### If Cockroach Labs is making available software to me under the Business Source License (BSL), does Cockroach Labs grant me any patent rights? - -The BSL does not explicitly reference patents in the text of the license. However, Cockroach Labs believes that the BSL includes an implied patent license and intends that in this case the BSL include an implied patent license under those patent claims that are licenseable by Cockroach Labs which are necessarily infringed by any permitted use of the BSL licensed software alone. +{% include common/licensing-faqs.md %} diff --git a/src/current/v24.2/sql-statements.md b/src/current/v24.2/sql-statements.md index 1e94e8f5531..302904cdc91 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]({% link {{ page.version.version }}/partitioning.md %}). [`ALTER PROCEDURE`]({% link {{ page.version.version }}/alter-procedure.md %}) | Modify a [stored procedure]({% link {{ page.version.version }}/stored-procedures.md %}). [`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. diff --git a/src/current/v24.2/ui-overview.md b/src/current/v24.2/ui-overview.md index 9326c48a8a7..64b7bd652cf 100644 --- a/src/current/v24.2/ui-overview.md +++ b/src/current/v24.2/ui-overview.md @@ -151,6 +151,8 @@ By default, the DB Console shares anonymous usage details with Cockroach Labs. F If you have [set a license]({% link {{ page.version.version }}/licensing-faqs.md %}#set-a-license), a license expiration message is displayed at the top-right of the DB Console. While the license is valid, the message will read `License expires in X days`, where `X` is the number of days. If the license is no longer valid, the message will read `License expired X days ago`. Hovering over either message displays a tooltip with the expiration date of the license. +{% include common/license-expiration-messages.md %} + ## See also - [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %})
24.2

Generic query plans

- Users can now enable generic query plans. Generic query plans optimize query execution for prepared statements by reusing precompiled query plans, and significantly reduce the CPU overhead associated with parsing and planning repeated queries, at the expense of plan quality. This feature is in Preview and requires an Enterprise license. + Users can now enable generic query plans. Generic query plans optimize query execution for prepared statements by reusing precompiled query plans, and significantly reduce the CPU overhead associated with parsing and planning repeated queries, at the expense of plan quality. This feature is in Preview.

24.2 Filter change data Not supported without an {{ site.data.products.enterprise }} license or using EXPERIMENTAL CHANGEFEED FOR.Not supported using EXPERIMENTAL CHANGEFEED FOR. Use CDC queries with CREATE CHANGEFEED to define the emitted change data.