Skip to content

Connect to Nebula Graph

After successfully launching Studio, you need to configure to connect to Nebula Graph. This topic describes how Studio connects to the Nebula Graph database.

Prerequisites

Before connecting to the Nebula Graph database, you need to confirm the following information:

  • The Nebula Graph services and Studio are started. For more information, see Deploy Studio.
  • You have the local IP address and the port used by the Graph service of Nebula Graph. The default port is 9669.

    Note

    Run ifconfig or ipconfig on the machine to get the IP address.

  • You have a Nebula Graph account and its password.

    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 root and any password to connect to Nebula Graph. For more information, see Nebula Graph Database Manual.

Procedure

To connect Studio to Nebula Graph, follow these steps:

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

    • Host: Enter the IP address and the port of the Graph service of Nebula Graph. The valid format is IP:port. The default port is 9669.

      Note

      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 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

  2. After the configuration, click the Connect button.

    If you can see the Explore page, Studio is successfully connected to Nebula Graph.

    The Console page shows that the connection is successful

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.

Next to do

When Studio is successfully connected to Nebula Graph, you can do these operations:

  • If your account has GOD or ADMIN privilege, you can create a schema on the Console page or on the Schema page, batch import data on the Import page, and execute nGQL statements on the Console page.
  • If your account has DBA or USER privilege, you can batch import data on the Import page or execute nGQL statements on the Console page.
  • If your account has GUEST privilege, you can retrieve data with nGQL statements on the Console page or explore and analyze data on the Explore page.

Log out

If you want to reset Nebula Graph, you can log out and reconfigure the database.

When the Studio is still connected to a Nebula Graph 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 Nebula Graph database.

reset


Last update: August 12, 2022