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, and shows you how to obtain and set trial and enterprise license keys for CockroachDB.

Enterprise features

Feature Description
BACKUP / RESTORE CockroachDB's BACKUP statement allows you to create full or incremental backups of your cluster's schema and data that are consistent as of a given timestamp. The RESTORE statement restores your cluster's schemas and data from an enterprise BACKUP stored on a services such as AWS S3, Google Cloud Storage, NFS, or HTTP storage.
Change Data Capture Change data capture (CDC) provides efficient, distributed, row-level change feeds into Apache Kafka for downstream processing such as reporting, caching, or full-text indexing.
Cluster Visualization The Node Map visualizes the geographical configuration of a multi-regional cluster by plotting the node localities on a world map.
Table Partitioning CockroachDB allows you to define table partitions, thus giving you row-level control of how and where your data is stored. Partitioning enables you to reduce latencies and costs and can assist in meeting regulatory requirements for your data.
Zone-aware index selection New in v19.1: Given multiple identical indexes that have different locality constraints using replication zones, the optimizer will prefer the index that is closest to the gateway node that is planning the query. In a properly configured geo-distributed cluster, this can lead to performance improvements due to improved data locality and reduced network traffic.

Types of licenses

Type Description
Trial License A trial license enables you to try out CockroachDB enterprise features for 30 days for free.
Enterprise License A paid enterprise license enables you to use CockroachDB enterprise features for longer periods (one year or more).

Obtain a trial or enterprise license key

To obtain a trial license key, fill out the registration form and receive your trial license key via email within a few minutes.

To upgrade to an enterprise license, contact Sales.

Set the trial or enterprise license key

As the CockroachDB root user, open the built-in SQL shell 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 command to set the name of your organization and the license key:

copy
icon/buttons/copy
$ cockroach sql --insecure
copy
icon/buttons/copy
>  SET CLUSTER SETTING cluster.organization = 'Acme Company';
copy
icon/buttons/copy
>  SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx';

Verify the license key

To verify the license key, open the built-in SQL shell and use the SHOW CLUSTER SETTING command to check the organization name and license key:

copy
icon/buttons/copy
>  SHOW CLUSTER SETTING cluster.organization;
+----------------------+
| cluster.organization |
+----------------------+
| Acme Company         |
+----------------------+
(1 row)
copy
icon/buttons/copy
>  SHOW CLUSTER SETTING enterprise.license;
+--------------------------------------------------------------------+
|                         enterprise.license                         |
+--------------------------------------------------------------------+
| xxxxxxxxxxxx                                                       |
+--------------------------------------------------------------------+
(1 row)

The license setting is also logged in the cockroach.log on the node where the command is run:

copy
icon/buttons/copy
$ 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}

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 the new license.

See also



Yes No