Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update studio v3.0.0 connect and reset #635

Merged
merged 1 commit into from
Aug 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Studio provides these features:

You can use Studio in one of these scenarios:

- You have a dataset, and you want to explore and analyze data in a visualized way. You can use Docker Compose or Nebula Graph Cloud Service to deploy Nebula Graph and then use Studio to explore or analyze data in a visualized way.
- You have a dataset, and you want to explore and analyze data in a visualized way. You can use Docker Compose to deploy Nebula Graph and then use Studio to explore or analyze data in a visualized way.

- You have deployed Nebula Graph and imported a dataset. You want to use a GUI to run nGQL statements or explore and analyze graph data in a visualized way.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Connect to Nebula Graph

On Nebula Graph Cloud Service, you can connect to Studio with one click. For more information, see [Connect to Nebula Graph Studio](https://cloud-docs.nebula-graph.com.cn/en/posts/manage-instances/dbaas-ug-connect-nebulastudio/). For Docker-based and RPM-based Studio v2.x, when it is started, you must configure it to connect to Nebula Graph v2.x. This article introduces how to connect Docker-based and PRM-based Studio v2.x to Nebula Graph v2.x.
<!--
On Nebula Graph Cloud Service, you can connect to Studio with one click. For more information, see [Connect to Nebula Graph Studio](https://cloud-docs.nebula-graph.com.cn/en/posts/manage-instances/dbaas-ug-connect-nebulastudio/).
-->
For Studio v2.x, when it is started, you must configure it to connect to Nebula Graph v2.x. This article introduces how to connect Studio v2.x to Nebula Graph v2.x.

## Prerequisites

Before you connect Docker-based or RPM-based Studio v2.x to Nebula Graph v2.x, you must do a check of these:
Before you connect Studio v2.x to Nebula Graph v2.x, you must do a check of these:

- The Nebula Graph v2.x services and Studio v2.x are started. For more information, see [Deploy Studio](st-ug-deploy.md).
- The Nebula Graph services and Studio are started. For more information, see [Deploy Studio](st-ug-deploy.md).

- You have the IP address and the port used by the Graph service of Nebula Graph v2.x. The default port is `9669`.

Expand All @@ -18,12 +20,12 @@ Before you connect Docker-based or RPM-based Studio v2.x to Nebula Graph v2.x, y

!!! note

If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the default username (user) and the default password (password) to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/2.0.1/).
If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/{{ nebula.release }}/).


## Procedure

To connect Docker-based and RPM-based Studio to Nebula Graph, follow these steps:
To connect Studio to Nebula Graph, follow these steps:

1. On the **Config Server** page of Studio, configure these fields:

Expand All @@ -34,17 +36,17 @@ To connect Docker-based and RPM-based Studio to Nebula Graph, follow these steps
When Nebula Graph and Studio are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field.

- **Username** and **Password**: Fill in the log in account according to the authentication settings of Nebula Graph
- If authentication is not enabled, you can use `user` and `password` as the username and its password.
- If authentication is not enabled, you can use `root` and any password as the username and its password.
- 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](../figs/st-ug-050-1.png "Config Server")

2. After the configuration, click the **Connect** button.

If you can see the **Console** page, Docker-based and RPM-based Studio is successfully connected to Nebula Graph.
If you can see the **Console** page, is successfully connected to Nebula Graph.

![The Console page shows that the connection is successful](../figs/st-ug-051-1.png "Nebula Graph is connected")
![The Console page shows that the connection is successful](../figs/st-ug-051.png "Nebula Graph is connected")

One session continues for up to 30 minutes. If you do not operate Studio within 30 minutes, the active session will time out and you must connect to Nebula Graph again.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Clear connection
<!--
On Nebula Graph Cloud Service, users cannot clear the connection.
-->
If you want to reset Nebula Graph, you can clear the connection and reconfigure the database

When the Studio is still connected to a Nebula Graph database, you can choose **setting > clear connect** at the toolbar. If the **Config Server** page is displayed on the browser, it means that Studio has successfully disconnected from the Nebula Graph database.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-051-1.png
Binary file not shown.
Binary file modified docs-2.0/nebula-studio/figs/st-ug-051.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.