Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
64 lines (41 sloc) 3.18 KB

DolphinDB User Guide

DolphinDB User Guide includes dolphindb server package, DolphinDB GUI, web-based cluster manager, Java/Python/C# API and various plugins.

Install DolphinDB

Download from

DolphinDB Community Trial

Unzip DolphinDB package. It has DolphinDB executable, license file, and web-based cluster manager, etc. No need to install after unzipping. To request Enterprise Trial, click "Request" to apply for an enterprise license.

DolphinDB GUI (recommended)

DolphinDB GUI supports syntax colorizing, autoprompt, data visualization, data browse, etc. DolphinDB GUI requires Java 8 or more recent versions.

After unzipping DolphinDB GUI, to start GUI:

  • Windows: double click gui.bat
  • Linux: sh

Python/Java/C# API

Please check for how to install and use Python/Java/C# API.

Cluster Configuration

Single node

To use DolphinDB on a single node, please check

Single server cluster

To configure a cluster on a physical server, please check

Multi-server cluster

To configure a cluster on multiple physical servers, please check

Use DolphinDB

  1. On the web-based cluster manager, we can configure the cluster, start or close data nodes, monitor performance of the nodes, check the partition schemes of distributed databases, and browse data.

  2. For how to use DolphinDB GUI, please check

  3. Regarding how to create distributed databases in DolphinDB, please check

User Access Control

Regarding the user access control functionalities in DolphinDB, please check

Possible problems

  1. After starting a server, the system immediately exists. The error message in the log file is "The license has been expired". Cause: license expired Solution: contact and update the license file.

  2. After starting the nodes on the web-based cluster manager, the nodes are still shown as stopped. Cause: need to refresh nodes status. Solution: click on the "refresh" button. If the log file has error message "Failed to bind the socket on XXXX" in the log file where XXXX is the port number of a data node to be started, this could mean that the port number is occupied by another application. If so, just close that application and try again. It could also mean the port is not yet released by the Linux kernel if you just closed the data node with this port number. For this case, just wait around 30 seconds and restart the nodes.

For any problem in using DolphinDB database, please first check the log file for more information. There is a log file on each of the data nodes and on the controller node. The default folder of the log file is the home directory. You can post your questions on or contact us at

You can’t perform that action at this time.