diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 9472d98c4c4..a5bdb92a2cb 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -31,7 +31,7 @@ jobs: - name: Git Config run: git config user.name whitewum && git config user.email min.wu@vesoft.com - - name: mike list delete + - name: Mike Deploy run: | mike list diff --git a/docs-2.0/1.introduction/3.vid.md b/docs-2.0/1.introduction/3.vid.md index edaee4d7ae2..17387229973 100644 --- a/docs-2.0/1.introduction/3.vid.md +++ b/docs-2.0/1.introduction/3.vid.md @@ -48,19 +48,16 @@ VIDs can be generated via applications. Here are some tips: The data type of VIDs must be defined when you [create the graph space](../3.ngql-guide/9.space-statements/1.create-space.md). Once defined, it cannot be modified. - \ No newline at end of file + For example, `match (n) return n;` returns an error because `start vid` cannot be located at this time. As a global scan, it is forbidden. diff --git a/docs-2.0/20.appendix/0.FAQ.md b/docs-2.0/20.appendix/0.FAQ.md index 4cfa815244c..9d871eaf579 100644 --- a/docs-2.0/20.appendix/0.FAQ.md +++ b/docs-2.0/20.appendix/0.FAQ.md @@ -255,7 +255,11 @@ Nebula Graph uses [glog](https://github.com/google/glog) to print logs. `glog` c ### "How to check the Nebula Graph version?" -If the service is running, run the command `SHOW HOSTS META` in `nebula-console`. See [SHOW HOSTS](../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md). +If the service is running: run command `SHOW HOSTS META` in `nebula-console`. See [SHOW HOSTS](../3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md). + +If the service is not running: + +Different installation methods make the method of checking the version different. The instructions are as follows: If the service is not running, run the command `./ --version` to get the version and the Git commit IDs of the Nebula Graph binary files. For example: diff --git a/docs-2.0/20.appendix/releasenote.md b/docs-2.0/20.appendix/releasenote.md index 656a6c302c7..cf51812bc41 100644 --- a/docs-2.0/20.appendix/releasenote.md +++ b/docs-2.0/20.appendix/releasenote.md @@ -1,72 +1,7 @@ # Nebula Graph {{ nebula.release }} release notes -## Feature - -- Support management of session. [#280](https://github.com/vesoft-inc/nebula-graph/pull/280) -- Support terminate the slow queries, know issue: there is a delay in querying and terminating the query due to the implementation. [#1152](https://github.com/vesoft-inc/nebula-graph/pull/1152) -- Enhance the ability to extract the indices from expressions for the `LOOKUP` statement. [#1188](https://github.com/vesoft-inc/nebula-graph/pull/1188) -- Supports configuring machine memory watermarks to alleviate OOM issues to some extent. [1067](https://github.com/vesoft-inc/nebula-graph/pull/1067) -- Support filter the edges in the `FindPath` statement. [#1091](https://github.com/vesoft-inc/nebula-graph/pull/1091) -- Support return structure of a graph without properties in the `Subgraph` statement.[#1134](https://github.com/vesoft-inc/nebula-graph/pull/1134) -- Improve the usage of the `timestamp` function. [#515](https://github.com/vesoft-inc/nebula-common/pull/515) -- Support for querying the version of each service. [#944](https://github.com/vesoft-inc/nebula-graph/pull/944) -- `Index` and `TTL` can be supported together. [#382](https://github.com/vesoft-inc/nebula-storage/pull/382) -- Support the creation of full-text indexes on specified properties. [#460](https://github.com/vesoft-inc/nebula-storage/pull/460) -- Support make comment when create space or schema. [#895](https://github.com/vesoft-inc/nebula-graph/pull/895) -- Support for full-text index rebuild. [#1123](https://github.com/vesoft-inc/nebula-graph/pull/1123) - -## Enhancement - -- The Listener interface is optimized to support full data acquisition. [#465](https://github.com/vesoft-inc/nebula-storage/pull/465), [#484](https://github.com/vesoft-inc/nebula-storage/pull/484) -- The leader table of the meta is reorganized. [#439](https://github.com/vesoft-inc/nebula-storage/pull/439) -- Add a DiskManager to check disk capacity. [#461](https://github.com/vesoft-inc/nebula-storage/pull/461) -- Improve heartbeat of raft to avoid leader change. [#438](https://github.com/vesoft-inc/nebula-storage/pull/438) -- Support concurrently go/fetch/lookup in storage. [#503](https://github.com/vesoft-inc/nebula-storage/pull/503) -- Enhanced for the `EXISTS` function to the `MAP`. [#973](https://github.com/vesoft-inc/nebula-graph/pull/973) -- Enforce the use of aggregate functions, such as `COUNT(v)+AVG(v)`. [#968](https://github.com/vesoft-inc/nebula-graph/pull/968) - ## Bug fix -- Fixed multiple statement execution problems caused by permissions. [#1165](https://github.com/vesoft-inc/nebula-graph/pull/1165) -- Fixed unwinding causing no results. [#1018](https://github.com/vesoft-inc/nebula-graph/pull/1018) -- Fixed crash problems caused by aggregation functions in some scenarios. [#1015](https://github.com/vesoft-inc/nebula-graph/pull/1015) -- Fixed index matching problems with `OR` expressions. [#1005](https://github.com/vesoft-inc/nebula-graph/pull/1005) -- Fixed case sensitivity of functions. [#927](https://github.com/vesoft-inc/nebula-graph/issues/927) -- Fixed issue where query index creation information was not checked for Tag/Edge type. [#933](https://github.com/vesoft-inc/nebula-graph/pull/933) -- Fixed a bug in the `Substring` function. [#491](https://github.com/vesoft-inc/nebula-common/pull/491) -- Fixed meta not returning leader change correctly. [#423](https://github.com/vesoft-inc/nebula-storage/pull/423) -- Fixed an issue with `LIMIT`, `ORDER`, `GROUP` statements using variables. [#1314](https://github.com/vesoft-inc/nebula-graph/pull/1314) -- Fixed issue with the `db_dump` tool printing VID of the `int` type. [#533](https://github.com/vesoft-inc/nebula-storage/pull/533) -- Fixed the issue that `FAILE` is still displayed after the `Balance` task is recovered. [#528](https://github.com/vesoft-inc/nebula-storage/pull/528) - -## Changes & Known issues - -- A little bit grammar change of Subgraph. - - ```ngql - # Add the WITH PROP keyword to the output property in {{ nebula.release }}. - GET SUBGRAPH WITH PROP FROM - - # The original syntax will only output the graph structure without properties. - GET SUBGRAPH FROM # - ``` - -- We must use the symbol `$-.` in `ORDER BY`. But in earlier releases, there is no need. - - ```ngql - # We must use the symbol `$-.` in `ORDER BY` in {{ nebula.release }}. - nebula> LOOKUP ON player \ - YIELD player.age As playerage \ - | GROUP BY $-.playerage \ - YIELD $-.playerage as age, count(*) AS number \ - | ORDER BY $-.number DESC, $-.age DESC; - - # There is no need to use the symbol `$-.` in earlier releases. - nebula> LOOKUP ON player \ - YIELD player.age As playerage \ - | GROUP BY $-.playerage \ - YIELD $-.playerage as age, count(*) AS number \ - | ORDER BY number DESC, age DESC; - ``` +- Fixed the performance reduction problems caused by the sessions will update at the next upload period when use space. [#1355](https://github.com/vesoft-inc/nebula-graph/pull/1355) -For the known bug/issue in {{ nebula.release }}, see [issues](https://github.com/vesoft-inc/nebula-graph/issues). +- Fixed the performance problems of k8s caused by processing logic of the remote address in connection requests. [#615](https://github.com/vesoft-inc/nebula-common/pull/615) diff --git a/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md b/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md index d91ed1efed2..262ffb0e5ca 100644 --- a/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md +++ b/docs-2.0/3.ngql-guide/10.tag-statements/6.delete-tag.md @@ -4,7 +4,7 @@ !!! enterpriseonly - This feature is supported by the Enterprise Edition only. + This feature is only available in the Enterprise Edition. A vertex can have one or more tags. diff --git a/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md b/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md index 4c6c31c52c1..76c00f3f42a 100644 --- a/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md +++ b/docs-2.0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md @@ -21,7 +21,7 @@ A natural language search interprets the search string as a phrase in natural hu ### Create full-text indexes ```ngql -CREATE {TAG | EDGE} INDEX ON { | } ([]); +CREATE FULLTEXT {TAG | EDGE} INDEX ON { | } ([]); ``` ### Show full-text indexes diff --git a/docs-2.0/8.service-tuning/3.system-design.md b/docs-2.0/8.service-tuning/3.system-design.md index fe0bed9beda..fa3d5a11058 100644 --- a/docs-2.0/8.service-tuning/3.system-design.md +++ b/docs-2.0/8.service-tuning/3.system-design.md @@ -24,7 +24,7 @@ Nebula Graph {{ nebula.release }} supports horizontal scaling. + Metad does not support horizontal scaling. -Vertical scaling usually has higher hardware costs and relatively simple operations. Nebula Graph {{nebula.release}} can also be scaled vertically. +Vertical scaling usually has higher hardware costs, but relatively simple operations. Nebula Graph {{nebula.release}} can also be scaled vertically. ## Data transmission and optimization diff --git a/docs-2.0/README.md b/docs-2.0/README.md index cf2a52a3a28..5b354db55fb 100644 --- a/docs-2.0/README.md +++ b/docs-2.0/README.md @@ -66,3 +66,4 @@ This manual has over 80 compatibilities and corresponding tips. ## Modify errors This Nebula Graph manual is written in the Markdown language. Users can click the pencil sign on the upper right side of each document title and modify errors. +--> diff --git a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md index 3a77cc43fad..32821eef8bb 100644 --- a/docs-2.0/nebula-dashboard/1.what-is-dashboard.md +++ b/docs-2.0/nebula-dashboard/1.what-is-dashboard.md @@ -12,7 +12,7 @@ Dashboard monitors: - The information of clusters, including the information of services, partitions, configurations, and long-term tasks. -Features of the enterprise package (TODO: planning) +- Features of the enterprise package (TODO: planning) !!! enterpriseonly diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md index c3a7761a7d3..e5986674f44 100644 --- a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md +++ b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md @@ -8,7 +8,7 @@ The correspondence between the Dashboard release and the Nebula Graph release is |Dashboard|Nebula Graph| |:---|:---| -|{{dashboard.release}}|2.5.0, 2.0.1| +|{{dashboard.release}}|2.x| ## Port @@ -26,12 +26,11 @@ The deployment of Dashboard occupies the following ports: ## Download Dashboard -Download the configuration files for the deployment. +Download the tar package as needed, and it is recommended to select the latest version. -| Dashboard tar-package | Nebula Graph version | +| Dashboard package | Nebula Graph version | | :----- | :----- | -| [nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-dashboard/{{ dashboard.release }}/nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.0 | - +| [nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-graph-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | v{{nebula.release}} | ## Service @@ -58,7 +57,7 @@ The above five services should be deployed as follows. To start the service, run the following statement in `node-exporter`: ```bash -$ nohup ./node-exporter --web.listen-address=:9100 & +$ nohup ./node-exporter --web.listen-address=":9100" & ``` After the service is started, you can enter `:9100` in the browser to check whether the service is started normally. @@ -106,7 +105,7 @@ After the service is started, you can enter `:9100` in the browser to check 2. Run the following statement to start the service: ```bash - $ nohup ./nebula-stats-exporter --bare-metal --bare-metal-config=./config.yaml & + $ nohup ./nebula-stats-exporter --listen-address=":9200" --bare-metal --bare-metal-config=./config.yaml & ``` After the service is started, you can enter `:9200` in the browser to check whether the service is started normally. @@ -128,6 +127,7 @@ After the service is started, you can enter `:9200` in the browser to check static_configs: - targets: [ '192.168.xx.100:9200', # The IP address and port of the nebula-stats-exporter service. + '192.168.xx.101:9200' ] - job_name: 'node-exporter' static_configs: diff --git a/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md b/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md index f0314c571a1..f84326d7dbb 100644 --- a/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md +++ b/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md @@ -5,6 +5,10 @@ Nebula Explorer (Explorer in short) is a browser-based visualization tool. It is !!! enterpriseonly Explorer is only available in the enterprise version. + +!!! Note + + You can also try some functions online in [Explorer](https://explorer.nebula-graph.io/). !!! Note @@ -33,4 +37,4 @@ Explorer has these features: Authentication is not enabled in Nebula Graph by default. Users can log into Studio with the `root` account and any password. -When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md). \ No newline at end of file +When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md). diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md index 08d33b330dd..5527d720154 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-edge-type.md @@ -1,6 +1,6 @@ # Operate edge types -After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This article only introduces how to use the **Schema** page to operate edge types in a graph space. +After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** page or the **Schema** page to create, retrieve, update, or delete edge types. This topic introduces how to use the **Schema** page to operate edge types in a graph space only. ## Studio version @@ -28,27 +28,25 @@ To create an edge type on the **Schema** page, follow these steps: 5. On the **Create** page, do these settings: - a. **Name**: Specify an appropriate name for the edge type. In this example, `serve` is used. + - **Name**: Specify an appropriate name for the edge type. In this example, `serve` is used. - b. (Optional) If necessary, under the name, click the **Comment** to input content. + - (Optional) If necessary, under the name, click the **Comment** to input content. - c. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings: + - (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings: - To define a property: Enter a property name, a data type, and a default value. - To add multiple properties: Click the **Add Property** button and define more properties. - - To cancel a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel"). + - To delete a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel"). - d. (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website"). + - (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website"). 6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings. ![Define properties of the `action` edge type](../figs/st-ug-027-1.png "Define an edge type") -7. Confirm the settings and then click the **+ Create** button. - -When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list. +7. Confirm the settings and then click the **+ Create** button. When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list. ## Edit an edge type diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md index 38030aea19f..5cb8f9cf88a 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-index.md @@ -1,6 +1,6 @@ # Operate Indexes -You can create an index for a Tag and/or an Edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge type Index. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, and delete indexes. This article introduces how to use the **Schema** page to operate an index. +You can create an index for a Tag and/or an Edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge type Index. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, and delete indexes. This topic introduces how to use the **Schema** page to operate an index only. !!! note @@ -46,8 +46,7 @@ To create an index on the **Schema** page, follow these steps: ![A page for index creation](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-030.png "Create an index") -7. Confirm the settings and then click the **+ Create** button. - When an index is created, the index list shows the new index. +7. Confirm the settings and then click the **+ Create** button. When an index is created, the index list shows the new index. ## View indexes diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md index 8469567399a..a4e2e00a736 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md @@ -23,15 +23,15 @@ To create a graph space on the **Schema** page, follow these steps: 2. On the **Graph Space List** page, click the **+ Create** button. 3. On the **Create** page, do these settings: - a. **Name**: Specify a name to the new graph space. In this example, `basketballplayer` is used. The name must be distinct in the database. The name cannot be used keywords or reserved keywords as identifiers. For more information, see [keywords](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md). + - **Name**: Specify a name to the new graph space. In this example, `basketballplayer` is used. The name must be distinct in the database. The name cannot be used keywords or reserved keywords as identifiers. For more information, see [keywords](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md). - b. **Vid type**: The data types of VIDs are restricted to `FIXED_STRING()` or `INT64`; a graph space can only select one VID type, `FIXED_STRING(32)` is used. For more information, see [VID](../../1.introduction/3.vid.md). + - **Vid type**: The data types of VIDs are restricted to `FIXED_STRING()` or `INT64`. A graph space can only select one VID type. In this example, `FIXED_STRING(32)` is used. For more information, see [VID](../../1.introduction/3.vid.md). - c. **Comment**: The remarks of a certain property or the space itself. The maximum length is 256 bytes. By default, there will be no comments on a space. But in this example, `Statistics of basketball players` is used. + - **Comment**: The remarks of a certain property or the space itself. The maximum length is 256 bytes. By default, there will be no comments on a space. But in this example, `Statistics of basketball players` is used. - d. **Optional Parameters**: Set `partition_num`, `replica_factor`. In this example, these parameters are set to `100` and `1` separately. For more information, see [`CREATE SPACE` syntax](../../3.ngql-guide/9.space-statements/1.create-space.md "Click to go to the Nebula Graph website"). + - **Optional Parameters**: Set the values of `partition_num` and `replica_factor` respectively. In this example, these parameters are set to `100` and `1` respectively. For more information, see [`CREATE SPACE` syntax](../../3.ngql-guide/9.space-statements/1.create-space.md "Click to go to the Nebula Graph website"). - In the **Equivalent to the following nGQL statement** panel, you can see the statement equivalent to the preceding settings. + In the **Equivalent to the following nGQL statement** panel, you can see the statement equivalent to the preceding settings. ```bash CREATE SPACE basketballplayer (partition_num = 100, replica_factor = 1, vid_type = FIXED_STRING(32)) COMMENT = "Statistics of basketball players" @@ -53,8 +53,7 @@ To delete a graph space on the **Schema** page, follow these steps: 2. In the graph space list, find a graph space and then the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "Delete") in the **Operations** column. ![Graph space list with the graph space to be deleted](./../figs/st-ug-029.png) -3. On the dialog box, confirm the information and then click the **OK** button. - When the graph space is deleted successfully, it is removed from the graph space list. +3. On the dialog box, confirm the information and then click the **OK** button. When the graph space is deleted successfully, it is removed from the **graph space list**. ## Next to do diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md index 1c983f8aa48..66387020739 100644 --- a/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-crud-tag.md @@ -1,6 +1,6 @@ # Operate tags -After a graph space is created in Nebula Graph, you can create tags. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, update, or delete tags. This article only introduces how to use the **Schema** page to operate tags in a graph space. +After a graph space is created in Nebula Graph, you can create tags. With Studio, you can use the **Console** page or the **Schema** page to create, retrieve, update, or delete tags. This topic introduces how to use the **Schema** page to operate tags in a graph space only. ## Studio version @@ -38,15 +38,13 @@ To create a tag on the **Schema** page, follow these steps: - To cancel a defined property: Besides the **Defaults** column, click the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel"). - c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website"). + c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](../../3.ngql-guide/8.clauses-and-options/ttl-options.md "Click to go to Nebula Graph website"). 6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings. ![Define properties of the `course` tag](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-028.png "Define a tag") -7. Confirm the settings and then click the **+ Create** button. - -When the tag is created successfully, the **Define Properties** panel shows all its properties on the list. +7. Confirm the settings and then click the **+ Create** button. When the tag is created successfully, the **Define Properties** panel shows all its properties on the list. ## Edit a tag @@ -62,7 +60,7 @@ To edit a tag on the **Schema** page, follow these steps: 5. On the **Edit** page, do these settings: - - To edit a Comment: Click **Edit** under the Name. + - To edit a Comment: Click **Edit** under the **Name**. - To edit a property: On the **Define Properties** panel, find a property, click **Edit**, and then change the data type or the default value. @@ -95,6 +93,8 @@ To delete a tag on the **Schema** page, follow these steps: 4. Click the **Tag** tab, find a tag and then the button ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png) in the **Operations** column. +5. CLick **OK**. + ## Next to do After the tag is created, you can use the **Console** page to insert vertex data one by one manually or use the **Import** page to bulk import vertex data. diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md index 2670d3f3361..c2cb06fd0db 100644 --- a/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md +++ b/docs-2.0/nebula-studio/troubleshooting/st-ug-config-server-errors.md @@ -26,7 +26,7 @@ Check Nebula Graph service status. Regarding the operation of viewing services: - If you use Nebula Graph deployed by Docker Compose and RPM, refer to the [Nebula Graph service status and ports](../deploy-connect/st-ug-deploy.md). -If the Nebula Graph service is normal, proceed to Step4 to continue troubleshooting. Otherwise, please restart Nebula Graph service. +If the Nebula Graph service is normal, proceed to Step 4 to continue troubleshooting. Otherwise, please restart Nebula Graph service. !!! Note diff --git a/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md b/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md index 30668a50d6e..fb76c49a09d 100644 --- a/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md +++ b/docs-2.0/nebula-studio/use-console/st-ug-open-in-explore.md @@ -2,6 +2,10 @@ With the **Open in Explore** function, you can run nGQL statements on the **Console** page to query vertex or edge data and then view the result on the **Explore** page in a visualized way. +## Supported versions + +Studio of v{{ studio.release }} or later versions supports this function. For more information, see [check updates](../about-studio/st-ug-check-updates.md). + ## Prerequisites To use the **Open in Explore** function, you must do a check of these: diff --git a/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md b/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md index 538971d09da..a33cd62f67b 100644 --- a/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md +++ b/docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md @@ -16,6 +16,10 @@ To use the **View Subgraphs** function, you must do a check of these: - A dataset exists in the database. In the example of this article, the **basketballplayer** dataset is used. For more information, see [Import data](../quick-start/st-ug-import-data.md). +!!! Note + + Users can view subgraphs online in [Studio](https://playground.nebula-graph.com.cn/explore). + ## Procedure To query the paths or subgraph on the **Console** page and then view them on the **Explore** page, follow these steps: diff --git a/mkdocs.yml b/mkdocs.yml index a55f6fa14cd..aa942ccb700 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,7 +80,7 @@ extra: release: 2.5.0 branch: v2.5.0 common: - release: 2.5.0 + release: 2.5.1 dashboard: release: 1.0.1 base100: 1.0.0 @@ -457,7 +457,7 @@ plugins: - git-revision-date-localized - with-pdf: copyright: 2021 Vesoft Inc. - cover_subtitle: master + cover_subtitle: master since v2.5.1 author: Min Wu, Yao Zhou, Cooper Liang, Foesa Yang, Max Zhu cover: true back_cover: true diff --git a/overrides/partials/header.html b/overrides/partials/header.html deleted file mode 100644 index 07ed13181ec..00000000000 --- a/overrides/partials/header.html +++ /dev/null @@ -1,90 +0,0 @@ -{#- - This file was automatically generated - do not edit --#} -
-
- - -
- diff --git a/requirements.txt b/requirements.txt index e994d097eac..cd6cf78db02 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ mkdocs==1.2.2 +mkdocs-material-extensions==1.0.1 mkdocs-material mkdocs-macros-plugin mike