Skip to main content

Get started with Database DevOps Professional or Enterprise Edition

Use this guide to set up NineData Database DevOps Professional or Enterprise Edition, invite organization members, add a data source, assign permissions, and run governed SQL changes.

Choose your starting point:

Edition promotion

Database DevOps Professional Edition offers 10 instances for permanent free use.

Procedure

Step One: Register for a NineData account

  1. Open the NineData Registration Page.

    registration

  2. Enter your phone number and click Get Verification Code, then enter the verification code sent by the NineData system.

    tip

    Only phone numbers from Mainland China are currently supported. If you are using a phone number outside the +86 area, you can only receive the verification code via email.

  3. Enter your username and password.

    tip

    The password strength requirements are as follows:

    • The password can contain letters, numbers, and special characters.

    • Length is 8~16 characters.

    • Must contain both letters and numbers.

    • Cannot contain empty characters (spaces).

  4. Enter your email and company name, read the Terms of Service and Privacy Policy carefully, then check the box in front of I have read and agree, and click Sign up.

    tip

    If you already entered your email address earlier, skip this field.

Step Two: Sign in to NineData

  1. Open the NineData Login Page.

    login

  2. Choose one of these sign-in methods: Password Login, Code Login, Login With SSO, or Login with WeChat .

    • Password Login: Enter the phone number or email address used during registration and the password, and then click Login.

      tip
      • If you use a phone number outside the +86 region, sign in with the email address used during registration.
      • If you forgot your login password, click Forgot Password and follow the prompts to Reset Password.
    • Code Login: Click Code Login, enter the phone number used during registration, click Get Code, enter the verification code sent by the NineData system, and then click Login.

      tip

      If you use a phone number outside the +86 region, enter the email address used during registration to receive the verification code.

    • Login With SSO: Sign in with SSO. For details, see Sign in to NineData through SSO.

    • Login with WeChat : Sign in to NineData by scanning the WeChat QR code.

Step Three: Invite Enterprise Members

  1. Log in to the NineData Console.

  2. From the left sidebar, go to Account > User.

    tip

    If you cannot find Account, confirm that the console is in organization mode. To switch from personal mode to organization mode, see Switch to Organization.

  3. On the User page, click Invite.

  4. In the Invite dialog, enter the email address of the member to invite, assign a role to that member, and then click OK. You can also click Add to invite multiple users at once.

    Role Description

    Each role contains a set of permissions. Users bound to a role inherit the permissions of that role. You can also create custom roles and grant only the permissions your team needs. For more information, see Manage Roles.

  5. Click OK to complete the user invitation. NineData then sends an invitation email to the user. After the user accepts the invitation and completes registration or sign-in, they can join the organization.

Step Four: Add Data Sources

This guide uses an Alibaba Cloud RDS MySQL public instance as the example data source. For other connection scenarios, see Create Data Sources.

  1. Add these NineData service node IPs to the whitelist of the Alibaba Cloud RDS MySQL instance. For whitelist instructions, see the Alibaba Cloud official documentation.

    • Hangzhou: 121.199.39.25
    • Beijing: 123.57.58.208
    • Zhangjiakou: 39.98.193.245
    • Shenzhen: 112.74.171.41
    • Shanghai: 116.63.42.85
  2. Log in to the NineData Console.

  3. From the left sidebar, go to Datasource > Datasource.

  4. Configure the data source by using the page prompts.

  5. After you finish the configuration, click Connection Test next to Create Datasource to test the connection. If the test returns Connection Successfully, click Create Datasource to add the data source. Otherwise, review the connection settings and test again.

    tip

    For detailed data source setup instructions, see Create Data Sources.

Step Five: Configure Data Source Access Permissions

NineData supports three authorization methods. Permissions granted through these methods coexist and do not override each other. This section uses authorizing through roles as an example to show how to grant data source access permissions to organization members.

Authorization Method
Authorization Initiator
Description
Request through approval workflowOrganization MemberOrganization members request permissions through Access Application. Use this method for temporary access when the member does not have the required permissions.
Authorize through RolesSystem AdministratorThe system administrator assigns roles to organization members for group-based permission management. When a member leaves the project, remove the role assignment.
Direct Authorization by AdministratorSystem AdministratorThe system administrator authorizes specific members directly. Use this method when permissions must be tailored for an individual user.
  1. Log in to the NineData Console.

  2. From the left sidebar, go to Account > Role.

    tip

    If you cannot find Account, confirm that the console is in organization mode. To switch from personal mode to organization mode, see Switch to Organization.

  3. Click Create Role in the lower left corner of the page.

  4. In the Create Role dialog box, enter a role name that identifies its purpose. Up to 16 characters are supported.

  5. Click OK to create the role. The console opens the permission configuration page for the new role. Under the Datasource Permission tab, click Add Permission.

    edit_role

  6. In the Add Permission window, select Environment or Datasource to authorize the new role, then click OK.

    tip
    • Environment: Authorize based on the environment configured during Adding Data Sources. An environment may be bound to multiple data sources.
    • Datasource: Directly select the corresponding data source for authorization.
  7. Configure the permissions for each module of the data source, then click Save.

    edit_permissions

  8. Next to Members, click Add. In the Add window, select one or more members to bind to this role.

    authorization

  9. After you click OK, the selected members appear in Members on the right. These members can now access the corresponding data sources.

    member_list

Step Six: Manage Data with SQL Console

  1. Log in to the NineData Console.

  2. From the left sidebar, go to DevOps > SQL Console.

    tip

    If you previously opened a data source and did not close it, NineData opens that data source page.

  3. Click the text box under SQL Console. The data source selector opens. Select the target data source and click Query to open SQL Console.

    tip

    If there are multiple data sources, you can enter full or partial keywords for exact or fuzzy search. These fields are searchable:

    • Data source name

    • IP address

      search

  4. After opening SQL Console, run data management operations on the data source.

    execute_sql

caution

For production changes, configure SQL development specifications and disable direct changes in SQL Console. Use SQL tasks with pre-audit, approval, and backup controls to reduce operational risk. For more information, see Step Seven: Release Production Changes.

Step Seven: Release Production Changes

For production databases, use SQL development specifications together with SQL tasks so every change follows a controlled approval workflow.

Disable SQL Console changes for production databases

  1. From the left sidebar, go to DevOps > Policy & Process.

  2. On the Policy & Process page, click the SQL Dev Policy tab, and then click the Name associated with the production data source.

  3. The console opens the Details page. Click the SQL Console tab, find these two rules, and use the settings in the table.

    Rule NameSwitch
    Edit Details
    Allowed SQL Console Update Data TypeOnClick Actions in the right column, find Allowed SQL Console Update Data, delete all operation types in the text box, and click OK.
    edit_dml_rule
    Allowed SQL Console Update Structure Operate TypeOnClick Actions in the right column, find SQL Console Allowed Type, delete all operation types in the text box, and click OK.
    edit_ddl_rule
  4. Open SQL Console from DevOps > SQL Console, and then try to change data. The change statement is intercepted and cannot be executed directly. You must submit an SQL task to perform the change.

    exec_intercepted

Release changes through SQL tasks

iShot_2023-06-16_15.15.45

  1. From the left sidebar, go to DevOps > SQL Task.

  2. On the SQL Task page, click Create SQL Task.

  3. On the Create SQL Task page, configure the SQL task.

    Parameter
    Description
    NameEnter a SQL task name that identifies the purpose of the change. Up to 64 characters are supported.
    DatasourceThe data source where the target database for change is located.
    DatabaseThe database where the SQL change needs to be executed.
    ExecutorThe person who executes the SQL statement after the current SQL task is approved.
    Note: The options in the Executor list depend on these conditions:
    • If the current data source is configured with development specifications, the list is based on the SQL Task Executor Config rule in the current specification. This rule is located on the SQL Task & Console tab. To configure development specifications, see Edit Specifications.
    • If the current data source is not configured with development specifications, the list shows users who have the SQL Task - Exec permission for the current data source. For authorization details, see Configure User Permissions.
    Note (Optional)A description of any unresolved matters for the current SQL task, such as the reason for executing the task, the expected execution time, etc.
    Alter SQLEnter the SQL statement to be executed or upload a file containing the SQL statement.
    • SQL Text: Directly enter the SQL statement to be executed in the text box.
    • SQL File: Click Upload File, select and upload a file containing the SQL statement to be executed.
      Note: After uploading, hover over the filename and choose review (Preview File) or delete (Delete File) next to the filename.
    Rollback SQL (Optional)Enter rollback SQL when your organization requires a rollback plan. NineData records it in the SQL task for compliance, but it does not affect the task lifecycle.
  4. Click Pre-Check. NineData checks the SQL in advance to identify syntax errors and other issues that may prevent execution. If an issue is found, click View Details in the prompt to view the error details and update the SQL.

  5. After Pre-Check is passed, click Save and Pre-Check to enter the Policy Pre-check page.

    tip

    The system pre-audits the SQL statement based on the SQL Development Specifications associated with the current data source. The result can be one of these outcomes:

    • Pre-audit passed: Depending on the approval process configuration, the task status changes to Pending or Approved. If approval submission is required, continue to the next step. If the task is already approved, the submission process is complete.
    • Pre-audit failed: The task status changes to Pre-Check Failed. Click Check Again to run pre-audit again, or withdraw the task, edit it, and submit it again.
  6. Click Submit Approval, select the workflow approvers in the dialog, and then click OK.

    tip

    The number of approvers depends on the approval process configured for the data source.

  7. The task status changes to Pending Approval. After approval, the designated Executor can execute the task. Before approval, these actions are available:

    • Withdraw: Withdraw the SQL task.
    • Transfer: Change the approver of the SQL task.
  8. After execution completes, return to SQL Console to verify that the changes were released successfully.

    change_success

Result

At the end of this guide, your organization has invited members, connected at least one data source, assigned access permissions, and established a controlled path for SQL changes.

Next steps

  • Create SQL development specifications for production data sources.
  • Configure approval processes for high-risk environments.
  • Use SQL tasks instead of direct SQL Console changes for production releases.