Review Policy

In Bytebase, you can establish a SQL Review Policy for each environment or project. This policy consists of a set of SQL lint rules tailored to each database engine. Once configured, Bytebase will check SQL against those rules.

bb-sql-review-policy

Prerequisites#

Workspace Admin/DBA role to configure the Review Policy.

Access SQL Review Policy#

You can access SQL Review Policy from following places:

SQL Review under Security & Policy sidebar
Environment setting
Project setting

Start by Choosing a Template#

You can choose a predefined template or create a new policy from scratch.

bb-sql-review-basic-info

bb-sql-review-configure-rule

Add or Remove SQL Review Rules#

You can add or remove SQL Review rules per database engine to this policy.

bb-sql-review-add-remove

Change Rule Level#

You can choose one of Error, Warning and Disabled.

Both Warning and Error will block the automatic rollout if configured.

Attach to Resources#

Note that Project level policy has higher priority than Environment one.

You can attach the SQL Review Policy to environments or projects. Only ONE policy can be attached per Environment or Project.

bb-sql-review-attach-resource

Disable or Delete SQL Review Policy#

You can disable the SQL Review Policy to prevent it from taking effect.

After disabling it, you can delete it.

Edit this page on GitHub