ArangoDB v3.13 is under development and not released yet. This documentation is not final and potentially incomplete.

Enterprise Edition License Management

How to apply a license and check the licensing status of an ArangoDB deployment

The Enterprise Edition of ArangoDB requires a license so that you can use ArangoDB for commercial purposes and have a dataset size over 100 GiB. See ArangoDB Editions for details.

How to set a license key and to retrieve information about the current license via the JavaScript API is described below. You can also use the HTTP API.

If you use the ArangoDB Kubernetes Operator, check the kube-arangodb documentation  for more details on how to set a license key.

Apply a license

To use the Enterprise Edition, set the license via arangosh like so:

db._setLicense("<license-string>");

You receive a message reporting whether the operation succeeded. Please be careful to copy the exact license key string and to put it in quotes as shown above.

{ "error": false, "code": 201 }

Your license has now been applied.

Check the license

At any point, you may check the current state of your license in arangosh:

db._getLicense();

The server response is different for the Community Edition and the Enterprise Edition.

{
  "upgrading": false,
  "diskUsage": {
    "bytesUsed": 127316844,
    "bytesLimit": 107374182400,
    "limitReached": false,
    "secondsUntilReadOnly": 315569520,
    "secondsUntilShutDown": 315569520,
    "status": "good"
  }
}

The diskUsage.status attribute tells you the state of your Community Edition deployment with regard to the dataset size limit at a glance and can have the following values:

  • good: The dataset size of your deployment is below the 100 GiB limit.
  • limit-reached: Your deployment exceeds the size limit and you have two days to bring the deployment back below 100 GiB. Consider acquiring an Enterprise Edition license to lift the limit.
  • read-only: Your deployment is in read-only mode because it exceeded the size limit for two days. All read operations to the instance keep functioning for two more days. However, no data or data definition changes can be made.
  • shutdown: The server shuts down after two days of read-only mode.

The other sub-attributes of diskUsage indicate the dataset size limit, the size determined for your deployment, whether it exceeds the limit, as well as the time until the read-only mode and the shutdown are expected to occur if you are over the limit.

{
  "upgrading": false,
  "features": {
    "expires": 1743568356
  },
  "hash": "95af ... 3de1",
  "license": "JD4E ... dnDw==",
  "version": 1,
  "status": "good"
}

The status attribute is the executive summary of your license and can have the following values:

  • good: Your license is valid for more than another 1 week.
  • expiring: Your license is about to expire shortly. Please contact your ArangoDB sales representative to acquire a new license or extend your old license.
  • read-only: Your license has expired at which point the deployment will be in read-only mode. All read operations to the instance will keep functioning. However, no data or data definition changes can be made. Please contact your ArangoDB sales representative immediately.

The attribute expires in features denotes the expiry date as Unix timestamp (in seconds since January 1st, 1970 UTC).

The license field holds an encrypted and base64-encoded version of the applied license for reference and support from ArangoDB.

Monitoring

In order to monitor the remaining validity of the license, the metric arangodb_license_expires is exposed by Coordinators and DB-Servers, see the Metrics API.

Managing Your License

Backups, restores, exports and imports and the license management do not interfere with each other. In other words, the license is not backed up and restored with any of the above mechanisms.

Make sure that you store your license in a safe place, and potentially the email with which you received it, should you require the license key to re-activate a deployment.

On this page