license#

swordfish.function.license()#

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

Parameters:
  • fileName (Constant, optional) – The path of the license.

  • pubKeyFile (Constant, optional) – The path of the public key file.

  • read (Constant, optional) – A Boolean value indicating whether to disable the license file verification before returning the result. The default value is false.

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, starfish, Beluga, Backtest, MatchingEngineSimulator will be returned.

productKey

the current product. The return value includes DOLPHIN, IOTBASIC, IOTPRO, SHARK, SWORDFISH, ORCA, DOLPHINX.

Return type:

Constant