README.md

Welcome to the Official Nebula Graph Documentation

Nebula Graph is a distributed, scalable, and lightning-fast graph database.

It is the optimal solution in the world capable of hosting graphs with dozens of billions of vertices (nodes) and trillions of edges with millisecond latency.

Preface

• About This Manual
• Manual Change Log

Overview (for Beginners)

• Introduction

• Concepts

  • Data Model
  • Query Language Overview

• Quick Start and Useful Links

  • Get Started
  • FAQ
  • Build Source Code
  • Deploy Cluster
  • Import .csv File
  • Ingest .sst File
  • Nebula Graph Clients

• Design and Architecture

  • Design Overview
  • Storage Architecture
  • Query Engine

Query Language (for All Users)

• Data Types
  • Data Types
  • Type Conversion
• Functions and Operators
  • Bitwise Operators
  • Built-In Functions
  • Comparison Functions And Operators
  • Group By Function
  • Limit Syntax
  • Logical Operators
  • Order By Function
  • Set Operations
  • uuid Function
• Language Structure
  • Literal Values
    • Boolean Literals
    • Numeric Literals
    • String Literals
  • Comment Syntax
  • Identifier Case Sensitivity
  • Keywords and Reserved Words
  • Pipe Syntax
  • Property Reference
  • Schema Object Names
  • Statement Composition
  • User-Defined Variables
• Statement Syntax

  • Data Definition Statements

    • Alter Tag/Edge Syntax
    • Create Space Syntax
    • Create Tag/Edge Syntax
    • Drop Edge Syntax
    • Drop Space Syntax
    • Drop Tag Syntax
    • Index
    • TTL (time-to-live)

  • Data Query and Manipulation Statements

    • Delete Edge Syntax
    • Delete Vertex Syntax
    • Fetch Syntax
    • Go Syntax
    • Insert Edge Syntax
    • Insert Vertex Syntax
    • Lookup Syntax
    • Return Syntax
    • Update Vertex/Edge Syntax
    • Upsert Syntax
    • Where Syntax
    • Yield Syntax

  • Utility Statements

    • Show Statements
      • Show Charset Syntax
      • Show Collation Syntax
      • Show Configs Syntax
      • Show Create Spaces Syntax
      • Show Create Tag/Edge Syntax
      • Show Hosts Syntax
      • Show Indexes Syntax
      • Show Parts Syntax
      • Show Roles Syntax
      • Show Snapshots Syntax
      • Show Spaces Syntax
      • Show Tag/Edge Syntax
      • Show Users Syntax
    • Describe Syntax
    • Use Syntax

  • Graph Algorithms

    • Find Path Syntax

Build Develop and Administration (for Developers and DBA)

• Build

  • Build Source Code
  • Build By Docker

• Develop and Interface

  • Key Value API
  • Nebula Graph Clients

• Deploy and Administrations

  • Deployment

    • Configuration Description
    • Deploy Cluster On Docker
    • Deploy Cluster
    • Installation With rpm

  • Server Administration

    • Account Management Statements
      • Alter User Syntax
      • Built-in Roles
      • Change Password
      • Create User Syntax
      • Drop User Syntax
      • Grant Role Syntax
      • Revoke Syntax
    • Configuration Statements
      • Configs Syntax
      • Logs
    • Graph Service Administration
      • Graph Metrics
    • Meta Service Administration
      • Meta Metrics
    • Storage Service Administration
      • Data Import
        • Download And Ingest .sst File
        • Import .csv File
        • Spark Writer
      • Data Export
        • Dump Tool
      • Storage Balance
      • Storage Metrics
      • Cluster Snapshot
      • Job Manager

Contributions (for Contributors)

• Contribute to Documentation
• Cpp Coding Style
• Developer Documentation Style Guide
• How to Contribute

Appendix

• Gremlin V.S. nGQL
• Cypher V.S. nGQL
• Upgrading Nebula Graph

Misc

Video

• YouTube
• bilibili