NebulaGraph Cloud quickstart guide

This guide covers how to quickly get started with NebulaGraph Cloud.

NebulaGraph Cloud is a cloud-native graph database service offered by NebulaGraph. It provides a web-based user interface (UI) for you to create and manage databases without the trouble of managing the underlying infrastructure.

Prerequisites

An AWS account is prepared.

Step 1. Sign up and log in to NebulaGraph Cloud

1. Open this URL in your browser.

2. Click Sign Up Now to create a NebulaGraph Cloud account using your email, Github or Google account.

   If using your email to sign up, you will receive an email containing a Verify button after registration. Click the button to verify your email address and set your password.

Step 2. Create a database

1. On the Database page that appears by default, click Create Database.

2. On the Create database tab, specify the following information:

   • Basic

     • Database Name: Customize a name for the database.
     • Cloud Provider: AWS is selected by default.
     • Region: The region us-east-2 is selected by default.
   • Capacity: Select a combination of node, storage size, and price based on your requirements. Now, you can enjoy a 14-day free trial with the resource combination of 2 vCPUs, 4GB RAM for a node.
   • Payment Method: Click AWS Marketplace Subscription to bind your AWS account as the payment method. You are prompted to log in to your AWS account and purchase NebulaGraph Cloud on the AWS Marketplace.

   Note

   After you complete the binding, it may take a few minutes for the payment method to be displayed on the NebulaGraph Cloud Web UI. You can refresh the page to check the status.

3. Review the summary on the right, then click Create.

(Optional) Step 3. Connect to your database

If you want to use SDKs to connect to your database, complete this step to configure network access, then move on to the subsequent steps. Otherwise, skip this step.

1. On the Database page, click the name of the database that you created to view the database details.

2. On the left-side navigation pane, click Network access under Security. NebulaGraph Cloud allows you to access the database through public network or private network. Follow either of the following steps based on your requirements:

   • Access the database through public network:

     1. On the IP Allow List tab, click the toggle switch to enable accessing the database through public network.
     2. Click + Add IP Addresses to add custom IP addresses to the allow list.

   • Access the database through private network:

     1. Click the Private Endpoint tab.

     2. On the Create Private Link Service pane, click Create to enable the private link service.

     3. On the Create Private Link Endpoint pane, specify your VPC ID and subnet ID, and run the automatically generated command in your AWS CLI to create the private link endpoint.

3. On the left-side navigation pane, click Overview under Basic.

4. In the upper-right corner of the Overview page, click Connect.

5. In the Connect to your database dialog box, specify the following items:

   • Select the connection type: Select Public or Private.
   • Install the client: Select NebulaGraph Java, NebulaGraph Go, or NebulaGraph Python, and click Download installation package for installation.
   • Connect: Click Generate or Regenerate, and take note of the following connection information: Host, Port, Username, and Password. If you need to refresh the password, click Regenerate.

6. Set up the SDKs with the connection information. For more information, see Java SDK guide, Go SDK guide, and Python SDK guide.

Step 4. Prepare data for your database

1. On the Database page, click the name of the database that you created to view the database details.

2. On the left-side navigation pane of the database details page, click Graph under Data.

3. You can import demo data or your custom data into the database. Follow either of the following methods based on your requirements.

   Use the demo dataset

   On the SCHEMA tab, click Use Demo Dataset to load the demo dataset in NebulaGraph Cloud. For more information, see Demo dataset.

   Import custom data

   Before you import data, you must create a graph to store the data to be imported. In NebulaGraph, graphs are created based on graph types, which define the data structure of the graphs. To ensure that your data is imported correctly, the graph type must match the data structure of the source data.

   1. (Optional) On the SCHEMA tab, click Create and follow the instructions introduced in Create schemas to create a schema.

   2. On the Schema page, select a schema and click the + plus icon next to Graph Type. Follow the instructions introduced in Create a graph type to create a graph type.

   3. On the Schema page, select the schema containing the graph types you created in step 2 and click Graph. Follow the instructions introduced in Create a graph to create a graph.

   4. Go to the database details page, and click Import on the left-side navigation pane.

   5. On the Import page, click Import Data and follow the instructions introduced in Create import task to import your data.

Step 5. Perform queries in the graph

1. On the Database page, click the name of the database that you created to view the database details.
2. On the left-side navigation pane of the database details page, click Query to perform queries in the console. For how to use the console, see Console overview.

For how to write GQL to perform queries, see GQL guide.

To log in to the GQL documentation center, enter the account of NebulaGraph Cloud you created in step 1 and the default password Nebula.123. You will be prompted to change the default password when you log in for the first time.

Step 6. Monitor database information and metrics

1. On the Database page, click the name of the database that you created to view the database details.
2. On the left-side navigation pane of the database details page, click Overview under Basic.
   • On the Basic pane, you can view the basic information of the database, such as the database name, status, and capacity.
   • On the Core Metrics pane, you can select the time range, start time and end time to view the core metrics of the database.

3. In the upper-right corner of the Core Metrics pane, click More to view more metrics. You can also click Metrics on the left-side navigation pane to view all the metrics of the database, including:

   • Query per second (QPS): The number of queries executed per second
   • Query latency (P95): The 95th percentile latency of queries
   • CPU utilization: The percentage of CPU used by the database
   • Memory utilization: The percentage of memory used by the database
   • Storage used: The amount of storage used by the database
   • Active Sessions: The frequency of changes in the number of active sessions