Congratulations on starting your CockroachDB Enterprise Trial! With it, you'll not only get access to CockroachDB's core capabilities like high availability and
SERIALIZABLE isolation, but also our Enterprise-only features like distributed
RESTORE, geo-partitioning, and cluster visualization.
If you haven't already, you'll need to locally install, remotely deploy, or orchestrate CockroachDB.
Enable Enterprise features
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.
$ cockroach sql --insecure
If you've secured your deployment, you'll need to include the flags for your certificates instead of the
Now, use the
SET CLUSTER SETTING command to set the name of your organization and the license key:
> SET CLUSTER SETTING cluster.organization = 'Acme Company'; SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx';
Then verify your organization in response to the following query:
> SHOW CLUSTER SETTING cluster.organization;
Use Enterprise features
Your cluster now has access to all of CockroachDB's enterprise features for the length of the trial:
|Geo-Partitioning||This feature gives you row-level control of how and where your data is stored to dramatically reduce read and write latencies and assist in meeting regulatory requirements in multi-region deployments.|
|Follower Reads||This feature reduces read latency in multi-region deployments by using the closest replica at the expense of reading slightly historical data.|
||This feature creates full or incremental backups of your cluster's schema and data that are consistent as of a given timestamp, stored on a service such as AWS S3, Google Cloud Storage, NFS, or HTTP storage.
Backups can be locality-aware such that each node writes files only to the backup destination that matches the node's locality. This is useful for reducing cloud storage data transfer costs by keeping data within cloud regions and complying with data domiciling requirements.
||This feature restores your cluster's schemas and data from an enterprise
|Change Data Capture (CDC)||This feature provides efficient, distributed, row-level change feeds into Apache Kafka for downstream processing such as reporting, caching, or full-text indexing.|
|Node Map||This feature visualizes the geographical configuration of a cluster by plotting node localities on a world map.|
|Locality-Aware Index Selection||Given multiple identical indexes that have different locality constraints using replication zones, the cost-based optimizer will prefer the index that is closest to the gateway node that is planning the query. In multi-region deployments, this can lead to performance improvements due to improved data locality and reduced network traffic.|
|Encryption at Rest||Supplementing CockroachDB's encryption in flight capabilities, this feature provides transparent encryption of a node's data on the local disk. It allows encryption of all files on disk using AES in counter mode, with all key sizes allowed.|
|GSSAPI with Kerberos Authentication||CockroachDB supports the Generic Security Services API (GSSAPI) with Kerberos authentication, which lets you use an external enterprise directory system that supports Kerberos, such as Active Directory.|
||This feature uses the CockroachDB distributed execution engine to quickly get large sets of data out of CockroachDB in a CSV format that can be ingested by downstream systems.|
If you or your team need any help during your trial, our engineers are available on CockroachDB Community Slack, our forum, or GitHub.