Skip to content

Connect to NebulaGraph

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

Prerequisites

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

  • The NebulaGraph 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 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.

Procedure

To connect Studio to NebulaGraph, 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 NebulaGraph. The valid format is IP:port. The default port is 9669.

      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.

    • Username and Password: Fill in the log in account according to the authentication settings of NebulaGraph.

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

    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.

Next to do

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

  • Create a schema on the Console page or on the Schema page.
  • Batch import data on the Import page.
  • Execute nGQL statements on the Console page.
  • Design the schema visually on the Schema drafting page.

Note

The permissions of an account determine the operations that can be performed. For details, see Roles and privileges.

Log out

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

Last update: February 19, 2024