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..e0084323576 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 @@ -53,7 +53,7 @@ To connect Explorer to NebulaGraph, follow these steps: !!! note - - When NebulaGraph and Explorer are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field. + - When NebulaGraph and Explorer are deployed on the same machine, you must enter the IP address of the machine, instead of `127.0.0.1` or `localhost`. - When connecting a NebulaGraph database on a new tab, The new session will overwrite the sessions of the old TAB. If you need to log in to multiple NebulaGraph databases at the same time, you can use different browsers or non-trace mode. - **Port**: The port of the Graph service. The default port is `9669`. diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md index 69cd0ea6585..4d106db1a3b 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md @@ -9,28 +9,29 @@ Before connecting to the NebulaGraph database, you need to confirm the following - The NebulaGraph services and Studio are started. For more information, see [Deploy Studio](st-ug-deploy.md). - You have the local IP address and the port used by the Graph service of NebulaGraph. The default port is `9669`. - - !!! note - - Run `ifconfig` or `ipconfig` on the machine to get the IP address. - You have a NebulaGraph account and its password. - !!! note - - If authentication is enabled in NebulaGraph and different role-based accounts are created, you must use the assigned account to connect to NebulaGraph. If authentication is disabled, you can use the `root` and any password to connect to NebulaGraph. For more information, see [NebulaGraph Database Manual](https://docs.nebula-graph.io/). - ## Procedure To connect Studio to NebulaGraph, follow these steps: -1. On the **Config Server** page of Studio, configure these fields: +1. Type `http://:7001` in the address bar of your browser. + + The following login page shows that Studio is successfully connected to NebulaGraph. + + ![NebulaGraph Studio Login page](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_en.png) - - **Host**: Enter the IP address and the port of the Graph service of NebulaGraph. The valid format is `IP:port`. The default port is `9669`. +2. On the **Config Server** page of Studio, configure these fields: + + - **Graphd IP address**: Enter the IP address of the Graph service of NebulaGraph. For example, `192.168.10.100`. !!! note - When NebulaGraph and Studio are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field. + - When NebulaGraph and Studio are deployed on the same machine, you must enter the IP address of the machine, instead of `127.0.0.1` or `localhost`. + - When connecting to a NebulaGraph database on a new tab, a new session will overwrite the sessions of the old TAB. If you need to log in to multiple NebulaGraph databases simultaneously, you can use a different browser or non-trace mode. + + - **Port**: The port of the Graph service. The default port is `9669`. - **Username** and **Password**: Fill in the log in account according to the authentication settings of NebulaGraph. @@ -39,14 +40,16 @@ To connect Studio to NebulaGraph, follow these steps: - If authentication is enabled and no account information has been created, you can only log in as GOD role and use `root` and `nebula` as the username and its password. - If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords. - - ![The Config Server page shows the fields to be configured for connection](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png "Config Server") -2. After the configuration, click the **Connect** button. +3. After the configuration, click the **Connect** button. + + !!! note + + One session continues for up to 30 minutes. If you do not operate Studio within 30 minutes, the active session will time out and you must connect to NebulaGraph again. - A welcome page is displayed on the first login, showing the relevant functions according to the usage process, and the test datasets can be automatically downloaded and imported. +A welcome page is displayed on the first login, showing the relevant functions according to the usage process, and the test datasets can be automatically downloaded and imported. -One session continues for up to 30 minutes. If you do not operate Studio within 30 minutes, the active session will time out and you must connect to NebulaGraph again. +To visit the welcome page, click ![help](https://docs-cdn.nebula-graph.com.cn/figures/navbar-help.png). ## Next to do @@ -67,6 +70,4 @@ On NebulaGraph Cloud Service, users cannot clear the connection. --> If you want to reset NebulaGraph, you can log out and reconfigure the database. -When the Studio is still connected to a NebulaGraph database, you can click the user profile picture in the upper right corner, and choose **Log out**. If the **Config Server** page is displayed on the browser, it means that Studio has successfully disconnected from the NebulaGraph database. - -![reset](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png) \ No newline at end of file +Click the user profile picture in the upper right corner, and choose **Log out**. \ No newline at end of file diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md index 86347968d4a..e7d72a9c440 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md @@ -54,7 +54,7 @@ Before you deploy RPM-based Studio, you must confirm that: If you can see the **Config Server** page on the browser, Studio is started successfully. - ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png) + ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_en.png) ### Uninstall @@ -140,7 +140,7 @@ Before you deploy DEB-based Studio, you must do a check of these: If you can see the **Config Server** page on the browser, Studio is started successfully. - ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png) + ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_en.png) ### Uninstall @@ -190,7 +190,7 @@ Before you deploy tar-based Studio, you must do a check of these: If you can see the **Config Server** page on the browser, Studio is started successfully. - ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png) + ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_en.png) ### Stop Service @@ -263,7 +263,7 @@ To deploy and start Docker-based Studio, run the following commands. Here we use If you can see the **Config Server** page on the browser, Docker-based Studio is started successfully. - ![The Config Server page shows that Docker-based Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png "Docker-based Studio is started") + ![The Config Server page shows that Docker-based Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_en.png "Docker-based Studio is started") ## Helm-based Studio @@ -316,7 +316,7 @@ Before installing Studio, you need to install the following software and ensure If you can see the **Config Server** page on the browser, Studio is started successfully. - ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png "Studio is started") + ![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_en.png "Studio is started") ### Uninstall diff --git a/docs-2.0/nebula-studio/manage-schema/st-ug-view-schema.md b/docs-2.0/nebula-studio/manage-schema/st-ug-view-schema.md new file mode 100644 index 00000000000..9dc1a4c11a3 --- /dev/null +++ b/docs-2.0/nebula-studio/manage-schema/st-ug-view-schema.md @@ -0,0 +1,19 @@ +# View Schema + +Users can visually view schemas in NebulaGraph Studio. + +## Steps + +1. In the toolbar, click the **Schema** tab. + +2. In the **Graph Space List** page, find a graph space and then click its name or click **Schema** in the **Operations** column. + +3. Click **View Schema** tab and click the **Get Schema** button. + +## Other operations + +In the **Graph Space List** page, find a graph space and then perform the following operations in the **Operations** column: + +- View Schema DDL: Displays schema creation statements for the graph space, including graph spaces, tags, edge types, and indexes. +- Clone Graph Space: Clones the schema of the graph space to a new graph space. +- Delete Graph pace: Deletes the graph space, including the schema and all vertices and edges. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 234e825cb4c..60301711778 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -79,7 +79,6 @@ plugins: - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - nebula-cloud/* - nebula-cloud.md - - nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md # When publishing a version of a document that includes Enterprise Edition, annotation the following page # begin # - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md @@ -559,6 +558,7 @@ nav: - Operate Tags: nebula-studio/manage-schema/st-ug-crud-tag.md - Operate Edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md - Operate Indexes: nebula-studio/manage-schema/st-ug-crud-index.md + - View Schema: nebula-studio/manage-schema/st-ug-view-schema.md - Schema drafting: nebula-studio/quick-start/draft.md - Troubleshooting: - Database connection error: nebula-studio/troubleshooting/st-ug-config-server-errors.md