About This Manual¶

This is the Nebula Graph User Manual. It documents Nebula Graph 1.2.1. For information about which versions have been released, see Release Notes.

Who Shall Read This Manual¶

This manual is written for algorithms engineers, data scientists, software developers, database administrators, and all the people who are interested in the Graph Database areas.

If you have questions about using Nebula Graph, join the Nebula Graph Community Slack or our Official Forum.

If you have suggestions concerning additions or corrections to the manual itself, please do not hesitate to open an issue on GitHub.

Syntax Conventions¶

Nebula Graph is under constant development, and this User Manual is updated frequently as well.

This manual uses certain typographical conventions:

• Fixed width

  A fixed-width font is used for ngql statements, code examples, system output, and file names.

• Bold

  Bold typeface indicates commands, user types, or interface.

• UPPERCASE

  REVERSED KEYWORDS and NON REVERSED KEYWORDS in query-language and code examples are almost always shown in upper case.

File Formats¶

The manual source files are written in Markdown format.

The HTML version is produced by mkdocs.