Skip to content

NebulaGraph Database Manual

About

中文

Initializing search

vesoft-inc/nebula-docs

NebulaGraph Database Manual

vesoft-inc/nebula-docs

About
Introduction
Introduction
- Introduction to graphs
- Graph databases
- Related technologies
- What is NebulaGraph
- Data model
- Path
- VID
- NebulaGraph architecture
  NebulaGraph architecture
Quick start
Quick start
nGQL guide
nGQL guide
- nGQL overview
  nGQL overview
- Data types
  Data types
  - Numeric
  - Boolean
  - String
  - Date and time
  - NULL
  - List
  - Set
  - Map
  - Type conversion
  - Geography
- Variables and composite queries
  Variables and composite queries
- Operators
  Operators
  - Comparison
  - Boolean
  - Pipe
  - Property reference
  - Set
  - String
  - List
  - Precedence
- Functions and expressions
  Functions and expressions
- General queries statements
  General queries statements
  - MATCH
  - OPTIONAL MATCH
  - LOOKUP
  - GO
  - FETCH
  - SHOW
    SHOW
    
    SHOW CHARSET
    
    SHOW COLLATION
    
    SHOW CREATE SPACE
    
    SHOW CREATE TAG/EDGE
    
    SHOW HOSTS
    
    SHOW INDEX STATUS
    
    SHOW INDEXES
    
    SHOW PARTS
    
    SHOW ROLES
    
    SHOW SNAPSHOTS
    
    SHOW SPACES
    
    SHOW STATS
    
    SHOW TAGS/EDGES
    
    SHOW USERS
    
    SHOW SESSIONS
    
    SHOW QUERIES
    
    SHOW META LEADER
- Clauses and options
  Clauses and options
  - GROUP BY
  - LIMIT and SKIP
  - SAMPLE
  - ORDER BY
  - RETURN
  - TTL
  - WHERE
  - YIELD
  - WITH
  - UNWIND
- Space statements
  Space statements
- Tag statements
  Tag statements
- Edge type statements
  Edge type statements
- Vertex statements
  Vertex statements
- Edge statements
  Edge statements
- Native index statements
  Native index statements
- Full-text index statements
  Full-text index statements
- Subgraph and path
  Subgraph and path
  - GET SUBGRAPH
  - FIND PATH
- Query tuning and terminating statements
  Query tuning and terminating statements
  - EXPLAIN and PROFILE
  - Kill queries
- Job statements
Deployment and installation
Deployment and installation
- Resource preparations
- Compile and install Nebula Graph
  Compile and install Nebula Graph
- Deploy standalone NebulaGraph
- Manage Service
- Connect to Service
- Manage Storage host
- Upgrade
  Upgrade
  - Upgrade NebulaGraph to the latest version
  - Upgrade NebulaGraph from v3.x to the current version
- Uninstall NebulaGraph
Configurations and logs
Configurations and logs
- Configurations
  Configurations
- Log management
  Log management
  - Runtime logs
Monitor and metrics
Monitor and metrics
- Query NebulaGraph metrics
- RocksDB Statistics
Data security
Data security
- Authentication and authorization
  Authentication and authorization
- SSL
Backup & Restore
Backup & Restore
- NebulaGraph BR
  NebulaGraph BR
- Manage snapshots
Synchronization & Migration
Synchronization & Migration
- Load balance
Practices
Practices
Client
Client
NebulaGraph Studio
NebulaGraph Studio
- About NebulaGraph Studio
  About NebulaGraph Studio
  - What is NebulaGraph Studio
  - Limitations
- Deploy and connect
  Deploy and connect
- Quick start
  Quick start
  - Design a schema
  - Create a schema
  - Import data
  - Use Console
  - Use Schema
    Use Schema
    
    Operate graph spaces
    
    Operate Tags
    
    Operate Edge types
    
    Operate Indexes
- Troubleshooting
  Troubleshooting
NebulaGraph Dashboard Community Edition
NebulaGraph Dashboard Community Edition
NebulaGraph Dashboard Enterprise Edition
NebulaGraph Dashboard Enterprise Edition
- What is NebulaGraph Dashboard Enterprise Edition
- Deploy Dashboard Enterprise Edition
- NebulaGraph Dashboard Enterprise Edition license
- Create and import clusters
  Create and import clusters
  - Create clusters
  - Import clusters
- Cluster management
  Cluster management
- Task Center
- Authority management
- Package management
- Global settings
- Monitoring metrics
- FAQ
NebulaGraph Explorer
NebulaGraph Explorer
- What is NebulaGraph Explorer
- Deploy and connect
  Deploy and connect
- Page overview
- Database management
  Database management
- Graph explorer
  Graph explorer
- Visual query
- Canvas
  Canvas
- Workflow
  Workflow
  - Workflow overview
  - Resource preparations
  - Workflow example
  - Workflow management
  - Job management
  - Workflow API
    Workflow API
    
    API overview
    
    Add a new job
    
    Get a list of all jobs
    
    Get a list of jobs for a specified workflow
    
    Query details for a specified job
    
    Cancel a running job
    
    Get the result data of a specified task
- Basic operations and shortcuts
NebulaGraph Importer
NebulaGraph Importer
NebulaGraph Exchange
NebulaGraph Exchange
- Introduction
  Introduction
  - What is NebulaGraph Exchange
  - Limitations
- Get Exchange
- Exchange configurations
  Exchange configurations
  - Options for import
  - Parameters in the configuration file
- Use NebulaGraph Exchange
  Use NebulaGraph Exchange
- Exchange FAQ
NebulaGraph Operator
NebulaGraph Operator
- What is NebulaGraph Operator
- Overview of using NebulaGraph Operator
- Deploy NebulaGraph Operator
- Deploy clusters
  Deploy clusters
  - Deploy clusters with Kubectl
  - Deploy clusters with Helm
- Configure clusters
  Configure clusters
  - Custom configuration parameters for a NebulaGraph cluster
  - Reclaim PVs
- Upgrade NebulaGraph clusters
- Connect to NebulaGraph databases
- Self-healing
- FAQ
Graph computing
Graph computing
NebulaGraph Spark Connector
NebulaGraph Flink Connector
NebulaGraph Bench
Appendix
Appendix
- Release Note
  Release Note
- Learning path
- About NebulaGraph licenses
- FAQ
- Ecosystem tools
- Write tools
- How to contribute
- History timeline
- Error code
PDF

Welcome to NebulaGraph 3.2.0 Documentation¶

Danger

A new version has been released.

Last update: February 19, 2024

Next Introduction to graphs

Copyright © 2022 NebulaGraph

Made with Material for MkDocs