Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time

DolphinDB User Guide

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

User manual:


Stack Overflow:

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 VS Code Extension (Recommended)

DolphinDB provides VS Code Extension that supports DolphinDB programming language, enabling users to manage DolphinDB scripts in VS Code and send them to the DolphinDB server for execution. You can install the extension in VS Code at lower use-cost. For detailed instructions on VS Code extension, see VS Code Extension tutorial.

You can also connect to the DolphinDB server and manage scripts using the DolphinDB GUI client. For detailed instructions on GUI, see DolphinDB GUI tutorial.

Python/Java/C# API

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


Single Node

To use DolphinDB on a single node, please check DolphinDB Standalone Deployment.

Single-server Cluster

To configure a cluster on a physical server, please check DolphinDB Single-Server Cluster Deployment.

Multi-server Cluster

To configure a cluster on multiple physical servers, please check DolphinDB Multi-Machine Cluster Deployment.

Use DolphinDB

  1. On the web-based cluster manager, we can configure the cluster, start or close data nodes and compute 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 DolphinDB GUI Help.

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

  4. Regarding how to use the DolphinDB streaming engines for real-time data processing and analyzing, see Stream for DolphinDB and Time-Series Stream Engine.

User Access Control

Regarding the user access control functionalities in DolphinDB, please check DolphinDB Database User Access Control and Security.

Possible Problems

  1. After starting a server, the system immediately exits. The error message in the log file is "The license has expired".

Cause: license expired

Solution: contact and update the license file.

  1. 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