diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index 47b9079aae8..f1be27bf62f 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -25,5 +25,5 @@ Please answer the following questions before submitting your issue. Thanks! - [ ] I searched for existing GitHub issues -- [ ] I updated Nebula Graph to most recent version +- [ ] I updated NebulaGraph to most recent version - [ ] I included all the necessary information above diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a3c7122b03b..81f0f3171e7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ - + ### What is changed, added or deleted? (Required) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f8c4a8218d..feb8152296d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribute to Documentation -Contributing to the **Nebula Graph** documentation can be a rewarding experience. We welcome your participation to help make the documentation better! +Contributing to the **NebulaGraph** documentation can be a rewarding experience. We welcome your participation to help make the documentation better! ## What to Contribute diff --git a/README.md b/README.md index 3766eb9384b..3b33ce38d67 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Nebula Graph documentation +# NebulaGraph documentation - [English](https://docs.nebula-graph.io) - [中文](https://docs.nebula-graph.com.cn/) ## Contributing -If you have any questions on our documentation, feel free to raise an [Issue](https://github.com/vesoft-inc/nebula-docs/issues) or directly create a [Pull Request](https://github.com/vesoft-inc/nebula-docs/pulls) to help fix or update it. See Nebula Graph [CONTRIBUTING](CONTRIBUTING.md) guide to get started. +If you have any questions on our documentation, feel free to raise an [Issue](https://github.com/vesoft-inc/nebula-docs/issues) or directly create a [Pull Request](https://github.com/vesoft-inc/nebula-docs/pulls) to help fix or update it. See NebulaGraph [CONTRIBUTING](CONTRIBUTING.md) guide to get started. diff --git a/docs-2.0/1.introduction/0-0-graph.md b/docs-2.0/1.introduction/0-0-graph.md index 647e27ccb31..11ddd945517 100644 --- a/docs-2.0/1.introduction/0-0-graph.md +++ b/docs-2.0/1.introduction/0-0-graph.md @@ -6,7 +6,7 @@ Graphs are one of the main areas of research in computer science. Graphs can eff ## What are graphs? -Graphs are everywhere. When hearing the word graph, many people think of bar charts or line charts, because sometimes we call them graphs, which show the connections between two or more data systems. The simplest example is the following picture, which shows the number of Nebula Graph GitHub repository stars over time. +Graphs are everywhere. When hearing the word graph, many people think of bar charts or line charts, because sometimes we call them graphs, which show the connections between two or more data systems. The simplest example is the following picture, which shows the number of NebulaGraph GitHub repository stars over time. ![image](https://user-images.githubusercontent.com/42762957/91426247-d3861000-e88e-11ea-8e17-e3d7d7069bd1.png "This is not the graph talked about in this book") diff --git a/docs-2.0/1.introduction/0-1-graph-database.md b/docs-2.0/1.introduction/0-1-graph-database.md index ded80a02148..88cbc818299 100644 --- a/docs-2.0/1.introduction/0-1-graph-database.md +++ b/docs-2.0/1.introduction/0-1-graph-database.md @@ -147,7 +147,7 @@ Cypher has inspired a series of graph query languages, including: [^GSQL]: https://docs.tigergraph.com/dev/gsql-ref -2019, Nebula Graph released Nebula Graph Query Language (nGQL) based on openCypher. +2019, NebulaGraph released NebulaGraph Query Language (nGQL) based on openCypher. ![Image](https://docs-cdn.nebula-graph.com.cn/books/images/langhis.jpg "图语言的历史") @@ -236,6 +236,6 @@ Oracle Graph[^Oracle] is a product of the relational database giant Oracle in th [^Oracle]: https://www.oracle.com/database/graph/ -#### Nebula Graph, a new generation of open-source distributed graph databases +#### NebulaGraph, a new generation of open-source distributed graph databases -In the following topics, we will formally introduce Nebula Graph, a new generation of open-source distributed graph databases. +In the following topics, we will formally introduce NebulaGraph, a new generation of open-source distributed graph databases. diff --git a/docs-2.0/1.introduction/0-2.relates.md b/docs-2.0/1.introduction/0-2.relates.md index 71863893c88..ee4b7af6223 100644 --- a/docs-2.0/1.introduction/0-2.relates.md +++ b/docs-2.0/1.introduction/0-2.relates.md @@ -55,7 +55,7 @@ Technically speaking, as a semi-structured unit of information, a document in a #### Graph Store -The last class of NoSQL databases is graph databases. Nebula Graph, is also a graph database. Although graph databases are also NoSQL databases, graph databases are fundamentally different from the above-mentioned NoSQL databases. Graph databases store data in the form of points, edges, and attributes. Its advantages include high flexibility, support for complex graph algorithms, and can be used to build complex relational graphs. We will discuss graph databases in detail in the subsequent topics. But in this topic, you just need to know that a graph database is a NoSQL type of database. Common graph databases include Nebula Graph, Neo4j, OrientDB, etc. +The last class of NoSQL databases is graph databases. NebulaGraph, is also a graph database. Although graph databases are also NoSQL databases, graph databases are fundamentally different from the above-mentioned NoSQL databases. Graph databases store data in the form of points, edges, and attributes. Its advantages include high flexibility, support for complex graph algorithms, and can be used to build complex relational graphs. We will discuss graph databases in detail in the subsequent topics. But in this topic, you just need to know that a graph database is a NoSQL type of database. Common graph databases include NebulaGraph, Neo4j, OrientDB, etc. ## Graph-related technologies diff --git a/docs-2.0/1.introduction/1.what-is-nebula-graph.md b/docs-2.0/1.introduction/1.what-is-nebula-graph.md index 1c66f951b99..4861fab49fb 100644 --- a/docs-2.0/1.introduction/1.what-is-nebula-graph.md +++ b/docs-2.0/1.introduction/1.what-is-nebula-graph.md @@ -1,82 +1,82 @@ -# What is Nebula Graph +# What is NebulaGraph -Nebula Graph is an open-source, distributed, easily scalable, and native graph database. It is capable of hosting graphs with hundreds of billions of vertices and trillions of edges, and serving queries with millisecond-latency. +NebulaGraph is an open-source, distributed, easily scalable, and native graph database. It is capable of hosting graphs with hundreds of billions of vertices and trillions of edges, and serving queries with millisecond-latency. -![Nebula Graph birdview](nebula-graph-birdview-3.0.png) +![NebulaGraph birdview](nebula-graph-birdview-3.0.png) ## What is a graph database -A graph database, such as Nebula Graph, is a database that specializes in storing vast graph networks and retrieving information from them. It efficiently stores data as vertices (nodes) and edges (relationships) in labeled property graphs. Properties can be attached to both vertices and edges. Each vertex can have one or multiple tags (labels). +A graph database, such as NebulaGraph, is a database that specializes in storing vast graph networks and retrieving information from them. It efficiently stores data as vertices (nodes) and edges (relationships) in labeled property graphs. Properties can be attached to both vertices and edges. Each vertex can have one or multiple tags (labels). ![What is a graph database](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/what-is-a-graph-database.png "What is a graph database") Graph databases are well suited for storing most kinds of data models abstracted from reality. Things are connected in almost all fields in the world. Modeling systems like relational databases extract the relationships between entities and squeeze them into table columns alone, with their types and properties stored in other columns or even other tables. This makes the data management time-consuming and cost-ineffective. -Nebula Graph, as a typical native graph database, allows you to store the rich relationships as edges with edge types and properties directly attached to them. +NebulaGraph, as a typical native graph database, allows you to store the rich relationships as edges with edge types and properties directly attached to them. -## Advantages of Nebula Graph +## Advantages of NebulaGraph ### Open-source -Nebula Graph is open under the Apache 2.0. More and more people such as database developers, data scientists, security experts, and algorithm engineers are participating in the designing and development of Nebula Graph. To join the opening of source code and ideas, surf the [Nebula Graph GitHub page](https://github.com/vesoft-inc/nebula-graph). +NebulaGraph is open under the Apache 2.0. More and more people such as database developers, data scientists, security experts, and algorithm engineers are participating in the designing and development of NebulaGraph. To join the opening of source code and ideas, surf the [NebulaGraph GitHub page](https://github.com/vesoft-inc/nebula-graph). ### Outstanding performance -Written in C++ and born for graph, Nebula Graph handles graph queries in milliseconds. Among most databases, Nebula Graph shows superior performance in providing graph data services. The larger the data size, the greater the superiority of Nebula Graph. For more information, see [Nebula Graph benchmarking](https://discuss.nebula-graph.io/t/nebula-graph-1-0-benchmark-report/581). +Written in C++ and born for graph, NebulaGraph handles graph queries in milliseconds. Among most databases, NebulaGraph shows superior performance in providing graph data services. The larger the data size, the greater the superiority of NebulaGraph. For more information, see [NebulaGraph benchmarking](https://discuss.nebula-graph.io/t/nebula-graph-1-0-benchmark-report/581). ### High scalability -Nebula Graph is designed in a shared-nothing architecture and supports scaling in and out without interrupting the database service. +NebulaGraph is designed in a shared-nothing architecture and supports scaling in and out without interrupting the database service. ### Developer friendly -Nebula Graph supports clients in popular programming languages like Java, Python, C++, and Go, and more are being developed. For more information, see Nebula Graph [clients](../20.appendix/6.eco-tool-version.md). +NebulaGraph supports clients in popular programming languages like Java, Python, C++, and Go, and more are being developed. For more information, see NebulaGraph [clients](../20.appendix/6.eco-tool-version.md). ### Reliable access control -Nebula Graph supports strict role-based access control and external authentication servers such as LDAP (Lightweight Directory Access Protocol) servers to enhance data security. For more information, see [Authentication and authorization](../7.data-security/1.authentication/1.authentication.md). +NebulaGraph supports strict role-based access control and external authentication servers such as LDAP (Lightweight Directory Access Protocol) servers to enhance data security. For more information, see [Authentication and authorization](../7.data-security/1.authentication/1.authentication.md). ### Diversified ecosystem -More and more native tools of Nebula Graph have been released, such as [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-web-docker), [Nebula Console](https://github.com/vesoft-inc/nebula-console), and [Nebula Exchange](https://github.com/vesoft-inc/nebula-exchange). For more ecosystem tools, see [Ecosystem tools overview](../20.appendix/6.eco-tool-version.md). +More and more native tools of NebulaGraph have been released, such as [NebulaGraph Studio](https://github.com/vesoft-inc/nebula-web-docker), [Nebula Console](https://github.com/vesoft-inc/nebula-console), and [Nebula Exchange](https://github.com/vesoft-inc/nebula-exchange). For more ecosystem tools, see [Ecosystem tools overview](../20.appendix/6.eco-tool-version.md). -Besides, Nebula Graph has the ability to be integrated with many cutting-edge technologies, such as Spark, Flink, and HBase, for the purpose of mutual strengthening in a world of increasing challenges and chances. +Besides, NebulaGraph has the ability to be integrated with many cutting-edge technologies, such as Spark, Flink, and HBase, for the purpose of mutual strengthening in a world of increasing challenges and chances. ### OpenCypher-compatible query language -The native Nebula Graph Query Language, also known as nGQL, is a declarative, openCypher-compatible textual query language. It is easy to understand and easy to use. For more information, see [nGQL guide](../3.ngql-guide/1.nGQL-overview/1.overview.md). +The native NebulaGraph Query Language, also known as nGQL, is a declarative, openCypher-compatible textual query language. It is easy to understand and easy to use. For more information, see [nGQL guide](../3.ngql-guide/1.nGQL-overview/1.overview.md). ### Future-oriented hardware with balanced reading and writing -Solid-state drives have extremely high performance and [they are getting cheaper](https://blocksandfiles.com/wp-content/uploads/2021/01/Wikibon-SSD-less-than-HDD-in-2026.jpg). Nebula Graph is a product based on SSD. Compared with products based on HDD and large memory, it is more suitable for future hardware trends and easier to achieve balanced reading and writing. +Solid-state drives have extremely high performance and [they are getting cheaper](https://blocksandfiles.com/wp-content/uploads/2021/01/Wikibon-SSD-less-than-HDD-in-2026.jpg). NebulaGraph is a product based on SSD. Compared with products based on HDD and large memory, it is more suitable for future hardware trends and easier to achieve balanced reading and writing. ### Easy data modeling and high flexibility -You can easily model the connected data into Nebula Graph for your business without forcing them into a structure such as a relational table, and properties can be added, updated, and deleted freely. For more information, see [Data modeling](2.data-model.md). +You can easily model the connected data into NebulaGraph for your business without forcing them into a structure such as a relational table, and properties can be added, updated, and deleted freely. For more information, see [Data modeling](2.data-model.md). ### High popularity -Nebula Graph is being used by tech leaders such as Tencent, Vivo, Meituan, and JD Digits. For more information, visit the [Nebula Graph official website](https://nebula-graph.io/). +NebulaGraph is being used by tech leaders such as Tencent, Vivo, Meituan, and JD Digits. For more information, visit the [NebulaGraph official website](https://nebula-graph.io/). ## Use cases -Nebula Graph can be used to support various graph-based scenarios. To spare the time spent on pushing the kinds of data mentioned in this section into relational databases and on bothering with join queries, use Nebula Graph. +NebulaGraph can be used to support various graph-based scenarios. To spare the time spent on pushing the kinds of data mentioned in this section into relational databases and on bothering with join queries, use NebulaGraph. ### Fraud detection -Financial institutions have to traverse countless transactions to piece together potential crimes and understand how combinations of transactions and devices might be related to a single fraud scheme. This kind of scenario can be modeled in graphs, and with the help of Nebula Graph, fraud rings and other sophisticated scams can be easily detected. +Financial institutions have to traverse countless transactions to piece together potential crimes and understand how combinations of transactions and devices might be related to a single fraud scheme. This kind of scenario can be modeled in graphs, and with the help of NebulaGraph, fraud rings and other sophisticated scams can be easily detected. ### Real-time recommendation -Nebula Graph offers the ability to instantly process the real-time information produced by a visitor and make accurate recommendations on articles, videos, products, and services. +NebulaGraph offers the ability to instantly process the real-time information produced by a visitor and make accurate recommendations on articles, videos, products, and services. ### Intelligent question-answer system -Natural languages can be transformed into knowledge graphs and stored in Nebula Graph. A question organized in a natural language can be resolved by a semantic parser in an intelligent question-answer system and re-organized. Then, possible answers to the question can be retrieved from the knowledge graph and provided to the one who asked the question. +Natural languages can be transformed into knowledge graphs and stored in NebulaGraph. A question organized in a natural language can be resolved by a semantic parser in an intelligent question-answer system and re-organized. Then, possible answers to the question can be retrieved from the knowledge graph and provided to the one who asked the question. ### Social networking -Information on people and their relationships are typical graph data. Nebula Graph can easily handle the social networking information of billions of people and trillions of relationships, and provide lightning-fast queries for friend recommendations and job promotions in the case of massive concurrency. +Information on people and their relationships are typical graph data. NebulaGraph can easily handle the social networking information of billions of people and trillions of relationships, and provide lightning-fast queries for friend recommendations and job promotions in the case of massive concurrency. ## Related links diff --git a/docs-2.0/1.introduction/2.data-model.md b/docs-2.0/1.introduction/2.data-model.md index 59727ac5d06..6ac70153ba2 100644 --- a/docs-2.0/1.introduction/2.data-model.md +++ b/docs-2.0/1.introduction/2.data-model.md @@ -1,21 +1,21 @@ # Data modeling -A data model is a model that organizes data and specifies how they are related to one another. This topic describes the Nebula Graph data model and provides suggestions for data modeling with Nebula Graph. +A data model is a model that organizes data and specifies how they are related to one another. This topic describes the Nebula Graph data model and provides suggestions for data modeling with NebulaGraph. ## Data structures -Nebula Graph data model uses six data structures to store data. They are graph spaces, vertices, edges, tags, edge types and properties. +NebulaGraph data model uses six data structures to store data. They are graph spaces, vertices, edges, tags, edge types and properties. - **Graph spaces**: Graph spaces are used to isolate data from different teams or programs. Data stored in different graph spaces are securely isolated. Storage replications, privileges, and partitions can be assigned. - **Vertices**: Vertices are used to store entities. -- In Nebula Graph, vertices are identified with vertex identifiers (i.e. `VID`). The `VID` must be unique in the same graph space. VID should be int64, or fixed_string(N). +- In NebulaGraph, vertices are identified with vertex identifiers (i.e. `VID`). The `VID` must be unique in the same graph space. VID should be int64, or fixed_string(N). - A vertex has zero to multiple tags. !!! compatibility - In Nebula Graph 2.x a vertex must have at least one tag. And in Nebula Graph {{nebula.release}}, a tag is not required for a vertex. + In NebulaGraph 2.x a vertex must have at least one tag. And in NebulaGraph {{nebula.release}}, a tag is not required for a vertex. - **Edges**: Edges are used to connect vertices. An edge is a connection or behavior between two vertices. - There can be multiple edges between two vertices. @@ -36,7 +36,7 @@ Nebula Graph data model uses six data structures to store data. They are graph s ## Directed property graph -Nebula Graph stores data in directed property graphs. A directed property graph has a set of vertices connected by directed edges. Both vertices and edges can have properties. A directed property graph is represented as: +NebulaGraph stores data in directed property graphs. A directed property graph has a set of vertices connected by directed edges. Both vertices and edges can have properties. A directed property graph is represented as: **G = < V, E, PV, PE >** @@ -56,10 +56,10 @@ The following table is an example of the structure of the basketball player data !!! Note - Nebula Graph supports only directed edges. + NebulaGraph supports only directed edges. !!! compatibility - Nebula Graph {{ nebula.release }} allows dangling edges. Therefore, when adding or deleting, you need to ensure the corresponding source vertex and destination vertex of an edge exist. For details, see [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md), [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md), [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md), and [DELETE EDGE](../3.ngql-guide/13.edge-statements/4.delete-edge.md). + NebulaGraph {{ nebula.release }} allows dangling edges. Therefore, when adding or deleting, you need to ensure the corresponding source vertex and destination vertex of an edge exist. For details, see [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md), [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md), [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md), and [DELETE EDGE](../3.ngql-guide/13.edge-statements/4.delete-edge.md). The MERGE statement in openCypher is not supported. diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/1.architecture-overview.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/1.architecture-overview.md index 9d45a5d5bc7..a32308d1071 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/1.architecture-overview.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/1.architecture-overview.md @@ -1,22 +1,22 @@ # Architecture overview -Nebula Graph consists of three services: the Graph Service, the Storage Service, and the Meta Service. It applies the separation of storage and computing architecture. +NebulaGraph consists of three services: the Graph Service, the Storage Service, and the Meta Service. It applies the separation of storage and computing architecture. -Each service has its executable binaries and processes launched from the binaries. Users can deploy a Nebula Graph cluster on a single machine or multiple machines using these binaries. +Each service has its executable binaries and processes launched from the binaries. Users can deploy a NebulaGraph cluster on a single machine or multiple machines using these binaries. -The following figure shows the architecture of a typical Nebula Graph cluster. +The following figure shows the architecture of a typical NebulaGraph cluster. -![Nebula Graph architecture](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/nebula-graph-architecture-1.png "Nebula Graph architecture") +![NebulaGraph architecture](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/nebula-graph-architecture-1.png "NebulaGraph architecture") ## The Meta Service -The Meta Service in the Nebula Graph architecture is run by the nebula-metad processes. It is responsible for metadata management, such as schema operations, cluster administration, and user privilege management. +The Meta Service in the NebulaGraph architecture is run by the nebula-metad processes. It is responsible for metadata management, such as schema operations, cluster administration, and user privilege management. For details on the Meta Service, see [Meta Service](2.meta-service.md). ## The Graph Service and the Storage Service -Nebula Graph applies the separation of storage and computing architecture. The Graph Service is responsible for querying. The Storage Service is responsible for storage. They are run by different processes, i.e., nebula-graphd and nebula-storaged. The benefits of the separation of storage and computing architecture are as follows: +NebulaGraph applies the separation of storage and computing architecture. The Graph Service is responsible for querying. The Storage Service is responsible for storage. They are run by different processes, i.e., nebula-graphd and nebula-storaged. The benefits of the separation of storage and computing architecture are as follows: * Great scalability @@ -30,7 +30,7 @@ Nebula Graph applies the separation of storage and computing architecture. The G The separation of storage and computing architecture provides a higher resource utilization rate, and it enables clients to manage the cost flexibly according to business demands. - + * Open to more possibilities diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md index 43dc21b5894..8cfce5a8179 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/2.meta-service.md @@ -15,7 +15,7 @@ The Meta Service is run by nebula-metad processes. Users can deploy nebula-metad All the nebula-metad processes form a Raft-based cluster, with one process as the leader and the others as the followers. -The leader is elected by the majorities and only the leader can provide service to the clients or other components of Nebula Graph. The followers will be run in a standby way and each has a data replication of the leader. Once the leader fails, one of the followers will be elected as the new leader. +The leader is elected by the majorities and only the leader can provide service to the clients or other components of NebulaGraph. The followers will be run in a standby way and each has a data replication of the leader. Once the leader fails, one of the followers will be elected as the new leader. !!! Note @@ -27,7 +27,7 @@ The leader is elected by the majorities and only the leader can provide service The Meta Service stores the information of user accounts and the privileges granted to the accounts. When the clients send queries to the Meta Service through an account, the Meta Service checks the account information and whether the account has the right privileges to execute the queries or not. -For more information on Nebula Graph access control, see [Authentication](../../7.data-security/1.authentication/1.authentication.md). +For more information on NebulaGraph access control, see [Authentication](../../7.data-security/1.authentication/1.authentication.md). ### Manages partitions @@ -35,15 +35,15 @@ The Meta Service stores and manages the locations of the storage partitions and ### Manages graph spaces -Nebula Graph supports multiple graph spaces. Data stored in different graph spaces are securely isolated. The Meta Service stores the metadata of all graph spaces and tracks the changes of them, such as adding or dropping a graph space. +NebulaGraph supports multiple graph spaces. Data stored in different graph spaces are securely isolated. The Meta Service stores the metadata of all graph spaces and tracks the changes of them, such as adding or dropping a graph space. ### Manages schema information -Nebula Graph is a strong-typed graph database. Its schema contains tags (i.e., the vertex types), edge types, tag properties, and edge type properties. +NebulaGraph is a strong-typed graph database. Its schema contains tags (i.e., the vertex types), edge types, tag properties, and edge type properties. The Meta Service stores the schema information. Besides, it performs the addition, modification, and deletion of the schema, and logs the versions of them. -For more information on Nebula Graph schema, see [Data model](../2.data-model.md). +For more information on NebulaGraph schema, see [Data model](../2.data-model.md). ### Manages TTL information diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md index 4e5eae2a626..6b70ab0f17a 100644 --- a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md +++ b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md @@ -1,6 +1,6 @@ # Storage Service -The persistent data of Nebula Graph have two parts. One is the [Meta Service](2.meta-service.md) that stores the meta-related data. +The persistent data of NebulaGraph have two parts. One is the [Meta Service](2.meta-service.md) that stores the meta-related data. The other is the Storage Service that stores the data, which is run by the nebula-storaged process. This topic will describe the architecture of the Storage Service. @@ -48,37 +48,37 @@ The following will describe some features of the Storage Service based on the ab ## KVStore -Nebula Graph develops and customizes its built-in KVStore for the following reasons. +NebulaGraph develops and customizes its built-in KVStore for the following reasons. - It is a high-performance KVStore. -- It is provided as a (kv) library and can be easily developed for the filter pushdown purpose. As a strong-typed database, how to provide Schema during pushdown is the key to efficiency for Nebula Graph. +- It is provided as a (kv) library and can be easily developed for the filter pushdown purpose. As a strong-typed database, how to provide Schema during pushdown is the key to efficiency for NebulaGraph. - It has strong data consistency. -Therefore, Nebula Graph develops its own KVStore with RocksDB as the local storage engine. The advantages are as follows. +Therefore, NebulaGraph develops its own KVStore with RocksDB as the local storage engine. The advantages are as follows. -- For multiple local hard disks, Nebula Graph can make full use of its concurrent capacities through deploying multiple data directories. +- For multiple local hard disks, NebulaGraph can make full use of its concurrent capacities through deploying multiple data directories. - The Meta Service manages all the Storage servers. All the partition distribution data and current machine status can be found in the meta service. Accordingly, users can execute a manual load balancing plan in meta service. !!! Note - Nebula Graph does not support auto load balancing because auto data transfer will affect online business. + NebulaGraph does not support auto load balancing because auto data transfer will affect online business. -- Nebula Graph provides its own WAL mode so one can customize the WAL. Each partition owns its WAL. +- NebulaGraph provides its own WAL mode so one can customize the WAL. Each partition owns its WAL. -- One Nebula Graph KVStore cluster supports multiple graph spaces, and each graph space has its own partition number and replica copies. Different graph spaces are isolated physically from each other in the same cluster. +- One NebulaGraph KVStore cluster supports multiple graph spaces, and each graph space has its own partition number and replica copies. Different graph spaces are isolated physically from each other in the same cluster. ## Data storage structure -Graphs consist of vertices and edges. Nebula Graph uses key-value pairs to store vertices, edges, and their properties. Vertices and edges are stored in keys and their properties are stored in values. Such structure enables efficient property filtering. +Graphs consist of vertices and edges. NebulaGraph uses key-value pairs to store vertices, edges, and their properties. Vertices and edges are stored in keys and their properties are stored in values. Such structure enables efficient property filtering. - The storage structure of vertices - Different from Nebula Graph version 2.x, version 3.x added a new key for each vertex. Compared to the old key that still exists, the new key has no `TagID` field and no value. Vertices in Nebula Graph can now live without tags owing to the new key. + Different from NebulaGraph version 2.x, version 3.x added a new key for each vertex. Compared to the old key that still exists, the new key has no `TagID` field and no value. Vertices in NebulaGraph can now live without tags owing to the new key. - ![The vertex structure of Nebula Graph](https://github.com/vesoft-inc/nebula-docs-cn/blob/{{nebula.branch}}/docs-2.0/1.introduction/3.nebula-graph-architecture/3.0-vertex-key.png?raw=true) + ![The vertex structure of NebulaGraph](https://github.com/vesoft-inc/nebula-docs-cn/blob/{{nebula.branch}}/docs-2.0/1.introduction/3.nebula-graph-architecture/3.0-vertex-key.png?raw=true) |Field|Description| |:---|:---| @@ -90,7 +90,7 @@ Graphs consist of vertices and edges. Nebula Graph uses key-value pairs to store - The storage structure of edges - ![The edge structure of Nebula Graph](https://github.com/vesoft-inc/nebula-docs-cn/blob/{{nebula.branch}}/docs-2.0/1.introduction/3.nebula-graph-architecture/3.0-edge-key.png?raw=true) + ![The edge structure of NebulaGraph](https://github.com/vesoft-inc/nebula-docs-cn/blob/{{nebula.branch}}/docs-2.0/1.introduction/3.nebula-graph-architecture/3.0-edge-key.png?raw=true) |Field|Description| |:---|:---| @@ -104,19 +104,19 @@ Graphs consist of vertices and edges. Nebula Graph uses key-value pairs to store ### Property descriptions -Nebula Graph uses strong-typed Schema. +NebulaGraph uses strong-typed Schema. -Nebula Graph will store the properties of vertex and edges in order after encoding them. Since the length of properties is fixed, queries can be made in no time according to offset. Before decoding, Nebula Graph needs to get (and cache) the schema information in the Meta Service. In addition, when encoding properties, Nebula Graph will add the corresponding schema version to support online schema change. +NebulaGraph will store the properties of vertex and edges in order after encoding them. Since the length of properties is fixed, queries can be made in no time according to offset. Before decoding, NebulaGraph needs to get (and cache) the schema information in the Meta Service. In addition, when encoding properties, NebulaGraph will add the corresponding schema version to support online schema change. ## Data partitioning -Since in an ultra-large-scale relational network, vertices can be as many as tens to hundreds of billions, and edges are even more than trillions. Even if only vertices and edges are stored, the storage capacity of both exceeds that of ordinary servers. Therefore, Nebula Graph uses hash to shard the graph elements and store them in different partitions. +Since in an ultra-large-scale relational network, vertices can be as many as tens to hundreds of billions, and edges are even more than trillions. Even if only vertices and edges are stored, the storage capacity of both exceeds that of ordinary servers. Therefore, NebulaGraph uses hash to shard the graph elements and store them in different partitions. ![data partitioning](https://www-cdn.nebula-graph.com.cn/nebula-blog/DataModel02.png) ### Edge partitioning and storage amplification -In Nebula Graph, an edge corresponds to two key-value pairs on the hard disk. When there are lots of edges and each has many properties, storage amplification will be obvious. The storage format of edges is shown in the figure below. +In NebulaGraph, an edge corresponds to two key-value pairs on the hard disk. When there are lots of edges and each has many properties, storage amplification will be obvious. The storage format of edges is shown in the figure below. ![partitioning by edge](https://github.com/vesoft-inc/nebula-docs-cn/blob/{{nebula.branch}}/docs-2.0/1.introduction/3.nebula-graph-architecture/edge-division.png?raw=true) @@ -132,19 +132,19 @@ In this example, ScrVertex connects DstVertex via EdgeA, forming the path of `(S EdgeA_Out and EdgeA_In are stored in storage layer with opposite directions, constituting EdgeA logically. EdgeA_Out is used for traversal requests starting from SrcVertex, such as `(a)-[]->()`; EdgeA_In is used for traversal requests starting from DstVertex, such as `()-[]->(a)`. -Like EdgeA_Out and EdgeA_In, Nebula Graph redundantly stores the information of each edge, which doubles the actual capacities needed for edge storage. The key corresponding to the edge occupies a small hard disk space, but the space occupied by Value is proportional to the length and amount of the property value. Therefore, it will occupy a relatively large hard disk space if the property value of the edge is large or there are many edge property values. +Like EdgeA_Out and EdgeA_In, NebulaGraph redundantly stores the information of each edge, which doubles the actual capacities needed for edge storage. The key corresponding to the edge occupies a small hard disk space, but the space occupied by Value is proportional to the length and amount of the property value. Therefore, it will occupy a relatively large hard disk space if the property value of the edge is large or there are many edge property values. To ensure the final consistency of the two key-value pairs when operating on edges, enable the [TOSS function](../../5.configurations-and-logs/1.configurations/3.graph-config.md ). After that, the operation will be performed in Partition x first where the out-edge is located, and then in Partition y where the in-edge is located. Finally, the result is returned. --> ### Partition algorithm -Nebula Graph uses a **static Hash** strategy to shard data through a modulo operation on vertex ID. All the out-keys, in-keys, and tag data will be placed in the same partition. In this way, query efficiency is increased dramatically. +NebulaGraph uses a **static Hash** strategy to shard data through a modulo operation on vertex ID. All the out-keys, in-keys, and tag data will be placed in the same partition. In this way, query efficiency is increased dramatically. !!! Note The number of partitions needs to be determined when users are creating a graph space since it cannot be changed afterward. Users are supposed to take into consideration the demands of future business when setting it. -When inserting into Nebula Graph, vertices and edges are distributed across different partitions. And the partitions are located on different machines. The number of partitions is set in the CREATE SPACE statement and cannot be changed afterward. +When inserting into NebulaGraph, vertices and edges are distributed across different partitions. And the partitions are located on different machines. The number of partitions is set in the CREATE SPACE statement and cannot be changed afterward. If certain vertices need to be placed on the same partition (i.e., on the same machine), see [Formula/code](https://github.com/vesoft-inc/nebula-common/blob/master/src/common/clients/meta/MetaClient.cpp). @@ -199,14 +199,14 @@ Failure: Scenario 1: Take a (space) cluster of a single replica as an example. I Raft and HDFS have different modes of duplication. Raft is based on a quorum vote, so the number of replicas cannot be even. ### Multi Group Raft -The Storage Service supports a distributed cluster architecture, so Nebula Graph implements Multi Group Raft according to Raft protocol. Each Raft group stores all the replicas of each partition. One replica is the leader, while others are followers. In this way, Nebula Graph achieves strong consistency and high availability. The functions of Raft are as follows. +The Storage Service supports a distributed cluster architecture, so NebulaGraph implements Multi Group Raft according to Raft protocol. Each Raft group stores all the replicas of each partition. One replica is the leader, while others are followers. In this way, NebulaGraph achieves strong consistency and high availability. The functions of Raft are as follows. -Nebula Graph uses Multi Group Raft to improve performance when there are many partitions because Raft-wal cannot be NULL. When there are too many partitions, costs will increase, such as storing information in Raft group, WAL files, or batch operation in low load. +NebulaGraph uses Multi Group Raft to improve performance when there are many partitions because Raft-wal cannot be NULL. When there are too many partitions, costs will increase, such as storing information in Raft group, WAL files, or batch operation in low load. There are two key points to implement the Multi Raft Group: @@ -220,7 +220,7 @@ There are two key points to implement the Multi Raft Group: ### Batch -For each partition, it is necessary to do a batch to improve throughput when writing the WAL serially. As Nebula Graph uses WAL to implement some special functions, batches need to be grouped, which is a feature of Nebula Graph. +For each partition, it is necessary to do a batch to improve throughput when writing the WAL serially. As NebulaGraph uses WAL to implement some special functions, batches need to be grouped, which is a feature of NebulaGraph. For example, lock-free CAS operations will execute after all the previous WALs are committed. So for a batch, if there are several WALs in CAS type, we need to divide this batch into several smaller groups and make sure they are committed serially. @@ -236,13 +236,13 @@ Raft listener can write the data into Elasticsearch cluster after receiving them ### Transfer Leadership -Transfer leadership is extremely important for balance. When moving a partition from one machine to another, Nebula Graph first checks if the source is a leader. If so, it should be moved to another peer. After data migration is completed, it is important to [balance leader distribution](../../8.service-tuning/load-balance.md) again. +Transfer leadership is extremely important for balance. When moving a partition from one machine to another, NebulaGraph first checks if the source is a leader. If so, it should be moved to another peer. After data migration is completed, it is important to [balance leader distribution](../../8.service-tuning/load-balance.md) again. When a transfer leadership command is committed, the leader will abandon its leadership and the followers will start a leader election. ### Peer changes -To avoid split-brain, when members in a Raft Group change, an intermediate state is required. In such a state, the quorum of the old group and new group always have an overlap. Thus it prevents the old or new group from making decisions unilaterally. To make it even simpler, in his doctoral thesis Diego Ongaro suggests adding or removing a peer once to ensure the overlap between the quorum of the new group and the old group. Nebula Graph also uses this approach, except that the way to add or remove a member is different. For details, please refer to addPeer/removePeer in the Raft Part class. +To avoid split-brain, when members in a Raft Group change, an intermediate state is required. In such a state, the quorum of the old group and new group always have an overlap. Thus it prevents the old or new group from making decisions unilaterally. To make it even simpler, in his doctoral thesis Diego Ongaro suggests adding or removing a peer once to ensure the overlap between the quorum of the new group and the old group. NebulaGraph also uses this approach, except that the way to add or remove a member is different. For details, please refer to addPeer/removePeer in the Raft Part class. ## Differences with HDFS diff --git a/docs-2.0/1.introduction/3.vid.md b/docs-2.0/1.introduction/3.vid.md index 2b676a0ab17..2c44a7dc076 100644 --- a/docs-2.0/1.introduction/3.vid.md +++ b/docs-2.0/1.introduction/3.vid.md @@ -1,6 +1,6 @@ # VID -In Nebula Graph, a vertex is uniquely identified by its ID, which is called a VID or a Vertex ID. +In NebulaGraph, a vertex is uniquely identified by its ID, which is called a VID or a Vertex ID. ## Features @@ -8,7 +8,7 @@ In Nebula Graph, a vertex is uniquely identified by its ID, which is called a VI - A VID in a graph space is unique. It functions just as a primary key in a relational database. VIDs in different graph spaces are independent. -- The VID generation method must be set by users, because Nebula Graph does not provide auto increasing ID, or UUID. +- The VID generation method must be set by users, because NebulaGraph does not provide auto increasing ID, or UUID. - Vertices with the same VID will be identified as the same one. For example: @@ -22,7 +22,7 @@ In Nebula Graph, a vertex is uniquely identified by its ID, which is called a VI ## VID Operation -- Nebula Graph 1.x only supports `INT64` while Nebula Graph 2.x supports `INT64` and `FIXED_STRING()`. In `CREATE SPACE`, VID types can be set via `vid_type`. +- NebulaGraph 1.x only supports `INT64` while NebulaGraph 2.x supports `INT64` and `FIXED_STRING()`. In `CREATE SPACE`, VID types can be set via `vid_type`. - `id()` function can be used to specify or locate a VID. @@ -52,7 +52,7 @@ A VID is set when you [insert a vertex](../3.ngql-guide/12.vertex-statements/1.i ## Query `start vid` and global scan -In most cases, the execution plan of query statements in Nebula Graph (`MATCH`, `GO`, and `LOOKUP`) must query the `start vid` in a certain way. +In most cases, the execution plan of query statements in NebulaGraph (`MATCH`, `GO`, and `LOOKUP`) must query the `start vid` in a certain way. There are only two ways to locate `start vid`: diff --git a/docs-2.0/14.client/1.nebula-client.md b/docs-2.0/14.client/1.nebula-client.md index f3f11b77297..58ce5c533ed 100644 --- a/docs-2.0/14.client/1.nebula-client.md +++ b/docs-2.0/14.client/1.nebula-client.md @@ -1,16 +1,16 @@ # Clients overview -Nebula Graph supports multiple types of clients for users to connect to and manage the Nebula Graph database. +NebulaGraph supports multiple types of clients for users to connect to and manage the NebulaGraph database. - [Nebula Console](../nebula-console.md): the native CLI client -- [Nebula CPP](3.nebula-cpp-client.md): the Nebula Graph client for C++ +- [Nebula CPP](3.nebula-cpp-client.md): the NebulaGraph client for C++ -- [Nebula Java](4.nebula-java-client.md): the Nebula Graph client for Java +- [Nebula Java](4.nebula-java-client.md): the NebulaGraph client for Java -- [Nebula Python](5.nebula-python-client.md): the Nebula Graph client for Python +- [Nebula Python](5.nebula-python-client.md): the NebulaGraph client for Python -- [Nebula Go](6.nebula-go-client.md): the Nebula Graph client for Golang +- [Nebula Go](6.nebula-go-client.md): the NebulaGraph client for Golang !!! note diff --git a/docs-2.0/14.client/3.nebula-cpp-client.md b/docs-2.0/14.client/3.nebula-cpp-client.md index b65d4199875..5ee7c9b442e 100644 --- a/docs-2.0/14.client/3.nebula-cpp-client.md +++ b/docs-2.0/14.client/3.nebula-cpp-client.md @@ -1,6 +1,6 @@ # Nebula CPP -[Nebula CPP](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}}) is a C++ client for connecting to and managing the Nebula Graph database. +[Nebula CPP](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}}) is a C++ client for connecting to and managing the NebulaGraph database. ## Prerequisites @@ -8,9 +8,9 @@ - You have prepared the [correct resources](../4.deployment-and-installation/1.resource-preparations.md). -## Compatibility with Nebula Graph +## Compatibility with NebulaGraph -|Nebula Graph version|Nebula CPP version| +|NebulaGraph version|Nebula CPP version| |:---|:---| |{{ nebula.release }}|{{cpp.release}}| |2.6.x|2.5.0| @@ -91,9 +91,9 @@ Compile the CPP file to an executable file, then you can use it. The following s $ LIBRARY_PATH=:$LIBRARY_PATH g++ -std=c++11 SessionExample.cpp -I -lnebula_graph_client -o session_example ``` - - `library_folder_path`: The storage path of the Nebula Graph dynamic libraries. The default path is `/usr/local/nebula/lib64`. + - `library_folder_path`: The storage path of the NebulaGraph dynamic libraries. The default path is `/usr/local/nebula/lib64`. - - `include_folder_path`: The storage of the Nebula Graph header files. The default path is `/usr/local/nebula/include`. + - `include_folder_path`: The storage of the NebulaGraph header files. The default path is `/usr/local/nebula/include`. For example: diff --git a/docs-2.0/14.client/4.nebula-java-client.md b/docs-2.0/14.client/4.nebula-java-client.md index 23ee7cc55da..41d481e2909 100644 --- a/docs-2.0/14.client/4.nebula-java-client.md +++ b/docs-2.0/14.client/4.nebula-java-client.md @@ -1,14 +1,14 @@ # Nebula Java -[Nebula Java](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}}) is a Java client for connecting to and managing the Nebula Graph database. +[Nebula Java](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}}) is a Java client for connecting to and managing the NebulaGraph database. ## Prerequisites You have installed Java 8.0 or later versions. -## Compatibility with Nebula Graph +## Compatibility with NebulaGraph -|Nebula Graph version|Nebula Java version| +|NebulaGraph version|Nebula Java version| |:---|:---| |{{ nebula.release }}|{{java.release}}| |2.6.x|2.6.1| diff --git a/docs-2.0/14.client/5.nebula-python-client.md b/docs-2.0/14.client/5.nebula-python-client.md index ff957d5cdc4..788c8585bba 100644 --- a/docs-2.0/14.client/5.nebula-python-client.md +++ b/docs-2.0/14.client/5.nebula-python-client.md @@ -1,14 +1,14 @@ # Nebula Python -[Nebula Python](https://github.com/vesoft-inc/nebula-python) is a Python client for connecting to and managing the Nebula Graph database. +[Nebula Python](https://github.com/vesoft-inc/nebula-python) is a Python client for connecting to and managing the NebulaGraph database. ## Prerequisites You have installed Python 3.6 or later versions. -## Compatibility with Nebula Graph +## Compatibility with NebulaGraph -|Nebula Graph version|Nebula Python version| +|NebulaGraph version|Nebula Python version| |:---|:---| |{{ nebula.release }}|{{python.release}}| |2.6.x|2.6.0| diff --git a/docs-2.0/14.client/6.nebula-go-client.md b/docs-2.0/14.client/6.nebula-go-client.md index 4a54c9b350b..4350eb524af 100644 --- a/docs-2.0/14.client/6.nebula-go-client.md +++ b/docs-2.0/14.client/6.nebula-go-client.md @@ -1,14 +1,14 @@ # Nebula Go -[Nebula Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}}) is a Golang client for connecting to and managing the Nebula Graph database. +[Nebula Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}}) is a Golang client for connecting to and managing the NebulaGraph database. ## Prerequisites You have installed Golang 1.13 or later versions. -## Compatibility with Nebula Graph +## Compatibility with NebulaGraph -|Nebula Graph version|Nebula Go version| +|NebulaGraph version|Nebula Go version| |:---|:---| |{{ nebula.release }}|{{go.release}}| |2.6.x|2.6.0| diff --git a/docs-2.0/15.contribution/how-to-contribute.md b/docs-2.0/15.contribution/how-to-contribute.md index c525986c451..aedbdac5650 100644 --- a/docs-2.0/15.contribution/how-to-contribute.md +++ b/docs-2.0/15.contribution/how-to-contribute.md @@ -28,7 +28,7 @@ This method applies to contribute codes, modify multiple documents in batches, o ## Step 1: Fork in the github.com -The Nebula Graph project has many [repositories](https://github.com/vesoft-inc). Take [the nebul repository](https://github.com/vesoft-inc/nebula) for example: +The NebulaGraph project has many [repositories](https://github.com/vesoft-inc). Take [the nebul repository](https://github.com/vesoft-inc/nebula) for example: 1. Visit [https://github.com/vesoft-inc/nebula](https://github.com/vesoft-inc/nebula). @@ -75,7 +75,7 @@ The Nebula Graph project has many [repositories](https://github.com/vesoft-inc). 4. (Optional) Define a pre-commit hook. - Please link the Nebula Graph pre-commit hook into the `.git` directory. + Please link the NebulaGraph pre-commit hook into the `.git` directory. This hook checks the commits for formatting, building, doc generation, etc. @@ -123,7 +123,7 @@ The Nebula Graph project has many [repositories](https://github.com/vesoft-inc). - Code style - **Nebula Graph** adopts `cpplint` to make sure that the project conforms to Google's coding style guides. The checker will be implemented before the code is committed. + **NebulaGraph** adopts `cpplint` to make sure that the project conforms to Google's coding style guides. The checker will be implemented before the code is committed. - Unit tests requirements @@ -131,7 +131,7 @@ The Nebula Graph project has many [repositories](https://github.com/vesoft-inc). - Build your code with unit tests enabled - For more information, see [Install Nebula Graph by compiling the source code](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md). + For more information, see [Install NebulaGraph by compiling the source code](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md). !!! Note @@ -192,7 +192,7 @@ For detailed methods, see [How to add test cases](https://github.com/vesoft-inc/ ### Step 1: Confirm the project donation -Contact the official Nebula Graph staff via email, WeChat, Slack, etc. to confirm the donation project. The project will be donated to the [Nebula Contrib organization](https://github.com/nebula-contrib). +Contact the official NebulaGraph staff via email, WeChat, Slack, etc. to confirm the donation project. The project will be donated to the [Nebula Contrib organization](https://github.com/nebula-contrib). Email address: info@vesoft.com @@ -202,7 +202,7 @@ Slack: [Join Slack](https://join.slack.com/t/nebulagraph/shared_invite/zt-7ybeju ### Step 2: Get the information of the project recipient -The Nebula Graph official staff will give the recipient ID of the Nebula Contrib project. +The NebulaGraph official staff will give the recipient ID of the Nebula Contrib project. ### Step 3: Donate a project diff --git a/docs-2.0/2.quick-start/1.quick-start-workflow.md b/docs-2.0/2.quick-start/1.quick-start-workflow.md index 2068f105868..4562a2b29dc 100644 --- a/docs-2.0/2.quick-start/1.quick-start-workflow.md +++ b/docs-2.0/2.quick-start/1.quick-start-workflow.md @@ -1,23 +1,23 @@ # Quick start workflow -The quick start introduces the simplest workflow to use Nebula Graph, including deploying Nebula Graph, connecting to Nebula Graph, and doing basic CRUD. +The quick start introduces the simplest workflow to use NebulaGraph, including deploying NebulaGraph, connecting to NebulaGraph, and doing basic CRUD. ## Documents -Users can quickly deploy and use Nebula Graph in the following steps. +Users can quickly deploy and use NebulaGraph in the following steps. -1. [Deploy Nebula Graph](2.install-nebula-graph.md) +1. [Deploy NebulaGraph](2.install-nebula-graph.md) - Users can use the RPM or DEB file to quickly deploy Nebula Graph. For other ways to deploy Nebula Graph and corresponding preparations, see [deployment and installation](../4.deployment-and-installation/1.resource-preparations.md). + Users can use the RPM or DEB file to quickly deploy NebulaGraph. For other ways to deploy NebulaGraph and corresponding preparations, see [deployment and installation](../4.deployment-and-installation/1.resource-preparations.md). -2. [Start Nebula Graph](5.start-stop-service.md) +2. [Start NebulaGraph](5.start-stop-service.md) - Users need to start Nebula Graph after deployment. + Users need to start NebulaGraph after deployment. -3. [Connect to Nebula Graph](3.connect-to-nebula-graph.md) +3. [Connect to NebulaGraph](3.connect-to-nebula-graph.md) - Then users can use clients to connect to Nebula Graph. Nebula Graph supports a variety of clients. This topic will describe how to use Nebula Console to connect to Nebula Graph. + Then users can use clients to connect to NebulaGraph. NebulaGraph supports a variety of clients. This topic will describe how to use Nebula Console to connect to NebulaGraph. -4. [CRUD in Nebula Graph](4.nebula-graph-crud.md) +4. [CRUD in NebulaGraph](4.nebula-graph-crud.md) - Users can use nGQL (Nebula Graph Query Language) to run CRUD after connecting to Nebula Graph. + Users can use nGQL (NebulaGraph Query Language) to run CRUD after connecting to NebulaGraph. diff --git a/docs-2.0/2.quick-start/2.install-nebula-graph.md b/docs-2.0/2.quick-start/2.install-nebula-graph.md index 3771365834c..28018072dc2 100644 --- a/docs-2.0/2.quick-start/2.install-nebula-graph.md +++ b/docs-2.0/2.quick-start/2.install-nebula-graph.md @@ -1,4 +1,4 @@ -# Step 1: Install Nebula Graph +# Step 1: Install NebulaGraph {% include "/source_install-nebula-graph-by-rpm-or-deb.md" %} diff --git a/docs-2.0/2.quick-start/3.connect-to-nebula-graph.md b/docs-2.0/2.quick-start/3.connect-to-nebula-graph.md index 9a07a1262a9..11a5ba57da8 100644 --- a/docs-2.0/2.quick-start/3.connect-to-nebula-graph.md +++ b/docs-2.0/2.quick-start/3.connect-to-nebula-graph.md @@ -1,4 +1,4 @@ -# Step 3: Connect to Nebula Graph +# Step 3: Connect to NebulaGraph {% include "/source_connect-to-nebula-graph.md" %} diff --git a/docs-2.0/2.quick-start/4.nebula-graph-crud.md b/docs-2.0/2.quick-start/4.nebula-graph-crud.md index 1e780792d6b..d0e52d5a9cd 100644 --- a/docs-2.0/2.quick-start/4.nebula-graph-crud.md +++ b/docs-2.0/2.quick-start/4.nebula-graph-crud.md @@ -1,16 +1,16 @@ # Step 4: Use nGQL (CRUD) -This topic will describe the basic CRUD operations in Nebula Graph. +This topic will describe the basic CRUD operations in NebulaGraph. For more information, see [nGQL guide](../3.ngql-guide/1.nGQL-overview/1.overview.md). -## Graph space and Nebula Graph schema +## Graph space and NebulaGraph schema -A Nebula Graph instance consists of one or more graph spaces. Graph spaces are physically isolated from each other. You can use different graph spaces in the same instance to store different datasets. +A NebulaGraph instance consists of one or more graph spaces. Graph spaces are physically isolated from each other. You can use different graph spaces in the same instance to store different datasets. -![Nebula Graph and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-graph-instance-and-graph-spaces.png) +![NebulaGraph and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-graph-instance-and-graph-spaces.png) -To insert data into a graph space, define a schema for the graph database. Nebula Graph schema is based on the following components. +To insert data into a graph space, define a schema for the graph database. NebulaGraph schema is based on the following components. | Schema component | Description | | ---------------- | ------------| @@ -25,9 +25,9 @@ In this topic, we will use the following dataset to demonstrate basic CRUD opera ![The demo dataset](dataset-for-crud.png) -## Manage the Storage services in a Nebula Graph cluster +## Manage the Storage services in a NebulaGraph cluster -First, add the Storage services to a Nebula Graph cluster. +First, add the Storage services to a NebulaGraph cluster. diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md index 193150f35e1..e6356c20942 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md @@ -340,7 +340,7 @@ | Statement | Syntax | Example | Description | | ------------------------------------------------------------ | ------------------------------------------------- | ------------------------------------ | -------------------------------------------------------- | | [SHOW CHARSET](../3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md) | `SHOW CHARSET` | `SHOW CHARSET` | Shows the available character sets. | - | [SHOW COLLATION](../3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md) | `SHOW COLLATION` | `SHOW COLLATION` | Shows the collations supported by Nebula Graph. | + | [SHOW COLLATION](../3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md) | `SHOW COLLATION` | `SHOW COLLATION` | Shows the collations supported by NebulaGraph. | | [SHOW CREATE SPACE](../3.ngql-guide/7.general-query-statements/6.show/4.show-create-space.md) | `SHOW CREATE SPACE ` | `SHOW CREATE SPACE basketballplayer` | Shows the creating statement of the specified graph space. | | [SHOW CREATE TAG/EDGE](../3.ngql-guide/7.general-query-statements/6.show/5.show-create-tag-edge.md) | `SHOW CREATE {TAG | EDGE }` | `SHOW CREATE TAG player` | Shows the basic information of the specified tag. | | [SHOW HOSTS](../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md) | `SHOW HOSTS [GRAPH | STORAGE | META]` | `SHOW HOSTS`
`SHOW HOSTS GRAPH` | Shows the host and version information of Graph Service, Storage Service, and Meta Service. | @@ -349,7 +349,7 @@ | [SHOW PARTS](../3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md) | `SHOW PARTS []` | `SHOW PARTS` | Shows the information of a specified partition or all partitions in a graph space. | | [SHOW ROLES](../3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md) | `SHOW ROLES IN ` | `SHOW ROLES in basketballplayer` | Shows the roles that are assigned to a user account. | | [SHOW SNAPSHOTS](../3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md) | `SHOW SNAPSHOTS` | `SHOW SNAPSHOTS` | Shows the information of all the snapshots. - | [SHOW SPACES](../3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md) | `SHOW SPACES` | `SHOW SPACES` | Shows existing graph spaces in Nebula Graph. | + | [SHOW SPACES](../3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md) | `SHOW SPACES` | `SHOW SPACES` | Shows existing graph spaces in NebulaGraph. | | [SHOW STATS](../3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md) | `SHOW STATS` | `SHOW STATS` | Shows the statistics of the graph space collected by the latest `STATS` job. | | [SHOW TAGS/EDGES](../3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md) | `SHOW TAGS | EDGES` | `SHOW TAGS`、`SHOW EDGES` | Shows all the tags in the current graph space. | | [SHOW USERS](../3.ngql-guide/7.general-query-statements/6.show/16.show-users.md) | `SHOW USERS` | `SHOW USERS` | Shows the user information. | @@ -382,7 +382,7 @@ | [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE [IF NOT EXISTS] ( [partition_num = ,] [replica_factor = ,] vid_type = {FIXED_STRING() | INT[64]} ) [COMMENT = '']` | `CREATE SPACE my_space_1 (vid_type=FIXED_STRING(30))` | Creates a graph space with | | [CREATE SPACE](../3.ngql-guide/9.space-statements/1.create-space.md) | `CREATE SPACE AS ` | `CREATE SPACE my_space_4 as my_space_3` | Clone a graph. space. | | [USE](../3.ngql-guide/9.space-statements/2.use-space.md) | `USE ` | `USE space1` | Specifies a graph space as the current working graph space for subsequent queries. | -| [SHOW SPACES](../3.ngql-guide/9.space-statements/3.show-spaces.md) | `SHOW SPACES` | `SHOW SPACES` | Lists all the graph spaces in the Nebula Graph examples. | +| [SHOW SPACES](../3.ngql-guide/9.space-statements/3.show-spaces.md) | `SHOW SPACES` | `SHOW SPACES` | Lists all the graph spaces in the NebulaGraph examples. | | [DESCRIBE SPACE](../3.ngql-guide/9.space-statements/4.describe-space.md) | `DESC[RIBE] SPACE ` | `DESCRIBE SPACE basketballplayer` | Returns the information about the specified graph space.息。 | | [DROP SPACE](../3.ngql-guide/9.space-statements/5.drop-space.md) | `DROP SPACE [IF EXISTS] ` | `DROP SPACE basketballplayer` | Deletes everything in the specified graph space. | @@ -411,7 +411,7 @@ | Statement | Syntax | Example | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md) | `INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...] VALUES : ([prop_value_list])` | `INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8)` | Inserts one or more vertices into a graph space in Nebula Graph. | +| [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md) | `INSERT VERTEX [IF NOT EXISTS] [tag_props, [tag_props] ...] VALUES : ([prop_value_list])` | `INSERT VERTEX t2 (name, age) VALUES "13":("n3", 12), "14":("n4", 8)` | Inserts one or more vertices into a graph space in NebulaGraph. | | [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md) | `DELETE VERTEX [, ...]` | `DELETE VERTEX "team1"` | Deletes vertices and the related incoming and outgoing edges of the vertices. | | [UPDATE VERTEX](../3.ngql-guide/12.vertex-statements/2.update-vertex.md) | `UPDATE VERTEX ON SET [WHEN ] [YIELD ]` | `UPDATE VERTEX ON player "player101" SET age = age + 2 ` | Updates properties on tags of a vertex. | | [UPSERT VERTEX](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `UPSERT VERTEX ON SET [WHEN ] [YIELD ]` | `UPSERT VERTEX ON player "player667" SET age = 31` | The `UPSERT` statement is a combination of `UPDATE` and `INSERT`. You can use `UPSERT VERTEX` to update the properties of a vertex if it exists or insert a new vertex if it does not exist. | @@ -420,7 +420,7 @@ | Statement | Syntax | Example | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md) | `INSERT EDGE [IF NOT EXISTS] ( ) VALUES -> [@] : ( ) [, -> [@] : ( ), ...]` | `INSERT EDGE e2 (name, age) VALUES "11"->"13":("n1", 1)` | Inserts an edge or multiple edges into a graph space from a source vertex (given by src_vid) to a destination vertex (given by dst_vid) with a specific rank in Nebula Graph. | +| [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md) | `INSERT EDGE [IF NOT EXISTS] ( ) VALUES -> [@] : ( ) [, -> [@] : ( ), ...]` | `INSERT EDGE e2 (name, age) VALUES "11"->"13":("n1", 1)` | Inserts an edge or multiple edges into a graph space from a source vertex (given by src_vid) to a destination vertex (given by dst_vid) with a specific rank in NebulaGraph. | | [DELETE EDGE](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `DELETE EDGE -> [@] [, -> [@] ...]` | `DELETE EDGE serve "player100" -> "team204"@0` | Deletes one edge or multiple edges at a time. | | [UPDATE EDGE](../3.ngql-guide/13.edge-statements/2.update-edge.md) | `UPDATE EDGE ON -> [@] SET [WHEN ] [YIELD ]` | `UPDATE EDGE ON serve "player100" -> "team204"@0 SET start_year = start_year + 1` | Updates properties on an edge. | | [UPSERT EDGE](../3.ngql-guide/12.vertex-statements/3.upsert-vertex.md) | `UPSERT EDGE ON -> [@rank] SET [WHEN ] [YIELD ]` | `UPSERT EDGE on serve "player666" -> "team200"@0 SET end_year = 2021` | The `UPSERT` statement is a combination of `UPDATE` and `INSERT`. You can use `UPSERT EDGE` to update the properties of an edge if it exists or insert a new edge if it does not exist. | diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index c2783c1f094..b303e91dc5f 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -1,14 +1,14 @@ # FAQ -This topic lists the frequently asked questions for using Nebula Graph {{ nebula.release }}. You can use the search box in the help center or the search function of the browser to match the questions you are looking for. +This topic lists the frequently asked questions for using NebulaGraph {{ nebula.release }}. You can use the search box in the help center or the search function of the browser to match the questions you are looking for. -If the solutions described in this topic cannot solve your problems, ask for help on the [Nebula Graph forum](https://discuss.nebula-graph.io/) or submit an issue on [GitHub issue](https://github.com/vesoft-inc/nebula/issues). +If the solutions described in this topic cannot solve your problems, ask for help on the [NebulaGraph forum](https://discuss.nebula-graph.io/) or submit an issue on [GitHub issue](https://github.com/vesoft-inc/nebula/issues). ## About manual updates ### "Why is the behavior in the manual not consistent with the system?" -Nebula Graph is still under development. Its behavior changes from time to time. Users can submit an [issue](https://github.com/vesoft-inc/nebula/issues/new) to inform the team if the manual and the system are not consistent. +NebulaGraph is still under development. Its behavior changes from time to time. Users can submit an [issue](https://github.com/vesoft-inc/nebula/issues/new) to inform the team if the manual and the system are not consistent. !!! note @@ -22,33 +22,33 @@ Nebula Graph is still under development. Its behavior changes from time to time. !!! compatibility "`X` version compatibility" - Neubla Graph {{ nebula.release }} is **not compatible** with Nebula Graph 1.x nor 2.0-RC in both data formats and RPC-protocols, and **vice versa**. - To upgrade data formats, see [Upgrade Nebula Graph to the current version](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md). + Neubla Graph {{ nebula.release }} is **not compatible** with NebulaGraph 1.x nor 2.0-RC in both data formats and RPC-protocols, and **vice versa**. + To upgrade data formats, see [Upgrade NebulaGraph to the current version](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md). Users must upgrade [all clients](../20.appendix/6.eco-tool-version.md). ## About execution errors ### "How to resolve the error `SemanticError: Missing yield clause.`?" -Starting with Nebula Graph 3.0.0, the statements `LOOKUP`, `GO`, and `FETCH` must output results with the `YIELD` clause. For more information, see [YIELD](../3.ngql-guide/8.clauses-and-options/yield.md). +Starting with NebulaGraph 3.0.0, the statements `LOOKUP`, `GO`, and `FETCH` must output results with the `YIELD` clause. For more information, see [YIELD](../3.ngql-guide/8.clauses-and-options/yield.md). ### "How to resolve the error `Zone not enough!`?" -From Nebula Graph version 3.0.0, the Storage services added in the configuration files **CANNOT** be read or written directly. The configuration files only register the Storage services into the Meta services. You must run the `ADD HOSTS` command to read and write data on Storage servers. For more information, see [Manage Storage hosts](../4.deployment-and-installation/manage-storage-host.md). +From NebulaGraph version 3.0.0, the Storage services added in the configuration files **CANNOT** be read or written directly. The configuration files only register the Storage services into the Meta services. You must run the `ADD HOSTS` command to read and write data on Storage servers. For more information, see [Manage Storage hosts](../4.deployment-and-installation/manage-storage-host.md). ### "How to resolve the error `To get the property of the vertex in 'v.age', should use the format 'var.tag.prop'`?" -From Nebula Graph version 3.0.0, patterns support matching multiple tags at the same time, so you need to specify a tag name when querying properties. The original statement `RETURN variable_name.property_name` is changed to `RETURN variable_name..property_name`. +From NebulaGraph version 3.0.0, patterns support matching multiple tags at the same time, so you need to specify a tag name when querying properties. The original statement `RETURN variable_name.property_name` is changed to `RETURN variable_name..property_name`. ### "How to resolve `[ERROR (-1005)]: Used memory hits the high watermark(0.800000) of total system memory.`?" -The reason for this error may be that `system_memory_high_watermark_ratio` specifies the trigger threshold of the memory high watermark alarm mechanism. The default value is `0.8`. If the system memory usage is higher than this value, an alarm mechanism will be triggered, and Nebula Graph will stop querying. +The reason for this error may be that `system_memory_high_watermark_ratio` specifies the trigger threshold of the memory high watermark alarm mechanism. The default value is `0.8`. If the system memory usage is higher than this value, an alarm mechanism will be triggered, and NebulaGraph will stop querying. Possible solutions are as follows: @@ -139,7 +139,7 @@ Check whether the length of the VID exceeds the limitation. For more information ### "How to resolve the error `edge conflict` or `vertex conflict`?" -Nebula Graph may return such errors when the Storage service receives multiple requests to insert or update the same vertex or edge within milliseconds. Try the failed requests again later. +NebulaGraph may return such errors when the Storage service receives multiple requests to insert or update the same vertex or edge within milliseconds. Try the failed requests again later. ### "How to resolve the error `RPC failure in MetaClient: Connection refused`?" @@ -186,19 +186,19 @@ Got 1 rows (time spent 1235/1934 us) - The second number `1934` shows the time spent from the client's perspective, that is, the time it takes for the client from sending a request, receiving a response, and displaying the result on the screen. -### Why does the port number of the `nebula-storaged` process keep showing red after connecting to Nebula Graph? +### Why does the port number of the `nebula-storaged` process keep showing red after connecting to NebulaGraph? -Because the `nebula-storaged` process waits for `nebula-metad` to add the current Storage service during the startup process. The Storage works after it receives the ready signal. Starting from Nebula Graph 3.0.0, the Meta service cannot directly read or write data in the Storage service that you add in the configuration file. The configuration file only registers the Storage service to the Meta service. You must run the `ADD HOSTS` command to enable the Meta to read and write data in the Storage service. For more information, see [Manage Storage hosts](../4.deployment-and-installation/manage-storage-host.md). +Because the `nebula-storaged` process waits for `nebula-metad` to add the current Storage service during the startup process. The Storage works after it receives the ready signal. Starting from NebulaGraph 3.0.0, the Meta service cannot directly read or write data in the Storage service that you add in the configuration file. The configuration file only registers the Storage service to the Meta service. You must run the `ADD HOSTS` command to enable the Meta to read and write data in the Storage service. For more information, see [Manage Storage hosts](../4.deployment-and-installation/manage-storage-host.md). -### Why is there no line separating each row in the returned result of Nebula Graph 2.6.0? +### Why is there no line separating each row in the returned result of NebulaGraph 2.6.0? -This is caused by the release of Nebula Console 2.6.0, not the change of Nebula Graph core. And it will not affect the content of the returned data itself. +This is caused by the release of Nebula Console 2.6.0, not the change of NebulaGraph core. And it will not affect the content of the returned data itself. ### About dangling edges A dangling edge is an edge that only connects to a single vertex and only one part of the edge connects to the vertex. -Dangling edges may appear in Nebula Graph {{ nebula.release }} as the design. And there is no `MERGE` statements of openCypher. The guarantee for dangling edges depends entirely on the application level. For more information, see [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md), [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md), [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md), [DELETE EDGE](../3.ngql-guide/13.edge-statements/4.delete-edge.md). +Dangling edges may appear in NebulaGraph {{ nebula.release }} as the design. And there is no `MERGE` statements of openCypher. The guarantee for dangling edges depends entirely on the application level. For more information, see [INSERT VERTEX](../3.ngql-guide/12.vertex-statements/1.insert-vertex.md), [DELETE VERTEX](../3.ngql-guide/12.vertex-statements/4.delete-vertex.md), [INSERT EDGE](../3.ngql-guide/13.edge-statements/1.insert-edge.md), [DELETE EDGE](../3.ngql-guide/13.edge-statements/4.delete-edge.md). ### "Can I set `replica_factor` as an even number in `CREATE SPACE` statements, e.g., `replica_factor = 2`?" @@ -298,14 +298,14 @@ You can use [Nebula Algorithm](../nebula-algorithm.md). ### "The log files are too large. How to recycle the logs?" -By default, the logs of Nebula Graph are stored in `/usr/local/nebula/logs/`. The INFO level log files are `nebula-graphd.INFO, nebula-storaged.INFO, nebula-metad.INFO`. If an alarm or error occurs, the suffixes are modified as `.WARNING` or `.ERROR`. +By default, the logs of NebulaGraph are stored in `/usr/local/nebula/logs/`. The INFO level log files are `nebula-graphd.INFO, nebula-storaged.INFO, nebula-metad.INFO`. If an alarm or error occurs, the suffixes are modified as `.WARNING` or `.ERROR`. -Nebula Graph uses [glog](https://github.com/google/glog) to print logs. `glog` cannot recycle the outdated files. To rotate logs, you can: +NebulaGraph uses [glog](https://github.com/google/glog) to print logs. `glog` cannot recycle the outdated files. To rotate logs, you can: - Use crontab to delete logs periodically. For more information, see [`Glog should delete old log files automatically`](https://github.com/google/glog/issues/423). - Use [logrotate](https://github.com/logrotate/logrotate) to manage log files. Before using logrotate, modify the configurations of corresponding services and set `timestamp_in_logfile_name` to `false`. -### "How to check the Nebula Graph version?" +### "How to check the NebulaGraph version?" If the service is running: run command `SHOW HOSTS META` in `nebula-console`. See [SHOW HOSTS](../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md). @@ -313,15 +313,15 @@ If the service is not running: Different installation methods make the method of checking the version different. The instructions are as follows: -If the service is not running, run the command `./ --version` to get the version and the Git commit IDs of the Nebula Graph binary files. For example: +If the service is not running, run the command `./ --version` to get the version and the Git commit IDs of the NebulaGraph binary files. For example: ```bash $ ./nebula-graphd --version ``` -- If you deploy Nebula Graph with Docker Compose +- If you deploy NebulaGraph with Docker Compose - Check the version of Nebula Graph deployed by Docker Compose. The method is similar to the previous method, except that you have to enter the container first. The commands are as follows: + Check the version of NebulaGraph deployed by Docker Compose. The method is similar to the previous method, except that you have to enter the container first. The commands are as follows: ```bash docker exec -it nebula-docker-compose_graphd_1 bash @@ -329,14 +329,14 @@ $ ./nebula-graphd --version ./nebula-graphd --version ``` -- If you install Nebula Graph with RPM/DEB package +- If you install NebulaGraph with RPM/DEB package - Run `rpm -qa |grep nebula` to check the version of Nebula Graph. + Run `rpm -qa |grep nebula` to check the version of NebulaGraph. +Nebula Operator (Operator for short) is a tool to automate the deployment, operation, and maintenance of NebulaGraph clusters on Kubernetes. Building upon the excellent scalability mechanism of Kubernetes, NebulaGraph introduced its operation and maintenance knowledge into the Kubernetes system, which makes NebulaGraph a real cloud-native graph database. For more information, see [What is Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md). --> ## Nebula Importer -Nebula Importer (Importer for short) is a CSV file import tool for Nebula Graph. The Importer can read the local CSV file, and then import the data into the Nebula Graph database. For details, see [What is Nebula Importer](../nebula-importer/use-importer.md). +Nebula Importer (Importer for short) is a CSV file import tool for NebulaGraph. The Importer can read the local CSV file, and then import the data into the NebulaGraph database. For details, see [What is Nebula Importer](../nebula-importer/use-importer.md). ## Nebula Spark Connector -Nebula Spark Connector is a Spark connector that provides the ability to read and write Nebula Graph data in the Spark standard format. Nebula Spark Connector consists of two parts, Reader and Writer. For details, see [What is Nebula Spark Connector](../nebula-spark-connector.md). +Nebula Spark Connector is a Spark connector that provides the ability to read and write NebulaGraph data in the Spark standard format. Nebula Spark Connector consists of two parts, Reader and Writer. For details, see [What is Nebula Spark Connector](../nebula-spark-connector.md). ## Nebula Flink Connector -Nebula Flink Connector is a connector that helps Flink users quickly access Nebula Graph. It supports reading data from the Nebula Graph database or writing data read from other external data sources to the Nebula Graph database. For details, see [What is Nebula Flink Connector](../nebula-flink-connector.md). +Nebula Flink Connector is a connector that helps Flink users quickly access NebulaGraph. It supports reading data from the NebulaGraph database or writing data read from other external data sources to the NebulaGraph database. For details, see [What is Nebula Flink Connector](../nebula-flink-connector.md). ## Nebula Algorithm -Nebula Algorithm (Algorithm for short) is a Spark application based on [GraphX](https://spark.apache.org/graphx/), which uses a complete algorithm tool to analyze data in the Nebula Graph database by submitting a Spark task To perform graph computing, use the algorithm under the lib repository through programming to perform graph computing for DataFrame. For details, see [What is Nebula Algorithm](../nebula-algorithm.md). +Nebula Algorithm (Algorithm for short) is a Spark application based on [GraphX](https://spark.apache.org/graphx/), which uses a complete algorithm tool to analyze data in the NebulaGraph database by submitting a Spark task To perform graph computing, use the algorithm under the lib repository through programming to perform graph computing for DataFrame. For details, see [What is Nebula Algorithm](../nebula-algorithm.md). ## Nebula Analytics -Nebula Analytics is a high-performance graph computing framework tool that performs graph analysis of data in the Nebula Graph database.. For details, see [What is Nebula Analytics](../nebula-analytics.md). +Nebula Analytics is a high-performance graph computing framework tool that performs graph analysis of data in the NebulaGraph database.. For details, see [What is Nebula Analytics](../nebula-analytics.md). ## Nebula Console -Nebula Console is the native CLI client of Nebula Graph. For how to use it, see [Connect Nebula Graph](../2.quick-start/3.connect-to-nebula-graph.md). +Nebula Console is the native CLI client of NebulaGraph. For how to use it, see [Connect NebulaGraph](../2.quick-start/3.connect-to-nebula-graph.md). ## Nebula Docker Compose -Docker Compose can quickly deploy Nebula Graph clusters. For how to use it, please refer to [Docker Compose Deployment Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md ). +Docker Compose can quickly deploy NebulaGraph clusters. For how to use it, please refer to [Docker Compose Deployment NebulaGraph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md ). ## Backup & Restore -[Backup&Restore](https://github.com/vesoft-inc/nebula-br) (BR for short) is a command line interface (CLI) tool that can help back up the graph space data of Nebula Graph, or restore it through a backup file data. +[Backup&Restore](https://github.com/vesoft-inc/nebula-br) (BR for short) is a command line interface (CLI) tool that can help back up the graph space data of NebulaGraph, or restore it through a backup file data. ## Nebula Bench -[Nebula Bench](https://github.com/vesoft-inc/nebula-bench) is used to test the baseline performance data of Nebula Graph. It uses the standard data set of LDBC. +[Nebula Bench](https://github.com/vesoft-inc/nebula-bench) is used to test the baseline performance data of NebulaGraph. It uses the standard data set of LDBC. ## Monitoring @@ -100,7 +100,7 @@ Docker Compose can quickly deploy Nebula Graph clusters. For how to use it, plea Select the latest version of `X.Y.*` which is the same as the core version. -|Nebula Graph version| Language (commit id) | +|NebulaGraph version| Language (commit id) | |:---| :--- | | {{ nebula.release }}| [C++](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}}) | | {{ nebula.release }}| [Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}}) | diff --git a/docs-2.0/20.appendix/history.md b/docs-2.0/20.appendix/history.md index 0ff5028b9b3..b8dc425bb9e 100644 --- a/docs-2.0/20.appendix/history.md +++ b/docs-2.0/20.appendix/history.md @@ -1,42 +1,42 @@ -# History timeline for Nebula Graph +# History timeline for NebulaGraph -1. 2018.9: [dutor](https://github.com/dutor) wrote and submitted the first line of Nebula Graph database code. +1. 2018.9: [dutor](https://github.com/dutor) wrote and submitted the first line of NebulaGraph database code. ![image](https://docs-cdn.nebula-graph.com.cn/books/images/dutor.png) -2. 2019.5: Nebula Graph v0.1.0-alpha was released as open-source. +2. 2019.5: NebulaGraph v0.1.0-alpha was released as open-source. ![image](https://docs-cdn.nebula-graph.com.cn/books/images/alpha-bj.png) ![image](https://docs-cdn.nebula-graph.com.cn/books/images/alpha-hz.jpg) - Nebula Graph v1.0.0-beta, v1.0.0-rc1, v1.0.0-rc2, v1.0.0-rc3, and v1.0.0-rc4 were released one after another within a year thereafter. + NebulaGraph v1.0.0-beta, v1.0.0-rc1, v1.0.0-rc2, v1.0.0-rc3, and v1.0.0-rc4 were released one after another within a year thereafter. ![image](https://docs-cdn.nebula-graph.com.cn/books/images/v010.png) -3. 2019.7: Nebula Graph's debut at HBaseCon[^HBaseCon]. @[dangleptr](https://github.com/dangleptr) +3. 2019.7: NebulaGraph's debut at HBaseCon[^HBaseCon]. @[dangleptr](https://github.com/dangleptr) ![image](https://www-cdn.nebula-graph.com.cn/nebula-blog/HBase01.png) - [^HBaseCon]: Nebula Graph v1.x supports both RocksDB and HBase as its storage engines. Nebula Graph v2.x removes HBase supports. + [^HBaseCon]: NebulaGraph v1.x supports both RocksDB and HBase as its storage engines. NebulaGraph v2.x removes HBase supports. -4. 2020.3: Nebula Graph v2.0 was starting developed in the final stage of v1.0 development. +4. 2020.3: NebulaGraph v2.0 was starting developed in the final stage of v1.0 development. -5. 2020.6: The first major version of Nebula Graph v1.0.0 GA was released. +5. 2020.6: The first major version of NebulaGraph v1.0.0 GA was released. ![image](https://docs-cdn.nebula-graph.com.cn/books/images/v100GA.png) -6. 2021.3: The second major version of Nebula Graph v2.0 GA was released. +6. 2021.3: The second major version of NebulaGraph v2.0 GA was released. ![image](https://docs-cdn.nebula-graph.com.cn/books/images/v200.png) -7. 2021.8: Nebula Graph v2.5.0 was released. +7. 2021.8: NebulaGraph v2.5.0 was released. ![image](https://docs-cdn.nebula-graph.com.cn/books/images/2.5.0.png) -8. 2021.10: Nebula Graph v2.6.0 was released. +8. 2021.10: NebulaGraph v2.6.0 was released. For more information about release notes, see [Releases](https://github.com/vesoft-inc/nebula/releases). -9. 2022.2: Nebula Graph v3.0.0 was released. +9. 2022.2: NebulaGraph v3.0.0 was released. For more information about release notes, see [Releases](https://github.com/vesoft-inc/nebula/releases). diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index c981331b2e9..ba836c360dc 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -1,16 +1,16 @@ -# Nebula Graph learning path +# NebulaGraph learning path -This topic is for anyone interested in learning more about Nebula Graph. You can master Nebula Graph from zero to hero through the documentation and videos in Nebula Graph learning path. +This topic is for anyone interested in learning more about NebulaGraph. You can master NebulaGraph from zero to hero through the documentation and videos in NebulaGraph learning path. ![learning path](learning-path.png) -## 1. About Nebula Graph +## 1. About NebulaGraph -### 1.1 What is Nebula Graph? +### 1.1 What is NebulaGraph? | Document | Video | | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [What is Nebula Graph](../1.introduction/1.what-is-nebula-graph.md) | [Nebula Graph](https://www.youtube.com/watch?v=LNwCzn2xdYI)| +| [What is NebulaGraph](../1.introduction/1.what-is-nebula-graph.md) | [NebulaGraph](https://www.youtube.com/watch?v=LNwCzn2xdYI)| ### 1.2 Data models @@ -28,7 +28,7 @@ This topic is for anyone interested in learning more about Nebula Graph. You can -### 1.4 Nebula Graph architecture +### 1.4 NebulaGraph architecture | Document | | ------------------------------------------------------------ | @@ -39,27 +39,27 @@ This topic is for anyone interested in learning more about Nebula Graph. You can ## 2. Quick start -### 2.1 Install Nebula Graph +### 2.1 Install NebulaGraph | Document | Video | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [Install with a RPM or DEB package](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) | - | | [Install with a TAR package](../4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md) | - | - | [Install with Docker](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md) | [Install Nebula Graph with Docker and Docker Compose](https://www.youtube.com/watch?v=yM5GDpJedEI) | - | [Install from source](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) | [Install Nebula Graph with Source Code](https://www.youtube.com/watch?v=x-I835eEBz0) | + | [Install with Docker](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md) | [Install NebulaGraph with Docker and Docker Compose](https://www.youtube.com/watch?v=yM5GDpJedEI) | + | [Install from source](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) | [Install NebulaGraph with Source Code](https://www.youtube.com/watch?v=x-I835eEBz0) | -### 2.2 Start Nebula Graph +### 2.2 Start NebulaGraph | Document | | ------------------------------------------------------------ | - | [Start and stop Nebula Graph](../2.quick-start/5.start-stop-service.md) | + | [Start and stop NebulaGraph](../2.quick-start/5.start-stop-service.md) | -### 2.3 Connect to Nebula Graph +### 2.3 Connect to NebulaGraph | Document | ------------------------------------------------------------ | - | [Connect to Nebula Graph](../2.quick-start/3.connect-to-nebula-graph.md) | + | [Connect to NebulaGraph](../2.quick-start/3.connect-to-nebula-graph.md) | ### 2.4 Use nGQL statements @@ -73,16 +73,16 @@ This topic is for anyone interested in learning more about Nebula Graph. You can | Document | | ------------------------------------------------------------ | - | [Deploy a Nebula Graph cluster with RPM/DEB](../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md) | + | [Deploy a NebulaGraph cluster with RPM/DEB](../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md) | -### 3.2 Upgrade Nebula Graph +### 3.2 Upgrade NebulaGraph | Document | | ------------------------------------------------------------ | - | [Upgrade Nebula Graph to {{nebula.branch}}](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md) | - | [Upgrade Nebula Graph from v2.0.x to {{nebula.branch}}](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md) | + | [Upgrade NebulaGraph to {{nebula.branch}}](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md) | + | [Upgrade NebulaGraph from v2.0.x to {{nebula.branch}}](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md) | -### 3.3 Configure Nebula Graph +### 3.3 Configure NebulaGraph | Document | | ------------------------------------------------------------ | @@ -118,7 +118,7 @@ This topic is for anyone interested in learning more about Nebula Graph. You can | Document | | ------------------------------------------------------------ | - | [Nebula Graph metrics](../6.monitor-and-metrics/1.query-performance-metrics.md) | + | [NebulaGraph metrics](../6.monitor-and-metrics/1.query-performance-metrics.md) | | [RocksDB statistics](../6.monitor-and-metrics/2.rocksdb-statistics.md) | - Data snapshot @@ -158,7 +158,7 @@ This topic is for anyone interested in learning more about Nebula Graph. You can | Visualization tools | Document | Video | | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | Data visualization | [Nebula Graph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md) | [Nebula Studio](https://www.youtube.com/watch?v=6V4salpkIbc&list=PL4ArMmsAnb86R2MfUKFjzTQizCZCrhu2p)| + | Data visualization | [NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md) | [Nebula Studio](https://www.youtube.com/watch?v=6V4salpkIbc&list=PL4ArMmsAnb86R2MfUKFjzTQizCZCrhu2p)| | Data monitoring and O&M | [Nebula Dashboard Community Edition](https://docs.nebula-graph.io/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/)和 [Nebula Dashboard Enterprise Edition](https://docs.nebula-graph.io/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/) | -| | Data analysis | [Nebula Explorer Enterprise Edition](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md) | - | @@ -214,11 +214,11 @@ This topic is for anyone interested in learning more about Nebula Graph. You can | Document | | ------------------------------------------------------------ | | [Handling Tens of Billions of Threat Intelligence Data with Graph Database at Kuaishou](https://nebula-graph.io/posts/kuaishou-security-intelligence-platform-with-nebula-graph/) | - | [Import data from Neo4j to Nebula Graph via Nebula Exchange: Best Practices](https://nebula-graph.io/posts/neo4j-nebula-graph-import-best-practice/) | - | [Hands-On Experience: Import Data to Nebula Graph with Spark](https://nebula-graph.io/posts/best-practices-import-data-spark-nebula-graph/) | + | [Import data from Neo4j to NebulaGraph via Nebula Exchange: Best Practices](https://nebula-graph.io/posts/neo4j-nebula-graph-import-best-practice/) | + | [Hands-On Experience: Import Data to NebulaGraph with Spark](https://nebula-graph.io/posts/best-practices-import-data-spark-nebula-graph/) | | [How to Select a Graph Database: Best Practices at RoyalFlush](https://nebula-graph.io/posts/how-to-select-a-graph-database/) | | [Practicing Nebula Operator on Cloud](https://nebula-graph.io/posts/nebula-operator-practice/) | - | [Using Ansible to Automate Deployment of Nebula Graph Cluster](https://nebula-graph.io/posts/deploy-nebula-graph-with-ansible/) | + | [Using Ansible to Automate Deployment of NebulaGraph Cluster](https://nebula-graph.io/posts/deploy-nebula-graph-with-ansible/) | ## 6. FAQ @@ -230,12 +230,12 @@ This topic is for anyone interested in learning more about Nebula Graph. You can ## 7. Practical tasks -You can check if you have mastered Nebula Graph by completing the following practical tasks. +You can check if you have mastered NebulaGraph by completing the following practical tasks. | Task | Reference | | ------------------------------------------------------- | ------------------------------------------------------------ | - | Compile the source code of Nebula Graph | [Install Nebula Graph by compiling the source code](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) | + | Compile the source code of NebulaGraph | [Install NebulaGraph by compiling the source code](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) | | Deploy Studio, Dashboard, and Explorer | [Deploy Studio](../nebula-studio/deploy-connect/st-ug-deploy.md), [Deploy Dashboard](../nebula-dashboard/2.deploy-dashboard.md), and [Deploy Explorer](../nebula-explorer/deploy-connect/ex-ug-deploy.md) | - | Load test Nebula Graph with K6 | [Nebula Bench](../nebula-bench.md) | + | Load test NebulaGraph with K6 | [Nebula Bench](../nebula-bench.md) | | Query LDBC data（such as queries for vertices, paths, or subgraphs.） | [LDBC](chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/pdf_viewer.html?r=http://ldbcouncil.org/ldbc_snb_docs/ldbc-snb-specification.pdf) and [interactive-short-1.cypher](https://github.com/ldbc/ldbc_snb_interactive/blob/main/cypher/queries/interactive-short-1.cypher) | diff --git a/docs-2.0/20.appendix/releasenote.md b/docs-2.0/20.appendix/releasenote.md index d49989a3e43..93ed737f201 100644 --- a/docs-2.0/20.appendix/releasenote.md +++ b/docs-2.0/20.appendix/releasenote.md @@ -1,8 +1,8 @@ -# Nebula Graph {{ nebula.release }} release notes +# NebulaGraph {{ nebula.release }} release notes ## Bug fix -- Support running Nebula Graph with a docker image on the ARM architecture. [#3939](https://github.com/vesoft-inc/nebula/pull/3939/) +- Support running NebulaGraph with a docker image on the ARM architecture. [#3939](https://github.com/vesoft-inc/nebula/pull/3939/) - Optimize the processing of using the version-matched client to connect to the server to avoid the connection failure problem. [#4075](https://github.com/vesoft-inc/nebula/pull/4075) diff --git a/docs-2.0/20.appendix/write-tools.md b/docs-2.0/20.appendix/write-tools.md index 29d34ce1873..62ba34d0050 100644 --- a/docs-2.0/20.appendix/write-tools.md +++ b/docs-2.0/20.appendix/write-tools.md @@ -1,6 +1,6 @@ # Import tools -There are many ways to write Nebula Graph {{ nebula.release }}: +There are many ways to write NebulaGraph {{ nebula.release }}: - Import with [the command -f](../2.quick-start/3.connect-to-nebula-graph.md): This method imports a small number of prepared nGQL files, which is suitable to prepare for a small amount of manual test data. - Import with [Studio](../nebula-studio/quick-start/st-ug-import-data.md): This method uses a browser to import multiple csv files of this machine. A single file cannot exceed 100 MB, and its format is limited. diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md index e59eb5bd515..db6d05ed441 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md @@ -1,12 +1,12 @@ -# Nebula Graph Query Language (nGQL) +# NebulaGraph Query Language (nGQL) -This topic gives an introduction to the query language of Nebula Graph, nGQL. +This topic gives an introduction to the query language of NebulaGraph, nGQL. ## What is nGQL -nGQL is a declarative graph query language for Nebula Graph. It allows expressive and efficient [graph patterns](3.graph-patterns.md). nGQL is designed for both developers and operations professionals. nGQL is an SQL-like query language, so it's easy to learn. +nGQL is a declarative graph query language for NebulaGraph. It allows expressive and efficient [graph patterns](3.graph-patterns.md). nGQL is designed for both developers and operations professionals. nGQL is an SQL-like query language, so it's easy to learn. -nGQL is a project in progress. New features and optimizations are done steadily. There can be differences between syntax and implementation. Submit an [issue](https://github.com/vesoft-inc/nebula-graph/issues) to inform the Nebula Graph team if you find a new issue of this type. Nebula Graph 3.0 or later releases will support [openCypher 9](https://www.opencypher.org/resources). +nGQL is a project in progress. New features and optimizations are done steadily. There can be differences between syntax and implementation. Submit an [issue](https://github.com/vesoft-inc/nebula-graph/issues) to inform the NebulaGraph team if you find a new issue of this type. NebulaGraph 3.0 or later releases will support [openCypher 9](https://www.opencypher.org/resources). ## What can nGQL do @@ -21,11 +21,11 @@ nGQL is a project in progress. New features and optimizations are done steadily. ## Example data Basketballplayer -Users can download the example data [Basketballplayer](https://docs.nebula-graph.io/2.0/basketballplayer-2.X.ngql) in Nebula Graph. After downloading the example data, you can import it to Nebula Graph by using the `-f` option in [Nebula Graph Console](../../2.quick-start/3.connect-to-nebula-graph.md). +Users can download the example data [Basketballplayer](https://docs.nebula-graph.io/2.0/basketballplayer-2.X.ngql) in NebulaGraph. After downloading the example data, you can import it to NebulaGraph by using the `-f` option in [NebulaGraph Console](../../2.quick-start/3.connect-to-nebula-graph.md). !!! note - Ensure that you have executed the `ADD HOSTS` command to add the Storage service to your Nebula Graph cluster before importing the example data. For more information, see [Manage Storage hosts](../../4.deployment-and-installation/manage-storage-host.md). + Ensure that you have executed the `ADD HOSTS` command to add the Storage service to your NebulaGraph cluster before importing the example data. For more information, see [Manage Storage hosts](../../4.deployment-and-installation/manage-storage-host.md). ## Placeholder identifiers and values @@ -73,7 +73,7 @@ nebula> CREATE TAG IF NOT EXISTS player(name string, age int); ### Native nGQL and openCypher -Native nGQL is the part of a graph query language designed and implemented by Nebula Graph. OpenCypher is a graph query language maintained by openCypher Implementers Group. +Native nGQL is the part of a graph query language designed and implemented by NebulaGraph. OpenCypher is a graph query language maintained by openCypher Implementers Group. The latest release is openCypher 9. The compatible parts of openCypher in nGQL are called openCypher compatible sentences (short as openCypher). @@ -93,7 +93,7 @@ NO. nGQL is designed to be compatible with part of DQL (match) and is not planned to be compatible with any DDL, DML, or DCL. - Multiple known incompatible items are listed in [Nebula Graph Issues](https://github.com/vesoft-inc/nebula-graph/issues?q=is%3Aissue+is%3Aopen+label%3Aincompatible). Submit an issue with the `incompatible` tag if you find a new issue of this type. Users can search in this manual with the keyword `compatibility` to find major compatibility issues. + Multiple known incompatible items are listed in [NebulaGraph Issues](https://github.com/vesoft-inc/nebula-graph/issues?q=is%3Aissue+is%3Aopen+label%3Aincompatible). Submit an issue with the `incompatible` tag if you find a new issue of this type. Users can search in this manual with the keyword `compatibility` to find major compatibility issues. ### What are the major differences between nGQL and openCypher 9? @@ -121,7 +121,7 @@ The following are some major differences (by design incompatible) between nGQL a ### Where can I find more nGQL examples? -Users can find more than 2500 nGQL examples in the [features](https://github.com/vesoft-inc/nebula-graph/tree/master/tests/tck/features) directory on the Nebula Graph GitHub page. +Users can find more than 2500 nGQL examples in the [features](https://github.com/vesoft-inc/nebula-graph/tree/master/tests/tck/features) directory on the NebulaGraph GitHub page. The `features` directory consists of `.feature` files. Each file records scenarios that you can use as nGQL examples. Here is an example: @@ -186,7 +186,7 @@ The keywords in the preceding example are described as follows. |`Given`|Describes the prerequisites of running the test statements in the current `.feature` file.| |`Scenario`|Describes the scenarios. If there is the `@skip` before one `Scenario`, this scenario may not work and do not use it as a working example in a production environment.| |`When`|Describes the nGQL statement to be executed. It can be a `executing query` or `profiling query`.| -|`Then`|Describes the expected return results of running the statement in the `When` clause. If the return results in your environment do not match the results described in the `.feature` file, submit an [issue](https://github.com/vesoft-inc/nebula-graph/issues) to inform the Nebula Graph team.| +|`Then`|Describes the expected return results of running the statement in the `When` clause. If the return results in your environment do not match the results described in the `.feature` file, submit an [issue](https://github.com/vesoft-inc/nebula-graph/issues) to inform the NebulaGraph team.| |`And`|Describes the side effects of running the statement in the `When` clause.| | `@skip` | This test case will be skipped. Commonly, the to-be-tested code is not ready.| @@ -196,10 +196,10 @@ Welcome to [add more tck case](https://github.com/vesoft-inc/nebula-graph/tree/m No. And no plan to support that. -### Does Nebula Graph support W3C RDF (SPARQL) or GraphQL? +### Does NebulaGraph support W3C RDF (SPARQL) or GraphQL? No. And no plan to support that. -The data model of Nebula Graph is the property graph. And as a strong schema system, Nebula Graph does not support RDF. +The data model of NebulaGraph is the property graph. And as a strong schema system, NebulaGraph does not support RDF. -Nebula Graph Query Language does not support `SPARQL` nor `GraphQL`. +NebulaGraph Query Language does not support `SPARQL` nor `GraphQL`. diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md index 39cea1de5db..8ac3cb19daf 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md @@ -1,6 +1,6 @@ # Patterns -Patterns and graph pattern matching are the very heart of a graph query language. This topic will describe the patterns in Nebula Graph, some of which have not yet been implemented. +Patterns and graph pattern matching are the very heart of a graph query language. This topic will describe the patterns in NebulaGraph, some of which have not yet been implemented. ## Patterns for vertices diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md index fcf8edf11f0..faf001cc37d 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/comments.md @@ -4,8 +4,8 @@ This topic will describe the comments in nGQL. ## Legacy version compatibility -* In Nebula Graph 1.x, there are four comment styles: `#`, `--`, `//`, `/* */`. -* Since Nebula Graph 2.x, `--` cannot be used as comments. +* In NebulaGraph 1.x, there are four comment styles: `#`, `--`, `//`, `/* */`. +* Since NebulaGraph 2.x, `--` cannot be used as comments. ## Examples diff --git a/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md b/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md index 367daab3f3d..485e7f100d8 100644 --- a/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md +++ b/docs-2.0/3.ngql-guide/1.nGQL-overview/ngql-style-guide.md @@ -190,7 +190,7 @@ The strings should be surrounded by double quotes. When single or double quotes need to be nested in a string, use a backslash (\) to escape. For example: ```ngql - RETURN "\"Nebula Graph is amazing,\" the user says."; + RETURN "\"NebulaGraph is amazing,\" the user says."; ``` diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md index d5ae868166e..c5e8398d279 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/1.create-tag.md @@ -11,7 +11,7 @@ Tags in nGQL are similar to labels in openCypher. But they are also quite differ ## Prerequisites -Running the `CREATE TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `CREATE TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax @@ -35,7 +35,7 @@ CREATE TAG [IF NOT EXISTS] |``|The name of the property. It must be unique for each tag. The rules for permitted property names are the same as those for tag names.| |``|Shows the data type of each property. For a full description of the property data types, see [Data types](../3.data-types/1.numeric.md) and [Boolean](../3.data-types/2.boolean.md).| |`NULL \| NOT NULL`|Specifies if the property supports `NULL | NOT NULL`. The default value is `NULL`.| -|`DEFAULT`|Specifies a default value for a property. The default value can be a literal value or an expression supported by Nebula Graph. If no value is specified, the default value is used when inserting a new vertex.| +|`DEFAULT`|Specifies a default value for a property. The default value can be a literal value or an expression supported by NebulaGraph. If no value is specified, the default value is used when inserting a new vertex.| |`COMMENT`|The remarks of a certain property or the tag itself. The maximum length is 256 bytes. By default, there will be no comments on a tag.| |`TTL_DURATION`|Specifies the life cycle for the property. The property that exceeds the specified TTL expires. The expiration threshold is the `TTL_COL` value plus the `TTL_DURATION`. The default value of `TTL_DURATION` is `0`. It means the data never expires.| |`TTL_COL`|Specifies the property to set a timeout on. The data type of the property must be `int` or `timestamp`. A tag can only specify one field as `TTL_COL`. For more information on TTL, see [TTL options](../8.clauses-and-options/ttl-options.md).| diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md index 5891479c067..b2d09e2bdfb 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/2.drop-tag.md @@ -12,7 +12,7 @@ This operation only deletes the Schema data. All the files or directories in the ## Prerequisites -- Running the `DROP TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +- Running the `DROP TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. - Before you drop a tag, make sure that the tag does not have any indexes. Otherwise, the conflict error (`[ERROR (-8)]: Conflict!`) will be returned when you run the `DROP TAG` statement. To drop an index, see [DROP INDEX](../14.native-index-statements/6.drop-native-index.md). diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md index 760157e9cad..ffcf81a2249 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/3.alter-tag.md @@ -4,7 +4,7 @@ ## Prerequisites -- Running the `ALTER TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +- Running the `ALTER TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. - Before you alter properties for a tag, make sure that the properties are not indexed. If the properties contain any indexes, the conflict error `[ERROR (-8)]: Conflict!` will occur when you `ALTER TAG`. For more information on dropping an index, see [DROP INDEX](../14.native-index-statements/6.drop-native-index.md). diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md index 05a36bb5164..781431dbfd6 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/5.describe-tag.md @@ -4,7 +4,7 @@ ## Prerequisite -Running the `DESCRIBE TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `DESCRIBE TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md index 335342c56df..335bdcb6c33 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md @@ -4,7 +4,7 @@ ## Prerequisites -Running the `DELETE TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `DELETE TAG` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md b/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md index f093b55fd66..88c3f3b70f1 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md @@ -2,7 +2,7 @@ OpenCypher has the features of `SET label` and `REMOVE label` to speed up the process of querying or labeling. -Nebula Graph achieves the same operations by creating and inserting tags to an existing vertex, which can quickly query vertices based on the tag name. Users can also run `DELETE TAG` to delete some vertices that are no longer needed. +NebulaGraph achieves the same operations by creating and inserting tags to an existing vertex, which can quickly query vertices based on the tag name. Users can also run `DELETE TAG` to delete some vertices that are no longer needed. ## Examples diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md index 9af67043fa7..1b84cca1bc2 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/1.create-edge.md @@ -11,7 +11,7 @@ Edge types in nGQL are similar to relationship types in openCypher. But they are ## Prerequisites -Running the `CREATE EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `CREATE EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax @@ -35,7 +35,7 @@ CREATE EDGE [IF NOT EXISTS] |``|The name of the property. It must be unique for each edge type. The rules for permitted property names are the same as those for edge type names.| |``|Shows the data type of each property. For a full description of the property data types, see [Data types](../3.data-types/1.numeric.md) and [Boolean](../3.data-types/2.boolean.md).| |`NULL \| NOT NULL`|Specifies if the property supports `NULL | NOT NULL`. The default value is `NULL`.| -|`DEFAULT`|Specifies a default value for a property. The default value can be a literal value or an expression supported by Nebula Graph. If no value is specified, the default value is used when inserting a new edge.| +|`DEFAULT`|Specifies a default value for a property. The default value can be a literal value or an expression supported by NebulaGraph. If no value is specified, the default value is used when inserting a new edge.| |`COMMENT`|The remarks of a certain property or the edge type itself. The maximum length is 256 bytes. By default, there will be no comments on an edge type.| |`TTL_DURATION`|Specifies the life cycle for the property. The property that exceeds the specified TTL expires. The expiration threshold is the `TTL_COL` value plus the `TTL_DURATION`. The default value of `TTL_DURATION` is `0`. It means the data never expires.| |`TTL_COL`|Specifies the property to set a timeout on. The data type of the property must be `int` or `timestamp`. An edge type can only specify one field as `TTL_COL`. For more information on TTL, see [TTL options](../8.clauses-and-options/ttl-options.md).| diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md index 160818250c6..440507cd598 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/2.drop-edge.md @@ -8,7 +8,7 @@ This operation only deletes the Schema data. All the files or directories in the ## Prerequisites -- Running the `DROP EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +- Running the `DROP EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. - Before you drop an edge type, make sure that the edge type does not have any indexes. Otherwise, the conflict error (`[ERROR (-8)]: Conflict!`) will be returned. To drop an index, see [DROP INDEX](../14.native-index-statements/6.drop-native-index.md). diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md index 465afbf6cda..26f12df2306 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md @@ -4,7 +4,7 @@ ## Prerequisites -- Running the `ALTER EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +- Running the `ALTER EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. - Before you alter properties for an edge type, make sure that the properties are not indexed. If the properties contain any indexes, the conflict error `[ERROR (-8)]: Conflict!` will occur when you `ALTER EDGE`. For more information on dropping an index, see [DROP INDEX](../14.native-index-statements/6.drop-native-index.md). diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md index 81c8b65341f..6b3f96afe9b 100644 --- a/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md +++ b/docs-2.0/3.ngql-guide/11.edge-type-statements/5.describe-edge.md @@ -4,7 +4,7 @@ ## Prerequisites -Running the `DESCRIBE EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `DESCRIBE EDGE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md index 8381835ba12..18cb5f69880 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md @@ -1,10 +1,10 @@ # INSERT VERTEX -The `INSERT VERTEX` statement inserts one or more vertices into a graph space in Nebula Graph. +The `INSERT VERTEX` statement inserts one or more vertices into a graph space in NebulaGraph. ## Prerequisites -Running the `INSERT VERTEX` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `INSERT VERTEX` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax @@ -55,11 +55,11 @@ prop_value_list: !!! caution - Nebula Graph {{ nebula.release }} supports inserting vertices without tags. + NebulaGraph {{ nebula.release }} supports inserting vertices without tags. * `prop_name_list` contains the names of the properties on the tag. -* `VID` is the vertex ID. In Nebula Graph 2.0, string and integer VID types are supported. The VID type is set when a graph space is created. For more information, see [CREATE SPACE](../9.space-statements/1.create-space.md). +* `VID` is the vertex ID. In NebulaGraph 2.0, string and integer VID types are supported. The VID type is set when a graph space is created. For more information, see [CREATE SPACE](../9.space-statements/1.create-space.md). * `prop_value_list` must provide the property values according to the `prop_name_list`. When the `NOT NULL` constraint is set for a given property, an error is returned if no property is given. When the default value for a property is `NULL`, you can omit to specify the property value. For details, see [CREATE TAG](../10.tag-statements/1.create-tag.md). diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md index ef75ee3a3c5..2087c1d5caa 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md @@ -2,7 +2,7 @@ The `UPDATE VERTEX` statement updates properties on tags of a vertex. -In Nebula Graph, `UPDATE VERTEX` supports compare-and-set (CAS). +In NebulaGraph, `UPDATE VERTEX` supports compare-and-set (CAS). !!! note diff --git a/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md b/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md index cb412834d81..3112b3c1f5a 100644 --- a/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md +++ b/docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md @@ -4,9 +4,9 @@ By default, the `DELETE VERTEX` statement deletes vertices but the incoming and !!! compatibility - - Nebula Graph 2.x deletes vertices and their incoming and outgoing edges. + - NebulaGraph 2.x deletes vertices and their incoming and outgoing edges. - - Nebula Graph {{nebula.release}} only deletes the vertices, and does not delete the related outgoing and incoming edges of the vertices. At this time, there will be dangling edges by default. + - NebulaGraph {{nebula.release}} only deletes the vertices, and does not delete the related outgoing and incoming edges of the vertices. At this time, there will be dangling edges by default. The `DELETE VERTEX` statement deletes one vertex or multiple vertices at a time. You can use `DELETE VERTEX` together with pipes. For more information about pipe, see [Pipe operator](../5.operators/4.pipe.md). @@ -44,7 +44,7 @@ nebula> GO FROM "player100" OVER serve WHERE properties(edge).start_year == "202 ## Process of deleting vertices -Once Nebula Graph deletes the vertices, all edges (incoming and outgoing edges) of the target vertex will become dangling edges. When Nebula Graph deletes the vertices `WITH EDGE`, Nebula Graph traverses the incoming and outgoing edges related to the vertices and deletes them all. Then Nebula Graph deletes the vertices. +Once NebulaGraph deletes the vertices, all edges (incoming and outgoing edges) of the target vertex will become dangling edges. When NebulaGraph deletes the vertices `WITH EDGE`, NebulaGraph traverses the incoming and outgoing edges related to the vertices and deletes them all. Then NebulaGraph deletes the vertices. !!! caution diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md index 02ae4c9922b..cee24469ea0 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -1,6 +1,6 @@ # INSERT EDGE -The `INSERT EDGE` statement inserts an edge or multiple edges into a graph space from a source vertex (given by src_vid) to a destination vertex (given by dst_vid) with a specific rank in Nebula Graph. +The `INSERT EDGE` statement inserts an edge or multiple edges into a graph space from a source vertex (given by src_vid) to a destination vertex (given by dst_vid) with a specific rank in NebulaGraph. When inserting an edge that already exists, `INSERT VERTEX` **overrides** the edge. @@ -96,7 +96,7 @@ nebula> FETCH PROP ON e2 "14"->"15"@1 YIELD edge AS e; !!! Note - * Nebula Graph {{ nebula.release }} allows dangling edges. Therefore, you can write the edge before the source vertex or the destination vertex exists. At this time, you can get the (not written) vertex VID through `._src` or `._dst` (which is not recommended). + * NebulaGraph {{ nebula.release }} allows dangling edges. Therefore, you can write the edge before the source vertex or the destination vertex exists. At this time, you can get the (not written) vertex VID through `._src` or `._dst` (which is not recommended). * Atomic operation is not guaranteed during the entire process for now. If it fails, please try again. Otherwise, partial writing will occur. At this time, the behavior of reading the data is undefined. * Concurrently writing the same edge will cause an `edge conflict` error, so please try again later. * The inserting speed of an edge is about half that of a vertex. Because in the storaged process, the insertion of an edge involves two tasks, while the insertion of a vertex involves only one task. diff --git a/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md b/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md index ac74d20b785..3f573514106 100644 --- a/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md +++ b/docs-2.0/3.ngql-guide/13.edge-statements/2.update-edge.md @@ -2,7 +2,7 @@ The `UPDATE EDGE` statement updates properties on an edge. -In Nebula Graph, `UPDATE EDGE` supports compare-and-swap (CAS). +In NebulaGraph, `UPDATE EDGE` supports compare-and-swap (CAS). ## Syntax diff --git a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md index a283e9336d3..b9ca4ab4513 100644 --- a/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md +++ b/docs-2.0/3.ngql-guide/14.native-index-statements/1.create-native-index.md @@ -40,13 +40,13 @@ Although the same results can be obtained by using alternative indexes for queri If you must use indexes, we suggest that you: -1. Import the data into Nebula Graph. +1. Import the data into NebulaGraph. 2. Create indexes. 3. [Rebuild indexes](4.rebuild-native-index.md). -4. After the index is created and the data is imported, you can use [LOOKUP](../7.general-query-statements/5.lookup.md) or [MATCH](../7.general-query-statements/2.match.md) to retrieve the data. You do not need to specify which indexes to use in a query, Nebula Graph figures that out by itself. +4. After the index is created and the data is imported, you can use [LOOKUP](../7.general-query-statements/5.lookup.md) or [MATCH](../7.general-query-statements/2.match.md) to retrieve the data. You do not need to specify which indexes to use in a query, NebulaGraph figures that out by itself. !!! Note @@ -123,7 +123,7 @@ nebula> CREATE TAG INDEX IF NOT EXISTS player_index_1 on player(name(10), age); !!! note - Nebula Graph follows the left matching principle to select indexes. + NebulaGraph follows the left matching principle to select indexes. (v2) \ !!! compatibility "OpenCypher compatibility" - In Nebula Graph versions earlier than 3.0.0, the prerequisite for matching a edge is that the edge itself has an index or a certain property of the edge has an index. As of version 3.0.0, there is no need to create an index for matching a edge, but you need to use `LIMIT` to limit the number of output results and you must specify the direction of the edge. + In NebulaGraph versions earlier than 3.0.0, the prerequisite for matching a edge is that the edge itself has an index or a certain property of the edge has an index. As of version 3.0.0, there is no need to create an index for matching a edge, but you need to use `LIMIT` to limit the number of output results and you must specify the direction of the edge. ```ngql nebula> MATCH ()<-[e]-() \ @@ -344,7 +344,7 @@ Just like vertices, you can specify edge types with `:` in a pattern. !!! compatibility "OpenCypher compatibility" - In Nebula Graph versions earlier than 3.0.0, the prerequisite for matching a edge type is that the edge type itself has an index or a certain property of the edge type has an index. As of version 3.0.0, there is no need to create an index for matching a edge type, but you need to use `LIMIT` to limit the number of output results and you must specify the direction of the edge. + In NebulaGraph versions earlier than 3.0.0, the prerequisite for matching a edge type is that the edge type itself has an index or a certain property of the edge type has an index. As of version 3.0.0, there is no need to create an index for matching a edge type, but you need to use `LIMIT` to limit the number of output results and you must specify the direction of the edge. ```ngql nebula> MATCH ()-[e:follow]->() \ @@ -588,4 +588,4 @@ See [OPTIONAL MATCH](optional-match.md)。 !!! Performance - In Nebula Graph, the performance and resource usage of the `MATCH` statement have been optimized. But we still recommend to use `GO`, `LOOKUP`, `|`, and `FETCH` instead of `MATCH` when high performance is required. + In NebulaGraph, the performance and resource usage of the `MATCH` statement have been optimized. But we still recommend to use `GO`, `LOOKUP`, `|`, and `FETCH` instead of `MATCH` when high performance is required. diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md index 01657d6a9bd..5227625bd0f 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/3.go.md @@ -29,7 +29,7 @@ YIELD [DISTINCT] [AS ] [, [AS ] ...] ``` -- ` STEPS`: specifies the hop number. If not specified, the default value for `N` is `one`. When `N` is `zero`, Nebula Graph does not traverse any edges and returns nothing. +- ` STEPS`: specifies the hop number. If not specified, the default value for `N` is `one`. When `N` is `zero`, NebulaGraph does not traverse any edges and returns nothing. !!! note diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md index da915109bc8..da10e377572 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/5.lookup.md @@ -20,13 +20,13 @@ This topic applies to native nGQL only. - Correct use of indexes can speed up queries, but indexes can dramatically reduce the write performance. The performance reduction can be 90% or even more. **DO NOT** use indexes in production environments unless you are fully aware of their influences on your service. -- If the specified property is not indexed when using the `LOOKUP` statement, Nebula Graph randomly selects one of the available indexes. +- If the specified property is not indexed when using the `LOOKUP` statement, NebulaGraph randomly selects one of the available indexes. - For example, the tag `player` has two properties, `name` and `age`. Both the tag `player` itself and the property `name` have indexes, but the property `age` has no indexes. When running `LOOKUP ON player WHERE player.age == 36 YIELD player.name;`, Nebula Graph randomly uses one of the indexes of the tag `player` and the property `name`. + For example, the tag `player` has two properties, `name` and `age`. Both the tag `player` itself and the property `name` have indexes, but the property `age` has no indexes. When running `LOOKUP ON player WHERE player.age == 36 YIELD player.name;`, NebulaGraph randomly uses one of the indexes of the tag `player` and the property `name`. !!! compatibility "Legacy version compatibility" - Before the release 2.5.0, if the specified property is not indexed when using the `LOOKUP` statement, Nebula Graph reports an error and does not use other indexes. + Before the release 2.5.0, if the specified property is not indexed when using the `LOOKUP` statement, NebulaGraph reports an error and does not use other indexes. ## Prerequisites diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/.3.show-configs.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/.3.show-configs.md index e3a54ad4656..d0568a64a38 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/.3.show-configs.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/.3.show-configs.md @@ -16,7 +16,7 @@ SHOW CONFIGS [GRAPH|META|STORAGE] |`META`|Shows the configuration of the Meta Service.| |`STORAGE`|Shows the configuration of the Meta Service.| -If no service name is set in the statement, Nebula Graph shows the mutable configurations of all services. +If no service name is set in the statement, NebulaGraph shows the mutable configurations of all services. ## Example @@ -42,10 +42,10 @@ The output of `SHOW CONFIGS` is explained as follows: |Column|Description| |-|-| -|`module`|The Nebula Graph service name.| +|`module`|The NebulaGraph service name.| |`name`|The parameter name.| |`type`|The data type of the value.| |`mode`|Shows whether the parameter can be modified or not.| |`value`|The value of the parameter.| -For more information about the Nebula Graph configurations, see [Configuration](../../../5.configurations-and-logs/1.configurations/1.configurations.md). +For more information about the NebulaGraph configurations, see [Configuration](../../../5.configurations-and-logs/1.configurations/1.configurations.md). diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md index 6f79454e7c2..bce0409cdac 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md @@ -2,7 +2,7 @@ The `SHOW CHARSET` statement shows the available character sets. -Currently available types are `utf8` and `utf8mb4`. The default charset type is `utf8`. Nebula Graph extends the `uft8` to support four-byte characters. Therefore `utf8` and `utf8mb4` are equivalent. +Currently available types are `utf8` and `utf8mb4`. The default charset type is `utf8`. NebulaGraph extends the `uft8` to support four-byte characters. Therefore `utf8` and `utf8mb4` are equivalent. ## Syntax diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md index 10c324ffdb8..68b52afbfb5 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md @@ -4,11 +4,11 @@ The `SHOW ROLES` statement shows the roles that are assigned to a user account. The return message differs according to the role of the user who is running this statement: -* If the user is a `GOD` or `ADMIN` and is granted access to the specified graph space, Nebula Graph shows all roles in this graph space except for `GOD`. +* If the user is a `GOD` or `ADMIN` and is granted access to the specified graph space, NebulaGraph shows all roles in this graph space except for `GOD`. -* If the user is a `DBA`, `USER`, or `GUEST` and is granted access to the specified graph space, Nebula Graph shows the user's own role in this graph space. +* If the user is a `DBA`, `USER`, or `GUEST` and is granted access to the specified graph space, NebulaGraph shows the user's own role in this graph space. -* If the user does not have access to the specified graph space, Nebula Graph returns `PermissionError`. +* If the user does not have access to the specified graph space, NebulaGraph returns `PermissionError`. For more information about roles, see [Roles and privileges](../../../7.data-security/1.authentication/3.role-list.md). diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md index 38eff101f02..d420edb8091 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md @@ -1,6 +1,6 @@ # SHOW SPACES -The `SHOW SPACES` statement shows existing graph spaces in Nebula Graph. +The `SHOW SPACES` statement shows existing graph spaces in NebulaGraph. For how to create a graph space, see [CREATE SPACE](./../../9.space-statements/1.create-space.md). diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md index 7517438b26a..a86b4a77fc4 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md @@ -1,6 +1,6 @@ # SHOW COLLATION -The `SHOW COLLATION` statement shows the collations supported by Nebula Graph. +The `SHOW COLLATION` statement shows the collations supported by NebulaGraph. Currently available types are: `utf8_bin`, `utf8_general_ci`, `utf8mb4_bin`, and `utf8mb4_general_ci`. diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md index 3e6975fb7f6..449107bbc4b 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md @@ -10,7 +10,7 @@ SHOW HOSTS [GRAPH | STORAGE | META]; !!! note - For a Nebula Graph cluster installed with the source code, the version of the cluster will not be displayed in the output after executing the command `SHOW HOSTS (GRAPH | STORAGE | META)` with the service name. + For a NebulaGraph cluster installed with the source code, the version of the cluster will not be displayed in the output after executing the command `SHOW HOSTS (GRAPH | STORAGE | META)` with the service name. ## Examples diff --git a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md index e084bbee601..c5d7e06e5ad 100644 --- a/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md +++ b/docs-2.0/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md @@ -31,4 +31,4 @@ nebula> SHOW EDGE INDEXES; !!! Compatibility "Legacy version compatibility" - In Nebula Graph 2.x, `SHOW TAG/EDGE INDEXES` only returns `Names`. + In NebulaGraph 2.x, `SHOW TAG/EDGE INDEXES` only returns `Names`. diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md index 9b58782655f..18cc04df110 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/limit.md @@ -12,7 +12,7 @@ The `LIMIT` clause constrains the number of rows in the output. The usage of `LI !!! compatibility "Legacy version compatibility" - In Nebula Graph 2.6.0, `GO` statements support the new `LIMIT` syntax. Some operators related to `LIMIT` support computing pushdown. + In NebulaGraph 2.6.0, `GO` statements support the new `LIMIT` syntax. Some operators related to `LIMIT` support computing pushdown. ## LIMIT in native nGQL statements @@ -196,5 +196,5 @@ nebula> MATCH (v:player{name:"Tim Duncan"}) --> (v2) \ diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md index 83917ab7593..29bf2fcdeae 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/ttl-options.md @@ -34,7 +34,7 @@ Since an edge can have only one edge type, once an edge property expires, the ed The expired data are still stored on the disk, but queries will filter them out. -Nebula Graph automatically deletes the expired data and reclaims the disk space during the next [compaction](../../8.service-tuning/compaction.md). +NebulaGraph automatically deletes the expired data and reclaims the disk space during the next [compaction](../../8.service-tuning/compaction.md). !!! note diff --git a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md index 6e8e222fcd9..850bb5f85a1 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md @@ -1,6 +1,6 @@ # CREATE SPACE -Graph spaces are used to store data in a physically isolated way in Nebula Graph, which is similar to the database concept in MySQL. The `CREATE SPACE` statement can create a new graph space or clone the schema of an existing graph space. +Graph spaces are used to store data in a physically isolated way in NebulaGraph, which is similar to the database concept in MySQL. The `CREATE SPACE` statement can create a new graph space or clone the schema of an existing graph space. ## Prerequisites @@ -22,23 +22,23 @@ CREATE SPACE [IF NOT EXISTS] ( |Parameter|Description| |:---|:---| |`IF NOT EXISTS`|Detects if the related graph space exists. If it does not exist, a new one will be created. The graph space existence detection here only compares the graph space name (excluding properties).| -|``|Uniquely identifies a graph space in a Nebula Graph instance. The name of the graph space starts with a letter, supports 1 to 4 bytes UTF-8 encoded characters, such as English letters (case-sensitive), digits, and Chinese characters, but does not support special characters except underscores. To use special characters or reserved keywords as identifiers, quote them with backticks. For more information, see [Keywords and reserved words](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md).| +|``|Uniquely identifies a graph space in a NebulaGraph instance. The name of the graph space starts with a letter, supports 1 to 4 bytes UTF-8 encoded characters, such as English letters (case-sensitive), digits, and Chinese characters, but does not support special characters except underscores. To use special characters or reserved keywords as identifiers, quote them with backticks. For more information, see [Keywords and reserved words](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md).| |`partition_num`|Specifies the number of partitions in each replica. The suggested number is five times the number of the hard disks in the cluster. For example, if you have 3 hard disks in the cluster, we recommend that you set 15 partitions. The default value is 100.| |`replica_factor`|Specifies the number of replicas in the cluster. The suggested number is 3 in a production environment and 1 in a test environment. The replica number must be an **odd number** for the need of quorum-based voting. The default value is 1.| -|`vid_type`|A required parameter. Specifies the VID type in a graph space. Available values are `FIXED_STRING(N)` and `INT64`. `INT` equals to `INT64`. `FIXED_STRING()` specifies the VID as a string, while `INT64` specifies it as an integer. `N` represents the maximum length of the VIDs. If you set a VID that is longer than `N` characters, Nebula Graph throws an error.| +|`vid_type`|A required parameter. Specifies the VID type in a graph space. Available values are `FIXED_STRING(N)` and `INT64`. `INT` equals to `INT64`. `FIXED_STRING()` specifies the VID as a string, while `INT64` specifies it as an integer. `N` represents the maximum length of the VIDs. If you set a VID that is longer than `N` characters, NebulaGraph throws an error.| |`COMMENT`|The remarks of the graph space. The maximum length is 256 bytes. By default, there is no comments on a space.| !!! caution - If the replica number is set to one, you will not be able to load balance or scale out the Nebula Graph Storage Service with the [BALANCE](../../8.service-tuning/load-balance.md) statement. + If the replica number is set to one, you will not be able to load balance or scale out the NebulaGraph Storage Service with the [BALANCE](../../8.service-tuning/load-balance.md) statement. !!! caution "Restrictions on VID type change and VID length" - The length of the VID should not be longer than `N` characters. If it exceeds `N`, Nebula Graph throws `The VID must be a 64-bit integer or a string fitting space vertex id length limit.`. + The length of the VID should not be longer than `N` characters. If it exceeds `N`, NebulaGraph throws `The VID must be a 64-bit integer or a string fitting space vertex id length limit.`. !!! note diff --git a/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md b/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md index 43b0f99526c..9ca11300d71 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/2.use-space.md @@ -4,7 +4,7 @@ ## Prerequisites -Running the `USE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, Nebula Graph throws an error. +Running the `USE` statement requires some [privileges](../../7.data-security/1.authentication/3.role-list.md) for the graph space. Otherwise, NebulaGraph throws an error. ## Syntax @@ -30,4 +30,4 @@ nebula> USE space2; You cannot use two graph spaces in one statement. - Different from Fabric Cypher, graph spaces in Nebula Graph are fully isolated from each other. Making a graph space as the working graph space prevents you from accessing other spaces. The only way to traverse in a new graph space is to switch by the `USE` statement. In Fabric Cypher, you can use two graph spaces in one statement (using the `USE + CALL` syntax). But in Nebula Graph, you can only use one graph space in one statement. + Different from Fabric Cypher, graph spaces in NebulaGraph are fully isolated from each other. Making a graph space as the working graph space prevents you from accessing other spaces. The only way to traverse in a new graph space is to switch by the `USE` statement. In Fabric Cypher, you can use two graph spaces in one statement (using the `USE + CALL` syntax). But in NebulaGraph, you can only use one graph space in one statement. diff --git a/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md b/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md index cb5beb6cdc4..7a0cbc1b90d 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/3.show-spaces.md @@ -1,6 +1,6 @@ # SHOW SPACES -`SHOW SPACES` lists all the graph spaces in the Nebula Graph examples. +`SHOW SPACES` lists all the graph spaces in the NebulaGraph examples. ## Syntax diff --git a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md index f1ea86eee96..795ecfa5a49 100644 --- a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md +++ b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md @@ -1,10 +1,10 @@ -# Prepare resources for compiling, installing, and running Nebula Graph +# Prepare resources for compiling, installing, and running NebulaGraph -This topic describes the requirements and suggestions for compiling and installing Nebula Graph, as well as how to estimate the resource you need to reserve for running a Nebula Graph cluster. +This topic describes the requirements and suggestions for compiling and installing NebulaGraph, as well as how to estimate the resource you need to reserve for running a NebulaGraph cluster. -## Requirements for compiling the Nebula Graph source code +## Requirements for compiling the NebulaGraph source code -### Hardware requirements for compiling Nebula Graph +### Hardware requirements for compiling NebulaGraph | Item | Requirement | | ---------------- | ----------- | @@ -12,17 +12,17 @@ This topic describes the requirements and suggestions for compiling and installi | Memory | 4 GB | | Disk | 10 GB, SSD | -### Supported operating systems for compiling Nebula Graph +### Supported operating systems for compiling NebulaGraph -For now, we can only compile Nebula Graph in the Linux system. We recommend that you use any Linux system with kernel version `4.15` or above. +For now, we can only compile NebulaGraph in the Linux system. We recommend that you use any Linux system with kernel version `4.15` or above. !!! note - To install Nebula Graph on Linux systems with kernel version lower than required, use [RPM/DEB packages](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) or [TAR files](2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md). + To install NebulaGraph on Linux systems with kernel version lower than required, use [RPM/DEB packages](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) or [TAR files](2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md). -### Software requirements for compiling Nebula Graph +### Software requirements for compiling NebulaGraph -You must have the correct version of the software listed below to compile Nebula Graph. If they are not as required or you are not sure, follow the steps in [Prepare software for compiling Nebula Graph](#prepare_software_for_compiling_nebula_graph) to get them ready. +You must have the correct version of the software listed below to compile NebulaGraph. If they are not as required or you are not sure, follow the steps in [Prepare software for compiling NebulaGraph](#prepare_software_for_compiling_nebula_graph) to get them ready. | Software | Version | Note | | ---------------- | ---------------------- | --------------------------------------------------------- | @@ -46,7 +46,7 @@ You must have the correct version of the software listed below to compile Nebula Other third-party software will be automatically downloaded and installed to the `build` directory at the configure (cmake) stage. -### Prepare software for compiling Nebula Graph +### Prepare software for compiling NebulaGraph If part of the dependencies are missing or the versions does not meet the requirements, manually install them with the following steps. You can skip unnecessary dependencies or steps according to your needs. @@ -94,7 +94,7 @@ If part of the dependencies are missing or the versions does not meet the requir gettext ``` -2. Check if the GCC and cmake on your host are in the right version. See [Software requirements for compiling Nebula Graph](#software_requirements_for_compiling_nebula_graph) for the required versions. +2. Check if the GCC and cmake on your host are in the right version. See [Software requirements for compiling NebulaGraph](#software_requirements_for_compiling_nebula_graph) for the required versions. ```bash @@ -123,7 +123,7 @@ If part of the dependencies are missing or the versions does not meet the requir apt install gcc-11 g++-11 ``` -## Requirements and suggestions for installing Nebula Graph in test environments +## Requirements and suggestions for installing NebulaGraph in test environments ### Hardware requirements for test environments @@ -136,10 +136,10 @@ If part of the dependencies are missing or the versions does not meet the requir ### Supported operating systems for test environments -For now, we can only install Nebula Graph in the Linux system. To install Nebula Graph in a test environment, we recommend that you use any Linux system with kernel version `3.9` or above. +For now, we can only install NebulaGraph in the Linux system. To install NebulaGraph in a test environment, we recommend that you use any Linux system with kernel version `3.9` or above. ### Suggested service architecture for test environments @@ -152,7 +152,7 @@ You can adjust some of the kernel parameters to better accommodate the need for For example, for a single-machine test environment, you can deploy 1 metad, 1 storaged, and 1 graphd processes in the machine. -For a more common test environment, such as a cluster of 3 machines (named as A, B, and C), you can deploy Nebula Graph as follows: +For a more common test environment, such as a cluster of 3 machines (named as A, B, and C), you can deploy NebulaGraph as follows: | Machine name | Number of metad | Number of storaged | Number of graphd | | ------------ | --------------- | ------------------ | ---------------- | @@ -160,7 +160,7 @@ For a more common test environment, such as a cluster of 3 machines (named as A, | B | None | 1 | 1 | | C | None | 1 | 1 | -## Requirements and suggestions for installing Nebula Graph in production environments +## Requirements and suggestions for installing NebulaGraph in production environments ### Hardware requirements for production environments @@ -173,9 +173,9 @@ For a more common test environment, such as a cluster of 3 machines (named as A, ### Supported operating systems for production environments -For now, we can only install Nebula Graph in the Linux system. To install Nebula Graph in a production environment, we recommend that you use any Linux system with kernel version 3.9 or above. +For now, we can only install NebulaGraph in the Linux system. To install NebulaGraph in a production environment, we recommend that you use any Linux system with kernel version 3.9 or above. -Users can adjust some of the kernel parameters to better accommodate the need for running Nebula Graph. For more information, see [kernel configuration](../5.configurations-and-logs/1.configurations/6.kernel-config.md). +Users can adjust some of the kernel parameters to better accommodate the need for running NebulaGraph. For more information, see [kernel configuration](../5.configurations-and-logs/1.configurations/6.kernel-config.md). ### Suggested service architecture for production environments @@ -193,7 +193,7 @@ Each metad process automatically creates and maintains a replica of the metadata The number of storaged processes does not affect the number of graph space replicas. -Users can deploy multiple processes on a single machine. For example, on a cluster of 5 machines (named as A, B, C, D, and E), you can deploy Nebula Graph as follows: +Users can deploy multiple processes on a single machine. For example, on a cluster of 5 machines (named as A, B, C, D, and E), you can deploy NebulaGraph as follows: | Machine name | Number of metad | Number of storaged | Number of graphd | | ------------ | --------------- | ------------------ | ---------------- | @@ -203,9 +203,9 @@ Users can deploy multiple processes on a single machine. For example, on a clust | D | None | 1 | 1 | | E | None | 1 | 1 | -## Capacity requirements for running a Nebula Graph cluster +## Capacity requirements for running a NebulaGraph cluster -Users can estimate the memory, disk space, and partition number needed for a Nebula Graph cluster of 3 replicas as follows. +Users can estimate the memory, disk space, and partition number needed for a NebulaGraph cluster of 3 replicas as follows. | Resource |Unit| How to estimate |Description| |:--- |:---|:--- |:---| @@ -229,7 +229,7 @@ Users can estimate the memory, disk space, and partition number needed for a Neb ### About storage devices -Nebula Graph is designed and implemented for NVMe SSD. All default parameters are optimized for the SSD devices and require extremely high IOPS and low latency. +NebulaGraph is designed and implemented for NVMe SSD. All default parameters are optimized for the SSD devices and require extremely high IOPS and low latency. - Due to the poor IOPS capability and long random seek latency, HDD is not recommended. Users may encounter many problems when using HDD. @@ -243,18 +243,18 @@ Nebula Graph is designed and implemented for NVMe SSD. All default parameters ar !!! enterpriseonly - Only Nebula Graph {{ nebula.release }} Enterprise Eidtion can be run or compiled directly on ARM architectures (including Apple Mac M1 or Huawei Kunpeng). Contact inquiry@vesoft.com for business supports. + Only NebulaGraph {{ nebula.release }} Enterprise Eidtion can be run or compiled directly on ARM architectures (including Apple Mac M1 or Huawei Kunpeng). Contact inquiry@vesoft.com for business supports. !!! note - Starting with 3.0.2, you can run containerized Nebula Graph databases on Docker Desktop for ARM macOS or on ARM Linux servers. + Starting with 3.0.2, you can run containerized NebulaGraph databases on Docker Desktop for ARM macOS or on ARM Linux servers. diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md index fd526a24584..361c0a3c158 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md @@ -1,6 +1,6 @@ -# Deploy Nebula Graph with Docker Compose +# Deploy NebulaGraph with Docker Compose -Using Docker Compose can quickly deploy Nebula Graph services based on the prepared configuration file. It is only recommended to use this method when testing functions of Nebula Graph. +Using Docker Compose can quickly deploy NebulaGraph services based on the prepared configuration file. It is only recommended to use this method when testing functions of NebulaGraph. ## Prerequisites @@ -12,19 +12,19 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa | Docker Compose | Latest | [Install Docker Compose](https://docs.docker.com/compose/install/) | | Git | Latest | [Download Git](https://git-scm.com/download/) | -* If you are deploying Nebula Graph as a non-root user, grant the user with Docker-related privileges. For detailed instructions, see [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user). +* If you are deploying NebulaGraph as a non-root user, grant the user with Docker-related privileges. For detailed instructions, see [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user). * You have started the Docker service on your host. -* If you have already deployed another version of Nebula Graph with Docker Compose on your host, to avoid compatibility issues, you need to delete the `nebula-docker-compose/data` directory. +* If you have already deployed another version of NebulaGraph with Docker Compose on your host, to avoid compatibility issues, you need to delete the `nebula-docker-compose/data` directory. -## How to deploy and connect to Nebula Graph +## How to deploy and connect to NebulaGraph 1. Clone the `{{dockercompose.release}}` branch of the `nebula-docker-compose` repository to your host with Git. !!! danger - The `master` branch contains the untested code for the latest Nebula Graph development release. **DO NOT** use this release in a production environment. + The `master` branch contains the untested code for the latest NebulaGraph development release. **DO NOT** use this release in a production environment. ```bash $ git clone -b {{dockercompose.branch}} https://github.com/vesoft-inc/nebula-docker-compose.git @@ -36,14 +36,14 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa $ cd nebula-docker-compose/ ``` -3. Run the following command to start all the Nebula Graph services. +3. Run the following command to start all the NebulaGraph services. - Starting with 3.0.2, Nebula Graph comes with ARM64 Linux Docker images. You can run containerized Nebula Graph databases on Docker Desktop for ARM macOS or on ARM Linux servers. + Starting with 3.0.2, NebulaGraph comes with ARM64 Linux Docker images. You can run containerized NebulaGraph databases on Docker Desktop for ARM macOS or on ARM Linux servers. !!! Note - Update the [Nebula Graph images](#how_to_upgrade_or_update_the_docker_images_of_nebula_graph_services) and [Nebula Console images](#how_to_update_the_nebula_console_client) first if they are out of date. + Update the [NebulaGraph images](#how_to_upgrade_or_update_the_docker_images_of_nebula_graph_services) and [Nebula Console images](#how_to_update_the_nebula_console_client) first if they are out of date. ```bash [nebula-docker-compose]$ docker-compose up -d @@ -60,11 +60,11 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa !!! Note - For more information of the preceding services, see [Nebula Graph architecture](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md). + For more information of the preceding services, see [NebulaGraph architecture](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md). -4. Connect to Nebula Graph. +4. Connect to NebulaGraph. - 1. Run the following command to start a new docker container with the Nebula Console image, and connect the container to the network where Nebula Graph is deployed (nebula-docker-compose_nebula-net). + 1. Run the following command to start a new docker container with the Nebula Console image, and connect the container to the network where NebulaGraph is deployed (nebula-docker-compose_nebula-net). ```bash $ docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:{{console.branch}} @@ -83,7 +83,7 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa 93ba48b4b288 none null local ``` - 2. Connect to Nebula Graph with Nebula Console. + 2. Connect to NebulaGraph with Nebula Console. ```bash docker> nebula-console -u -p --address=graphd --port=9669 @@ -110,13 +110,13 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa !!! Note - Starting from Nebula Graph version 3.0.0, the `nebula-storaged` service reported to metad needs to execute 'ADD HOSTS' manually before it can be used. + Starting from NebulaGraph version 3.0.0, the `nebula-storaged` service reported to metad needs to execute 'ADD HOSTS' manually before it can be used. -5. Run `exit` twice to switch back to your terminal (shell). You can run Step 4 to log in to Nebula Graph again. +5. Run `exit` twice to switch back to your terminal (shell). You can run Step 4 to log in to NebulaGraph again. -## Check the Nebula Graph service status and ports +## Check the NebulaGraph service status and ports -Run `docker-compose ps` to list all the services of Nebula Graph and their status and ports. +Run `docker-compose ps` to list all the services of NebulaGraph and their status and ports. ```bash $ docker-compose ps @@ -142,11 +142,11 @@ nebula-docker-compose_storaged2_1 ./bin/nebula-storaged --fl ... Up (health: 44500/tcp, 44501/tcp, 0.0.0.0:33300->9779/tcp ``` -Nebula Graph provides services to the clients through port `9669` by default. To use other ports, modify the `docker-compose.yaml` file in the `nebula-docker-compose` directory and restart the Nebula Graph services. +NebulaGraph provides services to the clients through port `9669` by default. To use other ports, modify the `docker-compose.yaml` file in the `nebula-docker-compose` directory and restart the NebulaGraph services. ## Check the service data and logs -All the data and logs of Nebula Graph are stored persistently in the `nebula-docker-compose/data` and `nebula-docker-compose/logs` directories. +All the data and logs of NebulaGraph are stored persistently in the `nebula-docker-compose/data` and `nebula-docker-compose/logs` directories. The structure of the directories is as follows: @@ -172,15 +172,15 @@ nebula-docker-compose/ └── storage2 ``` -## Stop the Nebula Graph services +## Stop the NebulaGraph services -You can run the following command to stop the Nebula Graph services: +You can run the following command to stop the NebulaGraph services: ```bash $ docker-compose down ``` -The following information indicates you have successfully stopped the Nebula Graph services: +The following information indicates you have successfully stopped the NebulaGraph services: ```bash Stopping nebula-docker-compose_graphd2_1 ... done @@ -206,11 +206,11 @@ Removing network nebula-docker-compose_nebula-net !!! danger - The parameter `-v` in the command `docker-compose down -v` will **delete** all your local Nebula Graph storage data. Try this command if you are using the nightly release and having some compatibility issues. + The parameter `-v` in the command `docker-compose down -v` will **delete** all your local NebulaGraph storage data. Try this command if you are using the nightly release and having some compatibility issues. ## Modify configurations -The configuration file of Nebula Graph deployed by Docker Compose is `nebula-docker-compose/docker-compose.yaml`. To make the new configuration take effect, modify the configuration in this file and restart the service. +The configuration file of NebulaGraph deployed by Docker Compose is `nebula-docker-compose/docker-compose.yaml`. To make the new configuration take effect, modify the configuration in this file and restart the service. For more instructions, see [Configurations](../../5.configurations-and-logs/1.configurations/1.configurations.md). @@ -232,15 +232,15 @@ graphd: `9669:9669` indicates the internal port 9669 is uniformly mapped to external ports, while `19669` indicates the internal port 19669 is randomly mapped to external ports. -### How to upgrade or update the docker images of Nebula Graph services +### How to upgrade or update the docker images of NebulaGraph services 1. In the `nebula-docker-compose/docker-compose.yaml` file, change all the `image` values to the required image version. 2. In the `nebula-docker-compose` directory, run `docker-compose pull` to update the images of the Graph Service, Storage Service, and Meta Service. -3. Run `docker-compose up -d` to start the Nebula Graph services again. +3. Run `docker-compose up -d` to start the NebulaGraph services again. -4. After connecting to Nebula Graph with Nebula Console, run `SHOW HOSTS GRAPH`, `SHOW HOSTS STORAGE`, or `SHOW HOSTS META` to check the version of the responding service respectively. +4. After connecting to NebulaGraph with Nebula Console, run `SHOW HOSTS GRAPH`, `SHOW HOSTS STORAGE`, or `SHOW HOSTS META` to check the version of the responding service respectively. ### `ERROR: toomanyrequests` when `docker-compose pull` @@ -260,6 +260,6 @@ docker pull vesoft/nebula-console:{{console.branch}} ## Related documents -- [Install and deploy Nebula Graph with the source code](1.install-nebula-graph-by-compiling-the-source-code.md) -- [Install Nebula Graph by RPM or DEB](2.install-nebula-graph-by-rpm-or-deb.md) -- [Connect to Nebula Graph](../connect-to-nebula-graph.md) +- [Install and deploy NebulaGraph with the source code](1.install-nebula-graph-by-compiling-the-source-code.md) +- [Install NebulaGraph by RPM or DEB](2.install-nebula-graph-by-rpm-or-deb.md) +- [Connect to NebulaGraph](../connect-to-nebula-graph.md) diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md index 3e6d983b1ab..1404cffb2ed 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md @@ -1,14 +1,14 @@ -# Install Nebula graph with the tar.gz file +# Install NebulaGraph with the tar.gz file -You can install Nebula Graph by downloading the tar.gz file. +You can install NebulaGraph by downloading the tar.gz file. !!! note - Nebula Graph provides installing with the tar.gz file starting from version 2.6.0. + NebulaGraph provides installing with the tar.gz file starting from version 2.6.0. ## Installation steps -1. Download the Nebula Graph tar.gz file using the following address. +1. Download the NebulaGraph tar.gz file using the following address. Before downloading, you need to replace `` with the version you want to download. @@ -39,13 +39,13 @@ You can install Nebula Graph by downloading the tar.gz file. https://oss-cdn.nebula-graph.com.cn/package//nebula-graph-.ubuntu2004.amd64.tar.gz.sha256sum.txt ``` - For example, to download the Nebula Graph {{nebula.branch}} tar.gz file for `CentOS 7.5`, run the following command: + For example, to download the NebulaGraph {{nebula.branch}} tar.gz file for `CentOS 7.5`, run the following command: ```bash wget https://oss-cdn.nebula-graph.com.cn/package/{{nebula.release}}/nebula-graph-{{nebula.release}}.el7.x86_64.tar.gz ``` -2. Decompress the tar.gz file to the Nebula Graph installation directory. +2. Decompress the tar.gz file to the NebulaGraph installation directory. ```bash tar -xvzf -C @@ -62,12 +62,12 @@ You can install Nebula Graph by downloading the tar.gz file. 3. Modify the name of the configuration file. - Enter the decompressed directory, rename the files `nebula-graphd.conf.default`, `nebula-metad.conf.default`, and `nebula-storaged.conf.default` in the subdirectory `etc`, and delete `.default` to apply the default configuration of Nebula Graph. To modify the configuration, see [Configurations](../../5.configurations-and-logs/1.configurations/1.configurations.md). + Enter the decompressed directory, rename the files `nebula-graphd.conf.default`, `nebula-metad.conf.default`, and `nebula-storaged.conf.default` in the subdirectory `etc`, and delete `.default` to apply the default configuration of NebulaGraph. To modify the configuration, see [Configurations](../../5.configurations-and-logs/1.configurations/1.configurations.md). -So far, you have installed Nebula Graph successfully. +So far, you have installed NebulaGraph successfully. ## Next to do - (Enterprise Edition)[Deploy license](../deploy-license.md) -- [Manage Nebula Graph services](../manage-service.md) +- [Manage NebulaGraph services](../manage-service.md) diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md index 6d4a3eac928..df0a286955c 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md @@ -1,6 +1,6 @@ -# Deploy a Nebula Graph cluster with RPM/DEB package on multiple servers +# Deploy a NebulaGraph cluster with RPM/DEB package on multiple servers -For now, Nebula Graph does not provide an official deployment tool. Users can deploy a Nebula Graph cluster with RPM or DEB package manually. This topic provides an example of deploying a Nebula Graph cluster on multiple servers (machines). +For now, NebulaGraph does not provide an official deployment tool. Users can deploy a NebulaGraph cluster with RPM or DEB package manually. This topic provides an example of deploying a NebulaGraph cluster on multiple servers (machines). ## Deployment @@ -19,19 +19,19 @@ For now, Nebula Graph does not provide an official deployment tool. Users can de ## Manual deployment process -### Step 1: Install Nebula Graph +### Step 1: Install NebulaGraph -Install Nebula Graph on each machine in the cluster. Available approaches of installation are as follows. +Install NebulaGraph on each machine in the cluster. Available approaches of installation are as follows. -* [Install Nebula Graph with RPM or DEB package](2.install-nebula-graph-by-rpm-or-deb.md) +* [Install NebulaGraph with RPM or DEB package](2.install-nebula-graph-by-rpm-or-deb.md) -* [Install Nebula Graph by compiling the source code](1.install-nebula-graph-by-compiling-the-source-code.md) +* [Install NebulaGraph by compiling the source code](1.install-nebula-graph-by-compiling-the-source-code.md) ### Step 2: Modify the configurations -To deploy Nebula Graph according to your requirements, you have to modify the configuration files. +To deploy NebulaGraph according to your requirements, you have to modify the configuration files. -All the configuration files for Nebula Graph, including `nebula-graphd.conf`, `nebula-metad.conf`, and `nebula-storaged.conf`, are stored in the `etc` directory in the installation path. You only need to modify the configuration for the corresponding service on the machines. The configurations that need to be modified for each machine are as follows. +All the configuration files for NebulaGraph, including `nebula-graphd.conf`, `nebula-metad.conf`, and `nebula-storaged.conf`, are stored in the `etc` directory in the installation path. You only need to modify the configuration for the corresponding service on the machines. The configurations that need to be modified for each machine are as follows. | Machine name | The configuration to be modified | | :----- | :--------------- | @@ -41,7 +41,7 @@ All the configuration files for Nebula Graph, including `nebula-graphd.conf`, `n | D | `nebula-graphd.conf`, `nebula-storaged.conf` | | E | `nebula-graphd.conf`, `nebula-storaged.conf` | -Users can refer to the content of the following configurations, which only show part of the cluster settings. The hidden content uses the default setting so that users can better understand the relationship between the servers in the Nebula Graph cluster. +Users can refer to the content of the following configurations, which only show part of the cluster settings. The hidden content uses the default setting so that users can better understand the relationship between the servers in the NebulaGraph cluster. !!! note @@ -267,7 +267,7 @@ Start the corresponding service on **each machine**. Descriptions are as follows | D | graphd, storaged | | E | graphd, storaged | -The command to start the Nebula Graph services is as follows. +The command to start the NebulaGraph services is as follows. ```bash sudo /usr/local/nebula/scripts/nebula.service start @@ -275,17 +275,17 @@ sudo /usr/local/nebula/scripts/nebula.service start !!! note - - Make sure all the processes of services on each machine are started. Otherwise, you will fail to start Nebula Graph. + - Make sure all the processes of services on each machine are started. Otherwise, you will fail to start NebulaGraph. - When the graphd process, the storaged process, and the metad process are all started, you can use `all` instead. - - `/usr/local/nebula` is the default installation path for Nebula Graph. Use the actual path if you have customized the path. For more information about how to start and stop the services, see [Manage Nebula Graph services](../manage-service.md). + - `/usr/local/nebula` is the default installation path for NebulaGraph. Use the actual path if you have customized the path. For more information about how to start and stop the services, see [Manage NebulaGraph services](../manage-service.md). ### Step 4: Add hosts ```bash $ ./nebula-console --addr 192.168.10.111 --port 9669 -u root -p nebula -Welcome to Nebula Graph! +Welcome to NebulaGraph! > ADD HOSTS 192.168.10.111:9779,192.168.10.112:9779,192.168.10.113:9779,192.168.10.114:9779,192.168.10.115:9779 Execution succeeded (time spent 1074/1295 us) @@ -301,7 +301,7 @@ Install the native CLI client [Nebula Console](../../2.quick-start/3.connect-to- $ ./nebula-console --addr 192.168.10.111 --port 9669 -u root -p nebula 2021/05/25 01:41:19 [INFO] connection pool is initialized successfully -Welcome to Nebula Graph! +Welcome to NebulaGraph! > SHOW HOSTS; +------------------+------+----------+--------------+----------------------+------------------------+---------+ diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md index da8b66fca9f..bc46c7ff096 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md @@ -1,16 +1,16 @@ -# Upgrade Nebula Graph v2.0.x to v{{nebula.release}} +# Upgrade NebulaGraph v2.0.x to v{{nebula.release}} -To upgrade Nebula Graph v2.0.x to v{{nebula.release}}, you only need to use the RPM/DEB package of v{{nebula.release}} for the upgrade, or [compile it](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) and then reinstall. +To upgrade NebulaGraph v2.0.x to v{{nebula.release}}, you only need to use the RPM/DEB package of v{{nebula.release}} for the upgrade, or [compile it](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) and then reinstall. !!! note - Nebula Graph v2.0.x refers to v2.0.0-GA and v2.0.1 releases. If your Nebula Graph version is too low (v2.0.0-RC, v2.0.0-beta, v1.x), see [Upgrade Nebula Graph to v{{nebula.release}}](upgrade-nebula-graph-to-latest.md). + NebulaGraph v2.0.x refers to v2.0.0-GA and v2.0.1 releases. If your NebulaGraph version is too low (v2.0.0-RC, v2.0.0-beta, v1.x), see [Upgrade NebulaGraph to v{{nebula.release}}](upgrade-nebula-graph-to-latest.md). ## Upgrade steps with RPM/DEB packages 1. Download the [RPM/DEB package](https://github.com/vesoft-inc/nebula-graph/releases/tag/v{{nebula.release}}). -2. Stop all Nebula Graph services. For details, see [Manage Nebula Graph Service](../../2.quick-start/5.start-stop-service.md). It is recommended to back up the configuration file before updating. +2. Stop all NebulaGraph services. For details, see [Manage NebulaGraph Service](../../2.quick-start/5.start-stop-service.md). It is recommended to back up the configuration file before updating. 3. Execute the following command to upgrade: @@ -32,13 +32,13 @@ To upgrade Nebula Graph v2.0.x to v{{nebula.release}}, you only need to use the $ sudo dpkg -i ``` -4. Start the required services on each server. For details, see [Manage Nebula Graph Service](../../2.quick-start/5.start-stop-service.md). +4. Start the required services on each server. For details, see [Manage NebulaGraph Service](../../2.quick-start/5.start-stop-service.md). ## Upgrade steps by compiling the new source code -1. Back up the old version of the configuration file. The configuration file is saved in the `etc` directory of the Nebula Graph installation path. +1. Back up the old version of the configuration file. The configuration file is saved in the `etc` directory of the NebulaGraph installation path. -2. Update the repository and compile the source code. For details, see [Install Nebula Graph by compiling the source code](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md). +2. Update the repository and compile the source code. For details, see [Install NebulaGraph by compiling the source code](../2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md). !!! note @@ -50,6 +50,6 @@ To upgrade Nebula Graph v2.0.x to v{{nebula.release}}, you only need to use the 2. Execute the command `docker-compose pull` in the directory `nebula-docker-compose` to update the images of all services. -3. Execute the command `docker-compose down` to stop the Nebula Graph service. +3. Execute the command `docker-compose down` to stop the NebulaGraph service. -4. Execute the command `docker-compose up -d` to start the Nebula Graph service. +4. Execute the command `docker-compose up -d` to start the NebulaGraph service. diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md index 15a5310bad9..547190fe2a4 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md @@ -1,29 +1,29 @@ -# Upgrade Nebula Graph from version 2.x to {{nebula.release}} +# Upgrade NebulaGraph from version 2.x to {{nebula.release}} -This topic describes how to upgrade Nebula Graph from version 2.x to {{nebula.release}}, taking upgrading from version 2.6.1 to {{nebula.release}} as an example. +This topic describes how to upgrade NebulaGraph from version 2.x to {{nebula.release}}, taking upgrading from version 2.6.1 to {{nebula.release}} as an example. ## Applicable source versions -This topic applies to upgrading Nebula Graph from 2.0.0 and later 2.x versions to {{nebula.release}}. It does not apply to historical versions earlier than 2.0.0, including the 1.x versions. +This topic applies to upgrading NebulaGraph from 2.0.0 and later 2.x versions to {{nebula.release}}. It does not apply to historical versions earlier than 2.0.0, including the 1.x versions. -To upgrade Nebula Graph from historical versions to {{nebula.release}}: +To upgrade NebulaGraph from historical versions to {{nebula.release}}: 1. Upgrade it to the latest 2.x version according to the docs of that version. 2. Follow this topic to upgrade it to {{nebula.release}}. !!! caution - To upgrade Nebula Graph from versions earlier than 2.0.0 (including the 1.x versions) to {{nebula.release}}, you need to find the `date_time_zonespec.csv` in the `share/resources` directory of {{nebula.release}} files, and then copy it to the same directory in the Nebula Graph installation path. + To upgrade NebulaGraph from versions earlier than 2.0.0 (including the 1.x versions) to {{nebula.release}}, you need to find the `date_time_zonespec.csv` in the `share/resources` directory of {{nebula.release}} files, and then copy it to the same directory in the NebulaGraph installation path. ## Limitations -* Rolling Upgrade is not supported. You must stop all the Nebula Graph services before the upgrade. +* Rolling Upgrade is not supported. You must stop all the NebulaGraph services before the upgrade. * There is no upgrade script. You have to manually upgrade each server in the cluster. -* This topic does not apply to scenarios where Nebula Graph is deployed with Docker, including Docker Swarm, Docker Compose, and K8s. +* This topic does not apply to scenarios where NebulaGraph is deployed with Docker, including Docker Swarm, Docker Compose, and K8s. -* You must upgrade the old Nebula Graph services on the same machines they are deployed. **DO NOT** change the IP addresses, configuration files of the machines, and **DO NOT** change the cluster topology. +* You must upgrade the old NebulaGraph services on the same machines they are deployed. **DO NOT** change the IP addresses, configuration files of the machines, and **DO NOT** change the cluster topology. * The hard disk space left on each machine should be **two times** as much as the space taken by the original data directories. Half of the reserved space is for storing the manual backup of data. The other half is for storing the WALs copied to the `dst_db_path` and the new keys generated to support vertices with no tags. @@ -37,7 +37,7 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: - Data swelling - The Nebula Graph 3.x version expands the original data format with one more key per vertex, so the data takes up more space after the upgrade. + The NebulaGraph 3.x version expands the original data format with one more key per vertex, so the data takes up more space after the upgrade. The format of the new key is: @@ -47,7 +47,7 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: - Client compatibility - After the upgrade, you will not be able to connect to Nebula Graph from old clients. You will need to upgrade all clients to a version compatible with Nebula Graph {{nebula.release}}. + After the upgrade, you will not be able to connect to NebulaGraph from old clients. You will need to upgrade all clients to a version compatible with NebulaGraph {{nebula.release}}. - Configuration changes @@ -69,7 +69,7 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: ## Preparations before the upgrade -- Download the TAR file of Nebula Graph {{nebula.release}} according to your operating system and system architecture. You need the binary files during the upgrade. Find the TAR file on [the download page](https://nebula-graph.io/download/). +- Download the TAR file of NebulaGraph {{nebula.release}} according to your operating system and system architecture. You need the binary files during the upgrade. Find the TAR file on [the download page](https://nebula-graph.io/download/). !!! note You can also get the new binaries from the source code or the RPM/DEB package. @@ -88,13 +88,13 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: ## Upgrade steps -1. Stop all Nebula Graph services. +1. Stop all NebulaGraph services. ``` /scripts/nebula.service stop all ``` - `nebula_install_path` indicates the installation path of Nebula Graph. + `nebula_install_path` indicates the installation path of NebulaGraph. The storaged progress needs around 1 minute to flush data. You can run `nebula.service status all` to check if all services are stopped. For more information about starting and stopping services, see [Manage services](../manage-service.md). @@ -102,10 +102,10 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: If the services are not fully stopped in 20 minutes, stop upgrading and ask for help on [the forum](https://discuss.nebula-graph.io/) or [Github](https://github.com/vesoft-inc/nebula/issues). -2. In the target path where you unpacked the TAR file, use the binaries in the `bin` directory to replace the old binaries in the `bin` directory in the Nebula Graph installation path. +2. In the target path where you unpacked the TAR file, use the binaries in the `bin` directory to replace the old binaries in the `bin` directory in the NebulaGraph installation path. !!! note - Update the binary of the corresponding service on each Nebula Graph server. + Update the binary of the corresponding service on each NebulaGraph server. 3. Modify the following parameters in all Graph configuration files to accommodate the value range of the new version. If the parameter values are within the specified range, skip this step. @@ -165,7 +165,7 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: !!! note If the operation fails, stop the upgrade and ask for help on [the forum](https://discuss.nebula-graph.com.cn/) or [GitHub](https://github.com/vesoft-inc/nebula/issues). -7. Connect to the new version of Nebula Graph to verify that services are available and data are complete. For how to connect, see [Connect to Nebula Graph](../connect-to-nebula-graph.md). +7. Connect to the new version of NebulaGraph to verify that services are available and data are complete. For how to connect, see [Connect to NebulaGraph](../connect-to-nebula-graph.md). Currently, there is no official way to check whether the upgrade is successful. You can run the following reference statements to test the upgrade: @@ -184,15 +184,15 @@ To upgrade Nebula Graph from historical versions to {{nebula.release}}: ## Upgrade failure and rollback -If the upgrade fails, stop all Nebula Graph services of the new version, recover the old configuration files and binaries, and start the services of the old version. +If the upgrade fails, stop all NebulaGraph services of the new version, recover the old configuration files and binaries, and start the services of the old version. -All Nebula Graph clients in use must be switched to the old version. +All NebulaGraph clients in use must be switched to the old version. ## FAQ ### Can I write through the client during the upgrade? -A: No. You must stop all Nebula Graph services during the upgrade. +A: No. You must stop all NebulaGraph services during the upgrade. ### How to upgrade if a machine has only the Graph Service, but not the Storage Service? @@ -228,4 +228,4 @@ If the issue persists, ask for help on [the forum](https://discuss.nebula-graph. ### Why the job type changed after the upgrade, but job ID remains the same? -A: `SHOW JOBS` depends on an internal ID to identify job types, but in Nebula Graph 2.5.0 the internal ID changed in [this pull request](https://github.com/vesoft-inc/nebula-common/pull/562/files), so this issue happens after upgrading from a version earlier than 2.5.0. +A: `SHOW JOBS` depends on an internal ID to identify job types, but in NebulaGraph 2.5.0 the internal ID changed in [this pull request](https://github.com/vesoft-inc/nebula-common/pull/562/files), so this issue happens after upgrading from a version earlier than 2.5.0. diff --git a/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md b/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md index a3c03bd6df6..1a75f0d158d 100644 --- a/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md +++ b/docs-2.0/4.deployment-and-installation/4.uninstall-nebula-graph.md @@ -1,22 +1,22 @@ -# Uninstall Nebula Graph +# Uninstall NebulaGraph -This topic describes how to uninstall Nebula Graph. +This topic describes how to uninstall NebulaGraph. !!! caution - Before re-installing Nebula Graph on a machine, follow this topic to completely uninstall the old Nebula Graph, in case the remaining data interferes with the new services, including inconsistencies between Meta services. + Before re-installing NebulaGraph on a machine, follow this topic to completely uninstall the old NebulaGraph, in case the remaining data interferes with the new services, including inconsistencies between Meta services. ## Prerequisite -The Nebula Graph services should be stopped before the uninstallation. For more information, see [Manage Nebula Graph services](../2.quick-start/5.start-stop-service.md). +The NebulaGraph services should be stopped before the uninstallation. For more information, see [Manage NebulaGraph services](../2.quick-start/5.start-stop-service.md). ## Step 1: Delete data files of the Storage and Meta Services -If you have modified the `data_path` in the configuration files for the Meta Service and Storage Service, the directories where Nebula Graph stores data may not be in the installation path of Nebula Graph. Check the configuration files to confirm the data paths, and then manually delete the directories to clear all data. +If you have modified the `data_path` in the configuration files for the Meta Service and Storage Service, the directories where NebulaGraph stores data may not be in the installation path of NebulaGraph. Check the configuration files to confirm the data paths, and then manually delete the directories to clear all data. !!! Note - For a Nebula Graph cluster, delete the data files of all Storage and Meta servers. + For a NebulaGraph cluster, delete the data files of all Storage and Meta servers. 1. Check the [Storage Service disk settings](../5.configurations-and-logs/1.configurations/4.storage-config.md#disk_configurations). For example: @@ -37,15 +37,15 @@ If you have modified the `data_path` in the configuration files for the Meta Ser Delete all installation directories, including the `cluster.id` file in them. -The default installation path is `/usr/local/nebula`, which is specified by `--prefix` while installing Nebula Graph. +The default installation path is `/usr/local/nebula`, which is specified by `--prefix` while installing NebulaGraph. -### Uninstall Nebula Graph deployed with source code +### Uninstall NebulaGraph deployed with source code -Find the installation directories of Nebula Graph, and delete them all. +Find the installation directories of NebulaGraph, and delete them all. -### Uninstall Nebula Graph deployed with RPM packages +### Uninstall NebulaGraph deployed with RPM packages -1. Run the following command to get the Nebula Graph version. +1. Run the following command to get the NebulaGraph version. ```bash $ rpm -qa | grep "nebula" @@ -57,7 +57,7 @@ Find the installation directories of Nebula Graph, and delete them all. nebula-graph-{{ nebula.release }}-1.x86_64 ``` -2. Run the following command to uninstall Nebula Graph. +2. Run the following command to uninstall NebulaGraph. ```bash sudo rpm -e @@ -71,9 +71,9 @@ Find the installation directories of Nebula Graph, and delete them all. 3. Delete the installation directories. -### Uninstall Nebula Graph deployed with DEB packages +### Uninstall NebulaGraph deployed with DEB packages -1. Run the following command to get the Nebula Graph version. +1. Run the following command to get the NebulaGraph version. ```bash $ dpkg -l | grep "nebula" @@ -85,7 +85,7 @@ Find the installation directories of Nebula Graph, and delete them all. ii nebula-graph {{ nebula.release }} amd64 Nebula Package built using CMake ``` -2. Run the following command to uninstall Nebula Graph. +2. Run the following command to uninstall NebulaGraph. ```bash sudo dpkg -r @@ -99,9 +99,9 @@ Find the installation directories of Nebula Graph, and delete them all. 3. Delete the installation directories. -### Uninstall Nebula Graph deployed with Docker Compose +### Uninstall NebulaGraph deployed with Docker Compose -1. In the `nebula-docker-compose` directory, run the following command to stop the Nebula Graph services. +1. In the `nebula-docker-compose` directory, run the following command to stop the NebulaGraph services. ```bash docker-compose down -v diff --git a/docs-2.0/4.deployment-and-installation/5.zone.md b/docs-2.0/4.deployment-and-installation/5.zone.md index 8b55526a6a0..00767e37f7f 100644 --- a/docs-2.0/4.deployment-and-installation/5.zone.md +++ b/docs-2.0/4.deployment-and-installation/5.zone.md @@ -1,12 +1,12 @@ # Manage zone -Nebula Graph supports the zone feature to manage Storage services in a cluster to achieve resource isolation, which is known as logical rack. +NebulaGraph supports the zone feature to manage Storage services in a cluster to achieve resource isolation, which is known as logical rack. ## Background !!! compatibility - From Nebula Graph version 3.0.0, the Storage services added in the configuration files **CANNOT** be read or written directly. The configuration files only register the Storage services into the Meta services. You must run the `ADD HOSTS` command to read and write data on Storage servers. + From NebulaGraph version 3.0.0, the Storage services added in the configuration files **CANNOT** be read or written directly. The configuration files only register the Storage services into the Meta services. You must run the `ADD HOSTS` command to read and write data on Storage servers. Users can add the Storage services to a zone. Users specify a zone when creating a graph space, the graph space will be created in all the Storage services of the zone. Partitions and replicas are evenly stored in each zone. As shown in the figure below. diff --git a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md index 7772cf51a54..afed32dd83d 100644 --- a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md +++ b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md @@ -36,4 +36,4 @@ For now, full-text search has the following limitations: 15. It may take a while for Elasticsearch to create indexes. If Nebula Graph warns no index is found, wait for the index to take effect (however, the waiting time is unknown and there is no code to check). -16. Nebula Graph clusters deployed with K8s do not support the full-text search feature. +16. NebulaGraph clusters deployed with K8s do not support the full-text search feature. diff --git a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md index 0784846e6ae..f454997b5f5 100644 --- a/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md +++ b/docs-2.0/4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md @@ -6,7 +6,7 @@ Full-text index data is written to the Elasticsearch cluster asynchronously. The * You have read and fully understood the [restrictions](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md) for using full-text indexes. -* You have [deployed a Nebula Graph cluster](../2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md). +* You have [deployed a NebulaGraph cluster](../2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md). * You have [deploy a Elasticsearch cluster](./2.deploy-es.md). @@ -22,7 +22,7 @@ Full-text index data is written to the Elasticsearch cluster asynchronously. The ### Step 1: Install the Storage service -The Listener process and the storaged process use the same binary file. However, their configuration files and using ports are different. You can install Nebula Graph on all servers that need to deploy a Listener, but only the Storage service can be used. For details, see [Install Nebula Graph by RPM or DEB Package](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md). +The Listener process and the storaged process use the same binary file. However, their configuration files and using ports are different. You can install NebulaGraph on all servers that need to deploy a Listener, but only the Storage service can be used. For details, see [Install NebulaGraph by RPM or DEB Package](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md). ### Step 2: Prepare the configuration file for the Listener @@ -60,9 +60,9 @@ Run the following command to start the Listener. `${listener_config_path}` is the path where you store the Listener configuration file. -### Step 4: Add Listeners to Nebula Graph +### Step 4: Add Listeners to NebulaGraph -[Connect to Nebula Graph](../../2.quick-start/3.connect-to-nebula-graph.md) and run [`USE `](../../3.ngql-guide/9.space-statements/2.use-space.md) to enter the graph space that you want to create full-text indexes for. Then run the following statement to add a Listener into Nebula Graph. +[Connect to NebulaGraph](../../2.quick-start/3.connect-to-nebula-graph.md) and run [`USE `](../../3.ngql-guide/9.space-statements/2.use-space.md) to enter the graph space that you want to create full-text indexes for. Then run the following statement to add a Listener into NebulaGraph. ```ngql ADD LISTENER ELASTICSEARCH [,, ...] diff --git a/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md b/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md index cae94615bbc..44e9e3ac3dd 100644 --- a/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md +++ b/docs-2.0/4.deployment-and-installation/connect-to-nebula-graph.md @@ -1,4 +1,4 @@ -# Connect to Nebula Graph +# Connect to NebulaGraph {% include "/source_connect-to-nebula-graph.md" %} diff --git a/docs-2.0/4.deployment-and-installation/deploy-license.md b/docs-2.0/4.deployment-and-installation/deploy-license.md index 62576a8400b..058e8c64771 100644 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ b/docs-2.0/4.deployment-and-installation/deploy-license.md @@ -1,6 +1,6 @@ # Deploy license -Nebula Graph Enterprise Edition requires the user to deploy a license file before starting the Enterprise Edition. This topic describes how to deploy a license file for the Enterprise Edition. +NebulaGraph Enterprise Edition requires the user to deploy a license file before starting the Enterprise Edition. This topic describes how to deploy a license file for the Enterprise Edition. !!! enterpriseonly @@ -8,7 +8,7 @@ Nebula Graph Enterprise Edition requires the user to deploy a license file befor ## Precautions -- If the license file is not deployed, Nebula Graph Enterprise Edition cannot be started. +- If the license file is not deployed, NebulaGraph Enterprise Edition cannot be started. - Do not modify the license file, otherwise the license will become invalid. @@ -52,15 +52,15 @@ The license file contains information such as `issuedDate` and `expirationDate`. |`organization`|The username.| |`issuedDate`|The date that the license is issued. | |`expirationDate`|The date that the license expires.| -|`product`|The product type. The product type of Nebula Graph is `nebula_graph`.| +|`product`|The product type. The product type of NebulaGraph is `nebula_graph`.| |`version`|The version information.| |`licenseType`|The license type, including `enterprise`, `samll_bussiness`, `pro`, and `individual`. | ## Steps -1. Send email to `inquiry@vesoft.com` to apply for the Nebula Graph Enterprise Edition package. +1. Send email to `inquiry@vesoft.com` to apply for the NebulaGraph Enterprise Edition package. -2. Install Nebula Graph Enterprise Edition. The installation method is the same as the Community Edition. See [Install Nebula Graph with RPM or DEB package](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md). +2. Install NebulaGraph Enterprise Edition. The installation method is the same as the Community Edition. See [Install NebulaGraph with RPM or DEB package](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md). 3. Send email to `inquiry@vesoft.com` to apply for the license file `nebula.license`. diff --git a/docs-2.0/4.deployment-and-installation/manage-service.md b/docs-2.0/4.deployment-and-installation/manage-service.md index 0c1ddb05b1d..14790911fc8 100644 --- a/docs-2.0/4.deployment-and-installation/manage-service.md +++ b/docs-2.0/4.deployment-and-installation/manage-service.md @@ -1,4 +1,4 @@ -# Manage Nebula Graph Service +# Manage NebulaGraph Service {% include "/source_manage-service.md" %} diff --git a/docs-2.0/4.deployment-and-installation/manage-storage-host.md b/docs-2.0/4.deployment-and-installation/manage-storage-host.md index a7f8ae65f61..7438c0e805c 100644 --- a/docs-2.0/4.deployment-and-installation/manage-storage-host.md +++ b/docs-2.0/4.deployment-and-installation/manage-storage-host.md @@ -1,10 +1,10 @@ # Manage Storage hosts -Starting from Nebula Graph 3.0.0, setting Storage hosts in the configuration files only registers the hosts on the Meta side, but does not add them into the cluster. You must run the `ADD HOSTS` statement to add the Storage hosts. +Starting from NebulaGraph 3.0.0, setting Storage hosts in the configuration files only registers the hosts on the Meta side, but does not add them into the cluster. You must run the `ADD HOSTS` statement to add the Storage hosts. ## Add Storage hosts -Add the Storage hosts to a Nebula Graph cluster. +Add the Storage hosts to a NebulaGraph cluster. ```ngql ADD HOSTS : [,: ...]; diff --git a/docs-2.0/4.deployment-and-installation/standalone-deployment.md b/docs-2.0/4.deployment-and-installation/standalone-deployment.md index 50b2e646515..94f225bf1a6 100644 --- a/docs-2.0/4.deployment-and-installation/standalone-deployment.md +++ b/docs-2.0/4.deployment-and-installation/standalone-deployment.md @@ -1,10 +1,10 @@ -# Standalone Nebula Graph +# Standalone NebulaGraph -Standalone Nebula Graph merges the Meta, Storage, and Graph services into a single process deployed on a single machine. This topic introduces scenarios, deployment steps, etc. of standalone Nebula Graph. +Standalone NebulaGraph merges the Meta, Storage, and Graph services into a single process deployed on a single machine. This topic introduces scenarios, deployment steps, etc. of standalone NebulaGraph. ## Background -The traditional Nebula Graph consists of three services, each service having executable binary files and the corresponding process. Processes communicate with each other by RPC. In standalone Nebula Graph, the three processes corresponding to the three services are combined into one process. For more information about Nebula Graph, see [Architecture overview](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md). +The traditional NebulaGraph consists of three services, each service having executable binary files and the corresponding process. Processes communicate with each other by RPC. In standalone NebulaGraph, the three processes corresponding to the three services are combined into one process. For more information about NebulaGraph, see [Architecture overview](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md). ## Scenarios @@ -12,7 +12,7 @@ Small data sizes and low availability requirements. For example, test environmen !!! danger - Do not use standalone Nebula Graph in production environments. + Do not use standalone NebulaGraph in production environments. ## Limitations @@ -21,25 +21,25 @@ Small data sizes and low availability requirements. For example, test environmen ## Resource requirements -For information about the resource requirements for standalone Nebula Graph, see [Software requirements for compiling Nebula Graph](1.resource-preparations.md). +For information about the resource requirements for standalone NebulaGraph, see [Software requirements for compiling NebulaGraph](1.resource-preparations.md). ## Steps -Currently, you can only install standalone Nebula Graph with the source code. The steps are similar to those of the multi-process Nebula Graph. You only need to modify the step **Generate Makefile with CMake** by adding `-DENABLE_STANDALONE_VERSION=on` to the command. For example: +Currently, you can only install standalone NebulaGraph with the source code. The steps are similar to those of the multi-process NebulaGraph. You only need to modify the step **Generate Makefile with CMake** by adding `-DENABLE_STANDALONE_VERSION=on` to the command. For example: ```bash cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nebula -DENABLE_TESTING=OFF -DENABLE_STANDALONE_VERSION=on -DCMAKE_BUILD_TYPE=Release .. ``` -For more information about installation details, see [Install Nebula Graph by compiling the source code](2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md). +For more information about installation details, see [Install NebulaGraph by compiling the source code](2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md). -After installing standalone Nebula Graph, see the topic [connect to Service](connect-to-nebula-graph.md) to connect to Nebula Graph databases. +After installing standalone NebulaGraph, see the topic [connect to Service](connect-to-nebula-graph.md) to connect to NebulaGraph databases. ## Configuration file -The path to the configuration file for standalone Nebula Graph is `/usr/local/nebula/etc` by default. +The path to the configuration file for standalone NebulaGraph is `/usr/local/nebula/etc` by default. -You can run `sudo cat nebula-standalone.conf.default` to see the file content. The parameters and the corresponding descriptions in the file are generally the same as the configurations for multi-process Nebula Graph except for the following parameters. +You can run `sudo cat nebula-standalone.conf.default` to see the file content. The parameters and the corresponding descriptions in the file are generally the same as the configurations for multi-process NebulaGraph except for the following parameters. | Parameter | Predefined value | Description | | ---------------- | ----------- | --------------------- | diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/.1.get-configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/.1.get-configurations.md index e228aa7b2af..f49843221fd 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/.1.get-configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/.1.get-configurations.md @@ -1,6 +1,6 @@ # Get configurations -This document gives some methods to get configurations in Nebula Graph. +This document gives some methods to get configurations in NebulaGraph. !!! note @@ -8,19 +8,19 @@ This document gives some methods to get configurations in Nebula Graph. ## Get configurations from local -Add `--local_config=true` to the top of each configuration file (the default path is `/usr/local/nebula/etc/`). Restart all the Nebula Graph services to make your modifications take effect. We suggest that new users use this method. +Add `--local_config=true` to the top of each configuration file (the default path is `/usr/local/nebula/etc/`). Restart all the NebulaGraph services to make your modifications take effect. We suggest that new users use this method. ## Get configuration from Meta Service To get configuration from Meta Service, set the `--local_config` parameter to `false` or use the default configuration files. -When the services are started for the first time, Nebula Graph reads the configurations from local and then persists them in the Meta Service. Once the Meta Service is persisted, Nebula Graph reads configurations only from the Meta Service, even you restart Nebula Graph. +When the services are started for the first time, NebulaGraph reads the configurations from local and then persists them in the Meta Service. Once the Meta Service is persisted, NebulaGraph reads configurations only from the Meta Service, even you restart NebulaGraph. ## FAQ ## How to modify configurations -You can modify Nebula Graph configurations by using these methods: +You can modify NebulaGraph configurations by using these methods: - Modify configurations by using `UPDATE CONFIG`. For more information see UPDATE CONFIG (doc TODO). - Modify configurations by configuring the configuration files. For more information, see [Get configuration from local](#get_configuration_from_local). diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md index 12fc0353f5c..08d84301a0f 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md @@ -1,10 +1,10 @@ # Configurations -Nebula Graph builds the configurations based on the [gflags](https://gflags.github.io/gflags/) repository. Most configurations are flags. When the Nebula Graph service starts, it will get the configuration information from [Configuration files](#configuration_files) by default. Configurations that are not in the file apply the default values. +NebulaGraph builds the configurations based on the [gflags](https://gflags.github.io/gflags/) repository. Most configurations are flags. When the NebulaGraph service starts, it will get the configuration information from [Configuration files](#configuration_files) by default. Configurations that are not in the file apply the default values. !!! note - * Because there are many configurations and they may change as Nebula Graph develops, this topic will not introduce all configurations. To get detailed descriptions of configurations, follow the instructions below. + * Because there are many configurations and they may change as NebulaGraph develops, this topic will not introduce all configurations. To get detailed descriptions of configurations, follow the instructions below. * It is not recommended to modify the configurations that are not introduced in this topic, unless you are familiar with the source code and fully understand the function of configurations. !!! compatibility "Legacy version compatibility" @@ -32,7 +32,7 @@ $ /usr/local/nebula/bin/nebula-graphd --help $ /usr/local/nebula/bin/nebula-storaged --help ``` -The above examples use the default storage path `/usr/local/nebula/bin/`. If you modify the installation path of Nebula Graph, use the actual path to query the configurations. +The above examples use the default storage path `/usr/local/nebula/bin/`. If you modify the installation path of NebulaGraph, use the actual path to query the configurations. ## Get configurations @@ -40,7 +40,7 @@ Use the `curl` command to get the value of the running configurations. !!! compatibility "Legacy version compatibility" - The `curl` commands and parameters in Nebula Graph v2.x. are different from Nebula Graph v1.x. + The `curl` commands and parameters in NebulaGraph v2.x. are different from NebulaGraph v1.x. For example: @@ -63,27 +63,27 @@ curl 127.0.0.1:19779/flags ### Configuration files for clusters installed from source, with an RPM/DEB package, or a TAR package -Nebula Graph provides two initial configuration files for each service, `.conf.default` and `.conf.production`. You can use them in different scenarios conveniently. For clusters installed from source and with a RPM/DEB package, the default path is `/usr/local/nebula/etc/`. For clusters installed with a TAR package, the path is `//etc`. +NebulaGraph provides two initial configuration files for each service, `.conf.default` and `.conf.production`. You can use them in different scenarios conveniently. For clusters installed from source and with a RPM/DEB package, the default path is `/usr/local/nebula/etc/`. For clusters installed with a TAR package, the path is `//etc`. The configuration values in the initial configuration file are for reference only and can be adjusted according to actual needs. To use the initial configuration file, choose one of the above two files and delete the suffix `.default` or `.production` to make it valid. !!! caution - To ensure the availability of services, the configurations of the same service must be consistent, except for the local IP address `local_ip`. For example, three Storage servers are deployed in one Nebula Graph cluster. The configurations of the three Storage servers need to be the same, except for the IP address. + To ensure the availability of services, the configurations of the same service must be consistent, except for the local IP address `local_ip`. For example, three Storage servers are deployed in one NebulaGraph cluster. The configurations of the three Storage servers need to be the same, except for the IP address. The initial configuration files corresponding to each service are as follows. -| Nebula Graph service | Initial configuration file | Description | +| NebulaGraph service | Initial configuration file | Description | | - | - | - | | Meta | `nebula-metad.conf.default` and `nebula-metad.conf.production` | [Meta service configuration](2.meta-config.md) | | Graph | `nebula-graphd.conf.default` and `nebula-graphd.conf.production` | [Graph service configuration](3.graph-config.md) | | Storage | `nebula-storaged.conf.default` and `nebula-storaged.conf.production` | [Storage service configuration](4.storage-config.md) | -Each initial configuration file of all services contains `local_config`. The default value is `true`, which means that the Nebula Graph service will get configurations from its configuration files and start it. +Each initial configuration file of all services contains `local_config`. The default value is `true`, which means that the NebulaGraph service will get configurations from its configuration files and start it. !!! caution - It is not recommended to modify the value of `local_config` to `false`. If modified, the Nebula Graph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. + It is not recommended to modify the value of `local_config` to `false`. If modified, the NebulaGraph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. ### Configuration files for clusters installed with Docker Compose @@ -101,13 +101,13 @@ For clusters installed with Kubectl through Nebula Operator, the configuration f ## Modify configurations -By default, each Nebula Graph service gets configured from its configuration files. You can modify configurations and make them valid according to the following steps: +By default, each NebulaGraph service gets configured from its configuration files. You can modify configurations and make them valid according to the following steps: * For clusters installed from source, with a RPM/DEB, or a TAR package 1. Use a text editor to modify the configuration files of the target service and save the modification. - 2. Choose an appropriate time to restart **all** Nebula Graph services to make the modifications valid. + 2. Choose an appropriate time to restart **all** NebulaGraph services to make the modifications valid. * For clusters installed with Docker Compose @@ -116,9 +116,9 @@ By default, each Nebula Graph service gets configured from its configuration fil * For clusters installed with Kubectl - For details, see [Customize configuration parameters for a Nebula Graph cluster](../../nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md). + For details, see [Customize configuration parameters for a NebulaGraph cluster](../../nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md). 1. Use a text editor to modify the configuration files of the target service and save the modification. -2. Choose an appropriate time to restart **all** Nebula Graph services to make the modifications valid. --> +2. Choose an appropriate time to restart **all** NebulaGraph services to make the modifications valid. --> diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md index dacc78ddc5c..6b2d3e301e0 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -1,10 +1,10 @@ # Meta Service configuration -Nebula Graph provides two initial configuration files for the Meta Service, `nebula-metad.conf.default` and `nebula-metad.conf.production`. Users can use them in different scenarios conveniently. The default file path is `/usr/local/nebula/etc/`. +NebulaGraph provides two initial configuration files for the Meta Service, `nebula-metad.conf.default` and `nebula-metad.conf.production`. Users can use them in different scenarios conveniently. The default file path is `/usr/local/nebula/etc/`. !!! caution - * It is not recommended to modify the value of `local_config` to `false`. If modified, the Nebula Graph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. + * It is not recommended to modify the value of `local_config` to `false`. If modified, the NebulaGraph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. * It is not recommended to modify the configurations that are not introduced in this topic, unless you are familiar with the source code and fully understand the function of configurations. ## How to use the configuration files @@ -13,7 +13,7 @@ To use the initial configuration file, choose one of the above two files and del ## About parameter values -If a parameter is not set in the configuration file, Nebula Graph uses the default value. Not all parameters are predefined. And the predefined parameters in the two initial configuration files are different. This topic uses the parameters in `nebula-metad.conf.default`. +If a parameter is not set in the configuration file, NebulaGraph uses the default value. Not all parameters are predefined. And the predefined parameters in the two initial configuration files are different. This topic uses the parameters in `nebula-metad.conf.default`. For all parameters and their current values, see [Configurations](1.configurations.md). @@ -23,20 +23,20 @@ For all parameters and their current values, see [Configurations](1.configuratio | ----------- | ----------------------- | ---------------------------------------------------- | | `daemonize` | `true` | When set to `true`, the process is a daemon process. | | `pid_file` | `pids/nebula-metad.pid` | The file that records the process ID. | -| `timezone_name` | - | Specifies the Nebula Graph time zone. This parameter is not predefined in the initial configuration files. You can manually set it if you need it. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example, `--timezone_name=UTC+08:00` represents the GMT+8 time zone.| -|`license_path`|`share/resources/nebula.license`| Path of the license of the Nebula Graph Enterprise Edition. Users need to [deploy a license file](../../4.deployment-and-installation/deploy-license.md) before starting the Enterprise Edition. This parameter is required only for the Nebula Graph Enterprise Edition. For details about how to configure licenses for other ecosystem tools, see the deployment documents of the corresponding ecosystem tools.| +| `timezone_name` | - | Specifies the NebulaGraph time zone. This parameter is not predefined in the initial configuration files. You can manually set it if you need it. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example, `--timezone_name=UTC+08:00` represents the GMT+8 time zone.| +|`license_path`|`share/resources/nebula.license`| Path of the license of the NebulaGraph Enterprise Edition. Users need to [deploy a license file](../../4.deployment-and-installation/deploy-license.md) before starting the Enterprise Edition. This parameter is required only for the NebulaGraph Enterprise Edition. For details about how to configure licenses for other ecosystem tools, see the deployment documents of the corresponding ecosystem tools.| !!! note - * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), Nebula Graph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC time. - * `timezone_name` is only used to transform the data stored in Nebula Graph. Other time-related data of the Nebula Graph processes still uses the default time zone of the host, such as the log printing time. + * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), NebulaGraph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC time. + * `timezone_name` is only used to transform the data stored in NebulaGraph. Other time-related data of the NebulaGraph processes still uses the default time zone of the host, such as the log printing time. ## Logging configurations | Name | Predefined value | Description | | :------------- | :------------------------ | :------------------------------------------------ | | `log_dir` | `logs` | The directory that stores the Meta Service log. It is recommended to put logs on a different hard disk from the data. | -| `minloglevel` | `0` | Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, Nebula Graph will not print any logs. | +| `minloglevel` | `0` | Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, NebulaGraph will not print any logs. | | `v` | `0` | Specifies the detailed level of the log. The larger the value, the more detailed the log is. Optional values are `0`, `1`, `2`, `3`. | | `logbufsecs` | `0` | Specifies the maximum time to buffer the logs. If there is a timeout, it will output the buffered log to the log file. `0` means real-time output. This configuration is measured in seconds. | |`redirect_stdout` |`true` | When set to `true`, the process redirects the`stdout` and `stderr` to separate output files. | @@ -56,7 +56,7 @@ For all parameters and their current values, see [Configurations](1.configuratio | `ws_http_port` | `19559` | Specifies the port for the HTTP service. | | `ws_h2_port` | `19560` | Specifies the port for the HTTP2 service. | |`ws_storage_http_port`|`19779`| Specifies the Storage service listening port used by the HTTP protocol. It must be consistent with the `ws_http_port` in the Storage service configuration file.| -|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise Nebula Graph **CANNOT** work normally. This configuration is measured in seconds. | +|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise NebulaGraph **CANNOT** work normally. This configuration is measured in seconds. | !!! caution diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md index ccd7e2cfab5..d5c1c0f4195 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -1,10 +1,10 @@ # Graph Service configuration -Nebula Graph provides two initial configuration files for the Graph Service, `nebula-graphd.conf.default` and `nebula-graphd.conf.production`. Users can use them in different scenarios conveniently. The default file path is `/usr/local/nebula/etc/`. +NebulaGraph provides two initial configuration files for the Graph Service, `nebula-graphd.conf.default` and `nebula-graphd.conf.production`. Users can use them in different scenarios conveniently. The default file path is `/usr/local/nebula/etc/`. !!! caution - * It is not recommended to modify the value of `local_config` to `false`. If modified, the Nebula Graph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. + * It is not recommended to modify the value of `local_config` to `false`. If modified, the NebulaGraph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. * It is not recommended to modify the configurations that are not introduced in this topic, unless you are familiar with the source code and fully understand the function of configurations. ## How to use the configuration files @@ -13,7 +13,7 @@ To use the initial configuration file, choose one of the above two files and del ## About parameter values -If a parameter is not set in the configuration file, Nebula Graph uses the default value. Not all parameters are predefined. And the predefined parameters in the two initial configuration files are different. This topic uses the parameters in `nebula-metad.conf.default`. +If a parameter is not set in the configuration file, NebulaGraph uses the default value. Not all parameters are predefined. And the predefined parameters in the two initial configuration files are different. This topic uses the parameters in `nebula-metad.conf.default`. For all parameters and their current values, see [Configurations](1.configurations.md). @@ -24,20 +24,20 @@ For all parameters and their current values, see [Configurations](1.configuratio | `daemonize` | `true` | When set to `true`, the process is a daemon process. | | `pid_file` | `pids/nebula-graphd.pid`| The file that records the process ID. | |`enable_optimizer` |`true` | When set to `true`, the optimizer is enabled. | -| `timezone_name` | - | Specifies the Nebula Graph time zone. This parameter is not predefined in the initial configuration files. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example， `--timezone_name=UTC+08:00` represents the GMT+8 time zone. | +| `timezone_name` | - | Specifies the NebulaGraph time zone. This parameter is not predefined in the initial configuration files. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example， `--timezone_name=UTC+08:00` represents the GMT+8 time zone. | | `local_config` | `true` | When set to `true`, the process gets configurations from the configuration files. | !!! note - * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), Nebula Graph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC time. - * `timezone_name` is only used to transform the data stored in Nebula Graph. Other time-related data of the Nebula Graph processes still uses the default time zone of the host, such as the log printing time. + * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), NebulaGraph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC time. + * `timezone_name` is only used to transform the data stored in NebulaGraph. Other time-related data of the NebulaGraph processes still uses the default time zone of the host, such as the log printing time. ## Logging configurations | Name | Predefined value | Description | | ------------- | ------------------------ | ------------------------------------------------ | | `log_dir` | `logs` | The directory that stores the Meta Service log. It is recommended to put logs on a different hard disk from the data. | -| `minloglevel` | `0` | Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, Nebula Graph will not print any logs. | +| `minloglevel` | `0` | Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, NebulaGraph will not print any logs. | | `v` | `0` | Specifies the detailed level of the log. The larger the value, the more detailed the log is. Optional values are `0`, `1`, `2`, `3`. | | `logbufsecs` | `0` | Specifies the maximum time to buffer the logs. If there is a timeout, it will output the buffered log to the log file. `0` means real-time output. This configuration is measured in seconds. | |`redirect_stdout` |`true` | When set to `true`, the process redirects the`stdout` and `stderr` to separate output files. | @@ -72,7 +72,7 @@ For all parameters and their current values, see [Configurations](1.configuratio | `ws_ip` | `0.0.0.0` | Specifies the IP address for the HTTP service. | | `ws_http_port` | `19669` | Specifies the port for the HTTP service. | | `ws_h2_port` | `19670` | Specifies the port for the HTTP2 service. | -|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise Nebula Graph **CANNOT** work normally. This configuration is measured in seconds. | +|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise NebulaGraph **CANNOT** work normally. This configuration is measured in seconds. | |`storage_client_timeout_ms` |-| Specifies the RPC connection timeout threshold between the Graph Service and the Storage Service. This parameter is not predefined in the initial configuration files. You can manually set it if you need it. The system default value is `60000`ms. | |`ws_meta_http_port` |`19559`| Specifies the Meta service listening port used by the HTTP protocol. It must be consistent with the `ws_http_port` in the Meta service configuration file.| @@ -98,13 +98,13 @@ For all parameters and their current values, see [Configurations](1.configuratio | Name | Predefined value | Description | | ------------------- | ------------------------ | ------------------------------------------ | -| `system_memory_high_watermark_ratio` | `0.8` | Specifies the trigger threshold of the high-level memory alarm mechanism. If the system memory usage is higher than this value, an alarm mechanism will be triggered, and Nebula Graph will stop querying. This parameter is not predefined in the initial configuration files. | +| `system_memory_high_watermark_ratio` | `0.8` | Specifies the trigger threshold of the high-level memory alarm mechanism. If the system memory usage is higher than this value, an alarm mechanism will be triggered, and NebulaGraph will stop querying. This parameter is not predefined in the initial configuration files. | ## Metrics configurations | Name | Predefined value | Description | | - | - | - | -| `enable_space_level_metrics` | `false` | Enable or disable space-level metrics. Such metric names contain the name of the graph space that it monitors, for example, `query_latency_us{space=basketballplayer}.avg.3600`. You can view the supported metrics with the `curl` command. For more information, see [Query Nebula Graph metrics](../../6.monitor-and-metrics/1.query-performance-metrics.md). | +| `enable_space_level_metrics` | `false` | Enable or disable space-level metrics. Such metric names contain the name of the graph space that it monitors, for example, `query_latency_us{space=basketballplayer}.avg.3600`. You can view the supported metrics with the `curl` command. For more information, see [Query NebulaGraph metrics](../../6.monitor-and-metrics/1.query-performance-metrics.md). | ## Experimental configurations diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md index 6ff73e5c8c8..4cc6ea62c18 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -1,10 +1,10 @@ # Storage Service configurations -Nebula Graph provides two initial configuration files for the Storage Service, `nebula-storaged.conf.default` and `nebula-storaged.conf.production`. Users can use them in different scenarios conveniently. The default file path is `/usr/local/nebula/etc/`. +NebulaGraph provides two initial configuration files for the Storage Service, `nebula-storaged.conf.default` and `nebula-storaged.conf.production`. Users can use them in different scenarios conveniently. The default file path is `/usr/local/nebula/etc/`. !!! caution - * It is not recommended to modify the value of `local_config` to `false`. If modified, the Nebula Graph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. + * It is not recommended to modify the value of `local_config` to `false`. If modified, the NebulaGraph service will first read the cached configurations, which may cause configuration inconsistencies between clusters and cause unknown risks. * It is not recommended to modify the configurations that are not introduced in this topic, unless you are familiar with the source code and fully understand the function of configurations. ## How to use the configuration files @@ -13,7 +13,7 @@ To use the initial configuration file, choose one of the above two files and del ## About parameter values -If a parameter is not set in the configuration file, Nebula Graph uses the default value. Not all parameters are predefined. And the predefined parameters in the two initial configuration files are different. This topic uses the parameters in `nebula-metad.conf.default`. For parameters that are not included in `nebula-metad.conf.default`, see `nebula-storaged.conf.production`. +If a parameter is not set in the configuration file, NebulaGraph uses the default value. Not all parameters are predefined. And the predefined parameters in the two initial configuration files are different. This topic uses the parameters in `nebula-metad.conf.default`. For parameters that are not included in `nebula-metad.conf.default`, see `nebula-storaged.conf.production`. !!! Note @@ -27,20 +27,20 @@ For all parameters and their current values, see [Configurations](1.configuratio | :----------- | :----------------------- | :------------------| | `daemonize` | `true` | When set to `true`, the process is a daemon process. | | `pid_file` | `pids/nebula-storaged.pid` | The file that records the process ID. | -| `timezone_name` | - | Specifies the Nebula Graph time zone. This parameter is not predefined in the initial configuration files. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example, `--timezone_name=UTC+08:00` represents the GMT+8 time zone. | +| `timezone_name` | - | Specifies the NebulaGraph time zone. This parameter is not predefined in the initial configuration files. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example, `--timezone_name=UTC+08:00` represents the GMT+8 time zone. | | `local_config` | `true` | When set to `true`, the process gets configurations from the configuration files. | !!! note - * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), Nebula Graph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC. - * `timezone_name` is only used to transform the data stored in Nebula Graph. Other time-related data of the Nebula Graph processes still uses the default time zone of the host, such as the log printing time. + * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), NebulaGraph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC. + * `timezone_name` is only used to transform the data stored in NebulaGraph. Other time-related data of the NebulaGraph processes still uses the default time zone of the host, such as the log printing time. ## Logging configurations | Name | Predefined value | Description | | :------------- | :------------------------ | :------------------------------------------------ | | `log_dir` | `logs` | The directory that stores the Meta Service log. It is recommended to put logs on a different hard disk from the data. | -| `minloglevel` | `0` | Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, Nebula Graph will not print any logs. | +| `minloglevel` | `0` | Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, NebulaGraph will not print any logs. | | `v` | `0` | Specifies the detailed level of the log. The larger the value, the more detailed the log is. Optional values are `0`, `1`, `2`, `3`. | | `logbufsecs` | `0` | Specifies the maximum time to buffer the logs. If there is a timeout, it will output the buffered log to the log file. `0` means real-time output. This configuration is measured in seconds. | |`redirect_stdout` | `true` | When set to `true`, the process redirects the`stdout` and `stderr` to separate output files. | @@ -59,7 +59,7 @@ For all parameters and their current values, see [Configurations](1.configuratio | `ws_ip` | `0.0.0.0` | Specifies the IP address for the HTTP service. | | `ws_http_port` | `19779` | Specifies the port for the HTTP service. | | `ws_h2_port` | `19780` | Specifies the port for the HTTP2 service. | -|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise Nebula Graph **CANNOT** work normally. This configuration is measured in seconds. | +|`heartbeat_interval_secs` | `10` | Specifies the default heartbeat interval. Make sure the `heartbeat_interval_secs` values for all services are the same, otherwise NebulaGraph **CANNOT** work normally. This configuration is measured in seconds. | !!! caution @@ -104,7 +104,7 @@ For all parameters and their current values, see [Configurations](1.configuratio !!! caution - The configuration `snapshot` in the following table is different from the snapshot in Nebula Graph. The `snapshot` here refers to the stock data on the leader when synchronizing Raft. + The configuration `snapshot` in the following table is different from the snapshot in NebulaGraph. The `snapshot` here refers to the stock data on the leader when synchronizing Raft. | Name | Predefined value | Description | | :-- | :----- | :--- | @@ -176,7 +176,7 @@ When the query starting from each vertex gets an edge, truncate it directly to a !!! compatibility - The reservoir sampling algorithm in Nebula Graph 1.x is no longer supported in Nebula Graph {{ nebula.release }}. + The reservoir sampling algorithm in NebulaGraph 1.x is no longer supported in NebulaGraph {{ nebula.release }}. ## Storage configurations for large dataset diff --git a/docs-2.0/5.configurations-and-logs/2.log-management/logs.md b/docs-2.0/5.configurations-and-logs/2.log-management/logs.md index 6f4af891549..d9864257873 100644 --- a/docs-2.0/5.configurations-and-logs/2.log-management/logs.md +++ b/docs-2.0/5.configurations-and-logs/2.log-management/logs.md @@ -1,16 +1,16 @@ # Logs -**Nebula Graph** uses [glog](https://github.com/google/glog) to print logs, uses [gflags](https://gflags.github.io/gflags/) to control the severity level of the log, and provides an HTTP interface to dynamically change the log level at runtime to facilitate tracking. +**NebulaGraph** uses [glog](https://github.com/google/glog) to print logs, uses [gflags](https://gflags.github.io/gflags/) to control the severity level of the log, and provides an HTTP interface to dynamically change the log level at runtime to facilitate tracking. ## Log directory The default log directory is `/usr/local/nebula/logs/`. -If the log directory is deleted while Nebula Graph is running, the log would not continue to be printed. However, this operation will not affect the services. To recover the logs, restart the services. +If the log directory is deleted while NebulaGraph is running, the log would not continue to be printed. However, this operation will not affect the services. To recover the logs, restart the services. ## Parameter descriptions -- `minloglevel`: Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, Nebula Graph will not print any logs. +- `minloglevel`: Specifies the minimum level of the log. That is, no logs below this level will be printed. Optional values are `0` (INFO), `1` (WARNING), `2` (ERROR), `3` (FATAL). It is recommended to set it to `0` during debugging and `1` in a production environment. If it is set to `4`, NebulaGraph will not print any logs. - `v`: Specifies the detailed level of the log. The larger the value, the more detailed the log is. Optional values are `0`, `1`, `2`, `3`. @@ -67,7 +67,7 @@ $ curl -X PUT -H "Content-Type: application/json" -d '{"minloglevel":0,"v":3}' " ``` -If the log level is changed while Nebula Graph is running, it will be restored to the level set in the configuration file after restarting the service. To permanently modify it, see [Configuration files](../1.configurations/1.configurations.md). +If the log level is changed while NebulaGraph is running, it will be restored to the level set in the configuration file after restarting the service. To permanently modify it, see [Configuration files](../1.configurations/1.configurations.md). ## RocksDB logs diff --git a/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md b/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md index 154a944fb99..3e4150609dc 100644 --- a/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md +++ b/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md @@ -1,10 +1,10 @@ -# Query Nebula Graph metrics +# Query NebulaGraph metrics -Nebula Graph supports querying the monitoring metrics through HTTP ports. +NebulaGraph supports querying the monitoring metrics through HTTP ports. ## Metrics structure -Each metric of Nebula Graph consists of three fields: name, type, and time range. The fields are separated by periods, for example, `num_queries.sum.600`. Different Nebula Graph services (Graph, Storage, or Meta) support different metrics. The detailed description is as follows. +Each metric of NebulaGraph consists of three fields: name, type, and time range. The fields are separated by periods, for example, `num_queries.sum.600`. Different NebulaGraph services (Graph, Storage, or Meta) support different metrics. The detailed description is as follows. |Field|Example|Description| |-|-|-| @@ -16,7 +16,7 @@ Each metric of Nebula Graph consists of three fields: name, type, and time range The Graph service supports a set of space-level metrics that record the information of different graph spaces separately. -To enable space-level metrics, set the value of `enable_space_level_metrics` to `true` in the Graph service configuration file before starting Nebula Graph. For details about how to modify the configuration, see [Configuration Management](../5.configurations-and-logs/1.configurations/1.configurations.md). +To enable space-level metrics, set the value of `enable_space_level_metrics` to `true` in the Graph service configuration file before starting NebulaGraph. For details about how to modify the configuration, see [Configuration Management](../5.configurations-and-logs/1.configurations/1.configurations.md). !!! note @@ -39,7 +39,7 @@ curl -G "http://:/stats?stats= [&format=json]" !!! note - If Nebula Graph is deployed with [Docker Compose](..//4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md), run `docker-compose ps` to check the ports that are mapped from the service ports inside of the container and then query through them. + If NebulaGraph is deployed with [Docker Compose](..//4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md), run `docker-compose ps` to check the ports that are mapped from the service ports inside of the container and then query through them. ### Examples @@ -77,7 +77,7 @@ curl -G "http://:/stats?stats= [&format=json]" * Query all metrics in a service. - If no metric is specified in the query, Nebula Graph returns all metrics in the service. + If no metric is specified in the query, NebulaGraph returns all metrics in the service. ```bash $ curl -G "http://192.168.8.40:19559/stats" diff --git a/docs-2.0/6.monitor-and-metrics/2.rocksdb-statistics.md b/docs-2.0/6.monitor-and-metrics/2.rocksdb-statistics.md index ca542422aa4..ab6a356fb8e 100644 --- a/docs-2.0/6.monitor-and-metrics/2.rocksdb-statistics.md +++ b/docs-2.0/6.monitor-and-metrics/2.rocksdb-statistics.md @@ -1,6 +1,6 @@ # RocksDB statistics -Nebula Graph uses RocksDB as the underlying storage. This topic describes how to collect and show the RocksDB statistics of Nebula Graph. +NebulaGraph uses RocksDB as the underlying storage. This topic describes how to collect and show the RocksDB statistics of NebulaGraph. ## Enable RocksDB diff --git a/docs-2.0/7.data-security/1.authentication/1.authentication.md b/docs-2.0/7.data-security/1.authentication/1.authentication.md index 4068a46c5c7..59484e9a9e5 100644 --- a/docs-2.0/7.data-security/1.authentication/1.authentication.md +++ b/docs-2.0/7.data-security/1.authentication/1.authentication.md @@ -1,18 +1,18 @@ # Authentication -Nebula Graph replies on local authentication or LDAP authentication to implement access control. +NebulaGraph replies on local authentication or LDAP authentication to implement access control. -Nebula Graph creates a session when a client connects to it. The session stores information about the connection, including the user information. If the authentication system is enabled, the session will be mapped to corresponding users. +NebulaGraph creates a session when a client connects to it. The session stores information about the connection, including the user information. If the authentication system is enabled, the session will be mapped to corresponding users. !!! Note - By default, the authentication is disabled and Nebula Graph allows connections with the username `root` and any password. + By default, the authentication is disabled and NebulaGraph allows connections with the username `root` and any password. -Nebula Graph supports local authentication and LDAP authentication. +NebulaGraph supports local authentication and LDAP authentication. ## Local authentication -Local authentication indicates that usernames and passwords are stored locally on the server, with the passwords encrypted. Users will be authenticated when trying to visit Nebula Graph. +Local authentication indicates that usernames and passwords are stored locally on the server, with the passwords encrypted. Users will be authenticated when trying to visit NebulaGraph. ### Enable local authentication @@ -24,15 +24,15 @@ Local authentication indicates that usernames and passwords are stored locally o - `--password_lock_time_in_secs`: This parameter is optional, and you need to add this parameter manually. Specify the time how long your account is locked after multiple incorrect password entries are entered. Unit: second. -2. Restart the Nebula Graph services. For how to restart, see [Manage Nebula Graph services](../../2.quick-start/5.start-stop-service.md). +2. Restart the NebulaGraph services. For how to restart, see [Manage NebulaGraph services](../../2.quick-start/5.start-stop-service.md). !!! note - You can use the username `root` and password `nebula` to log into Nebula Graph after enabling local authentication. This account has the build-in God role. For more information about roles, see [Roles and privileges](3.role-list.md). + You can use the username `root` and password `nebula` to log into NebulaGraph after enabling local authentication. This account has the build-in God role. For more information about roles, see [Roles and privileges](3.role-list.md). ## LDAP authentication -Lightweight Directory Access Protocol (LDAP) is a lightweight client-server protocol for accessing directories and building a centralized account management system. LDAP authentication and local authentication can be enabled at the same time, but LDAP authentication has a higher priority. If the local authentication server and the LDAP server both have the information of user `Amber`, Nebula Graph reads from the LDAP server first. +Lightweight Directory Access Protocol (LDAP) is a lightweight client-server protocol for accessing directories and building a centralized account management system. LDAP authentication and local authentication can be enabled at the same time, but LDAP authentication has a higher priority. If the local authentication server and the LDAP server both have the information of user `Amber`, NebulaGraph reads from the LDAP server first. ### Enable LDAP authentication diff --git a/docs-2.0/7.data-security/1.authentication/2.management-user.md b/docs-2.0/7.data-security/1.authentication/2.management-user.md index a5bd1e8b72d..e59d5d8aa6e 100644 --- a/docs-2.0/7.data-security/1.authentication/2.management-user.md +++ b/docs-2.0/7.data-security/1.authentication/2.management-user.md @@ -1,12 +1,12 @@ # User management -User management is an indispensable part of Nebula Graph access control. This topic describes how to manage users and roles. +User management is an indispensable part of NebulaGraph access control. This topic describes how to manage users and roles. -After [enabling authentication](1.authentication.md), only valid users can connect to Nebula Graph and access the resources according to the [user roles](3.role-list.md). +After [enabling authentication](1.authentication.md), only valid users can connect to NebulaGraph and access the resources according to the [user roles](3.role-list.md). !!! Note - * By default, the authentication is disabled. Nebula Graph allows connections with the username `root` and any password. + * By default, the authentication is disabled. NebulaGraph allows connections with the username `root` and any password. * Once the role of a user is modified, the user has to re-login to make the new role takes effect. @@ -28,7 +28,7 @@ The `root` user with the **GOD** role can run `CREATE USER` to create a new user ## GRANT ROLE -Users with the **GOD** role or the **ADMIN** role can run `GRANT ROLE` to assign a built-in role in a graph space to a user. For more information about Nebula Graph built-in roles, see [Roles and privileges](3.role-list.md). +Users with the **GOD** role or the **ADMIN** role can run `GRANT ROLE` to assign a built-in role in a graph space to a user. For more information about NebulaGraph built-in roles, see [Roles and privileges](3.role-list.md). * Syntax @@ -44,7 +44,7 @@ Users with the **GOD** role or the **ADMIN** role can run `GRANT ROLE` to assign ## REVOKE ROLE -Users with the **GOD** role or the **ADMIN** role can run `REVOKE ROLE` to revoke the built-in role of a user in a graph space. For more information about Nebula Graph built-in roles, see [Roles and privileges](3.role-list.md). +Users with the **GOD** role or the **ADMIN** role can run `REVOKE ROLE` to revoke the built-in role of a user in a graph space. For more information about NebulaGraph built-in roles, see [Roles and privileges](3.role-list.md). * Syntax diff --git a/docs-2.0/7.data-security/1.authentication/3.role-list.md b/docs-2.0/7.data-security/1.authentication/3.role-list.md index 2c6910ab678..4b8699f3457 100644 --- a/docs-2.0/7.data-security/1.authentication/3.role-list.md +++ b/docs-2.0/7.data-security/1.authentication/3.role-list.md @@ -4,7 +4,7 @@ A role is a collection of privileges. You can assign a role to a [user](2.manage ## Built-in roles -Nebula Graph does not support custom roles, but it has multiple built-in roles: +NebulaGraph does not support custom roles, but it has multiple built-in roles: * GOD @@ -47,7 +47,7 @@ Nebula Graph does not support custom roles, but it has multiple built-in roles: !!! note - * Nebula Graph does not support custom roles. Users can only use the default built-in roles. + * NebulaGraph does not support custom roles. Users can only use the default built-in roles. * A user can have only one role in a graph space. For authenticated users, see [User management](2.management-user.md). ## Role privileges and allowed nGQL diff --git a/docs-2.0/7.data-security/1.authentication/4.ldap.md b/docs-2.0/7.data-security/1.authentication/4.ldap.md index b6db17ef9ef..ac3f6cd5edd 100644 --- a/docs-2.0/7.data-security/1.authentication/4.ldap.md +++ b/docs-2.0/7.data-security/1.authentication/4.ldap.md @@ -1,6 +1,6 @@ # OpenLDAP authentication -This topic introduces how to connect Nebula Graph to the OpenLDAP server and use the DN (Distinguished Name) and password defined in OpenLDAP for authentication. +This topic introduces how to connect NebulaGraph to the OpenLDAP server and use the DN (Distinguished Name) and password defined in OpenLDAP for authentication. !!! enterpriseonly @@ -8,7 +8,7 @@ This topic introduces how to connect Nebula Graph to the OpenLDAP server and use ## Authentication method -After the OpenLDAP authentication is enabled and users log into Nebula Graph with the account and password, Nebula Graph checks whether the login account exists in the Meta service. If the account exists, Nebula Graph finds the corresponding DN in OpenLDAP according to the authentication method and verifies the password. +After the OpenLDAP authentication is enabled and users log into NebulaGraph with the account and password, NebulaGraph checks whether the login account exists in the Meta service. If the account exists, NebulaGraph finds the corresponding DN in OpenLDAP according to the authentication method and verifies the password. OpenLDAP supports two authentication methods: simple bind authentication (SimpleBindAuth) and search bind authentication (SearchBindAuth). @@ -32,7 +32,7 @@ Search bind authentication reads the Graph service configuration information and Take the existing account `test2` and password `passwdtest2` on OpenLDAP as an example. -1. [Connect to Nebula Graph](../../4.deployment-and-installation/connect-to-nebula-graph.md), create and authorize the shadow account `test2` corresponding to OpenLDAP. +1. [Connect to NebulaGraph](../../4.deployment-and-installation/connect-to-nebula-graph.md), create and authorize the shadow account `test2` corresponding to OpenLDAP. ```ngql nebula> CREATE USER test2 WITH PASSWORD ''; @@ -41,7 +41,7 @@ Take the existing account `test2` and password `passwdtest2` on OpenLDAP as an e !!! note - When creating an account in Nebula Graph, the password can be set arbitrarily. + When creating an account in NebulaGraph, the password can be set arbitrarily. 2. Edit the configuration file `nebula-graphd.conf` (The default path is`/usr/local/nebula/etc/`): @@ -85,7 +85,7 @@ Take the existing account `test2` and password `passwdtest2` on OpenLDAP as an e --ldap_basedn=ou=it,dc=sys,dc=com ``` -3. [Restart Nebula Graph services](../../4.deployment-and-installation/manage-service.md) to make the new configuration valid. +3. [Restart NebulaGraph services](../../4.deployment-and-installation/manage-service.md) to make the new configuration valid. 4. Run the login test. @@ -93,7 +93,7 @@ Take the existing account `test2` and password `passwdtest2` on OpenLDAP as an e $ ./nebula-console --addr 127.0.0.1 --port 9669 -u test2 -p passwdtest2 2021/09/08 03:49:39 [INFO] connection pool is initialized successfully - Welcome to Nebula Graph! + Welcome to NebulaGraph! ``` !!! note diff --git a/docs-2.0/7.data-security/3.manage-snapshot.md b/docs-2.0/7.data-security/3.manage-snapshot.md index cb094c4517c..ddf27b4996c 100644 --- a/docs-2.0/7.data-security/3.manage-snapshot.md +++ b/docs-2.0/7.data-security/3.manage-snapshot.md @@ -1,10 +1,10 @@ # Backup and restore data with snapshots -Nebula Graph supports using snapshots to back up and restore data. When data loss or misoperation occurs, the data will be restored through the snapshot. +NebulaGraph supports using snapshots to back up and restore data. When data loss or misoperation occurs, the data will be restored through the snapshot. ## Prerequisites -Nebula Graph [authentication](1.authentication/1.authentication.md) is disabled by default. In this case, all users can use the snapshot feature. +NebulaGraph [authentication](1.authentication/1.authentication.md) is disabled by default. In this case, all users can use the snapshot feature. If authentication is enabled, only the GOD role user can use the snapshot feature. For more information about roles, see [Roles and privileges](1.authentication/3.role-list.md). @@ -12,13 +12,13 @@ If authentication is enabled, only the GOD role user can use the snapshot featur * To prevent data loss, create a snapshot as soon as the system structure changes, for example, after operations such as `ADD HOST`, `DROP HOST`, `CREATE SPACE`, `DROP SPACE`, and `BALANCE` are performed. -* Nebula Graph cannot automatically delete the invalid files created by a failed snapshot task. You have to manually delete them by using [`DROP SNAPSHOT`](#delete_snapshots). +* NebulaGraph cannot automatically delete the invalid files created by a failed snapshot task. You have to manually delete them by using [`DROP SNAPSHOT`](#delete_snapshots). * Customizing the storage path for snapshots is not supported for now. The default path is `/usr/local/nebula/data`. ## Snapshot form and path -Nebula Graph snapshots are stored in the form of directories with names like `SNAPSHOT_2021_03_09_08_43_12`. The suffix `2021_03_09_08_43_12` is generated automatically based on the creation time (UTC). +NebulaGraph snapshots are stored in the form of directories with names like `SNAPSHOT_2021_03_09_08_43_12`. The suffix `2021_03_09_08_43_12` is generated automatically based on the creation time (UTC). When a snapshot is created, snapshot directories will be automatically created in the `checkpoints` directory on the leader Meta server and each Storage server. @@ -34,7 +34,7 @@ $ find |grep 'SNAPSHOT_2021_03_09_08_43_12' ## Create snapshots -Run `CREATE SNAPSHOT` to create a snapshot for all the graph spaces based on the current time for Nebula Graph. Creating a snapshot for a specific graph space is not supported yet. +Run `CREATE SNAPSHOT` to create a snapshot for all the graph spaces based on the current time for NebulaGraph. Creating a snapshot for a specific graph space is not supported yet. !!! note @@ -111,5 +111,5 @@ Currently, there is no command to restore data with snapshots. You need to manua ## Related documents -Besides snapshots, users can also use Backup&Restore (BR) to backup or restore Nebula Graph data. For more information, see [Backup&Restore](2.backup-restore/1.what-is-br.md). +Besides snapshots, users can also use Backup&Restore (BR) to backup or restore NebulaGraph data. For more information, see [Backup&Restore](2.backup-restore/1.what-is-br.md). --> diff --git a/docs-2.0/7.data-security/4.ssl.md b/docs-2.0/7.data-security/4.ssl.md index a25ec1a758d..3eb764a4da6 100644 --- a/docs-2.0/7.data-security/4.ssl.md +++ b/docs-2.0/7.data-security/4.ssl.md @@ -1,6 +1,6 @@ # SSL encryption -Nebula Graph supports data transmission with SSL encryption between clients, the Graph service, the Meta service, and the Storage service. This topic describes how to enable SSL encryption. +NebulaGraph supports data transmission with SSL encryption between clients, the Graph service, the Meta service, and the Storage service. This topic describes how to enable SSL encryption. ## Precaution @@ -20,7 +20,7 @@ Enabling SSL encryption will slightly affect the performance, such as causing op ## Certificate modes -To use SSL encryption, SSL certificates are required. Nebula Graph supports two certificate modes. +To use SSL encryption, SSL certificates are required. NebulaGraph supports two certificate modes. - Self-signed certificate mode @@ -32,7 +32,7 @@ To use SSL encryption, SSL certificates are required. Nebula Graph supports two ## Encryption policies -Nebula Graph supports three encryption policies. For details, see [Usage explanation](https://github.com/vesoft-inc/nebula/blob/a67d166b284cae1b534bf8d19c936ee38bf12e29/docs/rfcs/0001-ssl-transportation.md#usage-explanation). +NebulaGraph supports three encryption policies. For details, see [Usage explanation](https://github.com/vesoft-inc/nebula/blob/a67d166b284cae1b534bf8d19c936ee38bf12e29/docs/rfcs/0001-ssl-transportation.md#usage-explanation). - Encrypt the data transmission between clients, the Graph service, the Meta service, and the Storage service. diff --git a/docs-2.0/8.service-tuning/2.graph-modeling.md b/docs-2.0/8.service-tuning/2.graph-modeling.md index f7864065ebd..21e3799d6da 100644 --- a/docs-2.0/8.service-tuning/2.graph-modeling.md +++ b/docs-2.0/8.service-tuning/2.graph-modeling.md @@ -1,10 +1,10 @@ # Graph data modeling suggestions -This topic provides general suggestions for modeling data in Nebula Graph. +This topic provides general suggestions for modeling data in NebulaGraph. !!! note - The following suggestions may not apply to some special scenarios. In these cases, find help in the [Nebula Graph community](https://discuss.nebula-graph.io/). + The following suggestions may not apply to some special scenarios. In these cases, find help in the [NebulaGraph community](https://discuss.nebula-graph.io/). ## Model for performance @@ -16,11 +16,11 @@ Usually, various types of queries are validated in test scenarios to assess the ### No predefined bonds between Tags and Edge types -Define the bonds between Tags and Edge types in the application, not Nebula Graph. There are no statements that could get the bonds between Tags and Edge types. +Define the bonds between Tags and Edge types in the application, not NebulaGraph. There are no statements that could get the bonds between Tags and Edge types. ### Tags/Edge types predefine a set of properties -While creating Tags or Edge types, you need to define a set of properties. Properties are part of the Nebula Graph Schema. +While creating Tags or Edge types, you need to define a set of properties. Properties are part of the NebulaGraph Schema. ### Control changes in the business model and the data model @@ -28,7 +28,7 @@ Changes here refer to changes in business models and data models (meta-informati Some graph databases are designed to be Schema-free, so their data modeling, including the modeling of the graph topology and properties, can be very flexible. Properties can be re-modeled to graph topology, and vice versa. Such systems are often specifically optimized for graph topology access. -Nebula Graph {{ nebula.release }} is a strong-Schema (row storage) system, which means that the business model should not change frequently. For example, the property Schema should not change. It is similar to avoiding `ALTER TABLE` in MySQL. +NebulaGraph {{ nebula.release }} is a strong-Schema (row storage) system, which means that the business model should not change frequently. For example, the property Schema should not change. It is similar to avoiding `ALTER TABLE` in MySQL. On the contrary, vertices and their edges can be added or deleted at low costs. Thus, the easy-to-change part of the business model should be transformed to vertices or edges, rather than properties. @@ -36,7 +36,7 @@ For example, in a business model, people have relatively fixed properties such a ### Set temporary properties through self-loop edges -As a strong Schema system, Nebula Graph does not support List-type properties. And using `ALTER TAG` costs too much. If you need to add some temporary properties or List-type properties to a vertex, you can first create an edge type with the required properties, and then insert one or more edges that direct to the vertex itself. The figure is as follows. +As a strong Schema system, NebulaGraph does not support List-type properties. And using `ALTER TAG` costs too much. If you need to add some temporary properties or List-type properties to a vertex, you can first create an edge type with the required properties, and then insert one or more edges that direct to the vertex itself. The figure is as follows. ![loop property](loop-property.png) @@ -71,9 +71,9 @@ Operations on loops are not encapsulated with any syntactic sugars and you can u ### Breadth-first traversal over depth-first traversal -- Nebula Graph has lower performance for depth-first traversal based on the Graph topology, and better performance for breadth-first traversal and obtaining properties. For example, if model A contains properties "name", "age", and "eye color", it is recommended to create a tag `person` and add properties `name`, `age`, and `eye_color` to it. If you create a tag `eye_color` and an edge type `has`, and then create an edge to represent the eye color owned by the person, the traversal performance will not be high. +- NebulaGraph has lower performance for depth-first traversal based on the Graph topology, and better performance for breadth-first traversal and obtaining properties. For example, if model A contains properties "name", "age", and "eye color", it is recommended to create a tag `person` and add properties `name`, `age`, and `eye_color` to it. If you create a tag `eye_color` and an edge type `has`, and then create an edge to represent the eye color owned by the person, the traversal performance will not be high. -- The performance of finding an edge by an edge property is close to that of finding a vertex by a vertex property. For some databases, it is recommended to re-model edge properties as those of the intermediate vertices. For example, model the pattern `(src)-[edge {P1, P2}]->(dst)` as `(src)-[edge1]->(i_node {P1, P2})-[edge2]->(dst)`. With Nebula Graph {{ nebula.release }}, you can use `(src)-[edge {P1, P2}]->(dst)` directly to decrease the depth of the traversal and increase the performance. +- The performance of finding an edge by an edge property is close to that of finding a vertex by a vertex property. For some databases, it is recommended to re-model edge properties as those of the intermediate vertices. For example, model the pattern `(src)-[edge {P1, P2}]->(dst)` as `(src)-[edge1]->(i_node {P1, P2})-[edge2]->(dst)`. With NebulaGraph {{ nebula.release }}, you can use `(src)-[edge {P1, P2}]->(dst)` directly to decrease the depth of the traversal and increase the performance. ### Edge directions @@ -101,13 +101,13 @@ See [VID](../1.introduction/3.vid.md). ### Long texts -Do not use long texts to create edge properties. Edge properties are stored twice and long texts lead to greater write amplification. For how edges properties are stored, see [Storage architecture](../1.introduction/3.nebula-graph-architecture/4.storage-service.md). It is recommended to store long texts in HBase or Elasticsearch and store its address in Nebula Graph. +Do not use long texts to create edge properties. Edge properties are stored twice and long texts lead to greater write amplification. For how edges properties are stored, see [Storage architecture](../1.introduction/3.nebula-graph-architecture/4.storage-service.md). It is recommended to store long texts in HBase or Elasticsearch and store its address in NebulaGraph. ## Dynamic graphs (sequence graphs) are not supported In some scenarios, graphs need to have the time information to describe how the structure of the entire graph changes over time.[^twitter] -The Rank field on Edges in Nebula Graph {{ nebula.release }} can be used to store time in int64, but no field on vertices can do this because if you store the time information as property values, it will be covered by new insertion. Thus Nebula Graph does not support sequence graphs. +The Rank field on Edges in NebulaGraph {{ nebula.release }} can be used to store time in int64, but no field on vertices can do this because if you store the time information as property values, it will be covered by new insertion. Thus NebulaGraph does not support sequence graphs. ![image](sequence.png) diff --git a/docs-2.0/8.service-tuning/3.system-design.md b/docs-2.0/8.service-tuning/3.system-design.md index 65ed519687b..bae122e23d6 100644 --- a/docs-2.0/8.service-tuning/3.system-design.md +++ b/docs-2.0/8.service-tuning/3.system-design.md @@ -2,14 +2,14 @@ ## QPS or low-latency first -- Nebula Graph {{ nebula.release }} is good at handling small requests with high concurrency. In such scenarios, the whole graph is huge, containing maybe trillions of vertices or edges, but the subgraphs accessed by each request are not large (containing millions of vertices or edges), and the latency of a single request is low. The concurrent number of such requests, i.e., the QPS, can be huge. +- NebulaGraph {{ nebula.release }} is good at handling small requests with high concurrency. In such scenarios, the whole graph is huge, containing maybe trillions of vertices or edges, but the subgraphs accessed by each request are not large (containing millions of vertices or edges), and the latency of a single request is low. The concurrent number of such requests, i.e., the QPS, can be huge. - On the other hand, in interactive analysis scenarios, the request concurrency is usually not high, but the subgraphs accessed by each request are large, with thousands of millions of vertices or edges. To lower the latency of big requests in such scenarios, you can split big requests into multiple small requests in the application, and concurrently send them to multiple graphd processes. This can decrease the memory used by each graphd process as well. Besides, you can use [Nebula Algorithm](../nebula-algorithm.md) for such scenarios. ## Data transmission and optimization -- Read/write balance. Nebula Graph fits into OLTP scenarios with balanced read/write, i.e., concurrent write and read. It is not suitable for OLAP scenarios that usually need to write once and read many times. +- Read/write balance. NebulaGraph fits into OLTP scenarios with balanced read/write, i.e., concurrent write and read. It is not suitable for OLAP scenarios that usually need to write once and read many times. - Select different write methods. For large batches of data writing, use SST files. For small batches of data writing, use `INSERT`. - Run `COMPACTION` and `BALANCE` jobs to optimize data format and storage distribution at the right time. -- Nebula Graph {{ nebula.release }} does not support transactions and isolation in the relational database and is closer to NoSQL. +- NebulaGraph {{ nebula.release }} does not support transactions and isolation in the relational database and is closer to NoSQL. ## Query preheating and data preheating diff --git a/docs-2.0/8.service-tuning/4.plan.md b/docs-2.0/8.service-tuning/4.plan.md index 76c9b384c59..530aa7f2486 100644 --- a/docs-2.0/8.service-tuning/4.plan.md +++ b/docs-2.0/8.service-tuning/4.plan.md @@ -1,5 +1,5 @@ # Execution plan -Nebula Graph {{ nebula.release }} applies rule-based execution plans. Users cannot change execution plans, pre-compile queries (and corresponding plan cache), or accelerate queries by specifying indexes. +NebulaGraph {{ nebula.release }} applies rule-based execution plans. Users cannot change execution plans, pre-compile queries (and corresponding plan cache), or accelerate queries by specifying indexes. To view the execution plan and executive summary, see [EXPLAIN and PROFILE](../3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md). diff --git a/docs-2.0/8.service-tuning/compaction.md b/docs-2.0/8.service-tuning/compaction.md index c8c465ca226..b41ca5355d1 100644 --- a/docs-2.0/8.service-tuning/compaction.md +++ b/docs-2.0/8.service-tuning/compaction.md @@ -2,7 +2,7 @@ This topic gives some information about compaction. -In Nebula Graph, `Compaction` is the most important background process and has an important effect on performance. +In NebulaGraph, `Compaction` is the most important background process and has an important effect on performance. `Compaction` reads the data that is written on the hard disk, then re-organizes the data structure and the indexes, and then writes back to the hard disk. The read performance can increase by times after compaction. Thus, to get high read performance, trigger `compaction` (full `compaction`) manually when writing a large amount of data into Nebula Graph. @@ -10,7 +10,7 @@ In Nebula Graph, `Compaction` is the most important background process and has a Note that `compaction` leads to long-time hard disk IO. We suggest that users do compaction during off-peak hours (for example, early morning). -Nebula Graph has two types of `compaction`: automatic `compaction` and full `compaction`. +NebulaGraph has two types of `compaction`: automatic `compaction` and full `compaction`. ## Automatic `compaction` diff --git a/docs-2.0/8.service-tuning/load-balance.md b/docs-2.0/8.service-tuning/load-balance.md index be344df9077..5e760d6e699 100644 --- a/docs-2.0/8.service-tuning/load-balance.md +++ b/docs-2.0/8.service-tuning/load-balance.md @@ -88,7 +88,7 @@ After you add new storage hosts into the zone, no partition is deployed on the n +------------------+------+----------+--------------+-----------------------------------+------------------------+---------+ ``` -If any subtask fails, run [`RECOVER JOB `](../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md) to restart the balancing. If redoing load balancing does not solve the problem, ask for help in the [Nebula Graph community](https://discuss.nebula-graph.io/). +If any subtask fails, run [`RECOVER JOB `](../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md) to restart the balancing. If redoing load balancing does not solve the problem, ask for help in the [NebulaGraph community](https://discuss.nebula-graph.io/). ## Stop data balancing @@ -159,4 +159,4 @@ nebula> SHOW HOSTS; !!! caution - In Nebula Graph {{ nebula.release }}, switching leaders will cause a large number of short-term request errors (Storage Error `E_RPC_FAILURE`). For solutions, see [FAQ](../20.appendix/0.FAQ.md). + In NebulaGraph {{ nebula.release }}, switching leaders will cause a large number of short-term request errors (Storage Error `E_RPC_FAILURE`). For solutions, see [FAQ](../20.appendix/0.FAQ.md). diff --git a/docs-2.0/8.service-tuning/practice.md b/docs-2.0/8.service-tuning/practice.md index b9ec581e785..2523f45bc23 100644 --- a/docs-2.0/8.service-tuning/practice.md +++ b/docs-2.0/8.service-tuning/practice.md @@ -1,6 +1,6 @@ # Best practices -Nebula Graph is used in a variety of industries. This topic presents a few best practices for using Nebula Graph. For more best practices, see [Blog](https://nebula-graph.io/posts/). +NebulaGraph is used in a variety of industries. This topic presents a few best practices for using NebulaGraph. For more best practices, see [Blog](https://nebula-graph.io/posts/). ## Scenarios @@ -12,22 +12,22 @@ Nebula Graph is used in a variety of industries. This topic presents a few best ## Kernel -- [Nebula Graph Source Code Explained: Variable-Length Pattern Matching](https://nebula-graph.io/posts/nebula-graph-source-code-reading-06/) +- [NebulaGraph Source Code Explained: Variable-Length Pattern Matching](https://nebula-graph.io/posts/nebula-graph-source-code-reading-06/) -- [Adding a Test Case for Nebula Graph](https://nebula-graph.io/posts/add-test-case-nebula-graph/) +- [Adding a Test Case for NebulaGraph](https://nebula-graph.io/posts/add-test-case-nebula-graph/) -- [BDD-Based Integration Testing Framework for Nebula Graph: Part Ⅰ](https://nebula-graph.io/posts/bdd-testing-practice/) +- [BDD-Based Integration Testing Framework for NebulaGraph: Part Ⅰ](https://nebula-graph.io/posts/bdd-testing-practice/) -- [BDD-Based Integration Testing Framework for Nebula Graph: Part II](https://nebula-graph.io/posts/bdd-testing-practice-volume-2/) +- [BDD-Based Integration Testing Framework for NebulaGraph: Part II](https://nebula-graph.io/posts/bdd-testing-practice-volume-2/) -- [Understanding Subgraph in Nebula Graph 2.0](https://nebula-graph.io/posts/nebula-graph-subgraph-introduction/) +- [Understanding Subgraph in NebulaGraph 2.0](https://nebula-graph.io/posts/nebula-graph-subgraph-introduction/) -- [Full-Text Indexing in Nebula Graph 2.0](https://nebula-graph.io/posts/how-fulltext-index-works/) +- [Full-Text Indexing in NebulaGraph 2.0](https://nebula-graph.io/posts/how-fulltext-index-works/) ## Ecosystem tool - [Validating Import Performance of Nebula Importer](https://nebula-graph.io/posts/nebula-importer-practice/) -- [Ecosystem Tools: Nebula Graph Dashboard for Monitoring](https://nebula-graph.io/posts/what-is-nebula-dashboard/) +- [Ecosystem Tools: NebulaGraph Dashboard for Monitoring](https://nebula-graph.io/posts/what-is-nebula-dashboard/) - [Visualizing Graph Data with Nebula Explorer](https://nebula-graph.io/posts/what-is-nebula-explorer/) diff --git a/docs-2.0/8.service-tuning/super-node.md b/docs-2.0/8.service-tuning/super-node.md index 0c4619c37a9..b29f36634f1 100644 --- a/docs-2.0/8.service-tuning/super-node.md +++ b/docs-2.0/8.service-tuning/super-node.md @@ -6,7 +6,7 @@ In graph theory, a super vertex, also known as a dense vertex, is a vertex with Super vertices are very common because of the power-law distribution. For example, popular leaders in social networks (Internet celebrities), top stocks in the stock market, Big Four in the banking system, hubs in transportation networks, websites with high clicking rates on the Internet, and best sellers in E-commerce. -In Nebula Graph {{ nebula.release }}, a `vertex` and its `properties` form a `key-value pair`, with its `VID` and other meta information as the `key`. Its `Out-Edge Key-Value` and `In-Edge Key-Value` are stored in [the same partition](../1.introduction/3.nebula-graph-architecture/4.storage-service.md) in the form of LSM-trees in hard disks and caches. +In NebulaGraph {{ nebula.release }}, a `vertex` and its `properties` form a `key-value pair`, with its `VID` and other meta information as the `key`. Its `Out-Edge Key-Value` and `In-Edge Key-Value` are stored in [the same partition](../1.introduction/3.nebula-graph-architecture/4.storage-service.md) in the form of LSM-trees in hard disks and caches. Therefore, `directed traversals from this vertex` and `directed traversals ending at this vertex` both involve either `a large number of sequential IO scans` (ideally, after [Compaction](../8.service-tuning/compaction.md) or a large number of `random IO` (frequent writes to `the vertex` and its `ingoing and outgoing edges`). @@ -14,15 +14,15 @@ As a rule of thumb, a vertex is considered dense when the number of its edges ex !!! Note - In Nebula Graph {{ nebula.release }}, there is not any data structure to store the out/in degree for each vertex. Therefore, there is no direct method to know whether it is a super vertex or not. You can try to use Spark to count the degrees periodically. + In NebulaGraph {{ nebula.release }}, there is not any data structure to store the out/in degree for each vertex. Therefore, there is no direct method to know whether it is a super vertex or not. You can try to use Spark to count the degrees periodically. ### Indexes for duplicate properties In a property graph, there is another class of cases similar to super vertices: **a property has a very high duplication rate**, i.e., many vertices with the same `tag` but different `VIDs` have identical property and property values. -Property indexes in Nebula Graph {{ nebula.release }} are designed to reuse the functionality of RocksDB in the Storage Service, in which case indexes are modeled as `keys with the same prefix`. If the lookup of a property fails to hit the cache, it is processed as a random seek and a sequential prefix scan on the hard disk to find the corresponding VID. After that, the graph is usually traversed from this vertex, so that another random read and sequential scan for the corresponding key-value of this vertex will be triggered. The higher the duplication rate, the larger the scan range. +Property indexes in NebulaGraph {{ nebula.release }} are designed to reuse the functionality of RocksDB in the Storage Service, in which case indexes are modeled as `keys with the same prefix`. If the lookup of a property fails to hit the cache, it is processed as a random seek and a sequential prefix scan on the hard disk to find the corresponding VID. After that, the graph is usually traversed from this vertex, so that another random read and sequential scan for the corresponding key-value of this vertex will be triggered. The higher the duplication rate, the larger the scan range. -For more information about property indexes, see [How indexing works in Nebula Graph](https://nebula-graph.io/posts/how-indexing-works-in-nebula-graph/). +For more information about property indexes, see [How indexing works in NebulaGraph](https://nebula-graph.io/posts/how-indexing-works-in-nebula-graph/). Usually, special design and processing are required when the number of duplicate property values exceeds 10,000. diff --git a/docs-2.0/README.md b/docs-2.0/README.md index c6481cc9b43..fffa78592fa 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -1,4 +1,4 @@ -# Welcome to Nebula Graph {{ nebula.release }} Documentation +# Welcome to NebulaGraph {{ nebula.release }} Documentation !!! danger diff --git a/docs-2.0/nebula-algorithm.md b/docs-2.0/nebula-algorithm.md index 2b25e467330..ecd285e12bd 100644 --- a/docs-2.0/nebula-algorithm.md +++ b/docs-2.0/nebula-algorithm.md @@ -1,12 +1,12 @@ # Nebula Algorithm -[Nebula Algorithm](https://github.com/vesoft-inc/nebula-algorithm) (Algorithm) is a Spark application based on [GraphX](https://spark.apache.org/graphx/). It uses a complete algorithm tool to perform graph computing on the data in the Nebula Graph database by submitting a Spark task. You can also programmatically use the algorithm under the lib repository to perform graph computing on DataFrame. +[Nebula Algorithm](https://github.com/vesoft-inc/nebula-algorithm) (Algorithm) is a Spark application based on [GraphX](https://spark.apache.org/graphx/). It uses a complete algorithm tool to perform graph computing on the data in the NebulaGraph database by submitting a Spark task. You can also programmatically use the algorithm under the lib repository to perform graph computing on DataFrame. ## Version compatibility -The correspondence between the Nebula Algorithm release and the Nebula Graph core release is as follows. +The correspondence between the Nebula Algorithm release and the NebulaGraph core release is as follows. -|Algorithm client|Nebula Graph| +|Algorithm client|NebulaGraph| |:---|:---| |3.0-SNAPSHOT | nightly | |{{algorithm.release}}| {{nebula.release}} | @@ -18,7 +18,7 @@ The correspondence between the Nebula Algorithm release and the Nebula Graph cor Before using the Nebula Algorithm, users need to confirm the following information: -- The Nebula Graph services have been deployed and started. For details, see [Nebula Installation](4.deployment-and-installation/1.resource-preparations.md). +- The NebulaGraph services have been deployed and started. For details, see [Nebula Installation](4.deployment-and-installation/1.resource-preparations.md). - The Spark version is 2.4.x. @@ -34,7 +34,7 @@ Before using the Nebula Algorithm, users need to confirm the following informati - Graph computing outputs vertex datasets, and the algorithm results are stored in DataFrames as the properties of vertices. You can do further operations such as statistics and filtering according to your business requirements. -- When writing the algorithm results into the Nebula Graph, make sure that the Tag in the corresponding graph space has properties corresponding to the algorithm result name. The corresponding properties of each algorithm are as follows. +- When writing the algorithm results into the NebulaGraph, make sure that the Tag in the corresponding graph space has properties corresponding to the algorithm result name. The corresponding properties of each algorithm are as follows. | Algorithm | Properties name |Properties type| |:------------------------:|:-----------------------:|:-----------:| @@ -83,7 +83,7 @@ The graph computing algorithms supported by Nebula Algorithm are as follows. Nebula Algorithm implements the graph calculating as follows: -1. Read the graph data of DataFrame from the Nebula Graph database using the Nebula Spark Connector. +1. Read the graph data of DataFrame from the NebulaGraph database using the Nebula Spark Connector. 2. Transform the graph data of DataFrame to the GraphX graph. @@ -138,7 +138,7 @@ The `lib` repository provides 10 common graph algorithms. 2. Use the algorithm (take PageRank as an example) by filling in parameters. For more examples, see [example](https://github.com/vesoft-inc/nebula-algorithm/tree/master/example/src/main/scala/com/vesoft/nebula/algorithm). !!! note - By default, the DataFrame that executes the algorithm sets the first column as the starting vertex, the second column as the destination vertex, and the third column as the edge weights (not the rank in the Nebula Graph). + By default, the DataFrame that executes the algorithm sets the first column as the starting vertex, the second column as the destination vertex, and the third column as the edge weights (not the rank in the NebulaGraph). ```bash val prConfig = new PRConfig(5, 1.0) @@ -150,7 +150,7 @@ The `lib` repository provides 10 common graph algorithms. ### Submit the algorithm package directly !!! note - There are limitations to use sealed packages. For example, when sinking a repository into Nebula Graph, the property name of the tag created in the sunk graph space must match the preset name in the code. The first method is recommended if the user has development skills. + There are limitations to use sealed packages. For example, when sinking a repository into NebulaGraph, the property name of the tag created in the sunk graph space must match the preset name in the code. The first method is recommended if the user has development skills. 1. Set the [Configuration file](https://github.com/vesoft-inc/nebula-algorithm/blob/{{algorithm.branch}}/nebula-algorithm/src/main/resources/application.conf). @@ -175,38 +175,38 @@ The `lib` repository provides 10 common graph algorithms. hasWeight: false } - # Configurations related to Nebula Graph + # Configurations related to NebulaGraph nebula: { - # Data source. When Nebula Graph is the data source of the graph computing, the configuration of `nebula.read` is valid. + # Data source. When NebulaGraph is the data source of the graph computing, the configuration of `nebula.read` is valid. read: { # The IP addresses and ports of all Meta services. Multiple addresses are separated by commas (,). Example: "ip1:port1,ip2:port2". - # To deploy Nebula Graph by using Docker Compose, fill in the port with which Docker Compose maps to the outside. + # To deploy NebulaGraph by using Docker Compose, fill in the port with which Docker Compose maps to the outside. # Check the status with `docker-compose ps`. metaAddress: "192.168.*.10:9559" - # The name of the graph space in Nebula Graph. + # The name of the graph space in NebulaGraph. space: basketballplayer - # Edge types in Nebula Graph. When there are multiple labels, the data of multiple edges will be merged. + # Edge types in NebulaGraph. When there are multiple labels, the data of multiple edges will be merged. labels: ["serve"] - # The property name of each edge type in Nebula Graph. This property will be used as the weight column of the algorithm. Make sure that it corresponds to the edge type. + # The property name of each edge type in NebulaGraph. This property will be used as the weight column of the algorithm. Make sure that it corresponds to the edge type. weightCols: ["start_year"] } - # Data sink. When the graph computing result sinks into Nebula Graph, the configuration of `nebula.write` is valid. + # Data sink. When the graph computing result sinks into NebulaGraph, the configuration of `nebula.write` is valid. write:{ # The IP addresses and ports of all Graph services. Multiple addresses are separated by commas (,). Example: "ip1:port1,ip2:port2". # To deploy by using Docker Compose, fill in the port with which Docker Compose maps to the outside. # Check the status with `docker-compose ps`. graphAddress: "192.168.*.11:9669" # The IP addresses and ports of all Meta services. Multiple addresses are separated by commas (,). Example: "ip1:port1,ip2:port2". - # To deploy Nebula Graph by using Docker Compose, fill in the port with which Docker Compose maps to the outside. + # To deploy NebulaGraph by using Docker Compose, fill in the port with which Docker Compose maps to the outside. # Check the staus with `docker-compose ps`. metaAddress: "192.168.*.12:9559" user:root pswd:nebula # Before submitting the graph computing task, create the graph space and tag. - # The name of the graph space in Nebula Graph. + # The name of the graph space in NebulaGraph. space:nb - # The name of the tag in Nebula Graph. The graph computing result will be written into this tag. The property name of this tag is as follows. + # The name of the tag in NebulaGraph. The graph computing result will be written into this tag. The property name of this tag is as follows. # PageRank: pagerank # Louvain: louvain # ConnectedComponent: cc diff --git a/docs-2.0/nebula-analytics.md b/docs-2.0/nebula-analytics.md index 30b98bdba19..1dbda15f401 100644 --- a/docs-2.0/nebula-analytics.md +++ b/docs-2.0/nebula-analytics.md @@ -1,25 +1,25 @@ # Nebula Analytics -Nebula Analytics is a high-performance graph computing framework tool that performs graph analysis of data in the Nebula Graph database. +Nebula Analytics is a high-performance graph computing framework tool that performs graph analysis of data in the NebulaGraph database. !!! enterpriseonly - Only available for the Nebula Graph Enterprise Edition. + Only available for the NebulaGraph Enterprise Edition. ## Scenarios -You can import data from data sources as Nebula Graph clusters, CSV files on HDFS, or local CSV files into Nebula Analytics and export the graph computation results to Nebula Graph clusters, CSV files on HDFS, or local CSV files from Nebula Analytics. +You can import data from data sources as NebulaGraph clusters, CSV files on HDFS, or local CSV files into Nebula Analytics and export the graph computation results to NebulaGraph clusters, CSV files on HDFS, or local CSV files from Nebula Analytics. ## Limitations -When you import Nebula Graph cluster data into Nebula Analytics and export the graph computation results from Nebula Analytics to a Nebula Graph cluster, the graph computation results can only be exported to the graph space where the data source is located. +When you import NebulaGraph cluster data into Nebula Analytics and export the graph computation results from Nebula Analytics to a NebulaGraph cluster, the graph computation results can only be exported to the graph space where the data source is located. ## Version compatibility -The version correspondence between Nebula Analytics and Nebula Graph is as follows. +The version correspondence between Nebula Analytics and NebulaGraph is as follows. -|Nebula Analytics|Nebula Graph| +|Nebula Analytics|NebulaGraph| |:---|:---| |1.0.x|3.0.x| |0.9.0|2.6.x| @@ -54,7 +54,7 @@ sudo rpm -i nebula-analytics-1.0.0-centos.x86_64.rpm --prefix /home/xxx/nebula- +NebulaGraph is a distributed graph database that supports dynamic scaling services at runtime. Therefore, you can dynamically scale Storaged and Graphd services through Dashboard. The Metad service cannot be scaled. --> ## "Why cannot operate on the Metad service?" -The Metad service stores the metadata of the Nebula Graph database. Once the Metad service fails to function, the entire cluster may break down. Besides, the amount of data processed by the Metad service is not much, so it is not recommended to scale the Metad service. And we directly disabled operating on the Metad service in Dashboard to prevent the cluster from being unavailable due to the misoperation of users. +The Metad service stores the metadata of the NebulaGraph database. Once the Metad service fails to function, the entire cluster may break down. Besides, the amount of data processed by the Metad service is not much, so it is not recommended to scale the Metad service. And we directly disabled operating on the Metad service in Dashboard to prevent the cluster from being unavailable due to the misoperation of users. diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md b/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md index fa85eebd1fb..8ef6436801f 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md @@ -29,7 +29,7 @@ ## v3.2.0 (2022.02.15) - Feature enhancements: - - Compatible with Nebula Graph v3.0.x. + - Compatible with NebulaGraph v3.0.x. - Added the use of DEB to deploy and start Studio. - Import: - Added password confirmation when importing to enhance security. diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-terms.md b/docs-2.0/nebula-studio/about-studio/st-ug-terms.md index 37398036ef5..641d745a59f 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-terms.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-terms.md @@ -2,6 +2,6 @@ This topic provides explanations of terms you may need to know when using Studio. -- Nebula Graph Studio: Referred to as Studio in this manual. Studio is a browser-based visualization tool to manage Nebula Graph. It provides you with a graphical user interface to manipulate graph schemas, import data, explore graph data, and run nGQL statements to retrieve data. +- NebulaGraph Studio: Referred to as Studio in this manual. Studio is a browser-based visualization tool to manage NebulaGraph. It provides you with a graphical user interface to manipulate graph schemas, import data, explore graph data, and run nGQL statements to retrieve data. -- Nebula Graph: 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 (relationships) with millisecond latency. For details, refer to [Nebula Graph User Manual](../../README.md "Click to go to Nebula Graph User Manual"). \ No newline at end of file +- NebulaGraph: NebulaGraph 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 (relationships) with millisecond latency. For details, refer to [NebulaGraph User Manual](../../README.md "Click to go to NebulaGraph User Manual"). \ No newline at end of file diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md index 8f0ab3ddd71..a125ef61ee8 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md @@ -1,16 +1,16 @@ -# What is Nebula Graph Studio +# What is NebulaGraph Studio -Nebula Graph Studio (Studio in short) is a browser-based visualization tool to manage Nebula Graph. It provides you with a graphical user interface to manipulate graph schemas, import data, explore graph data, and run nGQL statements to retrieve data. With Studio, you can quickly become a graph exploration expert from scratch. Users can view the latest source code in the Nebula Graph GitHub repository, see [nebula-studio](https://github.com/vesoft-inc/nebula-studio) for details. +NebulaGraph Studio (Studio in short) is a browser-based visualization tool to manage NebulaGraph. It provides you with a graphical user interface to manipulate graph schemas, import data, explore graph data, and run nGQL statements to retrieve data. With Studio, you can quickly become a graph exploration expert from scratch. Users can view the latest source code in the NebulaGraph GitHub repository, see [nebula-studio](https://github.com/vesoft-inc/nebula-studio) for details. ## Released versions You can deploy Studio using the following methods: -- You can deploy Studio with Docker, RPM-based, Tar-based or DEB-based and connect it to Nebula Graph. For more information, see [Deploy Studio](../deploy-connect/st-ug-deploy.md). -- Helm-based. You can deploy Studio with Helm in the Kubernetes cluster and connect it to Nebula Graph. For more information, see [Helm-based Studio](../deploy-connect/st-ug-deploy-by-helm.md). +- You can deploy Studio with Docker, RPM-based, Tar-based or DEB-based and connect it to NebulaGraph. For more information, see [Deploy Studio](../deploy-connect/st-ug-deploy.md). +- Helm-based. You can deploy Studio with Helm in the Kubernetes cluster and connect it to NebulaGraph. For more information, see [Helm-based Studio](../deploy-connect/st-ug-deploy-by-helm.md). The functions of the above four deployment methods are the same and may be restricted when using Studio. For more information, see [Limitations](../about-studio/st-ug-limitations.md). @@ -19,9 +19,9 @@ The functions of the above four deployment methods are the same and may be restr Studio provides these features: -- Graphical user interface (GUI) makes Nebula Graph management more user-friendly: +- Graphical user interface (GUI) makes NebulaGraph management more user-friendly: - - On the **Schema** page, you can manage schemas with a graphical user interface. It helps you quickly get started with Nebula Graph. + - On the **Schema** page, you can manage schemas with a graphical user interface. It helps you quickly get started with NebulaGraph. - On the **Console** page, you can run nGQL statements and read the results in a human-friendly way. @@ -33,18 +33,18 @@ Studio provides these features: You can use Studio in one of these scenarios: -- You have a dataset, and you want to explore and analyze data in a visualized way. You can use Docker Compose to deploy Nebula Graph and then use Studio to explore or analyze data in a visualized way. +- You have a dataset, and you want to explore and analyze data in a visualized way. You can use Docker Compose to deploy NebulaGraph and then use Studio to explore or analyze data in a visualized way. -- You have deployed Nebula Graph and imported a dataset. You want to use a GUI to run nGQL statements or explore and analyze graph data in a visualized way. +- You have deployed NebulaGraph and imported a dataset. You want to use a GUI to run nGQL statements or explore and analyze graph data in a visualized way. -- You are a beginner of nGQL (Nebula Graph Query Language) and you prefer to use a GUI rather than a command-line interface (CLI) to learn the language. +- You are a beginner of nGQL (NebulaGraph Query Language) and you prefer to use a GUI rather than a command-line interface (CLI) to learn the language. ## Authentication -Authentication is not enabled in Nebula Graph by default. Users can log into Studio with the `root` account and any password. +Authentication is not enabled in NebulaGraph by default. Users can log into Studio with the `root` account and any password. -When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md). +When NebulaGraph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md). diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md index bf8ffc2d721..a9bd703e861 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md @@ -1,39 +1,39 @@ -# Connect to Nebula Graph +# Connect to NebulaGraph -After successfully launching Studio, you need to configure to connect to Nebula Graph. This topic describes how Studio connects to the Nebula Graph database. +After successfully launching Studio, you need to configure to connect to NebulaGraph. This topic describes how Studio connects to the NebulaGraph database. ## Prerequisites -Before connecting to the Nebula Graph database, you need to confirm the following information: +Before connecting to the NebulaGraph database, you need to confirm the following information: -- The Nebula Graph services and Studio are started. For more information, see [Deploy Studio](st-ug-deploy.md). +- The NebulaGraph services and Studio are started. For more information, see [Deploy Studio](st-ug-deploy.md). -- You have the local IP address and the port used by the Graph service of Nebula Graph. The default port is `9669`. +- You have the local IP address and the port used by the Graph service of NebulaGraph. The default port is `9669`. !!! note Run `ifconfig` or `ipconfig` on the machine to get the IP address. -- You have a Nebula Graph account and its password. +- You have a NebulaGraph account and its password. !!! note - If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/). + If authentication is enabled in NebulaGraph and different role-based accounts are created, you must use the assigned account to connect to NebulaGraph. If authentication is disabled, you can use the `root` and any password to connect to NebulaGraph. For more information, see [NebulaGraph Database Manual](https://docs.nebula-graph.io/). ## Procedure -To connect Studio to Nebula Graph, follow these steps: +To connect Studio to NebulaGraph, follow these steps: 1. On the **Config Server** page of Studio, configure these fields: - - **Host**: Enter the IP address and the port of the Graph service of Nebula Graph. The valid format is `IP:port`. The default port is `9669`. + - **Host**: Enter the IP address and the port of the Graph service of NebulaGraph. The valid format is `IP:port`. The default port is `9669`. !!! note - When Nebula Graph and Studio are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field. + When NebulaGraph and Studio are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field. - - **Username** and **Password**: Fill in the log in account according to the authentication settings of Nebula Graph. + - **Username** and **Password**: Fill in the log in account according to the authentication settings of NebulaGraph. - If authentication is not enabled, you can use `root` and any password as the username and its password. @@ -45,15 +45,15 @@ To connect Studio to Nebula Graph, follow these steps: 2. After the configuration, click the **Connect** button. - If you can see the **Explore** page, Studio is successfully connected to Nebula Graph. + If you can see the **Explore** page, Studio is successfully connected to NebulaGraph. - ![The Console page shows that the connection is successful](../figs/st-ug-051.png "Nebula Graph is connected") + ![The Console page shows that the connection is successful](../figs/st-ug-051.png "NebulaGraph is connected") -One session continues for up to 30 minutes. If you do not operate Studio within 30 minutes, the active session will time out and you must connect to Nebula Graph again. +One session continues for up to 30 minutes. If you do not operate Studio within 30 minutes, the active session will time out and you must connect to NebulaGraph again. ## Next to do -When Studio is successfully connected to Nebula Graph, you can do these operations: +When Studio is successfully connected to NebulaGraph, you can do these operations: - If your account has GOD or ADMIN privilege, you can create a schema on the **[Console](../quick-start/st-ug-create-schema.md)** page or on the **[Schema](../manage-schema/st-ug-crud-space.md)** page. diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md index 8f9455aedf5..e04907539e7 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md @@ -46,7 +46,7 @@ Before installing Studio, you need to install the following software and ensure ## Next to do -On the **Config Server** page, connect Docker-based Studio to Nebula Graph. For more information, see [Connect to Nebula Graph](st-ug-connect.md). +On the **Config Server** page, connect Docker-based Studio to NebulaGraph. For more information, see [Connect to NebulaGraph](st-ug-connect.md). ## Configuration diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md index 59af90d2099..41a3fcdbe89 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md @@ -1,6 +1,6 @@ # Deploy Studio This topic describes how to deploy Studio locally by Docker, RPM, tar and DEB package. @@ -15,7 +15,7 @@ This topic describes how to deploy Studio locally by Docker, RPM, tar and DEB pa Before you deploy RPM-based Studio, you must confirm that: -- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md). +- The NebulaGraph services are deployed and started. For more information, see [NebulaGraph Database Manual](../../2.quick-start/1.quick-start-workflow.md). - The Linux distribution is CentOS, install `lsof`. @@ -111,7 +111,7 @@ $ systemctl restart nebula-graph-studio.service Before you deploy tar-based Studio, you must do a check of these: -- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md). +- The NebulaGraph services are deployed and started. For more information, see [NebulaGraph Database Manual](../../2.quick-start/1.quick-start-workflow.md). - Before the installation starts, the following ports are not occupied. @@ -163,7 +163,7 @@ $ kill $(lsof -t -i :7001) #stop nebula-graph-studio Before you deploy DEB-based Studio, you must do a check of these: -- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md). +- The NebulaGraph services are deployed and started. For more information, see [NebulaGraph Database Manual](../../2.quick-start/1.quick-start-workflow.md). - The Linux distribution is Ubuntu. @@ -212,7 +212,7 @@ $ sudo dpkg -r nebula-graph-studio Before you deploy Docker-based Studio, you must do a check of these: -- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md). +- The NebulaGraph services are deployed and started. For more information, see [NebulaGraph Database Manual](../../2.quick-start/1.quick-start-workflow.md). - On the machine where Studio will run, Docker Compose is installed and started. For more information, see [Docker Compose Documentation](https://docs.docker.com/compose/install/ "Click to go to Docker Documentation"). @@ -225,11 +225,11 @@ Before you deploy Docker-based Studio, you must do a check of these: ### Procedure -To deploy and start Docker-based Studio, run the following commands. Here we use Nebula Graph v{{nebula.release}} for demonstration: +To deploy and start Docker-based Studio, run the following commands. Here we use NebulaGraph v{{nebula.release}} for demonstration: 1. Download the configuration files for the deployment. - | Installation package | Nebula Graph version | + | Installation package | NebulaGraph version | | ----- | ----- | | [nebula-graph-studio-v{{studio.release}}.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-v{{studio.release}}.tar.gz) | {{nebula.release}} | @@ -274,4 +274,4 @@ To deploy and start Docker-based Studio, run the following commands. Here we use ## Next to do -On the **Config Server** page, connect Docker-based Studio to Nebula Graph. For more information, see [Connect to Nebula Graph](st-ug-connect.md). +On the **Config Server** page, connect Docker-based Studio to NebulaGraph. For more information, see [Connect to NebulaGraph](st-ug-connect.md). diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-reset-connection.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-reset-connection.md index a7d80ab4104..6459278da49 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-reset-connection.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-reset-connection.md @@ -1,7 +1,7 @@ ## Clear connection -If you want to reset Nebula Graph, you can clear the connection and reconfigure the database. +If you want to reset NebulaGraph, you can clear the connection and reconfigure the database. -When the Studio is still connected to a Nebula Graph database, you can choose **setting > clear connect** at the toolbar. If the **Config Server** page is displayed on the browser, it means that Studio has successfully disconnected from the Nebula Graph database. \ No newline at end of file +When the Studio is still connected to a NebulaGraph database, you can choose **setting > clear connect** at the toolbar. If the **Config Server** page is displayed on the browser, it means that Studio has successfully disconnected from the NebulaGraph database. \ No newline at end of file diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md index 5527d720154..5224babccfa 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md @@ -1,6 +1,6 @@ # Operate edge types -After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This topic introduces how to use the **Schema** page to operate edge types in a graph space only. +After a graph space is created in NebulaGraph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This topic introduces how to use the **Schema** page to operate edge types in a graph space only. ## Studio version @@ -10,7 +10,7 @@ Studio of v{{ studio.release }} or later versions supports this function. For mo To operate an edge type on the **Schema** page of Studio, you must do a check of these: -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - A graph space is created. - Your account has the authority of GOD, ADMIN, or DBA. @@ -40,7 +40,7 @@ To create an edge type on the **Schema** page, follow these steps: - To delete a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel"). - - (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website"). + - (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to NebulaGraph website"). 6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings. diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md index a4ec628e78b..2af4d3a2ec4 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md @@ -4,7 +4,7 @@ You can create an index for a Tag and/or an Edge type. An index lets traversal s !!! note - You can create an index when a Tag or an Edge Type is created. But an index can decrease the write speed during data import. We recommend that you import data firstly and then create and rebuild an index. For more information, see [nGQL Manual](../../3.ngql-guide/14.native-index-statements/README.md "Click to go to the Nebula Graph website"). + You can create an index when a Tag or an Edge Type is created. But an index can decrease the write speed during data import. We recommend that you import data firstly and then create and rebuild an index. For more information, see [nGQL Manual](../../3.ngql-guide/14.native-index-statements/README.md "Click to go to the NebulaGraph website"). ## Studio version @@ -14,7 +14,7 @@ Studio of v{{ studio.release }} or later versions supports this function. For mo To operate an index on the **Schema** page of Studio, you must do a check of these: -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - A graph Space, Tags, and Edge Types are created. - Your account has the authority of GOD, ADMIN, or DBA. @@ -38,7 +38,7 @@ To create an index on the **Schema** page, follow these steps: !!! note - The order of the indexed properties has an effect on the result of the `LOOKUP` statement. For more information, see [nGQL Manual](../../3.ngql-guide/7.general-query-statements/5.lookup.md "Click to go to the Nebula Graph website"). + The order of the indexed properties has an effect on the result of the `LOOKUP` statement. For more information, see [nGQL Manual](../../3.ngql-guide/7.general-query-statements/5.lookup.md "Click to go to the NebulaGraph website"). - **Comment**: The remarks of a certain property or the index itself. The maximum length is 256 bytes. By default, there will be no comments on an index. But in this example, `follow_index` is used. diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md index a4e2e00a736..b030d10fa16 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md @@ -1,6 +1,6 @@ # Operate graph spaces -When Studio is connected to Nebula Graph, you can create or delete a graph space. You can use the **Console** page or the **Schema** page to do these operations. This article only introduces how to use the **Schema** page to operate graph spaces in Nebula Graph. +When Studio is connected to NebulaGraph, you can create or delete a graph space. You can use the **Console** page or the **Schema** page to do these operations. This article only introduces how to use the **Schema** page to operate graph spaces in NebulaGraph. ## Studio version @@ -10,10 +10,10 @@ Studio of v{{ studio.release }} or later versions supports this function. For mo To operate a graph space on the **Schema** page of Studio, you must do a check of these: -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - Your account has the authority of GOD. It means that: - - If the authentication is enabled in Nebula Graph, you can use `root` and any password to sign in to Studio. - - If the authentication is disabled in Nebula Graph, you must use `root` and its password to sign in to Studio. + - If the authentication is enabled in NebulaGraph, you can use `root` and any password to sign in to Studio. + - If the authentication is disabled in NebulaGraph, you must use `root` and its password to sign in to Studio. ## Create a graph space @@ -29,7 +29,7 @@ To create a graph space on the **Schema** page, follow these steps: - **Comment**: The remarks of a certain property or the space itself. The maximum length is 256 bytes. By default, there will be no comments on a space. But in this example, `Statistics of basketball players` is used. - - **Optional Parameters**: Set the values of `partition_num` and `replica_factor` respectively. In this example, these parameters are set to `100` and `1` respectively. For more information, see [`CREATE SPACE` syntax](../../3.ngql-guide/9.space-statements/1.create-space.md "Click to go to the Nebula Graph website"). + - **Optional Parameters**: Set the values of `partition_num` and `replica_factor` respectively. In this example, these parameters are set to `100` and `1` respectively. For more information, see [`CREATE SPACE` syntax](../../3.ngql-guide/9.space-statements/1.create-space.md "Click to go to the NebulaGraph website"). In the **Equivalent to the following nGQL statement** panel, you can see the statement equivalent to the preceding settings. diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md index 3df2184fce0..2aaed7e90a6 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md @@ -1,6 +1,6 @@ # Operate tags -After a graph space is created in Nebula Graph, you can create tags. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, update, or delete tags. This topic introduces how to use the **Schema** page to operate tags in a graph space only. +After a graph space is created in NebulaGraph, you can create tags. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, update, or delete tags. This topic introduces how to use the **Schema** page to operate tags in a graph space only. ## Studio version @@ -10,7 +10,7 @@ Studio of v{{ studio.release}} or later versions supports this function. For mor To operate a tag on the **Schema** page of Studio, you must do a check of these: -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - A graph space is created. - Your account has the authority of GOD, ADMIN, or DBA. @@ -38,7 +38,7 @@ To create a tag on the **Schema** page, follow these steps: - To cancel a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel"). - c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website"). + c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to NebulaGraph website"). 6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings. diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md b/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md index 1b2778b17c6..4859551ad03 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md @@ -1,16 +1,16 @@ # Create a schema -To batch import data into Nebula Graph, you must have a graph schema. You can create a schema on the **Console** page or on the **Schema** page of Studio. +To batch import data into NebulaGraph, you must have a graph schema. You can create a schema on the **Console** page or on the **Schema** page of Studio. !!! note - You can use nebula-console to create a schema. For more information, see [Nebula Graph Manual](../../README.md) and [Get started with Nebula Graph](../../2.quick-start/1.quick-start-workflow.md). + You can use nebula-console to create a schema. For more information, see [NebulaGraph Manual](../../README.md) and [Get started with NebulaGraph](../../2.quick-start/1.quick-start-workflow.md). ## Prerequisites To create a graph schema on Studio, you must do a check of these: -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - Your account has the privilege of GOD, ADMIN, or DBA. diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md b/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md index 5bae5e5d43b..a9cd8a9a774 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-import-data.md @@ -1,12 +1,12 @@ # Import data -After CSV files of data and a schema are created, you can use the **Import** page to batch import vertex and edge data into Nebula Graph for graph exploration and data analysis. +After CSV files of data and a schema are created, you can use the **Import** page to batch import vertex and edge data into NebulaGraph for graph exploration and data analysis. ## Prerequisites To batch import data, do a check of these: -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - A schema is created. @@ -43,7 +43,7 @@ To batch import data, follow these steps: !!! Note - In the same graph space, the VID is always unique and cannot be repeated. For VID information, see [VID](../../1.introduction/3.vid.md) "Click to enter the Nebula Graph Manual". + In the same graph space, the VID is always unique and cannot be repeated. For VID information, see [VID](../../1.introduction/3.vid.md) "Click to enter the NebulaGraph Manual". 8. In the **TAG 1** section, do these operations: diff --git a/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md b/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md index a790071cbe6..656afe1b0f4 100644 --- a/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md +++ b/docs-2.0/nebula-studio/quick-start/st-ug-plan-schema.md @@ -1,8 +1,8 @@ # Design a schema -To manipulate graph data in Nebula Graph with Studio, you must have a graph schema. This article introduces how to design a graph schema for Nebula Graph. +To manipulate graph data in NebulaGraph with Studio, you must have a graph schema. This article introduces how to design a graph schema for NebulaGraph. -A graph schema for Nebula Graph must have these essential elements: +A graph schema for NebulaGraph must have these essential elements: - Tags (namely vertex types) and their properties. diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md index c2cb06fd0db..7032d6f7f0e 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md @@ -10,7 +10,7 @@ You can troubleshoot the problem by following the steps below. ### Step1: Confirm that the format of the **Host** field is correct -You must fill in the IP address (`graph_server_ip`) and port of the Nebula Graph database Graph service. If no changes are made, the port defaults to `9669`. Even if Nebula Graph and Studio are deployed on the current machine, you must use the local IP address instead of `127.0.0.1`, `localhost` or `0.0.0.0`. +You must fill in the IP address (`graph_server_ip`) and port of the NebulaGraph database Graph service. If no changes are made, the port defaults to `9669`. Even if NebulaGraph and Studio are deployed on the current machine, you must use the local IP address instead of `127.0.0.1`, `localhost` or `0.0.0.0`. ### Step2: Confirm that the **username** and **password** are correct @@ -18,28 +18,28 @@ If authentication is not enabled, you can use root and any password as the usern If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords. -### Step3: Confirm that Nebula Graph service is normal +### Step3: Confirm that NebulaGraph service is normal -Check Nebula Graph service status. Regarding the operation of viewing services: +Check NebulaGraph service status. Regarding the operation of viewing services: -- If you compile and deploy Nebula Graph on a Linux server, refer to the [Nebula Graph service](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md). +- If you compile and deploy NebulaGraph on a Linux server, refer to the [NebulaGraph service](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md). -- If you use Nebula Graph deployed by Docker Compose and RPM, refer to the [Nebula Graph service status and ports](../deploy-connect/st-ug-deploy.md). +- If you use NebulaGraph deployed by Docker Compose and RPM, refer to the [NebulaGraph service status and ports](../deploy-connect/st-ug-deploy.md). -If the Nebula Graph service is normal, proceed to Step 4 to continue troubleshooting. Otherwise, please restart Nebula Graph service. +If the NebulaGraph service is normal, proceed to Step 4 to continue troubleshooting. Otherwise, please restart NebulaGraph service. !!! Note - If you used `docker-compose up -d` to satrt Nebula Graph before, you must run the `docker-compose down` to stop Nebula Graph. + If you used `docker-compose up -d` to satrt NebulaGraph before, you must run the `docker-compose down` to stop NebulaGraph. ### Step4: Confirm the network connection of the Graph service is normal -Run a command (for example, telnet 9669) on the Studio machine to confirm whether Nebula Graph's Graph service network connection is normal. +Run a command (for example, telnet 9669) on the Studio machine to confirm whether NebulaGraph's Graph service network connection is normal. If the connection fails, check according to the following steps: -- If Studio and Nebula Graph are on the same machine, check if the port is exposed. +- If Studio and NebulaGraph are on the same machine, check if the port is exposed. -- If Studio and Nebula Graph are not on the same machine, check the network configuration of the Nebula Graph server, such as firewall, gateway, and port. +- If Studio and NebulaGraph are not on the same machine, check the network configuration of the NebulaGraph server, such as firewall, gateway, and port. -If you cannot connect to the Nebula Graph service after troubleshooting with the above steps, please go to the [Nebula Graph forum](https://discuss.nebula-graph.io) for consultation. \ No newline at end of file +If you cannot connect to the NebulaGraph service after troubleshooting with the above steps, please go to the [NebulaGraph forum](https://discuss.nebula-graph.io) for consultation. \ No newline at end of file diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md index 355e723bf4e..6706f22fee4 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md @@ -31,7 +31,7 @@ If the above result is not returned, stop Studio and restart it first. For detai !!! note - If you used `docker-compose up -d` to satrt Nebula Graph before, you must run the `docker-compose down` to stop Nebula Graph. + If you used `docker-compose up -d` to satrt NebulaGraph before, you must run the `docker-compose down` to stop NebulaGraph. ### Step3: Confirm address @@ -47,8 +47,8 @@ If the connection is refused, check according to the following steps: If the connection fails, check according to the following steps: -- If Studio and Nebula Graph are on the same machine, check if the port is exposed. +- If Studio and NebulaGraph are on the same machine, check if the port is exposed. -- If Studio and Nebula Graph are not on the same machine, check the network configuration of the Nebula Graph server, such as firewall, gateway, and port. +- If Studio and NebulaGraph are not on the same machine, check the network configuration of the NebulaGraph server, such as firewall, gateway, and port. -If you cannot connect to the Nebula Graph service after troubleshooting with the above steps, please go to the [Nebula Graph forum](https://discuss.nebula-graph.io) for consultation. \ No newline at end of file +If you cannot connect to the NebulaGraph service after troubleshooting with the above steps, please go to the [NebulaGraph forum](https://discuss.nebula-graph.io) for consultation. \ No newline at end of file diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md index 1f785088211..12c61d80950 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md @@ -4,7 +4,7 @@ If you find that a function cannot be used, it is recommended to troubleshoot the problem according to the following steps: - 1. Confirm that Nebula Graph is the latest version. If you use Docker Compose to deploy the Nebula Graph database, it is recommended to run `docker-compose pull && docker-compose up -d` to pull the latest Docker image and start the container. + 1. Confirm that NebulaGraph is the latest version. If you use Docker Compose to deploy the NebulaGraph database, it is recommended to run `docker-compose pull && docker-compose up -d` to pull the latest Docker image and start the container. 2. Confirm that Studio is the latest version. For more information, refer to [check updates](../about-studio/st-ug-check-updates.md). diff --git a/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md b/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md index 7ec3701d7de..0162e8de93f 100644 --- a/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md +++ b/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md @@ -10,7 +10,7 @@ Studio of v{{ studio.release }} or later versions supports this function. For mo To use the **Open in Explore** function, you must do a check of these: -- Studio is connected to Nebula Graph. For more information, see [Connect to Nebula Graph](../deploy-connect/st-ug-connect.md). +- Studio is connected to NebulaGraph. For more information, see [Connect to NebulaGraph](../deploy-connect/st-ug-connect.md). - A dataset exists in the database. For more information, see [Import data](../quick-start/st-ug-import-data.md). diff --git a/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md b/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md index 953915817c2..4beb4d8777e 100644 --- a/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md +++ b/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md @@ -12,7 +12,7 @@ To use the **View Subgraphs** function, you must do a check of these: - The version of Studio is v{{studio.release}} or later. -- Studio is connected to Nebula Graph. +- Studio is connected to NebulaGraph. - A dataset exists in the database. In the example of this article, the **basketballplayer** dataset is used. For more information, see [Import data](../quick-start/st-ug-import-data.md). diff --git a/docs-2.0/reuse/source_connect-to-nebula-graph.md b/docs-2.0/reuse/source_connect-to-nebula-graph.md index f11afef62cf..a919c086609 100644 --- a/docs-2.0/reuse/source_connect-to-nebula-graph.md +++ b/docs-2.0/reuse/source_connect-to-nebula-graph.md @@ -1,26 +1,26 @@ -Nebula Graph supports multiple types of clients, including a CLI client, a GUI client, and clients developed in popular programming languages. This topic provides an overview of Nebula Graph clients and basic instructions on how to use the native CLI client, Nebula Console. +NebulaGraph supports multiple types of clients, including a CLI client, a GUI client, and clients developed in popular programming languages. This topic provides an overview of NebulaGraph clients and basic instructions on how to use the native CLI client, Nebula Console. -## Nebula Graph clients +## NebulaGraph clients -You can use supported [clients or console](https://docs.nebula-graph.io/{{nebula.release}}/20.appendix/6.eco-tool-version/) to connect to Nebula Graph. +You can use supported [clients or console](https://docs.nebula-graph.io/{{nebula.release}}/20.appendix/6.eco-tool-version/) to connect to NebulaGraph. -## Use Nebula Console to connect to Nebula Graph +## Use Nebula Console to connect to NebulaGraph ### Prerequisites -* You have started [Nebula Graph services](https://docs.nebula-graph.io/{{nebula.release}}/4.deployment-and-installation/manage-service/). +* You have started [NebulaGraph services](https://docs.nebula-graph.io/{{nebula.release}}/4.deployment-and-installation/manage-service/). -* The machine you plan to run Nebula Console on has network access to Nebula Graph services. +* The machine you plan to run Nebula Console on has network access to NebulaGraph services. -* The Nebula Console version is compatible with the Nebula Graph version. +* The Nebula Console version is compatible with the NebulaGraph version. !!! note - The same version of Nebula Console and Nebula Graph is the most compatible. There may be compatibility issues when connecting to Nebula Graph with a different version of Nebula Console. You may be unable to connenct to Nebula Graph due to the compatibiltiy issue and an error message `incompatible version between client and server` is displayed. + The same version of Nebula Console and NebulaGraph is the most compatible. There may be compatibility issues when connecting to NebulaGraph with a different version of Nebula Console. You may be unable to connenct to NebulaGraph due to the compatibiltiy issue and an error message `incompatible version between client and server` is displayed. ### Steps @@ -50,7 +50,7 @@ If you do not have a Nebula Graph database yet, we recommend that you try the cl 5. In the command line interface, change the working directory to the one where the nebula-console binary file is stored. -6. Run the following command to connect to Nebula Graph. +6. Run the following command to connect to NebulaGraph. * For Linux or macOS: @@ -72,9 +72,9 @@ If you do not have a Nebula Graph database yet, we recommend that you try the cl | - | - | | `-h` | Shows the help menu. | | `-addr` | Sets the IP address of the graphd service. The default address is 127.0.0.1. | - | `-port` | Sets the port number of the graphd service. The default port number is 9669.| - | `-u/-user` | Sets the username of your Nebula Graph account. Before enabling authentication, you can use any existing username. The default username is `root`. | - | `-p/-password` | Sets the password of your Nebula Graph account. Before enabling authentication, you can use any characters as the password. | + | `-port` | Sets the port number of the graphd service. The default port number is 9669.| + | `-u/-user` | Sets the username of your NebulaGraph account. Before enabling authentication, you can use any existing username. The default username is `root`. | + | `-p/-password` | Sets the password of your NebulaGraph account. Before enabling authentication, you can use any characters as the password. | | `-t/-timeout` | Sets an integer-type timeout threshold of the connection. The unit is second. The default value is 120. | | `-e/-eval` | Sets a string-type nGQL statement. The nGQL statement is executed once the connection succeeds. The connection stops after the result is returned. | | `-f/-file` | Sets the path of an nGQL file. The nGQL statements in the file are executed once the connection succeeds. The result will be returned and the connection stops then. | diff --git a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md index 7974048493a..cfffc578100 100644 --- a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md +++ b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md @@ -1,4 +1,4 @@ -RPM and DEB are common package formats on Linux systems. This topic shows how to quickly install Nebula Graph with the RPM or DEB package. +RPM and DEB are common package formats on Linux systems. This topic shows how to quickly install NebulaGraph with the RPM or DEB package. ## Prerequisites @@ -6,7 +6,7 @@ Prepare the right [resources](https://docs.nebula-graph.io/{{nebula.release}}/4. !!! note - The console is not complied or packaged with Nebula Graph server binaries. You can install [nebula-console](https://github.com/vesoft-inc/nebula-console) by yourself. + The console is not complied or packaged with NebulaGraph server binaries. You can install [nebula-console](https://github.com/vesoft-inc/nebula-console) by yourself. !!! enterpriseonly @@ -100,8 +100,8 @@ Prepare the right [resources](https://docs.nebula-graph.io/{{nebula.release}}/4. * Download the release version. - + On the [Nebula Graph Releases](https://github.com/vesoft-inc/nebula-graph/releases) page, find the required version and click **Assets**. - ![Select a Nebula Graph release version](../reuse/console-1.png) + + On the [NebulaGraph Releases](https://github.com/vesoft-inc/nebula-graph/releases) page, find the required version and click **Assets**. + ![Select a NebulaGraph release version](../reuse/console-1.png) + In the **Assets** area, click the package to download it. @@ -111,14 +111,14 @@ Prepare the right [resources](https://docs.nebula-graph.io/{{nebula.release}}/4. Nightly versions are usually used to test new features. Do not use it in a production environment. - + On the [Nebula Graph package](https://github.com/vesoft-inc/nebula/actions/workflows/package.yaml) page, click the latest **package** on the top of the package list. + + On the [NebulaGraph package](https://github.com/vesoft-inc/nebula/actions/workflows/package.yaml) page, click the latest **package** on the top of the package list. - ![Select a Nebula Graph nightly version](https://github.com/vesoft-inc/nebula-docs/blob/master/docs-2.0/figs/4.deployment-and-installation/2.complie-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb/nightly-page.png?raw=true) + ![Select a NebulaGraph nightly version](https://github.com/vesoft-inc/nebula-docs/blob/master/docs-2.0/figs/4.deployment-and-installation/2.complie-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb/nightly-page.png?raw=true) + In the **Artifacts** area, click the package to download it. --> -## Install Nebula Graph +## Install NebulaGraph * Use the following syntax to install with an RPM package. @@ -141,7 +141,7 @@ Prepare the right [resources](https://docs.nebula-graph.io/{{nebula.release}}/4. ``` !!! note - Customizing the installation path is not supported when installing Nebula Graph with a DEB package. The default installation path is `/usr/local/nebula/`. + Customizing the installation path is not supported when installing NebulaGraph with a DEB package. The default installation path is `/usr/local/nebula/`. For example, to install a DEB package for the {{nebula.release}} version, run the following command. @@ -157,6 +157,6 @@ Prepare the right [resources](https://docs.nebula-graph.io/{{nebula.release}}/4. - (Enterprise Edition)[Deploy license](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-license) -- [Start Nebula Graph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/5.start-stop-service/) +- [Start NebulaGraph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/5.start-stop-service/) -- [Connect to Nebula Graph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) +- [Connect to NebulaGraph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md index d32dbcc0649..a772a6dd63e 100644 --- a/docs-2.0/reuse/source_manage-service.md +++ b/docs-2.0/reuse/source_manage-service.md @@ -1,6 +1,6 @@ -You can use the `nebula.service` script to start, stop, restart, terminate, and check the Nebula Graph services. This topic takes starting, stopping and checking the Nebula Graph services for examples. +You can use the `nebula.service` script to start, stop, restart, terminate, and check the NebulaGraph services. This topic takes starting, stopping and checking the NebulaGraph services for examples. -`nebula.service` is stored in the `/usr/local/nebula/scripts` directory by default, which is also the default installation path of Nebula Graph. If you have customized the path, use the actual path in your environment. +`nebula.service` is stored in the `/usr/local/nebula/scripts` directory by default, which is also the default installation path of NebulaGraph. If you have customized the path, use the actual path in your environment. ## Syntax @@ -23,13 +23,13 @@ $ sudo /usr/local/nebula/scripts/nebula.service |`metad`|Set the Meta Service as the target service.| |`graphd`|Set the Graph Service as the target service.| |`storaged`|Set the Storage Service as the target service.| -|`all`|Set all the Nebula Graph services as the target services.| +|`all`|Set all the NebulaGraph services as the target services.| -## Start Nebula Graph +## Start NebulaGraph ### In non-container environment -Run the following command to start Nebula Graph. +Run the following command to start NebulaGraph. ```bash $ sudo /usr/local/nebula/scripts/nebula.service start all @@ -43,7 +43,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service start all ### In docker container (deployed with docker-compose) -Run the following command in the `nebula-docker-compose/` directory to start Nebula Graph. +Run the following command in the `nebula-docker-compose/` directory to start NebulaGraph. ```bash [nebula-docker-compose]$ docker-compose up -d @@ -60,7 +60,7 @@ Creating nebula-docker-compose_graphd2_1 ... done Creating nebula-docker-compose_graphd_1 ... done ``` -## Stop Nebula Graph +## Stop NebulaGraph !!! danger @@ -68,7 +68,7 @@ Creating nebula-docker-compose_graphd_1 ... done ### In non-container environment -Run the following command to stop Nebula Graph. +Run the following command to stop NebulaGraph. ```bash $ sudo /usr/local/nebula/scripts/nebula.service stop all @@ -82,7 +82,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service stop all ### In docker container (deployed with docker-compose) -Run the following command in the `nebula-docker-compose/` directory to stop Nebula Graph. +Run the following command in the `nebula-docker-compose/` directory to stop NebulaGraph. ```bash nebula-docker-compose]$ docker-compose down @@ -109,19 +109,19 @@ Removing network nebula-docker-compose_nebula-net !!! Note - If you are using a developing or nightly version for testing and have compatibility issues, try to run `docker-compose down -v` to **DELETE** all data stored in Nebula Graph and import data again. + If you are using a developing or nightly version for testing and have compatibility issues, try to run `docker-compose down -v` to **DELETE** all data stored in NebulaGraph and import data again. ## Check the service status ### In non-container environment -Run the following command to check the service status of Nebula Graph. +Run the following command to check the service status of NebulaGraph. ```bash $ sudo /usr/local/nebula/scripts/nebula.service status all ``` -* Nebula Graph is running normally if the following information is returned. +* NebulaGraph is running normally if the following information is returned. ```bash [INFO] nebula-metad(02b2091): Running as 26601, Listening on 9559 @@ -131,9 +131,9 @@ $ sudo /usr/local/nebula/scripts/nebula.service status all !!! note - After starting Nebula Graph, the port of the `nebula-storaged` process is shown in red. Because the `nebula-storaged` process waits for the `nebula-metad` to add the current Storage service during the startup process. The Storage works after it receives the ready signal. Starting from Nebula Graph 3.0.0, the Meta service cannot directly read or write data in the Storage service that you add in the configuration file. The configuration file only registers the Storage service to the Meta service. You must run the `ADD HOSTS` command to enable the Meta to read and write data in the Storage service. For more information, see [Manage Storage hosts](../4.deployment-and-installation/manage-storage-host.md). + After starting NebulaGraph, the port of the `nebula-storaged` process is shown in red. Because the `nebula-storaged` process waits for the `nebula-metad` to add the current Storage service during the startup process. The Storage works after it receives the ready signal. Starting from NebulaGraph 3.0.0, the Meta service cannot directly read or write data in the Storage service that you add in the configuration file. The configuration file only registers the Storage service to the Meta service. You must run the `ADD HOSTS` command to enable the Meta to read and write data in the Storage service. For more information, see [Manage Storage hosts](../4.deployment-and-installation/manage-storage-host.md). -* If the returned result is similar to the following one, there is a problem. You may also go to the [Nebula Graph community](https://discuss.nebula-graph.io/) for help. +* If the returned result is similar to the following one, there is a problem. You may also go to the [NebulaGraph community](https://discuss.nebula-graph.io/) for help. ```bash [INFO] nebula-metad: Running as 25600, Listening on 9559 @@ -141,11 +141,11 @@ $ sudo /usr/local/nebula/scripts/nebula.service status all [INFO] nebula-storaged: Running as 25646, Listening on 9779 ``` -The Nebula Graph services consist of the Meta Service, Graph Service, and Storage Service. The configuration files for all three services are stored in the `/usr/local/nebula/etc/` directory by default. You can check the configuration files according to the returned result to troubleshoot problems. +The NebulaGraph services consist of the Meta Service, Graph Service, and Storage Service. The configuration files for all three services are stored in the `/usr/local/nebula/etc/` directory by default. You can check the configuration files according to the returned result to troubleshoot problems. ### In docker container (deployed with docker-compose) -Run the following command in the `nebula-docker-compose/` directory to check the service status of Nebula Graph. +Run the following command in the `nebula-docker-compose/` directory to check the service status of NebulaGraph. ```bash nebula-docker-compose]$ docker-compose ps @@ -195,4 +195,4 @@ nebula-docker-compose]$ docker exec -it 2a6c56c405f5 bash ## Next to do -[Connect to Nebula Graph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) +[Connect to NebulaGraph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) diff --git a/mkdocs.yml b/mkdocs.yml index e3bc2cd028f..fdfcd9138b7 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ # Project information -site_name: Nebula Graph Database Manual -site_description: Documentation for Nebula Graph Database -site_author: Nebula Graph +site_name: NebulaGraph Database Manual +site_description: Documentation for NebulaGraph Database +site_author: NebulaGraph site_url: https://docs.nebula-graph.io/ edit_uri: 'edit/v3.0.2/docs-2.0/' docs_dir: docs-2.0 @@ -11,7 +11,7 @@ repo_name: 'vesoft-inc/nebula-docs' repo_url: 'https://github.com/vesoft-inc/nebula-docs' # Copyright -copyright: Copyright © 2022 Nebula Graph +copyright: Copyright © 2022 NebulaGraph # Configuration theme: @@ -125,11 +125,11 @@ nav: - Introduction to graphs: 1.introduction/0-0-graph.md - Graph databases: 1.introduction/0-1-graph-database.md - Related technologies: 1.introduction/0-2.relates.md - - What is Nebula Graph: 1.introduction/1.what-is-nebula-graph.md + - What is NebulaGraph: 1.introduction/1.what-is-nebula-graph.md - Data model: 1.introduction/2.data-model.md - Path: 1.introduction/2.1.path.md - VID: 1.introduction/3.vid.md - - Nebula Graph architecture: + - NebulaGraph architecture: - Architecture overview: 1.introduction/3.nebula-graph-architecture/1.architecture-overview.md - Meta Service: 1.introduction/3.nebula-graph-architecture/2.meta-service.md - Graph Service: 1.introduction/3.nebula-graph-architecture/3.graph-service.md @@ -137,9 +137,9 @@ nav: - Quick start: - Quick start workflow: 2.quick-start/1.quick-start-workflow.md - - Step 1 Install Nebula Graph: 2.quick-start/2.install-nebula-graph.md - - Step 2 Manage Nebula Graph Service: 2.quick-start/5.start-stop-service.md - - Step 3 Connect to Nebula Graph: 2.quick-start/3.connect-to-nebula-graph.md + - Step 1 Install NebulaGraph: 2.quick-start/2.install-nebula-graph.md + - Step 2 Manage NebulaGraph Service: 2.quick-start/5.start-stop-service.md + - Step 3 Connect to NebulaGraph: 2.quick-start/3.connect-to-nebula-graph.md - Step 4 Use nGQL (CRUD): 2.quick-start/4.nebula-graph-crud.md - nGQL cheatsheet: 2.quick-start/6.cheatsheet-for-ngql.md @@ -302,20 +302,20 @@ nav: - Resource preparations: 4.deployment-and-installation/1.resource-preparations.md - Compile and install Nebula Graph: - Install Nebula Graph by compiling the source code: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md - - Install Nebula Graph with RPM or DEB package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md - - Install Nebula Graph with the tar.gz file: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md - - Deploy Nebula Graph with Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md - - Deploy a Nebula Graph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md - - Deploy standalone Nebula Graph: 4.deployment-and-installation/standalone-deployment.md + - Install NebulaGraph with RPM or DEB package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md + - Install NebulaGraph with the tar.gz file: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md + - Deploy NebulaGraph with Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md + - Deploy a NebulaGraph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md + - Deploy standalone NebulaGraph: 4.deployment-and-installation/standalone-deployment.md - Deploy license: 4.deployment-and-installation/deploy-license.md - Manage Service: 4.deployment-and-installation/manage-service.md - Connect to Service: 4.deployment-and-installation/connect-to-nebula-graph.md - Manage Storage host: 4.deployment-and-installation/manage-storage-host.md # - Manage zone: 4.deployment-and-installation/5.zone.md - Upgrade: - - Upgrade Nebula Graph to the latest version: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md -# - Upgrade Nebula Graph from v2.0.x to the current version: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - - Uninstall Nebula Graph: 4.deployment-and-installation/4.uninstall-nebula-graph.md + - Upgrade NebulaGraph to the latest version: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md +# - Upgrade NebulaGraph from v2.0.x to the current version: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md + - Uninstall NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md - Configurations and logs: - Configurations: @@ -328,7 +328,7 @@ nav: - Logs: 5.configurations-and-logs/2.log-management/logs.md - Monitor and metrics: - - Query Nebula Graph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md + - Query NebulaGraph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md - RocksDB Statistics: 6.monitor-and-metrics/2.rocksdb-statistics.md - Data security: - Authentication and authorization: @@ -362,8 +362,8 @@ nav: - Nebula Python: 14.client/5.nebula-python-client.md - Nebula Go: 14.client/6.nebula-go-client.md -# - Nebula Graph Cloud: -# - What is Nebula Graph Cloud: nebula-cloud/1.what-is-cloud.md +# - NebulaGraph Cloud: +# - What is NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md # - Create a subscription: nebula-cloud/2.how-to-create-subsciption.md # - Configure a Solution: nebula-cloud/3.how-to-set-solution.md # - Cloud Solution roles: nebula-cloud/4.user-role-description.md @@ -377,10 +377,10 @@ nav: # - Privacy policy: nebula-cloud/8.privacy-policy.md - - Nebula Graph Studio: + - NebulaGraph Studio: - Change Log: nebula-studio/about-studio/st-ug-release-note.md - - About Nebula Graph Studio: - - What is Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md + - About NebulaGraph Studio: + - What is NebulaGraph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md - Explanations of terms: nebula-studio/about-studio/st-ug-terms.md - Limitations: nebula-studio/about-studio/st-ug-limitations.md - Check updates: nebula-studio/about-studio/st-ug-check-updates.md @@ -388,7 +388,7 @@ nav: - Deploy and connect: - Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md - Deploy Studio with Helm: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md - - Connect to Nebula Graph: nebula-studio/deploy-connect/st-ug-connect.md + - Connect to NebulaGraph: nebula-studio/deploy-connect/st-ug-connect.md - Clear connection: nebula-studio/deploy-connect/st-ug-reset-connection.md - Quick start: - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md @@ -441,7 +441,7 @@ nav: - What is Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md - Deploy and connect: - Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md - - Connect to Nebula Graph: nebula-explorer/deploy-connect/ex-ug-connect.md + - Connect to NebulaGraph: nebula-explorer/deploy-connect/ex-ug-connect.md - Page overview: nebula-explorer/ex-ug-page-overview.md - Start querying: nebula-explorer/ex-ug-query-exploration.md - Vertex Filter: nebula-explorer/node-filtering.md @@ -480,7 +480,7 @@ nav: - Import data from Pulsar: nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md - Import data from Kafka: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md - Import data from SST files: nebula-exchange/use-exchange/ex-ug-import-from-sst.md - - Export data from Nebula Graph: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md + - Export data from NebulaGraph: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - Exchange FAQ: nebula-exchange/ex-ug-FAQ.md # excluded in 3.0.0 - Nebula Operator: @@ -491,11 +491,11 @@ nav: # - Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md # - Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md # - Configure clusters: -# - Custom configuration parameters for a Nebula Graph cluster: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md +# - Custom configuration parameters for a NebulaGraph cluster: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md # - Reclaim PVs: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md # #banlance-3.1 notice Exclude - Balance storage data after scaling out: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md -# - Upgrade Nebula Graph clusters: nebula-operator/9.upgrade-nebula-cluster.md -# - Connect to Nebula Graph databases: nebula-operator/4.connect-to-nebula-graph-service.md +# - Upgrade NebulaGraph clusters: nebula-operator/9.upgrade-nebula-cluster.md +# - Connect to NebulaGraph databases: nebula-operator/4.connect-to-nebula-graph-service.md # - Self-healing: nebula-operator/5.operator-failover.md # - FAQ: nebula-operator/7.operator-faq.md diff --git a/third-party-lib-licenses.md b/third-party-lib-licenses.md index 98d69282716..9ded312389f 100644 --- a/third-party-lib-licenses.md +++ b/third-party-lib-licenses.md @@ -1,6 +1,6 @@ # Other Licenses -A list of the licenses of the libraries that are used for building Nebula Graph. +A list of the licenses of the libraries that are used for building NebulaGraph. ## libreadline