Skip to main content

Manage SQL development policies

NineData provides default SQL development policies for development and production environments. Use these policies to enforce SQL review rules, control risky operations, and apply different standards to environments or individual data sources.

Important notes​

  • Newly created policies must be based on existing policies.
  • Default policies cannot be deleted, but they can be edited.
  • In the DevOps Pro edition, creating policies is not supported, while DevOps Enterprise edition has no such limitation.

Before you begin​

  • You have created or joined an organization, and this organization has subscribed to either DevOps Pro or DevOps Enterprise. Please ensure that your annual or monthly subscription is still active. For more information, please refer to Manage Organizations.
  • Your current account has switched to the target organization. For more information, please refer to Switching to an Organization.
  • You have the role of system administrator in the organization.

Create a policy​

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. On the Policy & Process page, click the SQL Dev Policy tab, and then click Create Policy.

    tip

    Alternatively, click Duplicate in the Actions column for the target policy to create a new policy based on it.

  4. In the Create Policy dialog, configure the parameters and click OK.

    • Duplicate Policy: Select the policy on which to base the new policy.

      tip

      If you opened this dialog by clicking Duplicate, this field is preselected.

    • Name: Enter a meaningful name for the new policy. The name must be 1 to 32 characters.

      tip

      If you opened this dialog by clicking Duplicate, this field is already filled in.

    • Description (optional): Enter a description for the new policy, which can be between 1 and 64 characters.

  5. The console opens the Details page. Edit and switch the target rules on this page.

    tip

    SQL development rules are grouped by module. Use the category tabs to switch between rule groups.

:::

Edit a policy​

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.
  3. On the Policy & Process page, click the SQL Dev Policy tab, and then click the target Name.
  4. The console opens the Details page. Edit and toggle the target policy on this page.

Delete a policy​

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. On the Policy & Process page, click the SQL Dev Policy tab.

  4. Click the policy you want to delete, and then click Delete on the Details page.

    tip

    Alternatively, click Delete in the Actions column for the target policy.

  5. In the confirmation window that appears, click Delete.

    tip

    If the current policy is already associated with an environment or data source, select a replacement policy for these resources in the Associated Envir. and datasources existed, Please modify first. window, and then click Modify and Delete.

Associate a policy with an environment​

After you associate a SQL development policy with an environment, the new policy replaces the previous environment policy. All data sources in that environment use the new policy.

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.
  3. On the Envir. Config tab, find the target environment name, and click Edit in the Actions column.
  4. In the Edit Envir. Config window, select the required SQL Dev Policy, and click OK.

Associate a policy with a data source​

After you associate a SQL development policy with a data source, that data source uses the selected policy instead of the policy inherited from its environment. Other data sources in the same environment are not affected.

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. Click the Datasource Config tab, find the target data source name, and click Edit in the Actions column.

    tip

    In the SQL Dev Policy associated with the data source, the bind icon on the left indicates that SQL Dev Policy has inherited the configuration in the environment.

  4. In the Edit Datasource Config window, clear the checkbox to the left of Inheriting Envir. Config under SQL Dev Policy, select the required policy, and click OK.

    tip

    To restore the SQL Dev Policy configured in the environment, select Inheriting Envir. Config again.

Appendix: Conceptual explanation​

When configuring a SQL development policy, review these important configuration items.

Configuration Item
Explanation
LevelsUse Must Modify and Suggested to adjust the severity of each rule based on business requirements.
  • Must Modify: The highest severity level for SQL issues. Apply this level to rules that protect the database from severe impact. Developers must fix these issues before continuing.
  • Suggested: A lower severity level for more flexible standards. Non-compliance may result in SQL statements that are harder to maintain or less efficient.
DB TypeLists all database types supported by the policy. Select one or more database types that the policy applies to.

Result​

The selected SQL development policy takes effect at the configured scope. Environment-level policies apply to all data sources in the environment, while data source policies override the inherited environment policy only for that data source.

Next steps​

  • Review the policy rules before applying them to production data sources.
  • Assign approval processes in Manage approval processes so SQL tasks follow the expected workflow.