Announce Bytebase 1.0 and our Team Plan view the plan

Database Review Guide

An online tool for DBA to generate the database schema review / DDL guideline. Support MySQL now, PostgreSQL later.

Guideline for Prod

Guideline for Dev

coming soon

Database Review Guide for MySQL

Engine

engine.mysql.use-innodb

Error

Require InnoDB as the storage engine.

Naming

naming.table

Warning

Enforce the table name format. Default snake_lower_case.

format: ^[a-z]+(_[a-z]+)?$

naming.column

Warning

Enforce the column name format. Default snake_lower_case.

format: ^[a-z]+(_[a-z]+)?$

naming.index.uk

Warning

Enforce the unique key name format.

uk: ^uk_{{table}}_{{column_list}}$

naming.index.idx

Warning

Enforce the index name format.

idx: ^idx_{{table}}_{{column_list}}$

Query

query.select.no-select-all

Error

Disallow 'SELECT *'.

query.where.require

Error

Require 'WHERE' clause.

query.where.no-leading-wildcard-like

Error

Disallow leading '%' in LIKE, e.g. LIKE foo = '%x' is not allowed.

Table

table.require-pk

Error

Require the table to have a primary key.

Column

column.required

Warning

Enforce the required columns in each table.

columns:
id created_ts updated_ts creator_id updater_id

column.no-null

Warning

Columns cannot have NULL value.

Made by

at 2022-05-21