Database management¶
Deployment mode
This guide includes fully managed creation, upgrade, and pricing rules. For BYOC, use Create a BYOC database and Manage the data plane and databases.
This topic introduces how to manage database instances in NebulaGraph Cloud, including creating, suspending, resuming, scaling, and deleting instances.
Prerequisites¶
- A project is created. For more information, see Create a project.
- To perform the operations in this topic, you must be granted related roles. For more information, see Access control.
Create an instance¶
Required role: Project Admin
- In NebulaGraph Cloud, switch to the project you want to use.
- In the left-side navigation pane, click Databases.
- On the database page, click Create Database in the upper-right corner.
-
On the Create database page, specify the following information:
-
Database Tier: Select a plan based on your requirements:
- Standard: For development, learning, experimentation, and prototyping.
- Professional: For startups and scale-ups that need scalability and single-zone HA.
- Enterprise: For production workloads that need enterprise HA and larger specifications. It includes all Professional plan features, cross-AZ deployment with a replica factor of 3 by default, zone-aware routing, query and storage node specifications with up to 32 vCPUs and 256 GB RAM, and up to 2,560 GB of storage per storage node.
For a detailed comparison of the plans, see Upgrade to a paid plan.
-
Basic
- Database Name: Customize a name for the database.
- Cloud Provider: AWS is selected by default.
- Region: Choose the region based on your business requirements.
us-east-2is selected by default. For more information about the available regions for your business, see AWS Regions.us-east-2: US East (Ohio)us-west-2: US West (Oregon)
-
Capacity: Choose node and storage specifications based on your requirements.
New users can enjoy a 14-day free trial per NebulaGraph Cloud account, which comes with one database instance of 2 vCPUs, 4 GB of RAM, and 10 GB of storage, without requiring any payment information. For more information, see Try NebulaGraph Cloud for free.
- Payment Method: Click Add Payment Method 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.
-
-
Review the summary on the right, then click Create.
After the database instance is created, a dialog appears to display the administrator user
db_rootand password. The password is shown only once, so take note of it for later use.
Suspend & resume an instance¶
Required role: Project Admin
To suspend an instance, click ... of an instance on the Database page or its details page. In the drop-down list, select Suspend and confirm this action.
When the instance is suspended, note that:
- Only the following costs will be charged:
- Disk storage costs: $0.0002/GB/hour
- Fixed costs for data transfer usage: $0.0225/hour (charged if access to the instance through a public or private network is enabled)
- The instance is inaccessible, and read and write operations are impossible.
- The instance metrics are not monitored.
- The instance cannot be scaled.
To resume a suspended instance, click the Resume button for a database instance on the Database page. After confirming this action in a dialog, the instance's status will change from Suspended to Resuming, and then to Running. At this point, you will be charged fully based on your service plan and the affected items above will be restored.
Scale an instance¶
Required role: Project Admin
The available scaling operations depend on the database tier:
- Standard: Resize the node specification and increase the storage size.
- Professional and Enterprise: Resize node specifications, scale the numbers of Graph Nodes (query nodes) and Storage Nodes independently, and increase the storage size of each storage node.
Before performing a scaling operation, ensure that the database is on a paid plan and in the Running status.
Purchase a capacity bundle¶
This operation applies only to Standard databases.
When you first upgrade a Standard database to a paid plan, it remains at 2 vCPUs, 4 GB of RAM, and 10 GB of storage. Purchase a capacity bundle before resizing its node specification or increasing its storage size.
-
Open the capacity upgrade dialog from either of the following entry points:
- On the Databases page, click ... for the database and select Upgrade capacity.
- Open the database, go to its Overview page, click ..., and select Upgrade capacity.
-
Select a capacity bundle and click Upgrade capacity.
Resize node specification¶
The Resize operation is available for Standard, Professional, and Enterprise databases. For Standard databases upgraded from the free-trial capacity, purchase a capacity bundle before resizing.
-
Open the Resize dialog from either of the following entry points:
- On the Databases page, click ... for the database and select Resize.
- Open the database, go to its Overview page, click ..., and select Resize.
-
Review the current node specification displayed next to Current.
- Select the new node specification or specifications available for the database tier. The dialog displays the applicable price for each option.
- Review the estimated hourly cost and click Resize.
Warning
The database is temporarily unavailable while the resize operation is in progress.
Scale node counts¶
This operation applies only to Professional and Enterprise databases.
-
Open the Scale Database dialog from either of the following entry points:
- On the Databases page, click ... for a Professional or Enterprise database and select Scale.
- Open a Professional or Enterprise database, go to its Overview page, click ..., and select Scale.
-
Review the current tier and the current numbers of Graph Nodes and Storage Nodes.
- Select the new number of Graph Nodes and Storage Nodes. You can adjust the two node counts independently based on your workload.
- Review the estimated hourly cost and click Scale.
Warning
The database is unavailable while the scaling operation is in progress.
Increase storage size¶
To increase the database storage capacity, follow these steps. For Professional and Enterprise databases, the selected storage size applies to each storage node.
-
Open the Increase Storage Size dialog from either of the following entry points:
- On the Databases page, click ... for the database and select Increase Storage Size.
- Open the database, go to its Overview page, click ..., and select Increase Storage Size.
-
Enter or select a new Storage Size. The new value must be greater than the current storage size and within the range displayed in the dialog.
-
Review the total storage size, which is calculated as follows:
Storage size per node × Number of storage nodes -
Review the estimated hourly cost and click Increase Storage Size.
Warning
After the storage size is increased, it cannot be decreased.
Note that after the storage size is increased, you are not allowed to change it within the following 6 hours due to the limitation of Amazon EBS.
Delete an instance¶
Required role: Project Admin
To delete an instance, click ... of an instance on the Database page or its details page. In the drop-down list, select Delete and confirm this action.
For free trial users, your instance will be automatically deleted once the trial ends unless you upgrade to a paid plan beforehand.