From 76be6efbce87d54690ac79cc1ddee4afe66e7348 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 3 Nov 2023 15:28:04 +0800 Subject: [PATCH] update note level --- docs-2.0-en/1.introduction/2.data-model.md | 4 ++-- .../2.meta-service.md | 2 +- .../4.storage-service.md | 8 ++++---- docs-2.0-en/14.client/3.nebula-cpp-client.md | 2 +- .../15.contribution/how-to-contribute.md | 2 +- .../2.quick-start/1.quick-start-workflow.md | 6 +++--- .../2.quick-start/4.nebula-graph-crud.md | 4 ++-- .../2.quick-start/6.cheatsheet-for-ngql.md | 4 ++-- docs-2.0-en/20.appendix/0.FAQ.md | 2 +- docs-2.0-en/20.appendix/6.eco-tool-version.md | 2 +- .../3.ngql-guide/1.nGQL-overview/1.overview.md | 2 +- .../keywords-and-reserved-words.md | 2 +- .../10.tag-statements/2.drop-tag.md | 2 +- .../10.tag-statements/6.delete-tag.md | 2 +- .../12.vertex-statements/1.insert-vertex.md | 4 ++-- .../13.edge-statements/1.insert-edge.md | 4 ++-- .../1.create-native-index.md | 2 +- .../2.show-native-indexes.md | 2 +- .../4.rebuild-native-index.md | 2 +- .../5.show-native-index-status.md | 2 +- .../14.native-index-statements/README.md | 2 +- .../.1.configs-syntax.md | 2 +- .../7.general-query-statements/2.match.md | 8 ++++---- .../6.show/8.show-indexes.md | 2 +- .../8.clauses-and-options/ttl-options.md | 2 +- .../3.ngql-guide/8.clauses-and-options/with.md | 2 +- .../9.space-statements/2.use-space.md | 2 +- .../9.space-statements/5.drop-space.md | 2 +- ...nebula-graph-by-compiling-the-source-code.md | 2 +- ...3.deploy-nebula-graph-with-docker-compose.md | 6 +++--- .../4.uninstall-nebula-graph.md | 4 ++-- .../6.deploy-text-based-index/2.deploy-es.md | 2 +- .../1.configurations/1.configurations.md | 2 +- .../1.configurations/4.storage-config.md | 2 +- .../1.authentication/1.authentication.md | 4 ++-- .../1.authentication/2.management-user.md | 2 +- docs-2.0-en/8.service-tuning/compaction.md | 2 +- docs-2.0-en/8.service-tuning/super-node.md | 2 +- docs-2.0-en/README.md | 14 +++++--------- .../backup-and-restore/3.manage-snapshot.md | 2 +- .../nebula-br/1.what-is-br.md | 4 ++-- .../nebula-br/3.br-backup-data.md | 4 ++-- .../ex-ug-para-import-command.md | 6 ++---- .../1.introduction-to-nebula-operator.md | 2 +- .../11.rolling-update-strategy.md | 2 +- .../nebula-operator/2.deploy-nebula-operator.md | 2 +- .../3.1create-cluster-with-kubectl.md | 2 +- .../3.2create-cluster-with-helm.md | 2 +- .../8.4.manage-running-logs.md | 4 ++-- .../nebula-operator/9.upgrade-nebula-cluster.md | 2 +- .../about-studio/st-ug-what-is-graph-studio.md | 4 ++-- .../quick-start/st-ug-import-data.md | 2 +- .../st-ug-config-server-errors.md | 2 +- docs-2.0-zh/1.introduction/2.data-model.md | 6 +++--- .../2.meta-service.md | 2 +- .../4.storage-service.md | 6 +++--- docs-2.0-zh/14.client/3.nebula-cpp-client.md | 2 +- .../15.contribution/how-to-contribute.md | 4 ++-- .../2.quick-start/1.quick-start-overview.md | 6 +++--- .../6.cheatsheet-for-ngql-command.md | 4 ++-- docs-2.0-zh/20.appendix/0.FAQ.md | 2 +- docs-2.0-zh/20.appendix/6.eco-tool-version.md | 2 +- .../3.ngql-guide/1.nGQL-overview/1.overview.md | 2 +- .../1.nGQL-overview/3.graph-patterns.md | 4 ++-- .../10.tag-statements/2.drop-tag.md | 2 +- .../10.tag-statements/6.delete-tag.md | 2 +- .../12.vertex-statements/1.insert-vertex.md | 2 +- .../12.vertex-statements/4.delete-vertex.md | 2 +- .../13.edge-statements/1.insert-edge.md | 4 ++-- .../1.create-native-index.md | 2 +- .../4.rebuild-native-index.md | 2 +- .../5.show-native-index-status.md | 2 +- .../14.native-index-statements/README.md | 2 +- .../1.explain-and-profile.md | 2 +- .../.1.configs-syntax.md | 2 +- .../3.data-types/4.date-and-time.md | 2 +- docs-2.0-zh/3.ngql-guide/4.job-statements.md | 2 +- .../1.composite-queries.md | 2 +- .../2.user-defined-variables.md | 2 +- .../3.property-reference.md | 2 +- .../3.ngql-guide/5.operators/1.comparison.md | 4 ++-- .../3.ngql-guide/5.operators/7.string.md | 4 ++-- .../6.functions-and-expressions/8.predicate.md | 2 +- .../7.general-query-statements/2.match.md | 6 +++--- .../7.general-query-statements/3.go.md | 4 ++-- .../6.show/14.show-stats.md | 2 +- .../6.show/8.show-indexes.md | 2 +- .../3.ngql-guide/8.clauses-and-options/limit.md | 4 ++-- .../8.clauses-and-options/ttl-options.md | 4 ++-- .../3.ngql-guide/8.clauses-and-options/with.md | 2 +- .../3.ngql-guide/8.clauses-and-options/yield.md | 2 +- .../9.space-statements/2.use-space.md | 2 +- .../9.space-statements/5.drop-space.md | 4 ++-- .../1.resource-preparations.md | 4 ++-- ...nebula-graph-by-compiling-the-source-code.md | 4 ++-- ...3.deploy-nebula-graph-with-docker-compose.md | 6 +++--- .../4.uninstall-nebula-graph.md | 4 ++-- .../6.deploy-text-based-index/2.deploy-es.md | 2 +- .../1.configurations/1.configurations.md | 2 +- .../1.configurations/2.meta-config.md | 2 +- .../1.configurations/3.graph-config.md | 2 +- .../1.configurations/4.storage-config.md | 4 ++-- .../1.query-performance-metrics.md | 2 +- .../1.authentication/1.authentication.md | 2 +- .../1.authentication/2.management-user.md | 4 ++-- .../1.authentication/3.role-list.md | 6 +++--- .../8.service-tuning/2.graph-modeling.md | 2 +- docs-2.0-zh/8.service-tuning/compaction.md | 4 ++-- docs-2.0-zh/8.service-tuning/super-node.md | 2 +- docs-2.0-zh/README.md | 17 +++++++---------- .../backup-and-restore/3.manage-snapshot.md | 4 ++-- .../nebula-br/1.what-is-br.md | 14 +++++++------- .../nebula-br/3.br-backup-data.md | 4 ++-- .../about-exchange/ex-ug-what-is-exchange.md | 2 +- .../ex-ug-para-import-command.md | 5 ++--- .../1.introduction-to-nebula-operator.md | 2 +- .../11.rolling-update-strategy.md | 2 +- .../nebula-operator/2.deploy-nebula-operator.md | 2 +- .../3.1create-cluster-with-kubectl.md | 2 +- .../3.2create-cluster-with-helm.md | 2 +- .../8.4.manage-running-logs.md | 2 +- .../nebula-operator/9.upgrade-nebula-cluster.md | 2 +- .../about-studio/st-ug-what-is-graph-studio.md | 4 ++-- .../deploy-connect/st-ug-connect.md | 2 +- .../deploy-connect/st-ug-deploy.md | 2 +- .../manage-schema/st-ug-crud-index.md | 4 ++-- .../quick-start/st-ug-create-schema.md | 4 ++-- .../quick-start/st-ug-import-data.md | 2 +- .../st-ug-config-server-errors.md | 2 +- .../troubleshooting/st-ug-connection-errors.md | 2 +- .../reuse/source_ngql_for_quick_start.md | 12 ++++++------ 131 files changed, 208 insertions(+), 218 deletions(-) diff --git a/docs-2.0-en/1.introduction/2.data-model.md b/docs-2.0-en/1.introduction/2.data-model.md index 6ac70153ba2..6b32ddf8875 100644 --- a/docs-2.0-en/1.introduction/2.data-model.md +++ b/docs-2.0-en/1.introduction/2.data-model.md @@ -30,7 +30,7 @@ NebulaGraph data model uses six data structures to store data. They are graph sp - **Properties**: Properties are key-value pairs. Both vertices and edges are containers for properties. -!!! Note +!!! note Tags and Edge types are similar to "vertex tables" and "edge tables" in the relational databases. @@ -54,7 +54,7 @@ The following table is an example of the structure of the basketball player data | Edge type | **serve** | start_year (int)
end_year (int) | Represents actions taken by players in the team.
An action links a player with a team, and the direction is from a player to a team. | | Edge type | **follow** | degree (int) | Represents actions taken by players in the team.
An action links a player with another player, and the direction is from one player to the other player. | -!!! Note +!!! note NebulaGraph supports only directed edges. diff --git a/docs-2.0-en/1.introduction/3.nebula-graph-architecture/2.meta-service.md b/docs-2.0-en/1.introduction/3.nebula-graph-architecture/2.meta-service.md index 8cfce5a8179..88215b3ddfe 100644 --- a/docs-2.0-en/1.introduction/3.nebula-graph-architecture/2.meta-service.md +++ b/docs-2.0-en/1.introduction/3.nebula-graph-architecture/2.meta-service.md @@ -17,7 +17,7 @@ All the nebula-metad processes form a Raft-based cluster, with one process as th 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 +!!! note The data of the leader and the followers will keep consistent through Raft. Thus the breakdown and election of the leader will not cause data inconsistency. For more information on Raft, see [Storage service architecture](4.storage-service.md#raft). diff --git a/docs-2.0-en/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0-en/1.introduction/3.nebula-graph-architecture/4.storage-service.md index 31bb519088f..348073fb2ad 100644 --- a/docs-2.0-en/1.introduction/3.nebula-graph-architecture/4.storage-service.md +++ b/docs-2.0-en/1.introduction/3.nebula-graph-architecture/4.storage-service.md @@ -66,7 +66,7 @@ Therefore, NebulaGraph develops its own KVStore with RocksDB as the local storag - 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 + !!! note NebulaGraph does not support auto load balancing because auto data transfer will affect online business. @@ -143,7 +143,7 @@ Like EdgeA_Out and EdgeA_In, NebulaGraph redundantly stores the information of e 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 +!!! 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. @@ -189,7 +189,7 @@ In a distributed system, one data usually has multiple replicas so that the syst Basic principle: Raft is designed to ensure consistency between replicas. Raft uses election between replicas, and the (candidate) replica that wins more than half of the votes will become the Leader, providing external services on behalf of all replicas. The rest Followers will play backups. When the Leader fails (due to communication failure, operation and maintenance commands, etc.), the rest Followers will conduct a new round of elections and vote for a new Leader. The Leader and Followers will detect each other's survival through heartbeats and write them to the hard disk in Raft-wal mode. Replicas that do not respond to more than multiple heartbeats will be considered faulty. -!!! Note +!!! note Raft-wal needs to be written into the hard disk periodically. If hard disk bottlenecks to write, Raft will fail to send a heartbeat and conduct a new round of elections. If the hard disk IO is severely blocked, there will be no Leader for a long time. @@ -197,7 +197,7 @@ Read and write: For every writing request of the clients, the Leader will initia Failure: Scenario 1: Take a (space) cluster of a single replica as an example. If the system has only one replica, the Leader will be itself. If failure happens, the system will be completely unavailable. Scenario 2: Take a (space) cluster of three replicas as an example. If the system has three replicas, one of them will be the Leader and the rest will be the Followers. If the Leader fails, the rest two can still vote for a new Leader (and a Follower), and the system is still available. But if any of the two Followers fails again, the system will be completely unavailable due to inadequate voters. -!!! Note +!!! note Raft and HDFS have different modes of duplication. Raft is based on a quorum vote, so the number of replicas cannot be even. diff --git a/docs-2.0-en/14.client/3.nebula-cpp-client.md b/docs-2.0-en/14.client/3.nebula-cpp-client.md index 13a94bf73ce..4962067f4b0 100644 --- a/docs-2.0-en/14.client/3.nebula-cpp-client.md +++ b/docs-2.0-en/14.client/3.nebula-cpp-client.md @@ -49,7 +49,7 @@ This document describes how to install NebulaGraph CPP with the source code. 4. Generate the `makefile` file with CMake. - !!! Note + !!! note The default installation path is `/usr/local/nebula`. To modify it, add the `-DCMAKE_INSTALL_PREFIX=` option while running the following command. diff --git a/docs-2.0-en/15.contribution/how-to-contribute.md b/docs-2.0-en/15.contribution/how-to-contribute.md index 4912db2f804..1dcb6b2fca3 100644 --- a/docs-2.0-en/15.contribution/how-to-contribute.md +++ b/docs-2.0-en/15.contribution/how-to-contribute.md @@ -133,7 +133,7 @@ The NebulaGraph project has many [repositories](https://github.com/vesoft-inc). 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 + !!! note Make sure you have enabled the building of unit tests by setting `-DENABLE_TESTING=ON`. diff --git a/docs-2.0-en/2.quick-start/1.quick-start-workflow.md b/docs-2.0-en/2.quick-start/1.quick-start-workflow.md index e468cbd8dda..098e823cc0f 100644 --- a/docs-2.0-en/2.quick-start/1.quick-start-workflow.md +++ b/docs-2.0-en/2.quick-start/1.quick-start-workflow.md @@ -66,7 +66,7 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke $ git clone -b {{dockercompose.branch}} https://github.com/vesoft-inc/nebula-docker-compose.git ``` - !!! Note + !!! note The `x.y` version of Docker Compose aligns to the `x.y` version of NebulaGraph. For the NebulaGraph `z` version, Docker Compose does not publish the corresponding `z` version, but pulls the `z` version of the NebulaGraph image. @@ -79,7 +79,7 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke 3. Run the following command to start all the NebulaGraph services. - !!! Note + !!! note - Update the [NebulaGraph images](#how_to_upgrade_or_update_the_docker_images_of_nebulagraph_services) and [NebulaGraph Console images](#how_to_update_the_nebulagraph_console_client) first if they are out of date. - The return result after executing the command varies depending on the installation directory. @@ -137,7 +137,7 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke / # ./usr/local/bin/nebula-console -u -p --address=graphd --port=9669 ``` - !!! Note + !!! note By default, the authentication is off, you can only log in with an existing username (the default is `root`) and any password. To turn it on, see [Enable authentication](../7.data-security/1.authentication/1.authentication.md). diff --git a/docs-2.0-en/2.quick-start/4.nebula-graph-crud.md b/docs-2.0-en/2.quick-start/4.nebula-graph-crud.md index 4c65c8c0ec4..fdc85849f6d 100644 --- a/docs-2.0-en/2.quick-start/4.nebula-graph-crud.md +++ b/docs-2.0-en/2.quick-start/4.nebula-graph-crud.md @@ -372,7 +372,7 @@ nebula> FETCH PROP ON player "player100" YIELD properties(vertex); +-------------------------------+ ``` -!!! Note +!!! note The examples of `LOOKUP` and `MATCH` statements are in [indexes](#about_indexes). @@ -382,7 +382,7 @@ Users can use the `UPDATE` or the `UPSERT` statements to update existing data. `UPSERT` is the combination of `UPDATE` and `INSERT`. If you update a vertex or an edge with `UPSERT`, the database will insert a new vertex or edge if it does not exist. -!!! Note +!!! note `UPSERT` operates serially in a partition-based order. Therefore, it is slower than `INSERT` OR `UPDATE`. And `UPSERT` has concurrency only between multiple partitions. diff --git a/docs-2.0-en/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0-en/2.quick-start/6.cheatsheet-for-ngql.md index c023829853e..7b70daeb2a2 100644 --- a/docs-2.0-en/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0-en/2.quick-start/6.cheatsheet-for-ngql.md @@ -408,11 +408,11 @@ | `SIGN IN TEXT SERVICE [( [,, ]), (), ...]` | `SIGN IN TEXT SERVICE (127.0.0.1:9200)` | The full-text indexes is implemented based on [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch). After deploying an Elasticsearch cluster, you can use the `SIGN IN` statement to log in to the Elasticsearch client. | | `SHOW TEXT SEARCH CLIENTS` | `SHOW TEXT SEARCH CLIENTS` | Shows text search clients. | | `SIGN OUT TEXT SERVICE` | `SIGN OUT TEXT SERVICE` |Signs out to the text search clients. | - | `CREATE FULLTEXT {TAG | EDGE} INDEX ON { | } ([])` | `CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name)` | Creates full-text indexes. | + | `CREATE FULLTEXT {TAG | EDGE} INDEX ON { | } ( [,]...) [ANALYZER=""]` | `CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name)` | Creates full-text indexes. | | `SHOW FULLTEXT INDEXES` | `SHOW FULLTEXT INDEXES` | Show full-text indexes. | | `REBUILD FULLTEXT INDEX` | `REBUILD FULLTEXT INDEX` | Rebuild full-text indexes. | | `DROP FULLTEXT INDEX ` | `DROP FULLTEXT INDEX nebula_index_1` | Drop full-text indexes. | - | `LOOKUP ON { | } WHERE [YIELD ]` | `LOOKUP ON player WHERE FUZZY(player.name, "Tim Dunncan", AUTO, OR) YIELD player.name` | Use query options. | + | `LOOKUP ON { | } WHERE ES_QUERY(, "") YIELD [| LIMIT [,] ]` | `LOOKUP ON player WHERE ES_QUERY(fulltext_index_1,"Chris") YIELD id(vertex)` | Use query options. | ## Subgraph and path statements diff --git a/docs-2.0-en/20.appendix/0.FAQ.md b/docs-2.0-en/20.appendix/0.FAQ.md index c12cbd7d366..ff146d7bf4e 100644 --- a/docs-2.0-en/20.appendix/0.FAQ.md +++ b/docs-2.0-en/20.appendix/0.FAQ.md @@ -569,7 +569,7 @@ You can use telnet as follows to check for port status. telnet ``` -!!! Note +!!! note If you cannot use the telnet command, check if telnet is installed or enabled on your host. diff --git a/docs-2.0-en/20.appendix/6.eco-tool-version.md b/docs-2.0-en/20.appendix/6.eco-tool-version.md index 261938af3c1..b22239f4ccf 100644 --- a/docs-2.0-en/20.appendix/6.eco-tool-version.md +++ b/docs-2.0-en/20.appendix/6.eco-tool-version.md @@ -6,7 +6,7 @@ NebulaGraph Studio (Studio for short) is a graph database visualization tool that can be accessed through the Web. It can be used with NebulaGraph DBMS to provide one-stop services such as composition, data import, writing nGQL queries, and graph exploration. For details, see [What is NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md). -!!! Note +!!! note The release of the Studio is independent of NebulaGraph core, and its naming method is also not the same as the core naming rules. diff --git a/docs-2.0-en/3.ngql-guide/1.nGQL-overview/1.overview.md b/docs-2.0-en/3.ngql-guide/1.nGQL-overview/1.overview.md index df000ce493f..51bebc55a67 100644 --- a/docs-2.0-en/3.ngql-guide/1.nGQL-overview/1.overview.md +++ b/docs-2.0-en/3.ngql-guide/1.nGQL-overview/1.overview.md @@ -77,7 +77,7 @@ Native nGQL is the part of a graph query language designed and implemented by Ne The latest release is openCypher 9. The compatible parts of openCypher in nGQL are called openCypher compatible sentences (short as openCypher). -!!! Note +!!! note `nGQL` = `native nGQL` + `openCypher compatible sentences` diff --git a/docs-2.0-en/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md b/docs-2.0-en/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md index b05daa847e3..e3e96e1e85d 100644 --- a/docs-2.0-en/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md +++ b/docs-2.0-en/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md @@ -11,7 +11,7 @@ It is not recommended to use keywords to identify schemas. If you must use keywo - If the identifier contains any uppercase letter, you must enclose them with backticks (\`), such as \`Comment\`. Otherwise, the execution succeeds but the system automatically converts the identifier to all lowercase. - If the identifier contains all lowercase letters, you do not need to enclose them with backticks (\`). -!!! Note +!!! note Keywords are case-insensitive. diff --git a/docs-2.0-en/3.ngql-guide/10.tag-statements/2.drop-tag.md b/docs-2.0-en/3.ngql-guide/10.tag-statements/2.drop-tag.md index fe0e288649f..1d1fca80c5c 100644 --- a/docs-2.0-en/3.ngql-guide/10.tag-statements/2.drop-tag.md +++ b/docs-2.0-en/3.ngql-guide/10.tag-statements/2.drop-tag.md @@ -10,7 +10,7 @@ A vertex can have one or more tags. This operation only deletes the Schema data. All the files or directories in the disk will not be deleted directly until the next compaction. -!!! Compatibility +!!! compatibility In NebulaGraph {{nebula.release}}, inserting vertex without tag is not supported by default. If you want to use the vertex without tags, add `--graph_use_vertex_key=true` to the configuration files (`nebula-graphd.conf`) of all Graph services in the cluster, and add `--use_vertex_key=true` to the configuration files (`nebula-storaged.conf`) of all Storage services in the cluster. diff --git a/docs-2.0-en/3.ngql-guide/10.tag-statements/6.delete-tag.md b/docs-2.0-en/3.ngql-guide/10.tag-statements/6.delete-tag.md index f098b4e328a..6bb661b4a59 100644 --- a/docs-2.0-en/3.ngql-guide/10.tag-statements/6.delete-tag.md +++ b/docs-2.0-en/3.ngql-guide/10.tag-statements/6.delete-tag.md @@ -43,7 +43,7 @@ nebula> FETCH PROP ON * "test" YIELD vertex AS v; +---+ ``` -!!! Compatibility +!!! compatibility * In openCypher, you can use the statement `REMOVE v:LABEL` to delete the tag `LABEL` of the vertex `v`. * `DELETE TAG` and `DROP TAG` have the same semantics but different syntax. In nGQL, use `DELETE TAG`. diff --git a/docs-2.0-en/3.ngql-guide/12.vertex-statements/1.insert-vertex.md b/docs-2.0-en/3.ngql-guide/12.vertex-statements/1.insert-vertex.md index 527161b8303..3fef110cdd1 100644 --- a/docs-2.0-en/3.ngql-guide/12.vertex-statements/1.insert-vertex.md +++ b/docs-2.0-en/3.ngql-guide/12.vertex-statements/1.insert-vertex.md @@ -46,7 +46,7 @@ prop_value_list: - `IF NOT EXISTS` detects if the VID that you want to insert exists. If it does not exist, a new one will be inserted. - !!! Note + !!! note - `IF NOT EXISTS` only compares the names of the VID and the tag (excluding properties). - `IF NOT EXISTS` will read to check whether the data exists, which will have a significant impact on performance. @@ -57,7 +57,7 @@ prop_value_list: NebulaGraph {{ nebula.release }} supports inserting vertices without tags. - !!! Compatibility + !!! compatibility In NebulaGraph {{nebula.release}}, inserting vertex without tag is not supported by default. If you want to use the vertex without tags, add `--graph_use_vertex_key=true` to the configuration files (`nebula-graphd.conf`) of all Graph services in the cluster, add `--use_vertex_key=true` to the configuration files (`nebula-storaged.conf`) of all Storage services in the cluster. An example of a command to insert a vertex without tag is `INSERT VERTEX VALUES "1":();`. diff --git a/docs-2.0-en/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0-en/3.ngql-guide/13.edge-statements/1.insert-edge.md index 49c253e0972..d39cd11ea5a 100644 --- a/docs-2.0-en/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0-en/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -20,7 +20,7 @@ INSERT EDGE [IF NOT EXISTS] ( ) VALUES - `IF NOT EXISTS` detects if the edge that you want to insert exists. If it does not exist, a new one will be inserted. - !!! Note + !!! note - `IF NOT EXISTS` only detects whether exist and does not detect whether the property values overlap. - `IF NOT EXISTS` will read to check whether the data exists, which will have a significant impact on performance. @@ -94,7 +94,7 @@ nebula> FETCH PROP ON e2 "14"->"15"@1 YIELD edge AS e; +-------------------------------------------+ ``` -!!! Note +!!! note * 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. For example, if multiple machines are involved in the write operation, only one of the forward and reverse edges of a single edge is written successfully, or only part of the edge is written successfully when multiple edges are inserted. In this case, an error will be returned, so please execute the command again. diff --git a/docs-2.0-en/3.ngql-guide/14.native-index-statements/1.create-native-index.md b/docs-2.0-en/3.ngql-guide/14.native-index-statements/1.create-native-index.md index abf1529f82a..968fefb156b 100644 --- a/docs-2.0-en/3.ngql-guide/14.native-index-statements/1.create-native-index.md +++ b/docs-2.0-en/3.ngql-guide/14.native-index-statements/1.create-native-index.md @@ -45,7 +45,7 @@ If you must use indexes, we suggest that you: 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 +!!! note If you create an index before importing the data, the importing speed will be extremely slow due to the reduction in the write performance. diff --git a/docs-2.0-en/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md b/docs-2.0-en/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md index 81066829007..bf329b14935 100644 --- a/docs-2.0-en/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md +++ b/docs-2.0-en/3.ngql-guide/14.native-index-statements/2.show-native-indexes.md @@ -28,6 +28,6 @@ nebula> SHOW EDGE INDEXES; +----------------+----------+---------+ ``` -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" In NebulaGraph 2.x, the `SHOW TAG/EDGE INDEXES` statement only returns `Names`. diff --git a/docs-2.0-en/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md b/docs-2.0-en/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md index bd8c85446d6..1ed0e00ddbd 100644 --- a/docs-2.0-en/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md +++ b/docs-2.0-en/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md @@ -7,7 +7,7 @@ You can use `REBUILD INDEX` to rebuild the created tag or edge type index. For details on how to create an index, see [CREATE INDEX](1.create-native-index.md). -!!! performance +!!! caution The speed of rebuilding indexes can be optimized by modifying the `rebuild_index_part_rate_limit` and `snapshot_batch_size` parameters in the configuration file. In addition, greater parameter values may result in higher memory and network usage, see [Storage Service configurations](../../5.configurations-and-logs/1.configurations/4.storage-config.md#misc_configurations) for details. diff --git a/docs-2.0-en/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md b/docs-2.0-en/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md index 1d50bc5d158..0fda901b5c4 100644 --- a/docs-2.0-en/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md +++ b/docs-2.0-en/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md @@ -11,7 +11,7 @@ The status of rebuilding indexes includes: - `STOPPED`: The job has stopped. - `INVALID`: The job is invalid. -!!! Note +!!! note For details on how to create an index, see [CREATE INDEX](1.create-native-index.md). diff --git a/docs-2.0-en/3.ngql-guide/14.native-index-statements/README.md b/docs-2.0-en/3.ngql-guide/14.native-index-statements/README.md index 457ad13bdb4..b22b7b93d31 100644 --- a/docs-2.0-en/3.ngql-guide/14.native-index-statements/README.md +++ b/docs-2.0-en/3.ngql-guide/14.native-index-statements/README.md @@ -53,7 +53,7 @@ Full-text indexes are used to do prefix, wildcard, regexp, and fuzzy search on a - Full-text indexes do not support logical operations such as `AND`, `OR`, and `NOT`. -!!! Note +!!! note To do complete string matches, use native indexes. diff --git a/docs-2.0-en/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md b/docs-2.0-en/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md index cee7bf40db3..f2bc43db3ed 100644 --- a/docs-2.0-en/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md +++ b/docs-2.0-en/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md @@ -2,7 +2,7 @@ When you start the NebulaGraph cluster for the first time, the system reads the configuration from the local and saves it in the Meta service. After restarting the cluster, it will also read the configuration from the Meta service. The `CONFIG` statement can modify the NebulaGraph configuration saved in the Meta service without modifying your local files. -!!! Note +!!! note According to past practice, we suggest you fetch the configuration from the local. For details, see [Configuration](../../5.configurations-and-logs/1.configurations/1.configurations.md#Modify configurations). diff --git a/docs-2.0-en/3.ngql-guide/7.general-query-statements/2.match.md b/docs-2.0-en/3.ngql-guide/7.general-query-statements/2.match.md index 65f903b585e..616eb1d10db 100644 --- a/docs-2.0-en/3.ngql-guide/7.general-query-statements/2.match.md +++ b/docs-2.0-en/3.ngql-guide/7.general-query-statements/2.match.md @@ -96,7 +96,7 @@ nebula> MATCH (v:player:actor) \ ### Match vertex properties -!!! Note +!!! note The prerequisite for matching a vertex property is that the tag itself has an index of the corresponding property. Otherwise, you cannot execute the `MATCH` statement to match the property. @@ -342,7 +342,7 @@ nebula> MATCH ()-[e:follow]->() \ ### Match edge type properties -!!! Note +!!! note The prerequisite for matching an edge type property is that the edge type itself has an index of the corresponding property. Otherwise, you cannot execute the `MATCH` statement to match the property. @@ -439,7 +439,7 @@ nebula> MATCH (v:player{name:"Tim Duncan"}) -[*0]-> (v2) \ +----------------------------------------------------+ ``` -!!! Note +!!! note When you conditionally filter on multi-hop edges, such as `-[e:follow*2]->`, note that the `e` is a list of edges instead of a single edge. @@ -634,6 +634,6 @@ nebula> MATCH (m)-[]->(n) WHERE id(m)=="player100" \ See [OPTIONAL MATCH](optional-match.md). -!!! Performance +!!! caution 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-en/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md index eb3372ee4ed..10ae211fba1 100644 --- a/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md +++ b/docs-2.0-en/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md @@ -27,6 +27,6 @@ nebula> SHOW EDGE INDEXES; +----------------+----------+---------+ ``` -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" In NebulaGraph 2.x, `SHOW TAG/EDGE INDEXES` only returns `Names`. diff --git a/docs-2.0-en/3.ngql-guide/8.clauses-and-options/ttl-options.md b/docs-2.0-en/3.ngql-guide/8.clauses-and-options/ttl-options.md index bc2b7566ecc..a8fa9f4e6e1 100644 --- a/docs-2.0-en/3.ngql-guide/8.clauses-and-options/ttl-options.md +++ b/docs-2.0-en/3.ngql-guide/8.clauses-and-options/ttl-options.md @@ -25,7 +25,7 @@ The native nGQL TTL feature has the following options. |`ttl_col`|Specifies an existing property to set a lifespan on. The data type of the property must be `int` or `timestamp`.| |`ttl_duration`|Specifies the timeout adds-on value in seconds. The value must be a non-negative int64 number. A property expires if the sum of its value and the `ttl_duration` value is smaller than the current timestamp. If the `ttl_duration` value is `0`, the property never expires.
You can set `ttl_use_ms` to `true` in the configuration file `nebula-storaged.conf` (default path: `/usr/local/nightly/etc/`) to set the default unit to milliseconds.| -!!! caution +!!! warning - Before setting `ttl_use_ms` to `true`, make sure that no TTL has been set for any property, as shortening the expiration time may cause data to be erroneously deleted. diff --git a/docs-2.0-en/3.ngql-guide/8.clauses-and-options/with.md b/docs-2.0-en/3.ngql-guide/8.clauses-and-options/with.md index 96bc00ac7b7..fa29452c227 100644 --- a/docs-2.0-en/3.ngql-guide/8.clauses-and-options/with.md +++ b/docs-2.0-en/3.ngql-guide/8.clauses-and-options/with.md @@ -6,7 +6,7 @@ The `WITH` clause can retrieve the output from a query part, process it, and pas This topic applies to openCypher syntax only. -!!! Note +!!! note `WITH` has a similar function with the [Pipe](../5.operators/4.pipe.md) symbol in native nGQL, but they work in different ways. DO NOT use pipe symbols in the openCypher syntax or use `WITH` in native nGQL statements. diff --git a/docs-2.0-en/3.ngql-guide/9.space-statements/2.use-space.md b/docs-2.0-en/3.ngql-guide/9.space-statements/2.use-space.md index 9ca11300d71..d5c27e4719c 100644 --- a/docs-2.0-en/3.ngql-guide/9.space-statements/2.use-space.md +++ b/docs-2.0-en/3.ngql-guide/9.space-statements/2.use-space.md @@ -26,7 +26,7 @@ nebula> USE space1; nebula> USE space2; ``` -!!! Caution +!!! caution You cannot use two graph spaces in one statement. diff --git a/docs-2.0-en/3.ngql-guide/9.space-statements/5.drop-space.md b/docs-2.0-en/3.ngql-guide/9.space-statements/5.drop-space.md index 3dd480dc87f..3af3c129a06 100644 --- a/docs-2.0-en/3.ngql-guide/9.space-statements/5.drop-space.md +++ b/docs-2.0-en/3.ngql-guide/9.space-statements/5.drop-space.md @@ -26,7 +26,7 @@ You can use the `IF EXISTS` keywords when dropping spaces. These keywords automa In NebulaGraph versions earlier than 3.1.0, the `DROP SPACE` statement does not remove all the files and directories from the disk by default. -!!! caution +!!! danger **BE CAUTIOUS** about running the `DROP SPACE` statement. diff --git a/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md b/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md index eb3111419e6..a7b7c1829f1 100644 --- a/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md +++ b/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md @@ -56,7 +56,7 @@ Installing NebulaGraph from the source code allows you to customize the compilin 5. Compile NebulaGraph. - !!! Note + !!! note Check [Prepare resources for compiling, installing, and running NebulaGraph](../1.resource-preparations.md). diff --git a/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md index 4acc0e3d358..4cfc243447e 100644 --- a/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md +++ b/docs-2.0-en/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md @@ -31,7 +31,7 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar $ git clone -b {{dockercompose.branch}} https://github.com/vesoft-inc/nebula-docker-compose.git ``` - !!! Note + !!! note The `x.y` version of Docker Compose aligns to the `x.y` version of NebulaGraph. For the NebulaGraph `z` version, Docker Compose does not publish the corresponding `z` version, but pulls the `z` version of the NebulaGraph image. @@ -44,7 +44,7 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar 3. Run the following command to start all the NebulaGraph services. - !!! Note + !!! note - Update the [NebulaGraph images](#how_to_upgrade_or_update_the_docker_images_of_nebulagraph_services) and [NebulaGraph Console images](#how_to_update_the_nebulagraph_console_client) first if they are out of date. - The return result after executing the command varies depending on the installation directory. @@ -102,7 +102,7 @@ There are two ways to connect to NebulaGraph: / # ./usr/local/bin/nebula-console -u -p --address=graphd --port=9669 ``` - !!! Note + !!! note By default, the authentication is off, you can only log in with an existing username (the default is `root`) and any password. To turn it on, see [Enable authentication](../../7.data-security/1.authentication/1.authentication.md). diff --git a/docs-2.0-en/4.deployment-and-installation/4.uninstall-nebula-graph.md b/docs-2.0-en/4.deployment-and-installation/4.uninstall-nebula-graph.md index cecdb7187ef..a072b002226 100644 --- a/docs-2.0-en/4.deployment-and-installation/4.uninstall-nebula-graph.md +++ b/docs-2.0-en/4.deployment-and-installation/4.uninstall-nebula-graph.md @@ -14,7 +14,7 @@ The NebulaGraph services should be stopped before the uninstallation. For more i 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 +!!! note For a NebulaGraph cluster, delete the data files of all Storage and Meta servers. @@ -33,7 +33,7 @@ If you have modified the `data_path` in the configuration files for the Meta Ser ## Step 2: Delete the installation directories -!!! Note +!!! note Delete all installation directories, including the `cluster.id` file in them. diff --git a/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md b/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md index 17f3c390803..2240399390f 100644 --- a/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md +++ b/docs-2.0-en/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md @@ -32,7 +32,7 @@ SIGN IN TEXT SERVICE (, {HTTP | HTTPS} [,"", " SIGN IN TEXT SERVICE (192.168.8.100:9200, HTTP); ``` -!!! Note +!!! note Elasticsearch does not have a username or password by default. If you configured a username and password, you need to specify them in the `SIGN IN` statement. diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md index e57d37d8a97..d27f72ca49c 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/1.configurations.md @@ -57,7 +57,7 @@ Utilizing the `-s` or `-silent option allows for the concealment of the progress curl -s 127.0.0.1:19559/flags ``` -!!! Note +!!! note In an actual environment, use the real host IP address instead of `127.0.0.1` in the above example. diff --git a/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md index 97b98df6155..331e4ca79b7 100644 --- a/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0-en/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -19,7 +19,7 @@ If a parameter is not set in the configuration file, NebulaGraph uses the defaul Some parameter values in the configuration file can be dynamically modified during runtime. We label these parameters as **Yes** that supports runtime dynamic modification in this article. When the `local_config` value is set to `true`, the dynamically modified configuration is not persisted, and the configuration will be restored to the initial configuration after the service is restarted. For more information, see [Modify configurations](1.configurations.md). -!!! Note +!!! note The configurations of the Raft Listener and the Storage service are different. For details, see [Deploy Raft listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md). diff --git a/docs-2.0-en/7.data-security/1.authentication/1.authentication.md b/docs-2.0-en/7.data-security/1.authentication/1.authentication.md index 749f6a98d37..39166f19f4b 100644 --- a/docs-2.0-en/7.data-security/1.authentication/1.authentication.md +++ b/docs-2.0-en/7.data-security/1.authentication/1.authentication.md @@ -4,7 +4,7 @@ NebulaGraph replies on local authentication authentication to implement access c 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 +!!! note By default, the authentication is disabled and NebulaGraph allows connections with the username `root` and any password. @@ -18,7 +18,7 @@ Local authentication indicates that usernames and passwords are stored locally o - `--enable_authorize`: Set its value to `true` to enable authentication. - !!! Note + !!! note - By default, the authentication is disabled and NebulaGraph allows connections with the username `root` and any password. - 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). diff --git a/docs-2.0-en/7.data-security/1.authentication/2.management-user.md b/docs-2.0-en/7.data-security/1.authentication/2.management-user.md index 7ce5dd970e0..ec7aa3a6128 100644 --- a/docs-2.0-en/7.data-security/1.authentication/2.management-user.md +++ b/docs-2.0-en/7.data-security/1.authentication/2.management-user.md @@ -4,7 +4,7 @@ User management is an indispensable part of NebulaGraph access control. This top 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 +!!! note * 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. diff --git a/docs-2.0-en/8.service-tuning/compaction.md b/docs-2.0-en/8.service-tuning/compaction.md index 9b5c50eb5d2..de45c84b9b7 100644 --- a/docs-2.0-en/8.service-tuning/compaction.md +++ b/docs-2.0-en/8.service-tuning/compaction.md @@ -6,7 +6,7 @@ In NebulaGraph, `Compaction` is the most important background process and has an `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. -!!! Note +!!! note Note that `compaction` leads to long-time hard disk IO. We suggest that users do compaction during off-peak hours (for example, early morning). diff --git a/docs-2.0-en/8.service-tuning/super-node.md b/docs-2.0-en/8.service-tuning/super-node.md index e2a67b48f75..aff76799b70 100644 --- a/docs-2.0-en/8.service-tuning/super-node.md +++ b/docs-2.0-en/8.service-tuning/super-node.md @@ -12,7 +12,7 @@ Therefore, `directed traversals from this vertex` and `directed traversals endin As a rule of thumb, a vertex is considered dense when the number of its edges exceeds 10,000. Some special cases require additional consideration. -!!! Note +!!! note 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. diff --git a/docs-2.0-en/README.md b/docs-2.0-en/README.md index 28ed97f551b..0744a38d69f 100644 --- a/docs-2.0-en/README.md +++ b/docs-2.0-en/README.md @@ -45,19 +45,15 @@ This manual has over 80 compatibilities and corresponding tips. !!! caution - Cautions that need strict observation. If not, systematic breakdown, data loss, and security issues may happen. + May have adverse effects, such as causing performance degradation or triggering known minor problems. -!!! danger - - Operations that may cause danger. If not observed, systematic breakdown, data loss, and security issues will happen. +!!! warning -!!! performance + May lead to serious issues, such as data loss or system crash. - Operations that merit attention as for performance enhancement. - -!!! faq +!!! danger - Frequently asked questions. + May lead to extremely serious issues, such as system damage or information leakage. !!! compatibility diff --git a/docs-2.0-en/backup-and-restore/3.manage-snapshot.md b/docs-2.0-en/backup-and-restore/3.manage-snapshot.md index da040edc691..3372435760e 100644 --- a/docs-2.0-en/backup-and-restore/3.manage-snapshot.md +++ b/docs-2.0-en/backup-and-restore/3.manage-snapshot.md @@ -107,7 +107,7 @@ Currently, there is no command to restore data with snapshots. You need to manua 2. To restore the lost data through snapshots, you can take a snapshot at an appropriate time, copy the folders `data` and `wal` in the corresponding snapshot directory to its parent directory (at the same level with `checkpoints`) to overwrite the previous `data` and `wal`, and then restart the cluster. - !!! caution + !!! warning The data and wal directories of all Meta servers should be overwritten at the same time. Otherwise, the new leader Meta server will use the latest Meta data after a cluster is restarted. diff --git a/docs-2.0-en/backup-and-restore/nebula-br/1.what-is-br.md b/docs-2.0-en/backup-and-restore/nebula-br/1.what-is-br.md index 270b75cbd6f..69b666a313b 100644 --- a/docs-2.0-en/backup-and-restore/nebula-br/1.what-is-br.md +++ b/docs-2.0-en/backup-and-restore/nebula-br/1.what-is-br.md @@ -42,7 +42,7 @@ To back up data, the BR sends a backup request to the leader metad process to tr 1. The SSH login from the BR machine to the meta and the storage servers is verified. - !!! Note + !!! note Besides, if a remote storage system such as Amazon S3 or Alibaba Cloud OSS is necessary, their client installation and configuration are verified. @@ -113,7 +113,7 @@ The restoration process is implemented as follows: 1. The SSH login from the BR to the meta and the storage servers is verified. - !!! Note + !!! note Besides, if a cloud storage system such as Amazon S3 or Alibaba Cloud OSS is necessary, their client installation and configuration are verified. diff --git a/docs-2.0-en/backup-and-restore/nebula-br/3.br-backup-data.md b/docs-2.0-en/backup-and-restore/nebula-br/3.br-backup-data.md index bbbdbe39ce1..8d35eecd985 100644 --- a/docs-2.0-en/backup-and-restore/nebula-br/3.br-backup-data.md +++ b/docs-2.0-en/backup-and-restore/nebula-br/3.br-backup-data.md @@ -12,7 +12,7 @@ To back up data with the BR, do a check of these: - If you store the backup files locally, create a directory with the same absolute path on the meta servers, the storage servers, and the BR machine for the backup files and get the absolute path. Make sure the account has write privileges for this directory. - !!! note + !!! warning In the production environment, we recommend that you mount Network File System (NFS) storage to the meta servers, the storage servers, and the BR machine for local backup, or use Amazon S3 or Alibaba Cloud OSS for remote backup. When you restore the data from local files, you must manually move these backup files to a specified directory, which causes redundant data and troubles. For more information, see [Restore data from backup files](4.br-restore-data.md). @@ -20,7 +20,7 @@ To back up data with the BR, do a check of these: In the BR installation directory (the default path of the compiled BR is `./bin/br`), run the following command to perform a full backup for the entire cluster. -!!! Note +!!! note Make sure that the local path where the backup file is stored exists. diff --git a/docs-2.0-en/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md b/docs-2.0-en/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md index daa9cbb8546..6431bf9d4b7 100644 --- a/docs-2.0-en/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md +++ b/docs-2.0-en/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md @@ -18,11 +18,9 @@ After editing the configuration file, run the following commands to import speci !!! note - The version number of a JAR file is subject to the name of the JAR file that is actually compiled. + - The version number of a JAR file is subject to the name of the JAR file that is actually compiled. -!!! faq - - If users use the [yarn-cluster mode](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html) to submit a job, see the following command, **especially the two '--conf' commands in the example**. + - If users use the [yarn-cluster mode](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html) to submit a job, see the following command, **especially the two '--conf' commands in the example**. ```bash $SPARK_HOME/bin/spark-submit --master yarn-cluster \ diff --git a/docs-2.0-en/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0-en/nebula-operator/1.introduction-to-nebula-operator.md index 5b177c13c3c..8671ad2f4c6 100644 --- a/docs-2.0-en/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0-en/nebula-operator/1.introduction-to-nebula-operator.md @@ -38,7 +38,7 @@ NebulaGraph Operator does not support the v1.x version of NebulaGraph. NebulaGra | 2.5.x ~ 2.6.x | 0.9.0 | | 2.5.x | 0.8.0 | -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" - The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x. - Starting from NebulaGraph Operator 0.9.0, logs and data are stored separately. Using NebulaGraph Operator 0.9.0 or later versions to manage a NebulaGraph 2.5.x cluster created with Operator 0.8.0 can cause compatibility issues. You can backup the data of the NebulaGraph 2.5.x cluster and then create a 2.6.x cluster with Operator 0.9.0. diff --git a/docs-2.0-en/nebula-operator/11.rolling-update-strategy.md b/docs-2.0-en/nebula-operator/11.rolling-update-strategy.md index 8dea20c348c..80514e02ef4 100644 --- a/docs-2.0-en/nebula-operator/11.rolling-update-strategy.md +++ b/docs-2.0-en/nebula-operator/11.rolling-update-strategy.md @@ -19,7 +19,7 @@ In the YAML file for creating a cluster instance, add the `spec.storaged.enableF When `enableForceUpdate` is set to `true`, it means that the partition leader replicas will not be migrated, thus speeding up the rolling update process. Conversely, when set to `false`, it means that the leader replicas will be migrated to other nodes to ensure the read and write availability of the cluster. The default value is `false`. -!!! caution +!!! warning When setting `enableForceUpdate` to `true`, make sure there is no traffic entering the cluster for read and write operations. This is because this setting will force the cluster pods to be rebuilt, and during this process, data loss or client request failures may occur. diff --git a/docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md b/docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md index 36ea5062475..4b5e5da0591 100644 --- a/docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md +++ b/docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md @@ -175,7 +175,7 @@ For more information about `helm install`, see [Helm Install](https://helm.sh/do ### Upgrade NebulaGraph Operator -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" - Does not support upgrading 0.9.0 and below version NebulaGraph Operator to 1.x. - The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x. diff --git a/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md b/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md index 8ecfda885e7..18ce95076db 100644 --- a/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md +++ b/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md @@ -1,6 +1,6 @@ # Deploy NebulaGraph clusters with Kubectl -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x. diff --git a/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md b/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md index 79a7a95aa53..bf3c80c80cd 100644 --- a/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md +++ b/docs-2.0-en/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md @@ -1,6 +1,6 @@ # Deploy NebulaGraph clusters with Helm -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x. diff --git a/docs-2.0-en/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md b/docs-2.0-en/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md index 85f80a5a444..3c7a11d2f3b 100644 --- a/docs-2.0-en/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md +++ b/docs-2.0-en/nebula-operator/8.custom-cluster-configurations/8.4.manage-running-logs.md @@ -57,9 +57,9 @@ spec: If you don't want to mount additional log disks to back up log files, or if you want to collect logs and send them to a log center using services like [fluent-bit](https://fluentbit.io/), you can configure logs to be output to standard error. The Operator uses the [glog](https://github.com/google/glog) tool to log to standard error output. -!!! caution +!!! note - Currently, NebulaGraph Operator only collects standard error logs.。 + Currently, NebulaGraph Operator only collects standard error logs. In the YAML configuration file of the cluster instance, you can configure logging to standard error output in the `config` and `env` fields of each service. diff --git a/docs-2.0-en/nebula-operator/9.upgrade-nebula-cluster.md b/docs-2.0-en/nebula-operator/9.upgrade-nebula-cluster.md index 552d06df4d5..c2d29d45310 100644 --- a/docs-2.0-en/nebula-operator/9.upgrade-nebula-cluster.md +++ b/docs-2.0-en/nebula-operator/9.upgrade-nebula-cluster.md @@ -2,7 +2,7 @@ This topic introduces how to upgrade a NebulaGraph cluster created with NebulaGraph Operator. -!!! Compatibility "Legacy version compatibility" +!!! compatibility "Legacy version compatibility" The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x. diff --git a/docs-2.0-en/nebula-studio/about-studio/st-ug-what-is-graph-studio.md b/docs-2.0-en/nebula-studio/about-studio/st-ug-what-is-graph-studio.md index a4482877386..3da5550eb78 100644 --- a/docs-2.0-en/nebula-studio/about-studio/st-ug-what-is-graph-studio.md +++ b/docs-2.0-en/nebula-studio/about-studio/st-ug-what-is-graph-studio.md @@ -2,7 +2,7 @@ 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, and run nGQL statements to retrieve data. With Studio, you can quickly become a graph exploration expert from scratch. You can view the latest source code in the NebulaGraph GitHub repository, see [nebula-studio](https://github.com/vesoft-inc/nebula-studio) for details. -!!! Note +!!! note You can also try some functions [online](https://playground.nebula-graph.io/explorer) in Studio. @@ -47,7 +47,7 @@ When NebulaGraph enables authentication, users can only sign into Studio with th ## Version compatibility -!!! Note +!!! note The Studio version is released independently of the NebulaGraph core. The correspondence between the versions of Studio and the NebulaGraph core, as shown in the table below. diff --git a/docs-2.0-en/nebula-studio/quick-start/st-ug-import-data.md b/docs-2.0-en/nebula-studio/quick-start/st-ug-import-data.md index 6d9341d620c..002ff8ed5b3 100644 --- a/docs-2.0-en/nebula-studio/quick-start/st-ug-import-data.md +++ b/docs-2.0-en/nebula-studio/quick-start/st-ug-import-data.md @@ -28,7 +28,7 @@ Click **New Data Source** in the upper right corner of the page to set the data | SFTP | Add SFTP as the CSV file source. | | Local file | Upload a local CSV file. The file size can not exceed 200 MB, please put the files exceeding the limit into other types of data sources. | -!!! Note +!!! note - When uploading a local CSV file, you can select more than one CSV file at one time. - After adding a data source, you can click **Data Source Management** at the top of the page and switch tabs to view the details of different types of data sources, and you can also edit or delete data sources. diff --git a/docs-2.0-en/nebula-studio/troubleshooting/st-ug-config-server-errors.md b/docs-2.0-en/nebula-studio/troubleshooting/st-ug-config-server-errors.md index 7032d6f7f0e..302d157303a 100644 --- a/docs-2.0-en/nebula-studio/troubleshooting/st-ug-config-server-errors.md +++ b/docs-2.0-en/nebula-studio/troubleshooting/st-ug-config-server-errors.md @@ -28,7 +28,7 @@ Check NebulaGraph service status. Regarding the operation of viewing services: If the NebulaGraph service is normal, proceed to Step 4 to continue troubleshooting. Otherwise, please restart NebulaGraph service. -!!! Note +!!! note If you used `docker-compose up -d` to satrt NebulaGraph before, you must run the `docker-compose down` to stop NebulaGraph. diff --git a/docs-2.0-zh/1.introduction/2.data-model.md b/docs-2.0-zh/1.introduction/2.data-model.md index 64709a41aa4..b906e2d67cf 100644 --- a/docs-2.0-zh/1.introduction/2.data-model.md +++ b/docs-2.0-zh/1.introduction/2.data-model.md @@ -17,7 +17,7 @@ - 点是用点标识符（`VID`）标识的。`VID`在同一图空间中唯一。VID 是一个 int64，或者 fixed_string(N)。 - 点可以有 0 到多个 Tag。 - !!! Compatibility + !!! compatibility {{nebula.name}} 2.x 及以下版本中的点必须包含至少一个 Tag。 @@ -49,7 +49,7 @@ 属性是指以键值对（Key-value pair）形式表示的信息。 -!!! Note +!!! note Tag 和 Edge type 的作用，类似于关系型数据库中“点表”和“边表”的表结构。 @@ -66,7 +66,7 @@ |Edge type| **serve** | start_year (int)
end_year (int) | 表示球员的行为。
该行为将球员和球队联系起来，方向是从球员到球队。 | |Edge type| **follow** | degree (int) | 表示球员的行为。
该行为将两个球员联系起来，方向是从一个球员到另一个球员。 | -!!! Note +!!! note {{nebula.name}}中没有无向边，只支持有向边。 diff --git a/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/2.meta-service.md b/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/2.meta-service.md index 43537cfde32..4a87054a1d8 100644 --- a/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/2.meta-service.md +++ b/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/2.meta-service.md @@ -15,7 +15,7 @@ Meta 服务是由 nebula-metad 进程提供的，用户可以根据场景配置 leader 是由多数派选举出来，只有 leader 能够对客户端或其他组件提供服务，其他 follower 作为候补，如果 leader 出现故障，会在所有 follower 中选举出新的 leader。 -!!! Note +!!! note leader 和 follower 的数据通过 Raft 协议保持一致，因此 leader 故障和选举新 leader 不会导致数据不一致。更多关于 Raft 的介绍见 [Storage 服务](4.storage-service.md)。 diff --git a/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/4.storage-service.md index 469d86287c2..0ebbe2269cf 100644 --- a/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/4.storage-service.md +++ b/docs-2.0-zh/1.introduction/3.nebula-graph-architecture/4.storage-service.md @@ -143,7 +143,7 @@ EdgeA_Out 和 EdgeA_In 以方向相反的两条边的形式存在于存储层， 分片策略采用**静态 Hash **的方式，即对点 VID 进行取模操作，同一个点的所有 Tag、出边和入边信息都会存储到同一个分片，这种方式极大地提升了查询效率。 -!!! Note +!!! note 创建图空间时需指定分片数量，分片数量设置后无法修改，建议设置时提前满足业务将来的扩容需求。 @@ -189,7 +189,7 @@ pId = vid % numParts + 1; 基本原理：Raft 就是一种用于保证多副本一致性的协议。Raft 采用多个副本之间竞选的方式，赢得”超过半数”副本投票的（候选）副本成为 Leader，由 Leader 代表所有副本对外提供服务；其他 Follower 作为备份。当该 Leader 出现异常后（通信故障、运维命令等），其余 Follower 进行新一轮选举，投票出一个新的 Leader。Leader 和 Follower 之间通过心跳的方式相互探测是否存活，并以 Raft-wal 的方式写入硬盘，超过多个心跳仍无响应的副本会被认为发生故障。 -!!! Note +!!! note 因为 Raft-wal 需要定期写硬盘，如果硬盘写能力瓶颈会导致 Raft 心跳失败，导致重新发起选举。硬盘 IO 严重堵塞情况下，会导致长期无法选举出 Leader。 @@ -197,7 +197,7 @@ pId = vid % numParts + 1; 故障流程：场景 1：考虑一个配置为单副本（图空间）的集群；如果系统只有一个副本时，其自身就是 Leader；如果其发生故障，系统将完全不可用。场景 2：考虑一个配置为 3 副本（图空间）的集群；如果系统有 3 个副本，其中一个副本是 Leader，其他 2 个副本是 Follower；即使原 Leader 发生故障，剩下两个副本仍可投票出一个新的 Leader（以及一个 Follower），此时系统仍可使用；但是当这 2 个副本中任一者再次发生故障后，由于投票人数不足，系统将完全不可用。 -!!! Note +!!! note Raft 多副本的方式与 HDFS 多副本的方式是不同的，Raft 基于“多数派”投票，因此副本数量不能是偶数。 diff --git a/docs-2.0-zh/14.client/3.nebula-cpp-client.md b/docs-2.0-zh/14.client/3.nebula-cpp-client.md index ba254830521..2111da4c218 100644 --- a/docs-2.0-zh/14.client/3.nebula-cpp-client.md +++ b/docs-2.0-zh/14.client/3.nebula-cpp-client.md @@ -49,7 +49,7 @@ 4. 使用 CMake 生成 makefile 文件。 - !!! Note + !!! note 默认安装路径为`/usr/local/nebula`，如果需要修改路径，请在下方命令内增加参数 `-DCMAKE_INSTALL_PREFIX=`。 diff --git a/docs-2.0-zh/15.contribution/how-to-contribute.md b/docs-2.0-zh/15.contribution/how-to-contribute.md index caaae179ddd..a10b4630991 100644 --- a/docs-2.0-zh/15.contribution/how-to-contribute.md +++ b/docs-2.0-zh/15.contribution/how-to-contribute.md @@ -108,7 +108,7 @@ git checkout -b myfeature ``` - !!! Note + !!! note 由于一个 PR 通常包含多个 commits，最终合入 upstream/master 分支时，我们会将这些 commits 挤压（squash）成一个 commit 进行合并。因此强烈建议创建一个独立的分支进行更改，这样在合入时才容易被挤压。合并后，这个分支可以被丢弃。如果未创建单独的分支，而是直接将 commits 提交至 origin/master，在合入时，可能会出现问题。 若未创建单独的分支（或是 origin/master 合并了其他的分支等），导致 origin/master 和 upstream/master 不一致时，用户可以使用 hard reset 强制两者进行一致。例如： @@ -134,7 +134,7 @@ 详情请参见[使用源码安装{{nebula.name}}](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)。 - !!! Note + !!! note 请确保已设置`-DENABLE_TESTING = ON`启用构建单元测试。 diff --git a/docs-2.0-zh/2.quick-start/1.quick-start-overview.md b/docs-2.0-zh/2.quick-start/1.quick-start-overview.md index b16c11c5f1a..20e400c4c8d 100644 --- a/docs-2.0-zh/2.quick-start/1.quick-start-overview.md +++ b/docs-2.0-zh/2.quick-start/1.quick-start-overview.md @@ -59,7 +59,7 @@ $ git clone -b {{dockercompose.branch}} https://github.com/vesoft-inc/nebula-docker-compose.git ``` - !!! Note + !!! note Docker Compose 的`x.y`版本对齐内核的`x.y`版本，对于内核`z`版本，Docker Compose 不会发布对应的`z`版本，但是会拉取`z`版本的内核镜像。 @@ -90,7 +90,7 @@ 从 3.1 版本开始，Docker-compose 会自动启动 NebulaGraph Console 镜像的容器，并将 Storage 主机增加至集群中（即`ADD HOSTS`命令）。 - !!! Note + !!! note 上述服务的更多信息，请参见[架构总览](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 @@ -126,7 +126,7 @@ / # ./usr/local/bin/nebula-console -u -p --address=graphd --port=9669 ``` - !!! Note + !!! note 默认情况下，身份认证功能是关闭的，只能使用已存在的用户名（默认为`root`）和任意密码登录。如果想使用身份认证，请参见[身份认证](../7.data-security/1.authentication/1.authentication.md)。 diff --git a/docs-2.0-zh/2.quick-start/6.cheatsheet-for-ngql-command.md b/docs-2.0-zh/2.quick-start/6.cheatsheet-for-ngql-command.md index 9696d53646e..bc668085014 100644 --- a/docs-2.0-zh/2.quick-start/6.cheatsheet-for-ngql-command.md +++ b/docs-2.0-zh/2.quick-start/6.cheatsheet-for-ngql-command.md @@ -410,11 +410,11 @@ | `SIGN IN TEXT SERVICE [( [,, ]), (), ...]` | `SIGN IN TEXT SERVICE (127.0.0.1:9200)` | {{nebula.name}}的全文索引是基于 [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) 实现，部署 Elasticsearch 集群之后，可以使用`SIGN IN`语句登录 Elasticsearch 客户端。 | | `SHOW TEXT SEARCH CLIENTS` | `SHOW TEXT SEARCH CLIENTS` | 列出文本搜索客户端。 | | `SIGN OUT TEXT SERVICE` | `SIGN OUT TEXT SERVICE` | 退出所有文本搜索客户端。 | - | `CREATE FULLTEXT {TAG | EDGE} INDEX ON { | } ([])` | `CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name)` | 创建全文索引。 | + | `CREATE FULLTEXT {TAG | EDGE} INDEX ON { | } ( [,]...) [ANALYZER=""]` | `CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name)` | 创建全文索引。 | | `SHOW FULLTEXT INDEXES` | `SHOW FULLTEXT INDEXES` | 显示全文索引。 | | `REBUILD FULLTEXT INDEX` | `REBUILD FULLTEXT INDEX` | 重建全文索引。 | | `DROP FULLTEXT INDEX ` | `DROP FULLTEXT INDEX nebula_index_1` | 删除全文索引。 | - | `LOOKUP ON { | } WHERE [YIELD ]` | `LOOKUP ON player WHERE FUZZY(player.name, "Tim Dunncan", AUTO, OR) YIELD player.name` | 使用查询选项。 | + | `LOOKUP ON { | } WHERE ES_QUERY(, "") YIELD [| LIMIT [,] ]` | `LOOKUP ON player WHERE ES_QUERY(fulltext_index_1,"Chris") YIELD id(vertex)` | 使用查询选项。 | ## 子图和路径 diff --git a/docs-2.0-zh/20.appendix/0.FAQ.md b/docs-2.0-zh/20.appendix/0.FAQ.md index 1af593fca3c..cd3630353eb 100644 --- a/docs-2.0-zh/20.appendix/0.FAQ.md +++ b/docs-2.0-zh/20.appendix/0.FAQ.md @@ -526,7 +526,7 @@ dmp 文件是错误报告文件，详细记录了进程退出的信息，可以 telnet ``` -!!! Note +!!! note 如果无法使用 telnet 命令，请先检查主机中是否安装并启动了 telnet。 diff --git a/docs-2.0-zh/20.appendix/6.eco-tool-version.md b/docs-2.0-zh/20.appendix/6.eco-tool-version.md index c4bbad446bd..2dae4327f78 100644 --- a/docs-2.0-zh/20.appendix/6.eco-tool-version.md +++ b/docs-2.0-zh/20.appendix/6.eco-tool-version.md @@ -8,7 +8,7 @@ NebulaGraph Studio（简称 Studio）是一款可以通过 Web 访问的图数据库可视化工具，搭配{{nebula.name}}使用，提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。详情请参见[什么是 NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 -!!! Note +!!! note Studio 版本发布节奏独立于{{nebula.name}}内核，其命名方式也不参照内核命名规则，两者兼容对应关系如下表。 diff --git a/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/1.overview.md b/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/1.overview.md index 13a9eb55bc5..4d93d232488 100644 --- a/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/1.overview.md +++ b/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/1.overview.md @@ -84,7 +84,7 @@ nebula> CREATE TAG IF NOT EXISTS player(name string, age int); 由于 nGQL 语言部分兼容了 openCypher，这个部分在本文中称为 openCypher 兼容语句。 -!!! Note +!!! note `nGQL 语言` = `原生 nGQL 语句` + `openCypher 兼容语句` diff --git a/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md b/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md index 1711bde8273..f6cff457e25 100644 --- a/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md +++ b/docs-2.0-zh/3.ngql-guide/1.nGQL-overview/3.graph-patterns.md @@ -38,7 +38,7 @@ ## Tag 模式 -!!! Note +!!! note nGQL 中的`Tag`概念与 openCypher 中的`Label`有一些不同。例如，必须创建一个`Tag`之后才能使用它，而且`Tag`还定义了属性的类型。 @@ -136,7 +136,7 @@ (a)-[*..5]->(b) ``` -!!! Note +!!! note 必须指定最大长度，**不支持**仅指定最小长度（`(a)-[*3..]->(b)`）或都不指定（`(a)-[*]->(b)`）。 diff --git a/docs-2.0-zh/3.ngql-guide/10.tag-statements/2.drop-tag.md b/docs-2.0-zh/3.ngql-guide/10.tag-statements/2.drop-tag.md index 2fb4cc36705..ab2e701562d 100644 --- a/docs-2.0-zh/3.ngql-guide/10.tag-statements/2.drop-tag.md +++ b/docs-2.0-zh/3.ngql-guide/10.tag-statements/2.drop-tag.md @@ -10,7 +10,7 @@ 删除 Tag 操作仅删除 Schema 数据，硬盘上的文件或目录不会立刻删除，而是在下一次 Compaction 操作时删除。 -!!! Compatibility +!!! compatibility {{nebula.name}} {{nebula.release}} 中默认不支持插入无 Tag 的点。如需使用无 Tag 的点，在集群内所有 Graph 服务的配置文件（`nebula-graphd.conf`）中新增`--graph_use_vertex_key=true`；在所有 Storage 服务的配置文件（`nebula-storaged.conf`）中新增`--use_vertex_key=true`。 diff --git a/docs-2.0-zh/3.ngql-guide/10.tag-statements/6.delete-tag.md b/docs-2.0-zh/3.ngql-guide/10.tag-statements/6.delete-tag.md index c03b7981d9f..198407000f2 100644 --- a/docs-2.0-zh/3.ngql-guide/10.tag-statements/6.delete-tag.md +++ b/docs-2.0-zh/3.ngql-guide/10.tag-statements/6.delete-tag.md @@ -45,7 +45,7 @@ nebula> FETCH PROP ON * "test" YIELD vertex AS v; +---+ ``` -!!! Compatibility +!!! compatibility * 在 openCypher 中，可以使用 `REMOVE v:LABEL` 语句来移除该点 `v` 的 `LABEL`。 * 相同语意，但不同语法。在 nGQL 中使用 `DELETE TAG`。 diff --git a/docs-2.0-zh/3.ngql-guide/12.vertex-statements/1.insert-vertex.md b/docs-2.0-zh/3.ngql-guide/12.vertex-statements/1.insert-vertex.md index 38ce4a2967b..cc2886b50b8 100644 --- a/docs-2.0-zh/3.ngql-guide/12.vertex-statements/1.insert-vertex.md +++ b/docs-2.0-zh/3.ngql-guide/12.vertex-statements/1.insert-vertex.md @@ -48,7 +48,7 @@ prop_value_list: - `IF NOT EXISTS`：检测待插入的 VID 是否存在，只有不存在时，才会插入，如果已经存在，不会进行修改。 - !!! Note + !!! note - `IF NOT EXISTS` 仅检测 VID + Tag 的值是否相同，不会检测属性值。 - `IF NOT EXISTS` 会先读取一次数据是否存在，因此对性能会有明显影响。 diff --git a/docs-2.0-zh/3.ngql-guide/12.vertex-statements/4.delete-vertex.md b/docs-2.0-zh/3.ngql-guide/12.vertex-statements/4.delete-vertex.md index 4877ca734b2..b2fbe936bb5 100644 --- a/docs-2.0-zh/3.ngql-guide/12.vertex-statements/4.delete-vertex.md +++ b/docs-2.0-zh/3.ngql-guide/12.vertex-statements/4.delete-vertex.md @@ -2,7 +2,7 @@ `DELETE VERTEX`语句可以删除点，但是默认不删除该点关联的出边和入边。 -!!! Compatibility +!!! compatibility {{nebula.name}} 2.x 默认删除点及关联该点的出边和入边，{{nebula.name}} {{nebula.release}} 默认只删除点，不删除该点关联的出边和入边，此时将默认存在悬挂边。 diff --git a/docs-2.0-zh/3.ngql-guide/13.edge-statements/1.insert-edge.md b/docs-2.0-zh/3.ngql-guide/13.edge-statements/1.insert-edge.md index ecafeb50a3d..2fc30271d10 100644 --- a/docs-2.0-zh/3.ngql-guide/13.edge-statements/1.insert-edge.md +++ b/docs-2.0-zh/3.ngql-guide/13.edge-statements/1.insert-edge.md @@ -20,7 +20,7 @@ INSERT EDGE [IF NOT EXISTS] ( ) VALUES - `IF NOT EXISTS`：用户可以使用`IF NOT EXISTS`关键字检测待插入的边是否存在，只有不存在时，才会插入。 - !!! Note + !!! note - `IF NOT EXISTS` 仅检测<边的类型、起始点、目的点和 rank>是否存在，不会检测属性值是否重合。 - `IF NOT EXISTS` 会先读取一次数据是否存在，因此对性能会有明显影响。 @@ -94,7 +94,7 @@ nebula> FETCH PROP ON e2 "14"->"15"@1 YIELD edge AS e; +-------------------------------------------+ ``` -!!! Note +!!! note * {{nebula.name}} {{ nebula.release }} 允许存在悬挂边（Dangling edge）。因此可以在起点或者终点存在前，先写边；此时就可以通过 `._src`或`._dst`获取到（尚未写入的）点 VID（不建议这样使用）。 * 目前还不能保证操作的原子性，如果失败请重试，否则会发生部分写入。此时读取该数据的行为是未定义的。例如写入操作涉及到多个机器时，可能会出现插入单个边的正反向边只写入成功一个，或者插入多个边时只写入成功一部分，此时会返回报错，请重新执行命令。 diff --git a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/1.create-native-index.md b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/1.create-native-index.md index 11a8cdf63dc..cb7577da037 100644 --- a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/1.create-native-index.md +++ b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/1.create-native-index.md @@ -46,7 +46,7 @@ 4. 使用 [LOOKUP](../7.general-query-statements/5.lookup.md) 或 [MATCH](../7.general-query-statements/2.match.md) 语句查询数据。不需要（也无法）指定使用哪个索引，{{nebula.name}}会自动计算。 -!!! Note +!!! note 如果先创建索引再导入数据，会因为写性能的下降导致导入速度极慢。 diff --git a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md index f147e6b82d4..8cdfb006796 100644 --- a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md +++ b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md @@ -7,7 +7,7 @@ 请在创建索引后，选择合适的时间为存量数据重建索引。使用索引的详情请参见 [CREATE INDEX](1.create-native-index.md)。 -!!! performance +!!! caution 通过修改配置文件中的`rebuild_index_part_rate_limit` 和 `rebuild_index_batch_size` 两个参数，可优化重建索引的速度，另外，更大参数可能会导致更高的内存和网络占用，详情请参见 [Storage服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md#misc)。 diff --git a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md index a8b93646be9..2be837bc392 100644 --- a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md +++ b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md @@ -11,7 +11,7 @@ - `STOPPED`：停止 - `INVALID`：失效 -!!! Note +!!! note 如何创建索引请参见 [CREATE INDEX](1.create-native-index.md)。 diff --git a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/README.md b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/README.md index c9433bda08e..de5688000e4 100644 --- a/docs-2.0-zh/3.ngql-guide/14.native-index-statements/README.md +++ b/docs-2.0-zh/3.ngql-guide/14.native-index-statements/README.md @@ -51,7 +51,7 @@ - 不支持逻辑操作，例如`AND`、`OR`、`NOT`。 -!!! Note +!!! note 如果需要进行整个字符串的匹配，请使用原生索引。 diff --git a/docs-2.0-zh/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md b/docs-2.0-zh/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md index 144b6a8707c..31d961aa189 100644 --- a/docs-2.0-zh/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md +++ b/docs-2.0-zh/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md @@ -88,7 +88,7 @@ `dot`格式将返回 DOT 语言的信息，然后用户可以使用 Graphviz 生成计划图。 -!!! Note +!!! note Graphviz 是一款开源可视化图工具，可以绘制 DOT 语言脚本描述的图。Graphviz 提供一个在线工具，可以预览 DOT 语言文件，并将它们导出为 SVG 或 JSON 等其他格式。详情请参见 [Graphviz Online](https://dreampuf.github.io/GraphvizOnline/)。 diff --git a/docs-2.0-zh/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md b/docs-2.0-zh/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md index 851b7f9da5b..9e8266c20f4 100644 --- a/docs-2.0-zh/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md +++ b/docs-2.0-zh/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md @@ -2,7 +2,7 @@ 第一次启动{{nebula.name}}集群时，系统会从本地配置文件中读取配置，然后保存在 Meta 服务中，后续重启集群，也会从 Meta 服务中读取配置。`CONFIG`语句可以修改 Meta 服务中保存的{{nebula.name}}配置，不会修改本地配置文件。 -!!! Note +!!! note 根据过往实践，建议让{{nebula.name}}从本地文件获取配置。详情请参见[配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。 diff --git a/docs-2.0-zh/3.ngql-guide/3.data-types/4.date-and-time.md b/docs-2.0-zh/3.ngql-guide/3.data-types/4.date-and-time.md index fe90a08b59b..477e49fa21c 100644 --- a/docs-2.0-zh/3.ngql-guide/3.data-types/4.date-and-time.md +++ b/docs-2.0-zh/3.ngql-guide/3.data-types/4.date-and-time.md @@ -6,7 +6,7 @@ - 在插入时间类型的属性值时，{{nebula.name}}会根据[配置文件](../../5.configurations-and-logs/1.configurations/1.configurations.md)中`timezone_name`参数指定的时区，将该`DATE`、`TIME`、`DATETIME`转换成相应的世界协调时间（UTC）时间。 - !!! Note + !!! note 如需修改当前时区，请同时修改所有服务的配置文件中的`timezone_name`参数。 diff --git a/docs-2.0-zh/3.ngql-guide/4.job-statements.md b/docs-2.0-zh/3.ngql-guide/4.job-statements.md index e4cfd135494..199ddb7510a 100644 --- a/docs-2.0-zh/3.ngql-guide/4.job-statements.md +++ b/docs-2.0-zh/3.ngql-guide/4.job-statements.md @@ -58,7 +58,7 @@ nebula> SUBMIT JOB FLUSH; `SUBMIT JOB STATS`语句会在当前图空间内启动一个作业，该作业对当前图空间进行统计。作业完成后，用户可以使用`SHOW STATS`语句列出统计结果。详情请参见 [SHOW STATS](7.general-query-statements/6.show/14.show-stats.md)。 -!!! Note +!!! note 如果存储在{{nebula.name}}中的数据有变化，为了获取最新的统计结果，请重新执行`SUBMIT JOB STATS`。 diff --git a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md index ec681d6a10d..385bfe9bf37 100644 --- a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md +++ b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md @@ -22,7 +22,7 @@ 例如一个查询由三个子查询 A、B、C 组成，A 是一个读操作，B 是一个计算操作，C 是一个写操作，如果在执行过程中，任何一个操作执行失败，则整个结果是未定义的：没有回滚，而且写入的内容取决于执行程序。 -!!! Note +!!! note openCypher 没有事务要求。 diff --git a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md index c2306fa527b..f8cf5af7b4e 100644 --- a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md +++ b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md @@ -29,7 +29,7 @@ nGQL 扩展的自定义变量可以表示为`$var_name`，`var_name`由字母、 用户可以在复合查询中使用自定义变量。复合查询的详细信息请参见[复合查询](1.composite-queries.md)。 -!!! Note +!!! note - 自定义变量区分大小写。 - 在包含扩展的自定义变量的复合语句中，用英文分号`;`结束定义变量的语句。详情参见 [nGQL 风格指南](../../3.ngql-guide/1.nGQL-overview/ngql-style-guide.md)。 diff --git a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md index 357dbfd54ee..14ea59330d3 100644 --- a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md +++ b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md @@ -2,7 +2,7 @@ 用户可以在`WHERE`和`YIELD`子句中引用点或边的属性。 -!!! Note +!!! note 本功能仅适用于原生 nGQL 的 GO 语句。 diff --git a/docs-2.0-zh/3.ngql-guide/5.operators/1.comparison.md b/docs-2.0-zh/3.ngql-guide/5.operators/1.comparison.md index cb740c04421..817f76ae62e 100644 --- a/docs-2.0-zh/3.ngql-guide/5.operators/1.comparison.md +++ b/docs-2.0-zh/3.ngql-guide/5.operators/1.comparison.md @@ -17,7 +17,7 @@ 比较操作的结果是`true`或者`false`。 -!!! Note +!!! note - 比较不同类型的值通常没有定义，结果可能是`NULL`或其它。 @@ -33,7 +33,7 @@ openCypher 中没有`EMPTY`，因此不支持在 MATCH 语句中使用`EMPTY`。 字符串比较时，会区分大小写。不同类型的值不相等。 -!!! Note +!!! note nGQL 中的相等符号是`==`，openCypher 中的相等符号是`=`。 diff --git a/docs-2.0-zh/3.ngql-guide/5.operators/7.string.md b/docs-2.0-zh/3.ngql-guide/5.operators/7.string.md index ba82144a188..a55622b079c 100644 --- a/docs-2.0-zh/3.ngql-guide/5.operators/7.string.md +++ b/docs-2.0-zh/3.ngql-guide/5.operators/7.string.md @@ -11,7 +11,7 @@ |(NOT) ENDS WITH | 在字符串的结尾执行匹配。| |正则表达式 | 通过正则表达式匹配字符串。| -!!! Note +!!! note 所有搜索或匹配都区分大小写。 @@ -107,7 +107,7 @@ nebula> RETURN 'apple' ENDS WITH 'app', 'apple' ENDS WITH 'e', 'apple' ENDS WITH ### 正则表达式 -!!! Note +!!! note 当前仅 opencypher 兼容语句（`MATCH`、`WITH`等）支持正则表达式，原生 nGQL 语句（`FETCH`、`GO`、`LOOKUP`等）不支持正则表达式。 diff --git a/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/8.predicate.md b/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/8.predicate.md index eac7764f8ca..b2db590113d 100644 --- a/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/8.predicate.md +++ b/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/8.predicate.md @@ -12,7 +12,7 @@ | none() | 如果指定的谓词不适用于列表中的任何一个元素，则返回`true`，否则返回`false`。 | | single() | 如果指定的谓词适用于列表中的唯一一个元素，则返回`true`，否则返回`false`。 | -!!! Note +!!! note 如果列表为空，或者列表中的所有元素都为空，则返回 NULL。 diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/2.match.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/2.match.md index ffb97fb683a..ed726ef400c 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/2.match.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/2.match.md @@ -58,7 +58,7 @@ nebula> MATCH (v) \ ### 匹配 Tag -!!! Compatibility "历史版本兼容性" +!!! compatibility "历史版本兼容性" 在{{nebula.name}} 3.0.0 之前，匹配 Tag 的前提是 Tag 本身有索引或者 Tag 的某个属性有索引，否则，用户无法基于该 Tag 执行`MATCH`语句。从{{nebula.name}} 3.0.0 开始，匹配 Tag 可以不创建索引，但需要使用`LIMIT`限制输出结果数量。从{{nebula.name}} 3.5.0 开始，`MATCH`语句支持全表扫描，无需为 Tag 或 Tag 的某个属性创建索引，或者使用`LIMIT`限制输出结果数量，即可执行`MATCH`语句。 @@ -311,7 +311,7 @@ nebula> MATCH ()<-[e]-() \ 和点一样，用户可以用`:`表示模式中的 Edge type，例如`-[e:follow]-`。 -!!! Compatibility "历史版本兼容性" +!!! compatibility "历史版本兼容性" 在{{nebula.name}} 3.0.0 之前，匹配 Edge Type 的前提是 Edge type 本身有对应属性的索引，否则，用户无法基于 Edge Type 执行 `MATCH` 语句。从{{nebula.name}} 3.0.0 开始，匹配 Edge Type 可以不创建索引，但需要使用 `LIMIT` 限制输出结果数量，并且必须指定边的方向。从{{nebula.name}} 3.5.0 开始，无需为 Edge Type 创建索引或者使用`LIMIT`限制输出结果数量，即可使用`MATCH`语句匹配边。 @@ -615,6 +615,6 @@ nebula> MATCH (m)-[]->(n) WHERE id(m)=="player100" \ 参见[OPTIONAL MATCH](optional-match.md)。 -!!! Performance +!!! caution {{nebula.name}} {{ nebula.release }} 中`MATCH`语句的性能和资源占用得到了优化.但对性能要求较高时，仍建议使用 `GO`, `LOOKUP`, `|` 和 `FETCH` 等来替代`MATCH`。 diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/3.go.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/3.go.md index c47098e75f5..4d36bd8318f 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/3.go.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/3.go.md @@ -41,7 +41,7 @@ YIELD [DISTINCT] - `WHERE `：指定遍历的过滤条件。用户可以在起始点、目的点和边使用`WHERE`子句，还可以结合`AND`、`OR`、`NOT`、`XOR`一起使用。详情参见 [WHERE](../8.clauses-and-options/where.md)。 - !!! Note + !!! note - 遍历多个 Edge type 时，`WHERE`子句有一些限制。例如不支持`WHERE edge1.prop1 > edge2.prop2`。 - GO 语句执行时先遍历所有的点，然后再根据过滤器条件进行过滤。 @@ -56,7 +56,7 @@ YIELD [DISTINCT] - `ORDER BY`：指定输出结果的排序规则。详情参见 [ORDER BY](../8.clauses-and-options/order-by.md)。 - !!! Note + !!! note 没有指定排序规则时，输出结果的顺序不是固定的。 diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md index 6beb0006a68..0358fab2544 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md @@ -9,7 +9,7 @@ - 每个 Tag 关联的点的总数 - 每个 Edge type 关联的边的总数 -!!! Warning +!!! warning `SHOW STATS`返回的不是实时数据。因为返回的数据是最近一次 [SUBMIT JOB STATS](../../4.job-statements.md) 作业收集的数据。返回的数据可能包含 [TTL](../../8.clauses-and-options/ttl-options.md) 过期数据，该过期数据会在下次执行 [Compaction 操作](../../../8.service-tuning/compaction.md)时被删除并不纳入统计。 diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md index 50ca252837c..d88942d0091 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md @@ -27,6 +27,6 @@ nebula> SHOW EDGE INDEXES; +----------------+----------+---------+ ``` -!!! Compatibility "历史版本兼容性" +!!! compatibility "历史版本兼容性" {{nebula.name}} 2.0.1 中， `SHOW TAG/EDGE INDEXES` 语句仅返回 `Names`。 diff --git a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/limit.md b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/limit.md index 235a6393d47..b329c57f113 100644 --- a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/limit.md +++ b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/limit.md @@ -6,7 +6,7 @@ - 在 openCypher 兼容语句中，不允许在`LIMIT`子句前使用管道符，可以使用`SKIP`指明偏移量。 - !!! Note + !!! note 在原生 nGQL 或 openCypher 方式中使用`LIMIT`时，使用`ORDER BY`子句限制输出顺序非常重要，否则会输出一个不可预知的子集。 @@ -114,7 +114,7 @@ nebula> GO 3 STEPS FROM "player102" OVER * BIDIRECT\ `offset`和`number_rows`可以使用表达式，但是表达式的结果必须是非负整数。 -!!! Note +!!! note 两个整数组成的分数表达式会自动向下取整。例如`8/6`向下取整为 1。 diff --git a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/ttl-options.md b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/ttl-options.md index 4572ef9cf89..a216b9c956b 100644 --- a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/ttl-options.md +++ b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/ttl-options.md @@ -25,7 +25,7 @@ nGQL 支持的 TTL 选项如下。 |`ttl_col`|指定一个现有的要设置存活时间的属性。属性的数据类型必须是`int`或者`timestamp`。| |`ttl_duration`|指定时间戳差值，默认单位：秒。时间戳差值必须为 64 位非负整数。属性值和时间戳差值之和如果小于当前时间戳，属性就会过期。如果`ttl_duration`为`0`，属性永不过期。
可在配置文件`nebula-storaged.conf`（默认路径`/usr/local/nightly/etc/`）中设置`ttl_use_ms`为`true`将默认单位设为毫秒。| -!!! caution +!!! warning - 在设置`ttl_use_ms`为`true`前，请确保没有为属性设置 TTL，否则会因为过期时间缩短，导致数据被错误地删除。 - 在设置`ttl_use_ms`为`true`后，即设置`ttl_duration`的默认单位为毫秒后，`ttl_col`的默认单位仍然为秒，它的数据类型必须是`int`，并且需要手动转换属性值为毫秒。例如设置`ttl_col`为`a`，则需要将`a`的值转换为毫秒，如当`a`的值为`now()`，则需要将`a`的值设置为`now() * 1000`。 @@ -89,7 +89,7 @@ nebula> INSERT VERTEX t2(a, b, c) VALUES "102":(1648197138, 30, "Hello"); {{nebula.name}}自动删除过期数据后，会在下一次 [Compaction](../../8.service-tuning/compaction.md) 过程中回收硬盘空间。 -!!! Note +!!! note 如果[关闭 TTL 选项](#ttl_1)，上一次 Compaction 之后的过期数据将可以被查询到。 diff --git a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/with.md b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/with.md index 4030e5cc08e..4a65005a5d7 100644 --- a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/with.md +++ b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/with.md @@ -6,7 +6,7 @@ 本文操作仅适用于 openCypher 方式。 -!!! Note +!!! note 在原生 nGQL 中，有与`WITH`类似的[管道符](../5.operators/4.pipe.md)，但它们的工作方式不同。不要在 openCypher 方式中使用管道符，也不要在原生 nGQL 中使用`WITH`子句。 diff --git a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/yield.md b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/yield.md index 5cbe230858c..5aa90408a02 100644 --- a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/yield.md +++ b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/yield.md @@ -16,7 +16,7 @@ - 在 openCypher 中，`YIELD`用于在`CALL[…YIELD]`子句中指定过程调用的输出。 - !!! Note + !!! note nGQL 不支持`CALL[…YIELD]`。 diff --git a/docs-2.0-zh/3.ngql-guide/9.space-statements/2.use-space.md b/docs-2.0-zh/3.ngql-guide/9.space-statements/2.use-space.md index cbdbba56197..f5af5c1d4bd 100644 --- a/docs-2.0-zh/3.ngql-guide/9.space-statements/2.use-space.md +++ b/docs-2.0-zh/3.ngql-guide/9.space-statements/2.use-space.md @@ -26,7 +26,7 @@ nebula> USE space1; nebula> USE space2; ``` -!!! Caution +!!! caution 不能在一条语句中同时操作两个图空间。 diff --git a/docs-2.0-zh/3.ngql-guide/9.space-statements/5.drop-space.md b/docs-2.0-zh/3.ngql-guide/9.space-statements/5.drop-space.md index 1b788cb1520..f358f300e29 100644 --- a/docs-2.0-zh/3.ngql-guide/9.space-statements/5.drop-space.md +++ b/docs-2.0-zh/3.ngql-guide/9.space-statements/5.drop-space.md @@ -22,12 +22,12 @@ DROP SPACE [IF EXISTS] ; `IF EXISTS`关键字可以检测待删除的图空间是否存在，只有存在时，才会删除图空间。 -!!! Compatibility "历史版本兼容性" +!!! compatibility "历史版本兼容性" 在{{nebula.name}} 3.1.0 版本前，`DROP SPACE`语句不会删除硬盘上对应图空间的目录和文件。 -!!! caution +!!! danger 请**谨慎**执行删除图空间操作。 diff --git a/docs-2.0-zh/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0-zh/4.deployment-and-installation/1.resource-preparations.md index 34e57345e00..92b9b65c6d6 100644 --- a/docs-2.0-zh/4.deployment-and-installation/1.resource-preparations.md +++ b/docs-2.0-zh/4.deployment-and-installation/1.resource-preparations.md @@ -238,11 +238,11 @@ storaged 进程的数量不会影响图空间副本的数量。 答：对于社区版{{nebula.name}}，每个图空间对应一个 RocksDB 实例，并且`--data_path`选项（`etc`目录下的`nebula-storaged.conf`文件中）中的每个目录对应一个 RocksDB 实例。即，RocksDB 实例数量 = 图空间总数 * 目录总数。 -!!! Note +!!! note 用户可以在配置文件`nebula-storaged.conf`中添加`--enable_partitioned_index_filter=true`来降低 bloom 过滤器占用的内存大小，但是在某些随机寻道（random-seek）的情况下，可能会降低读取性能。 -!!! Caution +!!! caution 每个 RocksDB 实例即使还未写入任何数据时，仍会占用 70M 左右的磁盘空间。一个分区对应一个 RocksDB 实例，当分区设置特别多时，例如 100，图空间创建后即占用了大量磁盘空间。 diff --git a/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md b/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md index cf7e96e922f..c1a695bfdf0 100644 --- a/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md +++ b/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md @@ -46,7 +46,7 @@ 4. 使用 CMake 生成 makefile 文件。 - !!! Note + !!! note 默认安装路径为`/usr/local/nebula`，如果需要修改路径，请在下方命令内增加参数 `-DCMAKE_INSTALL_PREFIX=`。 @@ -58,7 +58,7 @@ 5. 编译{{nebula.name}}。 - !!! Note + !!! note 检查[软硬件要求和安装三方库依赖包](../1.resource-preparations.md)。 diff --git a/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md index 87bbc57e9e8..48119771995 100644 --- a/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md +++ b/docs-2.0-zh/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md @@ -30,7 +30,7 @@ $ git clone -b {{dockercompose.branch}} https://github.com/vesoft-inc/nebula-docker-compose.git ``` - !!! Note + !!! note Docker Compose 的`x.y`版本对齐内核的`x.y`版本，对于内核`z`版本，Docker Compose 不会发布对应的`z`版本，但是会拉取`z`版本的内核镜像。 @@ -64,7 +64,7 @@ 从 3.1 版本开始，Docker-compose 会自动启动 NebulaGraph Console 镜像的容器，并将 Storage 主机增加至集群中（即`ADD HOSTS`命令）。 - !!! Note + !!! note 上述服务的更多信息，请参见[架构总览](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md)。 @@ -100,7 +100,7 @@ / # ./usr/local/bin/nebula-console -u -p --address=graphd --port=9669 ``` - !!! Note + !!! note 默认情况下，身份认证功能是关闭的，只能使用已存在的用户名（默认为`root`）和任意密码登录。如果想使用身份认证，请参见[身份认证](../../7.data-security/1.authentication/1.authentication.md)。 diff --git a/docs-2.0-zh/4.deployment-and-installation/4.uninstall-nebula-graph.md b/docs-2.0-zh/4.deployment-and-installation/4.uninstall-nebula-graph.md index eff9caac780..851d7528fc5 100644 --- a/docs-2.0-zh/4.deployment-and-installation/4.uninstall-nebula-graph.md +++ b/docs-2.0-zh/4.deployment-and-installation/4.uninstall-nebula-graph.md @@ -14,7 +14,7 @@ 如果在配置文件内修改了数据文件的路径，可能会导致安装路径和数据文件保存路径不一致，因此需要查看配置文件，确认数据文件保存路径，然后手动删除数据文件目录。 -!!! Note +!!! note 如果是集群架构，需要删除所有 Storage 和 Meta 服务节点的数据文件。 @@ -33,7 +33,7 @@ ## 步骤 2：卸载安装目录 -!!! Note +!!! note 删除整个安装目录，包括`cluster.id`文件。 diff --git a/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md b/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md index badf39f1e98..90cd6f4ba17 100644 --- a/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md +++ b/docs-2.0-zh/4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md @@ -32,7 +32,7 @@ SIGN IN TEXT SERVICE (, {HTTP | HTTPS} [,"", " SIGN IN TEXT SERVICE (192.168.8.100:9200, HTTP); ``` -!!! Note +!!! note Elasticsearch 默认没有用户名和密码，如果设置了用户名和密码，请在`SIGN IN`语句中指定。 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md index d12afa7ee3b..8e43734614c 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/1.configurations.md @@ -65,7 +65,7 @@ curl 127.0.0.1:19779/flags curl -s 127.0.0.1:19559/flags ``` -!!! Note +!!! note 实际环境中需使用真实的主机 IP 地址取代以上示例中的`127.0.0.1`。 ## 配置文件简介 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md index f9a03857fd9..98cbf99c197 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -29,7 +29,7 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul | `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 |不支持| | `timezone_name` | - | 指定{{nebula.name}}的时区。初始配置文件中未设置该参数，如需使用请手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [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")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| -!!! Note +!!! note * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md)的属性值时，{{nebula.name}}会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 * `timezone_name`参数只用于转换{{nebula.name}}中存储的数据，{{nebula.name}}进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md index 55efaccd77f..3c9440e2b42 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -30,7 +30,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb | `timezone_name` | - | 指定{{nebula.name}}的时区。初始配置文件中未设置该参数，使用需手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [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")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| | `local_config` | `true` | 是否从配置文件获取配置信息。 |不支持| -!!! Note +!!! note * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md) 的属性值时，{{nebula.name}}会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 * `timezone_name`参数只用于转换{{nebula.name}}中存储的数据，{{nebula.name}}进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 diff --git a/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md index 9403b653589..7518a834d44 100644 --- a/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0-zh/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -19,7 +19,7 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 配置文件中的部分参数值可以在运行时动态修改。本文将这些参数标记为支持运行时动态修改，并当`local_config`值设置为`true`时重启服务后配置会恢复为初始配置。详情参见[修改配置](1.configurations.md)。 -!!! Note +!!! note Raft Listener 的配置和 Storage 服务配置不同，详情请参见[部署 Raft listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。 @@ -34,7 +34,7 @@ Storage 服务提供了两份初始配置文件`nebula-storaged.conf.default`和 | `timezone_name` | `UTC+00:00:00` | 指定{{nebula.name}}的时区。初始配置文件中未设置该参数，如需使用请手动添加。格式请参见 [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")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| | `local_config` | `true` | 是否从配置文件获取配置信息。 |不支持| -!!! Note +!!! note * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md)的属性值时，{{nebula.name}}会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 * `timezone_name`参数只用于转换{{nebula.name}}中存储的数据，{{nebula.name}}进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 diff --git a/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md b/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md index 9a1c66cd005..6c5259523eb 100644 --- a/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md +++ b/docs-2.0-zh/6.monitor-and-metrics/1.query-performance-metrics.md @@ -27,7 +27,7 @@ curl -G "http://:/stats?stats= [&format=json]" |`metric_name_list`|监控指标名称，多个监控指标用英文逗号（,）隔开。| |`&format=json`|将结果以 JSON 格式返回。| -!!! Note +!!! note 如果{{nebula.name}}服务部署在容器中，需要执行`docker-compose ps`命令查看映射到容器外部的端口，然后通过该端口查询。 diff --git a/docs-2.0-zh/7.data-security/1.authentication/1.authentication.md b/docs-2.0-zh/7.data-security/1.authentication/1.authentication.md index 9866f5d3beb..6a8bf080f32 100644 --- a/docs-2.0-zh/7.data-security/1.authentication/1.authentication.md +++ b/docs-2.0-zh/7.data-security/1.authentication/1.authentication.md @@ -16,7 +16,7 @@ - `--enable_authorize`：是否启用身份验证，可选值：`true`、`false`。 - !!! Note + !!! note - 默认情况下，身份验证功能是关闭的，用户可以使用`root`用户名和任意密码连接到{{nebula.name}}。 - 开启身份验证后，默认的 God 角色账号为`root`，密码为`nebula`。角色详情请参见[内置角色权限](3.role-list.md)。 diff --git a/docs-2.0-zh/7.data-security/1.authentication/2.management-user.md b/docs-2.0-zh/7.data-security/1.authentication/2.management-user.md index b4ec588b3b7..f9561d3ae4b 100644 --- a/docs-2.0-zh/7.data-security/1.authentication/2.management-user.md +++ b/docs-2.0-zh/7.data-security/1.authentication/2.management-user.md @@ -4,7 +4,7 @@ 开启[身份验证](1.authentication.md)后，用户需要使用已创建的用户才能连接{{nebula.name}}，而且连接后可以进行的操作也取决于该用户拥有的[角色权限](3.role-list.md)。 -!!! Note +!!! note * 默认情况下，身份验证功能是关闭的，用户可以使用 root 用户名和任意密码连接到{{nebula.name}}。 * 修改权限后，对应的用户需要重新登录才能生效。 @@ -171,7 +171,7 @@ 执行`DROP USER`语句可以删除用户。当前仅** God **角色用户能够执行`DROP USER`语句。 -!!! Note +!!! note 删除用户不会自动断开该用户当前会话，而且权限仍在当前会话中生效。 diff --git a/docs-2.0-zh/7.data-security/1.authentication/3.role-list.md b/docs-2.0-zh/7.data-security/1.authentication/3.role-list.md index ee1568b4cc7..c75c5e441c6 100644 --- a/docs-2.0-zh/7.data-security/1.authentication/3.role-list.md +++ b/docs-2.0-zh/7.data-security/1.authentication/3.role-list.md @@ -12,7 +12,7 @@ - Meta 服务初始化时，会自动创建 God 角色用户`root`，密码为`nebula`。 - !!! caution "注意" + !!! caution 请及时修改`root`用户的密码，保证数据安全。 @@ -27,7 +27,7 @@ - 可以将权限内的图空间授权给其他用户。 - !!! caution "注意" + !!! caution 只能授权低于 ADMIN 级别的角色给其他用户。 @@ -47,7 +47,7 @@ - 对权限内的图空间拥有 Schema 和 data 的**只读**权限。 -!!! Note +!!! note * 不支持自行创建角色，只能使用默认的内置角色。 * 一个用户在一个图空间内只能拥有一个角色权限。授权用户请参见[用户管理](2.management-user.md)。 diff --git a/docs-2.0-zh/8.service-tuning/2.graph-modeling.md b/docs-2.0-zh/8.service-tuning/2.graph-modeling.md index 41397027d9f..a35af1cd679 100644 --- a/docs-2.0-zh/8.service-tuning/2.graph-modeling.md +++ b/docs-2.0-zh/8.service-tuning/2.graph-modeling.md @@ -2,7 +2,7 @@ 本文介绍在{{nebula.name}}项目中成功应用的一些图建模和系统设计的通用建议。 -!!! Note +!!! note 本文建议是通用的，在特定领域有例外，请结合实际业务情况进行图建模。 diff --git a/docs-2.0-zh/8.service-tuning/compaction.md b/docs-2.0-zh/8.service-tuning/compaction.md index beb5b36c144..c3064b36c2e 100644 --- a/docs-2.0-zh/8.service-tuning/compaction.md +++ b/docs-2.0-zh/8.service-tuning/compaction.md @@ -6,7 +6,7 @@ `Compaction`操作会读取硬盘上的数据，然后重组数据结构和索引，然后再写回硬盘，可以成倍提升读取性能。将大量数据写入{{nebula.name}}后，为了提高读取性能，需要手动触发`Compaction`操作（全量`Compaction`）。 -!!! Note +!!! note `Compaction`操作会长时间占用硬盘的 IO，建议在业务低峰期（例如凌晨）执行该操作。 @@ -57,7 +57,7 @@ nebula> SHOW CONFIGS STORAGE; 全量`Compaction`可以对图空间进行大规模后台操作，例如合并文件、删除 TTL 过期数据等，该操作需要手动发起。使用如下语句执行全量`Compaction`操作： -!!! Note +!!! note 建议在业务低峰期（例如凌晨）执行该操作，避免大量占用硬盘 IO 影响业务。 diff --git a/docs-2.0-zh/8.service-tuning/super-node.md b/docs-2.0-zh/8.service-tuning/super-node.md index 8fbda39ce98..8592a5e2acd 100644 --- a/docs-2.0-zh/8.service-tuning/super-node.md +++ b/docs-2.0-zh/8.service-tuning/super-node.md @@ -13,7 +13,7 @@ 经验上说，当一个点的出入度超过 1 万时，就可以视为是稠密点。需要考虑一些特殊的设计和处理。 -!!! Note +!!! note {{nebula.name}}中没有专用的字段来记录每个点的出度和入度，也没有内置任务来进行统计，因此无法预知哪些点会是超级节点。一个折中的办法是使用 Spark 周期性地计算和统计。 diff --git a/docs-2.0-zh/README.md b/docs-2.0-zh/README.md index 528b72ba1cd..c044c3a87eb 100644 --- a/docs-2.0-zh/README.md +++ b/docs-2.0-zh/README.md @@ -1,6 +1,6 @@ # 欢迎阅读{{nebula.name}} {{ nebula.release }} 文档 -!!! Note +!!! note 本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}，GitHub commit [{{ git.short_commit }}](https://github.com/vesoft-inc/nebula-docs/commits/v{{nebula.release}})。该版本主色系为"桑色"，色号为 #55295B。 @@ -53,25 +53,22 @@ NebulaGraph 是一款开源的、分布式的、易扩展的原生图数据库 !!! caution - 需要严格遵守的注意事项。不遵守 caution 可能导致系统故障、数据丢失、安全问题等。 - -!!! danger - - 会引发危险的事项。不遵守 danger 必定会导致系统故障、数据丢失、安全问题等。 + 可能会产生不良影响，例如导致性能下降或引发已知的小问题。 -!!! performance +!!! warning - 性能调优时需要注意的事项。 + 可能导致严重后果，例如数据丢失、系统崩溃。 -!!! faq +!!! danger - 常见问题。 + 可能导致极其严重的后果，例如系统损坏、信息泄露。 !!! compatibility nGQL 与 openCypher 的兼容性或 nGQL 当前版本与历史版本的兼容性。 !!! enterpriseonly + 描述社区版和企业版的差异。 ## 修改文档中的错误 diff --git a/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md b/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md index 6630a43f53f..66085b0f1ba 100644 --- a/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md +++ b/docs-2.0-zh/backup-and-restore/3.manage-snapshot.md @@ -36,7 +36,7 @@ $ find |grep 'SNAPSHOT_2021_03_09_08_43_12' 命令`CREATE SNAPSHOT`可以创建集群当前时间点的快照。只支持创建所有图空间的快照，不支持创建指定图空间的快照。 -!!! Note +!!! note 如果快照创建失败，请[删除快照](#_7)重新创建。 @@ -106,7 +106,7 @@ nebula> SHOW SNAPSHOTS; 2. 当数据丢失需要通过快照恢复时，用户可以找到合适的时间点快照，将内部的文件夹`data`和`wal`分别拷贝到各自的上级目录（和`checkpoints`平级），覆盖之前的`data`和`wal`，然后重启集群即可。 - !!! caution + !!! warning 需要同时覆盖所有 Meta 节点的 data 和 wal 目录，因为存在重启集群后发生 Meta 重新选举 leader 的情况，如果不覆盖所有 Meta 节点，新的 leader 使用的还是最新的 Meta 数据，导致恢复失败。 diff --git a/docs-2.0-zh/backup-and-restore/nebula-br/1.what-is-br.md b/docs-2.0-zh/backup-and-restore/nebula-br/1.what-is-br.md index b4b790b7933..b43b2468d74 100644 --- a/docs-2.0-zh/backup-and-restore/nebula-br/1.what-is-br.md +++ b/docs-2.0-zh/backup-and-restore/nebula-br/1.what-is-br.md @@ -32,20 +32,20 @@ Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮 1. 验证 BR 访问 Meta 服务器和 Storage 服务器的 SSH 登录信息。 - !!! Note + !!! note 如果必须使用云存储，例如 Alibaba Cloud OSS 或 Amazon S3，还需要验证它们的客户端安装和配置。 2. BR 发起请求创建备份文件。 3. leader 的 metad 进程被锁定。 - !!! Note + !!! note 从此时起至第 9 步结束，无法在指定图空间内执行任何 nGQL 的 DDL 语句。 4. leader 的 metad 进程阻塞指定图空间的写请求。 - !!! Note + !!! note 从此时起至第 7 步结束，无法在指定图空间内执行任何 nGQL 的 DML 语句，但是可以执行 DQL 语句。 @@ -53,7 +53,7 @@ Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮 6. leader 的 metad 进程扫描本地 RocksDB 文件，输出为 SST（Static Sorted Table）格式文件。 7. leader 的 metad 进程解除阻塞指定图空间的写请求。 - !!! Note + !!! note 从此时起，可以在指定图空间内执行 nGQL 的 DML 语句。 @@ -66,14 +66,14 @@ Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮 - 备份文件名称 9. leader 的 metad 进程解除锁定。 - !!! Note + !!! note 从此时起，可以在指定图空间内执行任何 nGQL 的 DDL 语句。 10. BR 通过 SSH 登录至 leader 所在的 Meta 服务器和所有 Storage 服务器，然后备份文件。 11. 如果使用的是 Alibaba Cloud OSS 或 Amazon S3，BR 会调用命令将备份文件上传至云存储中。 - !!! Note + !!! note 本步骤会大量读取磁盘，建议使用万兆网络保证速率。如果上传过程中出现网络错误，备份会失败，必须重新执行备份操作。目前备份过程不支持断点续传。 12. BR 发起请求清理 Storage 服务器的快照，备份完成。 @@ -97,7 +97,7 @@ Backup&Restore（简称 BR）是一款命令行界面（CLI）工具，可以帮 1. 验证 BR 访问 Meta 服务器和 Storage 服务器的 SSH 登录信息。 - !!! Note + !!! note 如果必须使用云存储，例如 Alibaba Cloud OSS 或 Amazon S3，还需要验证它们的客户端安装和配置。 diff --git a/docs-2.0-zh/backup-and-restore/nebula-br/3.br-backup-data.md b/docs-2.0-zh/backup-and-restore/nebula-br/3.br-backup-data.md index 45aed5cb565..ef223e7b379 100644 --- a/docs-2.0-zh/backup-and-restore/nebula-br/3.br-backup-data.md +++ b/docs-2.0-zh/backup-and-restore/nebula-br/3.br-backup-data.md @@ -10,7 +10,7 @@ - 如果在本地保存备份文件，需要在 Meta 服务器、Storage 服务器和 BR 机器上创建绝对路径相同的备份目录，并记录绝对路径，同时需要保证账号对该目录有写权限。 - !!! Note + !!! warning 在生产环境中，我们建议用户将 NFS (Network File System）存储设备挂载到 Meta 服务器、Storage 服务器和 BR 机器上进行本地备份，或者使用 Alibaba Cloud OSS、Amazon S3 进行远程备份。否则当需要通过本地文件恢复数据时，必须手动将这些备份文件移动到指定目录，会导致数据冗余和某些问题。更多信息，请参见[使用 BR 恢复数据](4.br-restore-data.md)。 @@ -18,7 +18,7 @@ 在 BR 工具的安装路径下（编译安装的默认路径为`./bin/br`）运行以下命令对整个集群进行全量备份操作。 -!!! Note +!!! note 确保备份文件的路径存在。 diff --git a/docs-2.0-zh/import-export/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md b/docs-2.0-zh/import-export/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md index 42421d5b482..7cc5d061748 100644 --- a/docs-2.0-zh/import-export/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md +++ b/docs-2.0-zh/import-export/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md @@ -37,7 +37,7 @@ Exchange 具有以下优点： - 支持断点续传：导入数据时支持断点续传，有助于节省时间，提高数据导入效率。 - !!! Note + !!! note 目前仅迁移 Neo4j 数据时支持断点续传。 diff --git a/docs-2.0-zh/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md b/docs-2.0-zh/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md index 50f789290b5..44b52a5fdac 100644 --- a/docs-2.0-zh/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md +++ b/docs-2.0-zh/import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md @@ -17,11 +17,10 @@ ``` !!! note - JAR 文件版本号以实际编译得到的 JAR 文件名称为准。 -!!! faq + - JAR 文件版本号以实际编译得到的 JAR 文件名称为准。 - 如果使用 [yarn-cluster 模式](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html)提交任务，请参考如下示例，**尤其是示例中的两个**`--conf`。 + - 如果使用 [yarn-cluster 模式](https://spark-reference-doc-cn.readthedocs.io/zh_CN/latest/deploy-guide/running-on-yarn.html)提交任务，请参考如下示例，**尤其是示例中的两个**`--conf`。 ```bash $SPARK_HOME/bin/spark-submit --master yarn-cluster \ diff --git a/docs-2.0-zh/nebula-operator/1.introduction-to-nebula-operator.md b/docs-2.0-zh/nebula-operator/1.introduction-to-nebula-operator.md index c186c7f0be3..8cd9c55de95 100644 --- a/docs-2.0-zh/nebula-operator/1.introduction-to-nebula-operator.md +++ b/docs-2.0-zh/nebula-operator/1.introduction-to-nebula-operator.md @@ -40,7 +40,7 @@ NebulaGraph Operator 不支持 v1.x 版本的 NebulaGraph，其与{{nebula.name} | 2.5.x | 0.8.0 | -!!! Compatibility "历史版本兼容性" +!!! compatibility "历史版本兼容性" - 1.x 版本的 NebulaGraph Operator 不兼容 3.x 以下版本的 NebulaGraph. - 由于 0.9.0 版本的 NebulaGraph Operator 的日志盘和数据盘分开存储，因此用 0.9.0 版的 NebulaGraph Operator 管理通过 0.8.0 版本创建的 2.5.x 版本的{{nebula.name}}集群会导致兼容性问题。用户可以备份 2.5.x 版本的{{nebula.name}}集群，然后使用 0.9.0 版本的 Operator 创建 2.6.x 版本集群。 diff --git a/docs-2.0-zh/nebula-operator/11.rolling-update-strategy.md b/docs-2.0-zh/nebula-operator/11.rolling-update-strategy.md index 2ea319472cf..7db867fa6c1 100644 --- a/docs-2.0-zh/nebula-operator/11.rolling-update-strategy.md +++ b/docs-2.0-zh/nebula-operator/11.rolling-update-strategy.md @@ -19,7 +19,7 @@ Operator 会在以下情况下触发{{nebula.name}}集群的滚动更新： 当`enableForceUpdate`为`true`时，表示不迁移分片 Leader 副本，从而加快滚动更新的速度；反之，表示迁移分片 Leader 副本，以保证集群的读写可用性。默认值为`false`。 -!!! caution +!!! warning 设置`enableForceUpdate`为`true`时，确保没有流量进入集群进行读写操作。因为该设置会强制重建集群 Pod，此过程会发生数据丢失或客户端请求失败的情况。 diff --git a/docs-2.0-zh/nebula-operator/2.deploy-nebula-operator.md b/docs-2.0-zh/nebula-operator/2.deploy-nebula-operator.md index 6b93c3f5015..78d30380be3 100644 --- a/docs-2.0-zh/nebula-operator/2.deploy-nebula-operator.md +++ b/docs-2.0-zh/nebula-operator/2.deploy-nebula-operator.md @@ -168,7 +168,7 @@ helm install nebula-operator nebula-operator/nebula-operator --namespace=:7001`。 - !!! Note + !!! note 在运行 Docker 版 Studio 的机器上，用户可以运行 `ifconfig` 或者 `ipconfig` 获取本机 IP 地址。如果使用这台机器访问 Studio，可以在浏览器地址栏里输入 `http://localhost:7001`。 diff --git a/docs-2.0-zh/nebula-studio/manage-schema/st-ug-crud-index.md b/docs-2.0-zh/nebula-studio/manage-schema/st-ug-crud-index.md index bf0c08f969b..5950e0ed900 100644 --- a/docs-2.0-zh/nebula-studio/manage-schema/st-ug-crud-index.md +++ b/docs-2.0-zh/nebula-studio/manage-schema/st-ug-crud-index.md @@ -2,7 +2,7 @@ 用户可以为 Tag 和 Edge type 创建索引，使得图查询时可以从拥有共同属性的同一类型的点或边开始遍历，使大型图的查询更为高效。用户可以选择使用 **控制台** 或者 **Schema** 操作索引。本文仅说明如何使用 **Schema** 操作索引。 -!!! Note +!!! note 一般在创建了 Tag 或者 Edge type 之后即可创建索引，但是，索引会影响写性能，所以，建议先导入数据，再批量重建索引。关于索引的详细信息，参考 [索引介绍](../../3.ngql-guide/14.native-index-statements/README.md "点击前往{{nebula.name}}网站")。 @@ -32,7 +32,7 @@ 4. **描述**（可选）：输入索引的备注。 5. **索引属性**（可选）：点击 **+ 添加属性**，在弹出的对话框列表里选择需要关联的属性，点击 **确认**。如果需要关联多个属性，重复这一步骤。用户可以按界面提示重排索引属性的顺序。本示例中选择 `degree`。 - !!! Note + !!! note 索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详细信息，参考 [LOOKUP](../../3.ngql-guide/7.general-query-statements/5.lookup.md "点击前往{{nebula.name}}网站")。 diff --git a/docs-2.0-zh/nebula-studio/quick-start/st-ug-create-schema.md b/docs-2.0-zh/nebula-studio/quick-start/st-ug-create-schema.md index 8740b201818..c0f6f702b88 100644 --- a/docs-2.0-zh/nebula-studio/quick-start/st-ug-create-schema.md +++ b/docs-2.0-zh/nebula-studio/quick-start/st-ug-create-schema.md @@ -2,7 +2,7 @@ 在{{nebula.name}}中，用户必须先有 Schema，才能向其中写入点数据和边数据。本文描述如何使用{{nebula.name}}的**控制台**或 **Schema** 功能创建 Schema。 -!!! Note +!!! note - 用户可以使用 nebula-console 创建 Schema。详情参见 [{{nebula.name}}使用手册](../../README.md)和 [{{nebula.name}}快速开始](../../2.quick-start/1.quick-start-overview.md)。 - 用户可以使用 Schema 草图功能图形化设计 Schema。详情参见 [Schema 草图](draft.md)。 @@ -19,7 +19,7 @@ - 已经创建图空间。 -!!! Note +!!! note 本示例已经创建图空间。如果账号拥有 GOD 权限，也可以在 **控制台** 或 **Schema** 上创建一个图空间。 diff --git a/docs-2.0-zh/nebula-studio/quick-start/st-ug-import-data.md b/docs-2.0-zh/nebula-studio/quick-start/st-ug-import-data.md index 3742e3fc4df..7b7757f3f7b 100644 --- a/docs-2.0-zh/nebula-studio/quick-start/st-ug-import-data.md +++ b/docs-2.0-zh/nebula-studio/quick-start/st-ug-import-data.md @@ -28,7 +28,7 @@ Studio 支持界面化地将 CSV 格式数据导入至{{nebula.name}}中。 | SFTP | 添加 SFTP 作为 CSV 文件来源。 | | 本地文件 | 上传本地 CSV 文件。文件大小不能超过 200 MB，超过限制的文件请放入其他方式的数据源中。 | -!!! Note +!!! note - 上传本地 CSV 文件时，一次可以选择多个 CSV 文件。 - 数据源添加后，可以在页面上方单击**数据源管理**，切换页签即可查看不同类型的数据源详情，也可以编辑或删除数据源。 diff --git a/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-config-server-errors.md b/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-config-server-errors.md index 28f57e9b001..43a698142e6 100644 --- a/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-config-server-errors.md +++ b/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-config-server-errors.md @@ -27,7 +27,7 @@ 如果{{nebula.name}}服务正常，进入第 4 步继续排查问题。否则，请重启{{nebula.name}}服务。 -!!! Note +!!! note 如果之前使用 `docker-compose up -d` 启动{{nebula.name}}，必须运行 `docker-compose down` 命令停止{{nebula.name}}。 diff --git a/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-connection-errors.md b/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-connection-errors.md index dc979e69051..3a25b7d9e0f 100644 --- a/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-connection-errors.md +++ b/docs-2.0-zh/nebula-studio/troubleshooting/st-ug-connection-errors.md @@ -31,7 +31,7 @@ nebula-web-docker_web_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:32784->7001/tcp ``` - !!! Note + !!! note 如果之前使用 `docker-compose up -d` 启动 Studio，必须运行 `docker-compose down` 命令停止 Studio。 diff --git a/docs-2.0-zh/reuse/source_ngql_for_quick_start.md b/docs-2.0-zh/reuse/source_ngql_for_quick_start.md index 3bf4c953131..1c3399bcfe8 100644 --- a/docs-2.0-zh/reuse/source_ngql_for_quick_start.md +++ b/docs-2.0-zh/reuse/source_ngql_for_quick_start.md @@ -35,7 +35,7 @@ - `CREATE TAG INDEX` - `CREATE EDGE INDEX` -!!! Note +!!! note 默认心跳周期是 10 秒。修改心跳周期参数`heartbeat_interval_secs`，请参见[配置简介](https://docs.nebula-graph.com.cn/{{nebula.release}}/5.configurations-and-logs/1.configurations/1.configurations/)。 @@ -336,7 +336,7 @@ nebula> CREATE EDGE serve(start_year int, end_year int); - 使用临时变量 - !!! Note + !!! note 当复合语句作为一个整体提交给服务器时，其中的临时变量会在语句结束时被释放。 @@ -364,7 +364,7 @@ nebula> FETCH PROP ON player "player100" YIELD properties(vertex); +-------------------------------+ ``` -!!! Note +!!! note `LOOKUP`和`MATCH`的示例在下文的[索引](#_12) 部分查看。 @@ -376,7 +376,7 @@ nebula> FETCH PROP ON player "player100" YIELD properties(vertex); `UPSERT`是`UPDATE`和`INSERT`的结合体。当使用`UPSERT`更新一个点或边，如果它不存在，数据库会自动插入一个新的点或边。 -!!! Note +!!! note 每个 partition 内部，`UPSERT` 操作是一个串行操作，所以执行速度比执行 `INSERT` 或 `UPDATE` 慢很多。其仅在多个 partition 之间有并发。 @@ -481,7 +481,7 @@ nebula> FETCH PROP ON player "player100" YIELD properties(vertex); 用户可以通过 [CREATE INDEX](https://docs.nebula-graph.com.cn/{{nebula.release}}/3.ngql-guide/14.native-index-statements/1.create-native-index/) 语句为 Tag 和 Edge type 增加索引。 -!!! caution "使用索引必读" +!!! caution `MATCH`和`LOOKUP`语句的执行都依赖索引，但是索引会导致写性能大幅降低。请**不要随意**在生产环境中使用索引，除非很清楚使用索引对业务的影响。 @@ -502,7 +502,7 @@ nebula> FETCH PROP ON player "player100" YIELD properties(vertex); REBUILD {TAG | EDGE} INDEX ; ``` -!!! Note +!!! note 为没有指定长度的变量属性创建索引时，需要指定索引长度。在 utf-8 编码中，一个中文字符占 3 字节，请根据变量属性长度设置合适的索引长度。例如 10 个中文字符，索引长度需要为 30。详情请参见[创建索引](https://docs.nebula-graph.com.cn/{{nebula.release}}/3.ngql-guide/14.native-index-statements/1.create-native-index/)。