👀 Introduction toggle

Create Schema Review Policy

There are two ways to create the Schema Review Policy.

One is from Schema Review Policy dashboard in Settings.

schema-review-create-from-policy-dashboard

The other is from Environment dashboard.

schema-review-create-from-environment-dashboard

Creating the Schema Review Policy is a 3-step process.

Step 1

Specify the basic information, including display name for schema review policy, selected environment and schema review policy template.

!

Note that only ONE policy can be attached per Environment.

Step 2

Specify each Schema Review Rule, including error level and rule-specific fields.

Change rule level

You can choose one of Error, Warning and Disabled.

Error will block the automatic run of Issue, while Warning will not.

When the rule is Disabled, it will not take effect.

schema-review-change-rule-level

Change rule configuration

There are currently three types of rules that need to be configured.

Regular expression

The rule Table Naming Convention and Column Naming Convention use regular expression as format.

schema-review-change-regex

Template

The rule Index Naming Convention, Unique Key Naming Convention and Foreign Key Naming Convention use Template as format.

schema-review-change-template

Column list

The rule Enforce the Required Columns in Each Table needs Column List.

schema-review-change-column-list

Details of the rules can be found here.

Step 3

Preview and confirm the Schema Review Rule.