license

Syntax

license([fileName], [pubKeyFile], [read=false])

Arguments

fileName (optional) is the path of the license.

pubKeyFile (optional) is the path of the public key file.

read (optional) is a Boolean value indicating whether to disable the license file verification before returning the result. The default value is false.

Details

Display information regarding the DolphinDB license. If fileName is not specified, the license information from memory is obtained by default.

It returns a dictionary with the following keys:

Keys Meaning
authorization authorization types: trial/test/commercial
licenseType The license type:
  • 1: fingerprint authentication;
  • 2: online verification;
  • 3: license server;
  • 0: others
maxMemoryPerNode the maximum memory for each node (in GB)
bindCores CPU ID(s) (starting from 0) that are already bound to the DolphinDB process. Note that it takes effect only when bindCPU is configured to true.
maxCoresPerNode the maximum cores for each node
clientName the client name
port the port number bound to the node. It is returned only for the license server and its connected nodes.
bindCPU whether a DolphinDB process is bound to a CPU
expiration the expiration date of the license
maxNodes the maximum number of nodes for the cluster
version the version number of the server. Only a server that is not higher than the version can be used. If it is empty, there is no restriction on the version.
modules a decimal converted from 4-bit binary number, indicating the supported modules.
moduleNames names of supported modules. Currently, only orderbook, internalFunction, cep, gpu will be returned.
productKey the current product. The return value includes DOLPHIN, IOTBASIC, IOTPRO, SHARK, SWORDFISH.

Examples

license();
/* output
clientName->internal
bindCPU->true
maxNodes->128
moduleNames-> orderbook internalFunction cep gpu
productKey->DOLPHIN
version->3.10
modules->15
authorization->trial
maxMemoryPerNode->512
licenseType->0
bindCores->
maxCoresPerNode->128
port->0
expiration->2024.09.30
*/