Setting or Replacing a License min read


Info

This topic does not apply to SingleStore Managed Service.

Info

If you are managing your cluster with MemSQL Ops, go here instead.

This page describes how to set or replace your license. If you need a new free or Enterprise trial license, go to the SingleStore Customer Portal. If you need a non-trial Enterprise license, contact sales@singlestore.com.

Setting a license

To update or replace your license, use the sdb-admin set-license command. Replace <license> with your license key from the SingleStore Customer Portal.

sdb-admin set-license --license <license>

This is the same process for both online and offline scenarios, and unlike previous licenses that shipped as part of the SingleStore DB tarball file, there is no license file that you need to keep track of on your host machines.

Determining capacity and usage for your license

Using SingleStore DB Studio

SingleStore DB Studio integrates with both RAM-based and unit-based licenses for reporting on capacity versus licensed usage. You can install and use SingleStore DB Studio with existing clusters managed by MemSQL Ops, or use Studio in new deployments managed by the SingleStore management tools.

Using SingleStore DB directly

You can use SHOW STATUS EXTENDED LIKE "%capacity%" to see your license capacity compared to your current usage. For RAM-based licenses, you will see the following output:

SHOW STATUS EXTENDED LIKE "%capacity%";
****
+--------------------------+-----------+
| Variable_name            | Value     |
+--------------------------+-----------+
| License_capacity         | 131072 MB |
| Maximum_cluster_capacity | 131072 MB |
| Used_cluster_capacity    | 13314 MB  |
+--------------------------+-----------+

And if you have a unit-based license, you will see the following output:

SHOW STATUS EXTENDED LIKE "%capacity%";
****
+--------------------------+---------+
| Variable_name            | Value   |
+--------------------------+---------+
| License_capacity         | 4 units |
| Maximum_cluster_capacity | 4 units |
| Used_cluster_capacity    | 2 units |
+--------------------------+---------+

License_capacity and Maximum_cluster_capacity is your allowed capacity, while Used_cluster_capacity shows what you have used against the capacity. In the second example, two out of four units have been used. A unit is a combination of compute (8 vCPU or less) and RAM (32 GB or less) and only applies to host machines that run leaf nodes.

To understand how nodes, host machines, and license units relate to each other, see the SingleStore FAQ.