Feature returns whether a particular feature is available in a particular plan.

IsValidEnvironmentName checks if the environment name is valid.

Active is the member status for ACTIVE.

ActivityIssueApprovalNotify is the type for notifying issue approval.

ActivityIssueCommentCreate is the type for creating issue comments.

ActivityIssueCreate is the type for creating issues.

ActivityIssueFieldUpdate is the type for updating issue fields.

ActivityIssueStatusUpdate is the type for updating issue status.

ActivityMemberActivate is the type for activating members.

ActivityMemberCreate is the type for creating members.

ActivityMemberDeactivate is the type for deactivating members.

ActivityMemberRoleUpdate is the type for updating member roles.

Notifications via webhooks.

ActivityPipelineRollout is the type for notifying releasers to rollout.

ActivityPipelineStageStatusUpdate is the type for stage begins or ends.

ActivityPipelineTaskEarliestAllowedTimeUpdate is the type for updating pipeline task the earliest allowed time.

ActivityPipelineTaskStatementUpdate is the type for updating pipeline task SQL statement.

ActivityPipelineTaskRunStatusUpdate is the type for updating pipeline task run status.

ActivityPipelineTaskStatementUpdate is the type for updating pipeline task SQL statement.

ActivityPipelineTaskStatusUpdate is the type for updating pipeline task status.

ActivityProjectDatabaseTransfer is the type for transferring databases.

ActivityProjectMemberCreate is the type for creating project members.

ActivityProjectMemberDelete is the type for deleting project members.

ActivityProjectRepositoryPush is the type for pushing repositories.

ActivitySQLExport is the type for exporting SQL.

ActivitySQLQuery is the type for executing query.

Admin is the ADMIN type of data source.

AllUsers is the email of the pseudo allUsers account.

AllUsersID is the ID of the allUsers robot.

AnomalyDatabaseConnection is the anomaly type for database connections.

AnomalyDatabaseSchemaDrift is the anomaly type for database schema drifts.

AnomalyInstanceConnection is the anomaly type for instance connections.

AnomalyInstanceMigrationSchema is the anomaly type for schema migrations.

Archived is the status for an archived row.

ASC is the sort order to return in ascending order.

DatabaseLabelSizeMax is the maximum size of database labels.

DefaultPolicyID is the ID of the default policy.

DefaultProdEnvironmentID is the initial resource ID for the prod environment.

DefaultProdEnvironmentUID is the initial resource UID for the prod environment.

DefaultProjectID is the resource ID for the default project.

DefaultTestEnvironmentID is the initial resource ID for the test environment.

DESC is the sort order to return in descending order.

EndUser is the principal type for END_USER.

ENTERPRISE is the plan type for ENTERPRISE.

EnvironmentLabelKey is the reserved key for environment.

EnvironmentTierValueProtected is PROTECTED environment tier value.

EnvironmentTierValueUnprotected is UNPROTECTED environment tier value.

ExternalApprovalTypeFeishu is the ExternalApproval from feishu.

ExternalApprovalTypeRelay is the ExternalApproval from relay.

Feature2FA allows user to manage 2FA provider and authenticate (login) with 2FA.

FeatureAccessControl allows user to config the access control.

FeatureAIAssistant enables AI features powered by OpenAI.

FeatureAnnouncement enable announcement banner setting.

FeatureAuditLog enables viewing audit logs.

FeatureBatchQuery enables batch query databases in SQL Editor.

FeatureBranding enables customized branding.

FeatureCustomApproval enables custom risk level definition and custom approval chain definition.

FeatureCustomInstanceScanInterval allows user to customize schema and anomaly scan interval per instance.

FeatureCustomRole enables customizing roles.

FeatureDatabaseGrouping allows user to create database/schema groups.

FeatureDBAWorkflow enforces the DBA workflow.

FeatureDirectorySync allows to sync users and groups from Entra ID.

FeatureDisallowPasswordSignin allows user to disallow password signin.

FeatureDisallowSignup allows user to change the disallow signup flag.

FeatureEncryptedSecrets is a feature that allows user to setting the encrypted secrets for the database.

FeatureEnvironmentTierPolicy allows user to set the tier of an environment.

FeatureExternalSecretManager uses secrets from external secret manager.

FeatureIndexAdvisor provides the index advisor for databases.

FeatureInstanceSSHConnection provides SSH connection for instances.

FeatureIssueAdvancedSearch supports search issue with advanced filter.

FeatureIssueProjectSetting supports some advanced project settings for issue.

FeatureMultiTenancy allows user to enable batch mode for the project.

FeatureOnlineMigration allows user to perform online-migration.

FeaturePasswordRestriction allows user to configure the password restriction.

FeatureRBAC enables RBAC.

FeatureReadReplicaConnection allows user to set a read replica connection including host and port to data source.

FeatureRolloutPolicy allows user to specify approval policy for the environment e.g.

FeatureSchemaDrift detects if there occurs schema drift.

FeatureSchemaTemplate allows user to create and use the schema template.

FeatureSecureToken allows user to manage authentication token security.

FeatureSensitiveData allows user to annotate and protect sensitive data.

FeatureSharedSQLScript enables sharing sql script.

FeatureSQLReview allows user to specify schema policy for the environment e.g.

FeatureSSO allows user to manage SSO provider and authenticate (login) with SSO.

FeatureSyncSchemaAllVersions allows user to sync the base database schema all versions into target database.

FeatureTaskScheduleTime allows user to run task at a scheduled time.

FeatureWatermark enables full-screen watermark.

FREE is the plan type for FREE.

Invited is the member status for INVITED.

IssueCanceled is the issue status for CANCELED.

IssueDatabaseDataExport is the issue type for requesting data export.

IssueDatabaseGeneral is the issue type for general database issues.

IssueDone is the issue status for DONE.

IssueGrantRequest is the issue type for requesting grant.

IssueOpen is the issue status for OPEN.

Normal is the status for a normal row.

NotFound is the NOT_FOUND sync status.

OK is the OK sync status.

PipelineApprovalValueManualAlways means the pipeline should be manually approved by user to proceed.

PipelineApprovalValueManualNever means the pipeline will automatically be approved without user intervention.

PolicyResourceTypeDatabase is the resource type for databases.

PolicyResourceTypeEnvironment is the resource type for environments.

PolicyResourceTypeInstance is the resource type for instances.

PolicyResourceTypeProject is the resource type for projects.

PolicyResourceTypeUnknown is the unknown resource type.

PolicyResourceTypeWorkspace is the resource type for workspaces.

PolicyTypeDataSourceQuery is the policy type for data source query.

PolicyTypeDisableCopyData is the disable copy data policy type.

PolicyTypeEnvironmentTier is the tier of an environment.

PolicyTypeExportData is the policy type for data export control.

PolicyTypeIAM is the policy for IAM.

PolicyTypeMasking is the masking policy type.

PolicyTypeMaskingException is the masking exception policy type.

PolicyTypeMaskingRule is the masking rule policy type.

PolicyTypeRestrictIssueCreationForSQLReview is the policy type for restricting issue creation for SQL review.

PolicyTypeRollout is the rollout policy type.

PolicyTypeSlowQuery is the slow query policy type.

PolicyTypeTag is the policy type for resource tags.

PrincipalIDForFirstUser is the principal id for the first user in workspace.

ReservedTagReviewConfig is the tag for review config.

RO is the read-only type of data source.

ServiceAccount is the principal type for SERVICE_ACCOUNT.

ServiceAccountAccessKeyPrefix is the prefix for service account access key.

SettingAppIM is the setting name for IM applications.

SettingAuthSecret is the setting name for auth secret.

SettingBrandingLogo is the setting name for branding logo.

SettingDataClassification is the setting name for data classification.

SettingEnterpriseLicense is the setting name for enterprise license.

SettingMaskingAlgorithms is the setting name for masking algorithms.

SettingPasswordRestriction is the setting name for password.

SettingPluginAgent is the setting name for the internal agent API.

SettingPluginOpenAIEndpoint is used for OpenAI's API endpoint.

SettingPluginOpenAIKey is used for OpenAI's API key.

SettingSchemaTemplate is the setting name for schema template.

SettingSCIM is the setting name for SCIM config.

SettingSemanticTypes is the setting name for semantic types.

SettingSQLResultSizeLimit is the setting name for SQL query result size limit.

SettingWatermark is the setting name for watermark displaying.

SettingWorkspaceApproval is the setting name for workspace approval config.

SettingWorkspaceExternalApproval is the setting name for workspace external approval config.

SettingWorkspaceID is the setting name for workspace identifier.

SettingWorkspaceMailDelivery is the setting name for workspace mail delivery.

SettingWorkspaceProfile is the setting name for workspace profile settings.

SystemBot is the principal type for SYSTEM_BOT.

SystemBotEmail is the email of the system robot.

SystemBotID is the ID of the system robot.

TaskCanceled is the task status for CANCELED.

TaskDatabaseCreate is the task type for creating databases.

TaskDatabaseDataExport is the task type for exporting database data.

TaskDatabaseDataUpdate is the task type for updating database data.

TaskDatabaseSchemaBaseline is the task type for database schema baseline.

TaskDatabaseSchemaUpdate is the task type for updating database schemas.

TaskDatabaseSchemaUpdateGhostCutover is the task type for gh-ost switching the original table and the ghost table.

TaskDatabaseSchemaUpdateGhostSync is the task type for gh-ost syncing ghost table.

TaskDatabaseSchemaUpdateSDL is the task type for updating database schemas via state-based migration.

TaskDone is the task status for DONE.

TaskFailed is the task status for FAILED.

TaskGeneral is the task type for general tasks.

TaskPending is the task status for PENDING.

TaskPendingApproval is the task status for PENDING_APPROVAL.

TaskRunCanceled is the task run status for CANCELED.

TaskRunDone is the task run status for DONE.

TaskRunFailed is the task run status for FAILED.

TaskRunning is the task status for RUNNING.

TaskRunNotStarted is the task run status for NOT_STARTED.

TaskRunPending is the task run status of PENDING.

TaskRunRunning is the task run status for RUNNING.

TaskRunSkipped is the task run status for SKIPPED.

TaskRunUnknown is the task run status for UNKNOWN.

TaskSkipped is the task status for SKIPPED.

TEAM is the plan type for TEAM.

TenantLabelKey is the label key for tenant.

Unknown is the member status for UNKNOWN.

AllowedResourceTypes includes allowed resource types for each policy type.

FeatureMatrix is a map from the a particular feature to the respective enablement of a particular plan in [FREE, TEAM, Enterprise].

InstanceLimitFeature is the map for instance feature.

Progress is a generalized struct which can track the progress of a task.

TaskFind is the API message for finding tasks.

TaskPatch is the API message for patching a task.

ActivityType is the type for an activity.

AnomalyType is the type of a task.

DataSourceType is the type of data source.

EnvironmentTierValue is the value for environment tier policy.

ExternalApprovalType is the type of the ExternalApproval.

FeatureType is the type of a feature.

IssueStatus is the status of an issue.

IssueType is the type of an issue.

MemberStatus is the status of an member.

PipelineApprovalValue is value for approval policy.

PlanType is the type for a plan.

PolicyResourceType is the resource type for a policy.

PolicyType is the type or name of a policy.

PrincipalType is the type of a principal.

ReservedTag is the reserved tags for bb.policy.tag.

Role is the type of a role.

RowStatus is the status for a row.

SettingName is the name of a setting.

SortOrder is the sort order for the returned list.

SyncStatus is the database sync status.

TaskRunStatus is the status of a task run.

TaskStatus is the status of a task.

TaskType is the type of a task.