From 9011b9d3ab37eadfe51c2bb73dc68e01389cbbfd Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Mon, 30 Jan 2023 13:55:47 +0800 Subject: [PATCH 01/30] update explorer connect (#1883) --- .../2.deploy-connect-dashboard-ent.md | 4 ++++ .../deploy-connect/ex-ug-connect.md | 16 ++++++++++++++-- .../deploy-connect/ex-ug-deploy.md | 16 +--------------- mkdocs.yml | 1 + 4 files changed, 20 insertions(+), 17 deletions(-) diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index 834dc3f219e..dffdec97084 100644 --- a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -375,3 +375,7 @@ To uninstall Dashboard Enterprise Edition, run the following command. ``` sudo dpkg -r ``` + +## Next to do + +[Connect to Dashboard](3.connect-dashboard.md) \ No newline at end of file diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md index 2c42543b42b..cc29bc93192 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md @@ -12,6 +12,8 @@ Before connecting to the NebulaGraph database, you need to confirm the following - You have a NebulaGraph account and its password. +- We recommend you to use the Chrome browser of the version above 89. Otherwise, there may be compatibility issues. + ## OAuth2.0 Configuration !!! caution @@ -47,7 +49,17 @@ After the configuration is complete, restart the Explorer service. The OAuth aut To connect Explorer to NebulaGraph, follow these steps: -1. On the **Config Server** page of Explorer, configure these fields: +1. Type `http://:7002` in the address bar of your browser. + + The following login page shows that Explorer is successfully connected to NebulaGraph. + + ![NebulaGraph Explorer Login page](https://docs-cdn.nebula-graph.com.cn/figures/explorer_connect_230116_en.png) + + !!! note + + When logging into NebulaGraph Explorer for the first time, the content of *END USER LICENSE AGREEMENT* is displayed on the login page. Please read it and then click **I agree**. + +2. On the **Config Server** page of Explorer, configure these fields: - **Graphd IP address**: Enter the IP address of the Graph service of NebulaGraph. For example, `192.168.10.100`. @@ -66,7 +78,7 @@ To connect Explorer to NebulaGraph, follow these steps: - If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords. -2. After the configuration, click the **Login** button. +3. After the configuration, click the **Login** button. !!! note diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 1c021f81561..a3d7016c83a 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -309,20 +309,6 @@ The Dag Controller can perform complex graph computing with NebulaGraph Analytic exec_file: /home/xxx/nebula-analytics/scripts/run_algo.sh ``` - - - - ## Next to do -When Explorer is started, use `http://:7002` to get access to Explorer. - -The following login page shows that Explorer is successfully connected to NebulaGraph. - -![NebulaGraph Explorer Login page](https://docs-cdn.nebula-graph.com.cn/figures/explorer_deploy.png) - -!!! note - - When logging into NebulaGraph Explorer for the first time, the content of *END USER LICENSE AGREEMENT* is displayed on the login page. Please read it and then click **I agree**. - -After entering the Explorer login interface, you need to connect to NebulaGraph. For more information, refer to [Connecting to the NebulaGraph](../deploy-connect/ex-ug-connect.md). +[Connect to Explorer](ex-ug-connect.md) diff --git a/mkdocs.yml b/mkdocs.yml index 234e825cb4c..6e00b5aa548 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -575,6 +575,7 @@ nav: - NebulaGraph Dashboard Enterprise Edition: - What is NebulaGraph Dashboard Enterprise Edition: nebula-dashboard-ent/1.what-is-dashboard-ent.md - Deploy Dashboard Enterprise Edition: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md + - Connect to Dashboard: nebula-dashboard-ent/3.connect-dashboard.md - NebulaGraph Dashboard Enterprise Edition license: nebula-dashboard-ent/11.dashboard-ent-license.md - Create and import clusters: - Create clusters: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md From 66a258050204adc4dda72bf3cf25bca12ff07321 Mon Sep 17 00:00:00 2001 From: "min.wu" <50101159+whitewum@users.noreply.github.com> Date: Mon, 30 Jan 2023 14:44:44 +0800 Subject: [PATCH 02/30] Update 1.create-space.md (#1872) --- docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md index a3cbff286b4..d5c26432afe 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/1.create-space.md @@ -25,7 +25,7 @@ CREATE SPACE [IF NOT EXISTS] ( |``|Uniquely identifies a graph space in a NebulaGraph instance. The name of the graph space starts with a letter, supports 1 to 4 bytes UTF-8 encoded characters, such as English letters (case-sensitive), digits, and Chinese characters, but does not support special characters except underscores. To use special characters or reserved keywords as identifiers, quote them with backticks. For more information, see [Keywords and reserved words](../../3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md).| |`partition_num`|Specifies the number of partitions in each replica. The suggested value is 20 times (2 times for HDD) the number of the hard disks in the cluster. For example, if you have three hard disks in the cluster, we recommend that you set 60 partitions. The default value is 100.| |`replica_factor`|Specifies the number of replicas in the cluster. The suggested number is 3 in a production environment and 1 in a test environment. The replica number must be an **odd number** for the need of quorum-based voting. The default value is 1.| -|`vid_type`|A required parameter. Specifies the VID type in a graph space. Available values are `FIXED_STRING(N)` and `INT64`. `INT` equals to `INT64`.
``FIXED_STRING()` specifies the VID as a string, while `INT64` specifies it as an integer. `N` represents the maximum length of the VIDs. If you set a VID that is longer than `N` bytes, NebulaGraph throws an error.| +|`vid_type`|A required parameter. Specifies the VID type in a graph space. Available values are `FIXED_STRING(N)` and `INT64`. `INT` equals to `INT64`.
``FIXED_STRING()` specifies the VID as a string, while `INT64` specifies it as an integer. `N` represents the maximum length of the VIDs. If you set a VID that is longer than `N` bytes, NebulaGraph throws an error. Note, for UTF-8 chars, the length may vary in different cases, i.e. a UTF-8 Chinese char is 3 byte, this means 11 Chinese chars(length-33) will exeed a FIXED_STRING(32) vid defination.| |`COMMENT`|The remarks of the graph space. The maximum length is 256 bytes. By default, there is no comments on a space.| + ## Differences with HDFS The Storage Service is a Raft-based distributed architecture, which has certain differences with that of HDFS. For example: diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md index d753607498e..f03ce4184be 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -174,6 +174,8 @@ For more information, see [RocksDB official documentation](https://rocksdb.org/) {{ ent.ent_begin }} + ## Black box configurations From cd12f1e56e0f4cfedeb304dac6a181571c9a977c Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 3 Feb 2023 11:03:48 +0800 Subject: [PATCH 27/30] studio 3.6.0 release notes (#1916) * studio 3.6.0 release notes * update --- .../release-notes/studio-release-note.md | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/studio-release-note.md b/docs-2.0/20.appendix/release-notes/studio-release-note.md index 83955f511f2..731017ebc52 100644 --- a/docs-2.0/20.appendix/release-notes/studio-release-note.md +++ b/docs-2.0/20.appendix/release-notes/studio-release-note.md @@ -1,16 +1,21 @@ # NebulaGraph Studio release notes -## v3.5.0 +## v3.6.0 - Feature - - Support [schema drafting](../../nebula-studio/quick-start/draft.md). The Schema is designed directly by dragging and dropping on the canvas. The vertex and edge relationship is more intuitive and supports applying the schema to a graph space with one click. + - Support viewing the [creation statements](../../nebula-studio/manage-schema/st-ug-view-schema.md) of the schema. + - Add product feedback page. - Enhancement - - The welcome page provides some demo datasets. - - The console supports adding comments with `//`. - - The favorites folder contents can be saved on the server. - - Support searching graph space names in the graph space list. - - Added a white screen page for the crash. + - Remove the timeout limit for slow queries. + - Browser compatibility hint. + - Optimize the login page. + - Support adding comments with `#` on the console page. + - Optimize the console page. - Bugfix - - Fixed the bug that importing Int8/16/32 and fixed_string data failed. \ No newline at end of file + + - Fix the bug that the list has not been refreshed after uploading files. + - Fix the invalid error message of the schema drafting. + - Fix the bug that the **view schema** data has not been cleared after switching the login user. + - Fix the presentation problem of the thumbnail in the schema drafting. \ No newline at end of file From 5065048cd5fab0dda14dd4314a338b0421fd9c75 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Fri, 3 Feb 2023 11:27:51 +0800 Subject: [PATCH 28/30] Update use-importer.md (#1915) * Update use-importer.md * Update docs-2.0/nebula-importer/use-importer.md --------- Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com> --- docs-2.0/nebula-importer/use-importer.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md index e5986a7c64a..9bbcc9fa392 100644 --- a/docs-2.0/nebula-importer/use-importer.md +++ b/docs-2.0/nebula-importer/use-importer.md @@ -214,6 +214,7 @@ files: withHeader: false withLabel: false delimiter: "," + lazyQuotes: false ``` |Parameter|Default value|Required|Description| @@ -229,6 +230,7 @@ files: |`files.csv.withHeader`|`false`|Yes|Whether there is a header.| |`files.csv.withLabel`|`false`|Yes|Whether there is a label.| |`files.csv.delimiter`|`","`|Yes|Specifies the delimiter for the CSV file. A string delimiter that supports only one character.| +|`lazyQuotes`|`false`|No|If `lazyQuotes` is true, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field.| #### Schema configuration @@ -252,14 +254,23 @@ schema: - name: age type: int index: 2 + - name: name + type: string + index: 1 - name: gender type: string + - name: phone + type: string + nullable: true + - name: wechat + type: string + nullable: true + nullValue: "__NULL__" ``` |Parameter|Default value|Required|Description| |:---|:---|:---|:---| |`files.schema.type`|-|Yes|Schema type. Possible values are `vertex` and `edge`.| -|`files.schema.vertex.vid.type`|-|No|The data type of the vertex ID. Possible values are `int` and `string`.| |`files.schema.vertex.vid.index`|-|No|The vertex ID corresponds to the column number in the CSV file.| |`files.schema.vertex.vid.function`|-|No|Functions to generate the VIDs. Currently, we only support function `hash`.| |`files.schema.vertex.vid.prefix`|-|No|Add prefix to the original vid. When function is specified also, `prefix` is applied to the original vid before `function`.| @@ -267,6 +278,10 @@ schema: |`files.schema.vertex.tags.props.name`|-|Yes|Tag property name, which must match the Tag property in the NebulaGraph.| |`files.schema.vertex.tags.props.type`|-|Yes|Property data type, supporting `bool`,`int`,`float`,`double`,`string`,`time`,`timestamp`,`date`,`datetime`,`geography`,`geography(point)`,`geography(linestring)` and `geography(polygon)`.| |`files.schema.vertex.tags.props.index`|-|No|Property corresponds to the sequence number of the column in the CSV file.| +|`files.schema.vertex.tags.props.nullable`|`false`|No|Whether this prop property can be `NULL`, optional values is `true` or `false`.| +|`files.schema.vertex.tags.props.nullValue`|`""`|No|Ignored when nullable is false. The property is set to NULL when the value is equal to nullValue.| +|`files.schema.vertex.tags.props.alternativeIndices`|-|No| Ignored when `nullable` is `false`. When the property value is not `nullValue`, the value is fetched from csv according to the index sequence.| +|`files.schema.vertex.tags.props.defaultValue`|-|No| Ignored when `nullable` is false. The property default value, when all the values obtained by `index` and `alternativeIndices` are `nullValue`.| !!! note The sequence numbers of the columns in the CSV file start from 0, that is, the sequence numbers of the first column are 0, and the sequence numbers of the second column are 1. From 19a3b9ebd4accdb2b1c1f5ddf198d1d4daca0af6 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 3 Feb 2023 11:28:37 +0800 Subject: [PATCH 29/30] update explorer 3.4.0 release notes (#1914) --- .../release-notes/explorer-release-note.md | 69 +++++++++++-------- 1 file changed, 39 insertions(+), 30 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/explorer-release-note.md b/docs-2.0/20.appendix/release-notes/explorer-release-note.md index 3073e0ba455..1092225ded1 100644 --- a/docs-2.0/20.appendix/release-notes/explorer-release-note.md +++ b/docs-2.0/20.appendix/release-notes/explorer-release-note.md @@ -1,38 +1,47 @@ # NebulaGraph Explorer release notes -## v3.2.1 - -- Bugfix - - Fixed the bug that the connection timeout and HTTP error `500` when connecting to a non-existent address. - - Fixed the bug that the vertex properties could not be displayed on the canvas when randomly importing vertices. - -## v3.2.0 +## v3.4.0 - Feature - - Support [edge aggregation](../..//nebula-explorer/canvas-operations/visualization-mode.md). The edges with the same starting vertex, end vertex and edge type on the canvas are aggregated, making it clear which vertices have a lot of relationships. It also supports the computation of properties of aggregated edges. - - Support [schema drafting](../../nebula-explorer/db-management/draft.md). The Schema is designed directly by dragging and dropping on the canvas. The vertex and edge relationship is more intuitive and supports applying the schema to a graph space with one click. - - Support [iFrame](../../nebula-explorer/iframe.md). You can embedding canvas into third-party pages by using inline frameworks. - - Support [custom icon library and edge style](../../nebula-explorer/canvas-operations/canvas-overview.md). Explorer has ten built-in icons for industry categories and supports uploading pictures as an icon. - - Support [nGQL template](../../nebula-explorer/db-management/ngql-template.md). Design the query statement template directly or make nGQL statement as a template in the console, and then directly call the template and fill in the parameters to query. - - Support [database user management](../../nebula-explorer/db-management/dbuser_management.md). Manage database users visually, including creating and authorizing users. - - Workflow added [node2vec algorithm](../../graph-computing/algorithm-description.md). - - (Beta) Support [OAuth 2.0 authentication](../../nebula-explorer/deploy-connect/ex-ug-connect.md). Users can log in to Explorer only after being authenticated by OAuth2.0 to ensure data security. + + - Support viewing the [creation statements](../../nebula-explorer/db-management/10.create-schema.md) of the schema. + - Add beta function switch on the global settings page. + - Add product feedback page. - Enhancement - - The [Dag Controller](../../nebula-explorer/deploy-connect/ex-ug-deploy.md) is built into the installation package. - - The welcome page provides some demo datasets. - - Increases the drag effect of the vertex. - - The console supports adding comments with `//`. - - The favorites folder contents can be saved on the server. - - Support searching graph space names in the graph space list. - - The workflow prompts you to enter a missing parameter manually. - - The help page provides introductory videos. - - Workflow supports the configuration of resources on the page. - - Added a white screen page for the crash. - - Optimize page loading speed. + + - Remove the timeout limit for slow queries. + - Keep history on the console page after switching pages. + - Support adding comments with `#` on the console page. + - Support adding comments with `#` or `//` when creating nGQL templates. + - Update the global settings page. + - Support the visual modification of the IP whitelist. + - Show VID on canvas by default. + - Browser compatibility hint. + - Show the kernel version in the connection information. + - Add indexes to the built-in dataset. + - Optimize the login page. + - Optimize Workflow: + - Add algorithm descriptions. + - Optimize the parameter configurations of the graph algorithm. + - Optimize the presentation of the result. + - Optimize interaction: + - Vertex filter + - Query by tag + - Search path + - Optimize presentation: + - Optimize the presentation of schema statistics. + - Optimize the layout of force. + - Optimize the layout of the visual query results after importing them to the canvas. + - Optimize the presentation of vertices on dangling edges. + - Optimize the console page. + - Optimize hint: + - Optimize guidances. + - Optimize error messages. - Bugfix - - Fixed the bug that the right-click menu would not collapse automatically. - - Fixed the bug that the canvas auto-scaling when adding filter criteria. - - Fixed the bug that the canvas shook when switching to 3D mode with a large amount of data. - - Fixed the bug that importing Int8/16/32 and fixed_string data failed. + + - Fix the bug that can not be able to view the import task log. + - Fix the bug that some data of the edges in the `demo_basketballplayer` dataset is missing. + - Fix the crash of the page. + - Fix the bug that the results of the graph algorithm in the workflow can not show the details of vertices after importing them to canvas. \ No newline at end of file From fa48b8286e6c81dd3ad5a561ef2cca7e76779ace Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 3 Feb 2023 11:49:36 +0800 Subject: [PATCH 30/30] Update explorer-release-note.md (#1924) --- .../release-notes/explorer-release-note.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs-2.0/20.appendix/release-notes/explorer-release-note.md b/docs-2.0/20.appendix/release-notes/explorer-release-note.md index 1092225ded1..7db517a913c 100644 --- a/docs-2.0/20.appendix/release-notes/explorer-release-note.md +++ b/docs-2.0/20.appendix/release-notes/explorer-release-note.md @@ -5,8 +5,8 @@ - Feature - Support viewing the [creation statements](../../nebula-explorer/db-management/10.create-schema.md) of the schema. - - Add beta function switch on the global settings page. - - Add product feedback page. + - Add a **Beta functions** switch button on the global settings page. + - Add a product feedback page. - Enhancement @@ -17,7 +17,7 @@ - Update the global settings page. - Support the visual modification of the IP whitelist. - Show VID on canvas by default. - - Browser compatibility hint. + - Display browser compatibility hints. - Show the kernel version in the connection information. - Add indexes to the built-in dataset. - Optimize the login page. @@ -25,17 +25,17 @@ - Add algorithm descriptions. - Optimize the parameter configurations of the graph algorithm. - Optimize the presentation of the result. - - Optimize interaction: + - Optimize interactions: - Vertex filter - Query by tag - Search path - - Optimize presentation: + - Optimize presentations: - Optimize the presentation of schema statistics. - Optimize the layout of force. - Optimize the layout of the visual query results after importing them to the canvas. - Optimize the presentation of vertices on dangling edges. - Optimize the console page. - - Optimize hint: + - Optimize hints: - Optimize guidances. - Optimize error messages. @@ -44,4 +44,4 @@ - Fix the bug that can not be able to view the import task log. - Fix the bug that some data of the edges in the `demo_basketballplayer` dataset is missing. - Fix the crash of the page. - - Fix the bug that the results of the graph algorithm in the workflow can not show the details of vertices after importing them to canvas. \ No newline at end of file + - Fix the bug that the results of the graph algorithm in the workflow can not show the details of vertices after importing them to canvas.