Obtain and Install a Product License

The installation of either a Limited Use License or an Enterprise License is required to enable NuoDB functionality. For more information on NuoDB licenses, see NuoDB Product Licenses.

If a valid non-expired Enterprise License is installed, then the functionality provided by the Enterprise License is enabled.

Obtain a NuoDB License File

To obtain the license file required to enable deployment of the Limited Use License or the Enterprise License, contact NuoDB Support.

The contents of NuoDB license files have following form:

-----BEGIN LICENSE-----
<base64-encoded data>
-----END LICENSE-----

It is important that the license file is not modified in any way, so that the license can be verified by NuoDB (this includes changing whitespace in the file, which can happen unintentionally on Windows if a file is copy-and-pasted into an editor like Notepad).

Check the NuoDB License File

The human-readable information encoded in the license file can be printed using the following command:

nuocmd --show-json check license --license-file </path/to/nuodb.lic>

{
  "expires": "2119-08-16T20:00:30.720739",
  "holder": "Test Customer",
  "type": "ENTERPRISE"
}

Execute the nuocmd --show-json check license command before installing the license to ensure that the license has the correct attributes before installing it into the domain.

Check the Effective License

The effective license for a domain or for a particular NuoDB Admin Process (AP) can be checked by using the following command:

nuocmd --show-json get effective-license

{
  "decodedLicense": {
    "expires": "2119-08-16T20:00:30.720739",
    "holder": "Test Customer",
    "type": "LIMITED"
  },
  "effectiveForDomain": true
}

The decodedLicense field contains the same information that would be found by running nuocmd check license. The effectiveForDomain field indicates whether the license is stored in the domain state, which makes it available to all APs. The effectiveForDomain is true if the license is installed using nuocmd set license. The effectiveForDomain is false if the license is stored in $NUODB_CFGDIR/nuodb.lic.

In previous versions of NuoDB, the only way to install a license was by storing it in $NUODB_CFGDIR/nuodb.lic, which meant it had to be installed on all NuoDB Admin servers manually.

Install a License

The Limited Use License or the Enterprise License can be installed into the domain using the following command:

nuocmd set license --license-file </path/to/nuodb.lic>

This command propagates the license to all APs in the domain.

Confirm the License Type

To confirm that your NuoDB domain has the correct license, use the nuocmd get effective-license command:

nuocmd --show-json get effective-license

{
  "decodedLicense": {
    "expires": "2119-08-16T20:00:30.720739",
    "holder": "Test Customer",
    "type": "ENTERPRISE"
  },
  "effectiveForDomain": true,
  "encodedLicense": "-----BEGIN LICENSE----- ... -----END LICENSE-----\n"
}

The output above shows that the license type is ENTERPRISE, which imposes no limits on the user. The effectiveForDomain field is true to indicate that the license is stored in the domain state and available to all APs.

The original way of installing a license by creating file $NUODB_CFGDIR/nuodb.lic still works but it is our recommendation to use the new method. The new method has precedence over the original way.

For more information on NuoDB Command (nuocmd) and other command line tools, see Command Line Tools.