Licensing FAQs

On this page

CockroachDB is made available under the CockroachDB Software License.

Types of licenses

For additional custom licensing options, contact 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

Feature licensing

The table below shows how certain core and Enterprise features are licensed:

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.

Set a license

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:

$ cockroach sql --insecure

>  SET CLUSTER SETTING cluster.organization = 'Acme Company';

>  SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx';

Verify a license

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

>  SHOW CLUSTER SETTING cluster.organization;

  cluster.organization
+----------------------+
  Acme Company
(1 row)

>  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:

$ 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. 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.

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.

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.

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.

Was this helpful?