# Constants

Active is the state for a normal row.
ApprovalGroupDBA means the assignee can be selected from the workspace owners and DBAs.
ApprovalGroupOwner means the assignee can be selected from the project owners.
ApprovalStrategyAutomatic means the pipeline will automatically be approved without user intervention.
ApprovalStrategyManual means the pipeline should be manually approved by user to proceed.
BackupPlanScheduleDaily is DAILY backup plan policy value.
BackupPlanScheduleUnset is NEVER backup plan policy value.
BackupPlanScheduleWeekly is WEEKLY backup plan policy value.
DataSourceAdmin is the ADMIN type of data source.
DataSourceRO is the read-only type of data source.
Deleted is the state for an removed row.
DeploymentTypeDatabaseCreate is the deployment type for creating databases.
DeploymentTypeDatabaseDDL is the deployment type for updating database schemas (DDL).
DeploymentTypeDatabaseDDLGhost is the deployment type for updating database schemas using gh-ost.
DeploymentTypeDatabaseDML is the deployment type for updating database data (DML).
DeploymentTypeDatabaseDMLRollback is the deployment type for a generated rollback issue.
DeploymentTypeDatabaseRestorePITR is the deployment type for performing a Point-in-time Recovery.
EngineTypeClickHouse is the database type for CLICKHOUSE.
EngineTypeMariaDB is the database type for MARIADB.
EngineTypeMongoDB is the database type for MongoDB.
EngineTypeMSSQL is the database type for MSSQL.
EngineTypeMySQL is the database type for MYSQL.
EngineTypeOceanbase is the database type for OCEANBASE.
EngineTypeOracle is the database type for ORACLE.
EngineTypePostgres is the database type for POSTGRES.
EngineTypeRedis is the database type for REDIS.
EngineTypeRedshift is the database type for REDSHIFT.
EngineTypeSnowflake is the database type for SNOWFLAKE.
EngineTypeSpanner is the database type for SPANNER.
EngineTypeSQLite is the database type for SQLite.
EngineTypeTiDB is the database type for TiDB.
PolicyTypeAccessControl is the policy type for access control policy.
PolicyTypeBackupPlan is the policy type for backup plan policy.
PolicyTypeDeploymentApproval is the policy type for deployment approval policy.
PolicyTypeSensitiveData is the policy type for sensitive data policy.
PolicyTypeSQLReview is the policy type for SQL review policy.
ProjectSchemaChangeDDL the DDL schema change type in the project.
ProjectSchemaChangeSDL the SDL schema change type in the project.
ProjectTenantModeDisabled means the tenant mode for the project is disabled.
ProjectTenantModeEnabled means the tenant mode for the project is enabled.
ProjectVisibilityPrivate is the private visibility type for project.
ProjectVisibilityPublic is the public visibility type for project.
ProjectWorkflowUI is the UI workflow type.
ProjectWorkflowVCS is the VCS workflow type.
SchemaRuleAutoIncrementColumnNaming enforce the auto_increment column name format.
SchemaRuleCharsetAllowlist enforce the charset allowlist.
SchemaRuleCollationAllowlist enforce the collation allowlist.
SchemaRuleColumnAutoIncrementInitialValue enforce the initial auto-increment value.
SchemaRuleColumnAutoIncrementMustInteger require the auto-increment column to be integer.
SchemaRuleColumnAutoIncrementMustUnsigned enforce the auto-increment column to be unsigned.
SchemaRuleColumnCommentConvention enforce the column comment convention.
SchemaRuleColumnDisallowChange disallow CHANGE COLUMN statement.
SchemaRuleColumnDisallowChangeType disallow change column type.
SchemaRuleColumnDisallowChangingOrder disallow changing column order.
SchemaRuleColumnDisallowSetCharset disallow set column charset.
SchemaRuleColumnMaximumCharacterLength enforce the maximum character length.
SchemaRuleColumnNaming enforce the column name format.
SchemaRuleColumnNotNull enforce the columns cannot have NULL value.
SchemaRuleColumnRequireDefault enforce the column default.
SchemaRuleColumnSetDefaultForNotNull require the not null column to set default value.
SchemaRuleColumnTypeDisallowList enforce the column type disallow list.
SchemaRuleCommentLength limit comment length.
SchemaRuleCurrentTimeColumnCountLimit enforce the current column count limit.
SchemaRuleDropEmptyDatabase enforce the MySQL and TiDB support check if the database is empty before users drop it.
SchemaRuleFKNaming enforce the foreign key name format.
SchemaRuleIDXNaming enforce the index name format.
SchemaRuleIndexKeyNumberLimit enforce the index key number limit.
SchemaRuleIndexNoDuplicateColumn require the index no duplicate column.
SchemaRuleIndexPKTypeLimit enforce the type restriction of columns in primary key.
SchemaRuleIndexPrimaryKeyTypeAllowlist enforce the primary key type allowlist.
SchemaRuleIndexTotalNumberLimit enforce the index total number limit.
SchemaRuleIndexTypeNoBlob enforce the type restriction of columns in index.
SchemaRulePKNaming enforce the primary key name format.
SchemaRuleRequiredColumn enforce the required columns in each table.
SchemaRuleSchemaBackwardCompatibility enforce the MySQL and TiDB support check whether the schema change is backward compatible.
SchemaRuleStatementAffectedRowLimit enforce the UPDATE/DELETE affected row limit.
SchemaRuleStatementDisallowCommit disallow using commit in the issue.
SchemaRuleStatementDisallowLimit disallow the LIMIT clause in INSERT, DELETE and UPDATE statements.
SchemaRuleStatementDisallowOrderBy disallow the ORDER BY clause in DELETE and UPDATE statements.
SchemaRuleStatementDMLDryRun dry run the dml.
SchemaRuleStatementInsertDisallowOrderByRand disallow the order by rand in the INSERT statement.
SchemaRuleStatementInsertMustSpecifyColumn enforce the insert column specified.
SchemaRuleStatementInsertRowLimit enforce the insert row limit.
SchemaRuleStatementMergeAlterTable disallow redundant ALTER TABLE statements.
SchemaRuleStatementNoLeadingWildcardLike disallow leading '%' in LIKE, e.g.
SchemaRuleStatementNoSelectAll disallow 'SELECT *'.
SchemaRuleStatementRequireWhere require 'WHERE' clause.
SchemaRuleTableCommentConvention enforce the table comment convention.
SchemaRuleTableDisallowPartition disallow the table partition.
SchemaRuleTableDropNamingConvention require only the table following the naming convention can be deleted.
SchemaRuleTableNaming enforce the table name format.
SchemaRuleTableNoFK require the table disallow the foreign key.
SchemaRuleTableRequirePK require the table to have a primary key.
SchemaRuleUKNaming enforce the unique key name format.
SensitiveDataMaskTypeDefault is the sensitive data type to hide data with a default method.
SQLReviewRuleLevelDisabled is the disabled level for SQL review rule.
SQLReviewRuleLevelError is the error level for SQL review rule.
SQLReviewRuleLevelWarning is the warning level for SQL review rule.

# Structs

AccessControlPolicy is the API message for access control policy.
AccessControlRule is the API message for access control rule.
AuthResponse is the API message for user login response.
BackupPlanPolicy is the policy configuration for backup plan.
CommentConventionRulePayload is the payload for comment convention rule.
DatabaseFindMessage is the API message for finding database.
DatabaseMessage is the API message for database.
DatabasePatchMessage is the API message to patch the database.
DataSourceMessage is the API message for a data source.
DeploymentApprovalPolicy is the policy configuration for deployment approval.
DeploymentApprovalStrategy is the API message for deployment approval strategy.
EnvironmentMessage is the API message for an environment.
EnvironmentPatchMessage is the API message to patch the environment.
InstanceFindMessage is the API message for finding instance.
InstanceMessage is the API message for an instance.
InstancePatchMessage is the API message to patch the instance.
ListDatabaseMessage is the API message for list database response.
ListEnvironmentMessage is the API message for list environment response.
ListInstanceMessage is the API message for list instance response.
ListPolicyMessage is the API message for list policy response.
ListProjectMessage is the API message for list project response.
Login is the API message for user login.
NamingRulePayload is the payload for naming rule.
NumberTypeRulePayload is the number type payload.
PolicyFindMessage is the API message for finding policies.
PolicyMessage is the API message for policy.
PolicyPatchMessage is the API message to patch the policy.
ProjectMessage is the API message for project.
ProjectPatchMessage is the API message to patch the project.
RequiredColumnRulePayload is the payload for required column rule.
Role is the API message for role.
RoleAttribute is the attribute for role.
RoleUpsert is the API message for upserting a new role.
SensitiveData is the API message for sensitive data.
SensitiveDataPolicy is the API message for sensitive data policy.
SQLReviewPolicy is the API message for SQL review policy.
SQLReviewRule is the API message for SQL review rule.
StringArrayTypeRulePayload is the payload for rules with string array value.

# Interfaces

Client is the API message for Bytebase OpenAPI client.

# Type aliases

ApprovalGroup is the group for deployment approval policy.
ApprovalStrategy is strategy for deployment approval policy.
BackupPlanSchedule is schedule for backup plan policy.
DataSourceType is the type for data source.
DeploymentType is the type for deployment.
EngineType is the type of the instance engine.
PolicyType is the type for the policy.
ProjectSchemaChange is the schema change type for project.
ProjectTenantMode is the tenant mode for project.
ProjectVisibility is the visibility for project.
ProjectWorkflow is the workflow for project.
SensitiveDataMaskType is the mask type for sensitive data.
SQLReviewRuleLevel is the error level for SQL review rule.
SQLReviewRuleType is the type of schema rule.
State is the state for a row.