Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor(iam): bb.settings.getWorkspaceProfile permission (#18822)

ecmadao3d59cb5f73c7
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index 332535b1d8..db0a2e623b 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -6382,17 +6382,6 @@ components:
type: boolean
title: external_url_from_flag
description: Whether the external URL is set via command-line flag (and thus cannot be changed via UI).
- announcement:
- title: announcement
- description: The setting of custom announcement
- $ref: '#/components/schemas/bytebase.v1.Announcement'
- enableMetricCollection:
- type: boolean
- title: enable_metric_collection
- description: Whether to enable metric collection for the workspace.
- restriction:
- title: restriction
- $ref: '#/components/schemas/bytebase.v1.Restriction'
title: ActuatorInfo
additionalProperties: false
description: |-
@@ -13910,53 +13899,6 @@ components:
title: ResourcePackage
additionalProperties: false
description: Custom branding resources for the Bytebase instance.
- bytebase.v1.Restriction:
- type: object
- properties:
- disallowSignup:
- type: boolean
- title: disallow_signup
- description: Whether self-service user signup is disabled.
- require2fa:
- type: boolean
- title: require_2fa
- description: Whether two-factor authentication is required for all users.
- disallowPasswordSignin:
- type: boolean
- title: disallow_password_signin
- description: Whether password-based signin is disabled (except for workspace admins).
- passwordRestriction:
- title: password_restriction
- description: Password complexity and restriction requirements.
- $ref: '#/components/schemas/bytebase.v1.WorkspaceProfileSetting.PasswordRestriction'
- watermark:
- type: boolean
- title: watermark
- description: Whether to display watermark on pages.
- databaseChangeMode:
- title: database_change_mode
- description: The workspace database change mode.
- $ref: '#/components/schemas/bytebase.v1.DatabaseChangeMode'
- inactiveSessionTimeout:
- title: inactive_session_timeout
- description: The session expiration time if not activity detected for the user. Value <= 0 means no limit.
- $ref: '#/components/schemas/google.protobuf.Duration'
- domains:
- type: array
- items:
- type: string
- title: domains
- description: The workspace domain, e.g., bytebase.com.
- enforceIdentityDomain:
- type: boolean
- title: enforce_identity_domain
- description: Only user and group from the domains can be created and login.
- maximumRoleExpiration:
- title: maximum_role_expiration
- description: The max duration for role expired.
- $ref: '#/components/schemas/google.protobuf.Duration'
- title: Restriction
- additionalProperties: false
bytebase.v1.ReviewConfig:
type: object
properties:
@@ -18835,10 +18777,6 @@ components:
documentation for additional information.
security: []
tags:
- - name: bytebase.v1.IssueService
- description: IssueService manages issues for tracking database changes and tasks.
- - name: bytebase.v1.SettingService
- description: SettingService manages workspace-level settings and configurations.
- name: bytebase.v1.UserService
description: UserService manages user accounts and authentication.
- name: bytebase.v1.ActuatorService
@@ -18863,6 +18801,8 @@ tags:
description: GroupService manages user groups for organizing users and permissions.
- name: bytebase.v1.IdentityProviderService
description: IdentityProviderService manages external identity providers for SSO authentication.
+ - name: bytebase.v1.IssueService
+ description: IssueService manages issues for tracking database changes and tasks.
- name: bytebase.v1.OrgPolicyService
description: OrgPolicyService manages organizational policies at various resource levels.
- name: bytebase.v1.SQLService
@@ -18881,6 +18821,8 @@ tags:
description: RoleService manages workspace roles and permissions.
- name: bytebase.v1.RolloutService
description: RolloutService manages the execution of deployment plans.
+ - name: bytebase.v1.SettingService
+ description: SettingService manages workspace-level settings and configurations.
- name: bytebase.v1.SheetService
description: SheetService manages SQL scripts and saved queries.
- name: bytebase.v1.SubscriptionService
diff --git a/backend/api/v1/actuator_service.go b/backend/api/v1/actuator_service.go
index 812e92963a..c6fbc2e53a 100644
--- a/backend/api/v1/actuator_service.go
+++ b/backend/api/v1/actuator_service.go
@@ -141,8 +141,6 @@ func (s *ActuatorService) getServerInfo(ctx context.Context) (*v1pb.ActuatorInfo
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to find workspace setting"))
}
- passwordSetting := convertToPasswordRestrictionSetting(setting.GetPasswordRestriction())
-
systemSetting, err := s.store.GetSystemSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get system setting"))
@@ -168,35 +166,20 @@ func (s *ActuatorService) getServerInfo(ctx context.Context) (*v1pb.ActuatorInfo
externalURL = s.profile.ExternalURL
}
- restriction := &v1pb.Restriction{
- DisallowSignup: setting.DisallowSignup || s.profile.SaaS,
- Require_2Fa: setting.Require_2Fa,
- DisallowPasswordSignin: setting.DisallowPasswordSignin,
- PasswordRestriction: passwordSetting,
- Watermark: setting.GetWatermark(),
- InactiveSessionTimeout: setting.GetInactiveSessionTimeout(),
- DatabaseChangeMode: v1pb.DatabaseChangeMode(setting.DatabaseChangeMode),
- Domains: setting.GetDomains(),
- MaximumRoleExpiration: setting.GetMaximumRoleExpiration(),
- }
-
serverInfo := v1pb.ActuatorInfo{
- Version: s.profile.Version,
- GitCommit: s.profile.GitCommit,
- Saas: s.profile.SaaS,
- Demo: s.profile.Demo,
- NeedAdminSetup: activeEndUserCount == 0,
- ExternalUrl: externalURL,
- LastActiveTime: timestamppb.New(time.Unix(s.profile.LastActiveTS.Load(), 0)),
- WorkspaceId: workspaceID,
- Debug: s.profile.RuntimeDebug.Load(),
- Docker: s.profile.IsDocker,
- UnlicensedFeatures: unlicensedFeaturesString,
- EnableSample: hasSampleInstances,
- ExternalUrlFromFlag: s.profile.ExternalURL != "",
- Announcement: convertToV1Announcement(setting.Announcement),
- EnableMetricCollection: setting.GetEnableMetricCollection(),
- Restriction: restriction,
+ Version: s.profile.Version,
+ GitCommit: s.profile.GitCommit,
+ Saas: s.profile.SaaS,
+ Demo: s.profile.Demo,
+ NeedAdminSetup: activeEndUserCount == 0,
+ ExternalUrl: externalURL,
+ LastActiveTime: timestamppb.New(time.Unix(s.profile.LastActiveTS.Load(), 0)),
+ WorkspaceId: workspaceID,
+ Debug: s.profile.RuntimeDebug.Load(),
+ Docker: s.profile.IsDocker,
+ UnlicensedFeatures: unlicensedFeaturesString,
+ EnableSample: hasSampleInstances,
+ ExternalUrlFromFlag: s.profile.ExternalURL != "",
}
stats, err := s.store.StatUsers(ctx)
diff --git a/backend/api/v1/setting_service.go b/backend/api/v1/setting_service.go
index 50d52c4e26..828c66dc7f 100644
--- a/backend/api/v1/setting_service.go
+++ b/backend/api/v1/setting_service.go
@@ -71,6 +71,10 @@ func (s *SettingService) ListSettings(ctx context.Context, _ *connect.Request[v1
if setting.Name == storepb.SettingName_ENVIRONMENT {
continue
}
+ // workspace profile setting is controlled by bb.settings.getWorkspaceProfile permission, not expose in the ListSettings API.
+ if setting.Name == storepb.SettingName_WORKSPACE_PROFILE {
+ continue
+ }
settingMessage, err := convertToSettingMessage(setting, s.profile)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to convert setting message: %v", err))
@@ -98,9 +102,14 @@ func (s *SettingService) GetSetting(ctx context.Context, request *connect.Reques
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("setting is not available"))
}
- permission := iam.PermissionSettingsGet
- if storeSettingName == storepb.SettingName_ENVIRONMENT {
+ var permission iam.Permission
+ switch storeSettingName {
+ case storepb.SettingName_ENVIRONMENT:
permission = iam.PermissionEnvironmentSettingsGet
+ case storepb.SettingName_WORKSPACE_PROFILE:
+ permission = iam.PermissionWorkspaceProfileSettingsGet
+ default:
+ permission = iam.PermissionSettingsGet
}
if err := s.CheckSettingPermission(ctx, permission); err != nil {
return nil, err
@@ -146,9 +155,14 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("feature %s is unavailable in current mode", settingName))
}
- permission := iam.PermissionSettingsSet
- if storeSettingName == storepb.SettingName_ENVIRONMENT {
+ var permission iam.Permission
+ switch storeSettingName {
+ case storepb.SettingName_ENVIRONMENT:
permission = iam.PermissionEnvironmentSettingsSet
+ case storepb.SettingName_WORKSPACE_PROFILE:
+ permission = iam.PermissionWorkspaceProfileSettingsSet
+ default:
+ permission = iam.PermissionSettingsSet
}
if err := s.CheckSettingPermission(ctx, permission); err != nil {
return nil, err
diff --git a/backend/component/iam/acl.yaml b/backend/component/iam/acl.yaml
index d4a234d04d..7e7fa7a2c8 100644
--- a/backend/component/iam/acl.yaml
+++ b/backend/component/iam/acl.yaml
@@ -84,9 +84,11 @@ roles:
- bb.rollouts.list
- bb.settings.get
- bb.settings.getEnvironment
+ - bb.settings.getWorkspaceProfile
- bb.settings.list
- bb.settings.set
- bb.settings.setEnvironment
+ - bb.settings.setWorkspaceProfile
- bb.sheets.create
- bb.sheets.get
- bb.sheets.update
@@ -195,9 +197,11 @@ roles:
- bb.rollouts.list
- bb.settings.get
- bb.settings.getEnvironment
+ - bb.settings.getWorkspaceProfile
- bb.settings.list
- bb.settings.set
- bb.settings.setEnvironment
+ - bb.settings.setWorkspaceProfile
- bb.sheets.create
- bb.sheets.get
- bb.sheets.update
@@ -228,6 +232,7 @@ roles:
- bb.roles.list
- bb.roles.get
- bb.settings.getEnvironment
+ - bb.settings.getWorkspaceProfile
- bb.groups.create
- bb.groups.get
- bb.groups.list
diff --git a/backend/component/iam/permission.go b/backend/component/iam/permission.go
index 93dba14d6b..0ea176fd13 100644
--- a/backend/component/iam/permission.go
+++ b/backend/component/iam/permission.go
@@ -12,118 +12,120 @@ var permissionYAML []byte
type Permission = string
const (
- PermissionAuditLogsExport Permission = "bb.auditLogs.export"
- PermissionAuditLogsSearch Permission = "bb.auditLogs.search"
- PermissionChangelogsGet Permission = "bb.changelogs.get"
- PermissionChangelogsList Permission = "bb.changelogs.list"
- PermissionDatabaseCatalogsGet Permission = "bb.databaseCatalogs.get"
- PermissionDatabaseCatalogsUpdate Permission = "bb.databaseCatalogs.update"
- PermissionDatabaseGroupsCreate Permission = "bb.databaseGroups.create"
- PermissionDatabaseGroupsDelete Permission = "bb.databaseGroups.delete"
- PermissionDatabaseGroupsGet Permission = "bb.databaseGroups.get"
- PermissionDatabaseGroupsList Permission = "bb.databaseGroups.list"
- PermissionDatabaseGroupsUpdate Permission = "bb.databaseGroups.update"
- PermissionDatabasesCheck Permission = "bb.databases.check"
- PermissionDatabasesGet Permission = "bb.databases.get"
- PermissionDatabasesGetSchema Permission = "bb.databases.getSchema"
- PermissionDatabasesList Permission = "bb.databases.list"
- PermissionDatabasesSync Permission = "bb.databases.sync"
- PermissionDatabasesUpdate Permission = "bb.databases.update"
- PermissionIdentityProvidersCreate Permission = "bb.identityProviders.create"
- PermissionIdentityProvidersDelete Permission = "bb.identityProviders.delete"
- PermissionIdentityProvidersGet Permission = "bb.identityProviders.get"
- PermissionIdentityProvidersUpdate Permission = "bb.identityProviders.update"
- PermissionInstancesCreate Permission = "bb.instances.create"
- PermissionInstancesDelete Permission = "bb.instances.delete"
- PermissionInstancesGet Permission = "bb.instances.get"
- PermissionInstancesList Permission = "bb.instances.list"
- PermissionInstancesSync Permission = "bb.instances.sync"
- PermissionInstancesUndelete Permission = "bb.instances.undelete"
- PermissionInstancesUpdate Permission = "bb.instances.update"
- PermissionInstanceRolesGet Permission = "bb.instanceRoles.get"
- PermissionInstanceRolesList Permission = "bb.instanceRoles.list"
- PermissionIssueCommentsCreate Permission = "bb.issueComments.create"
- PermissionIssueCommentsList Permission = "bb.issueComments.list"
- PermissionIssueCommentsUpdate Permission = "bb.issueComments.update"
- PermissionIssuesCreate Permission = "bb.issues.create"
- PermissionIssuesGet Permission = "bb.issues.get"
- PermissionIssuesList Permission = "bb.issues.list"
- PermissionIssuesUpdate Permission = "bb.issues.update"
- PermissionPlanCheckRunsGet Permission = "bb.planCheckRuns.get"
- PermissionPlanCheckRunsRun Permission = "bb.planCheckRuns.run"
- PermissionPlansCreate Permission = "bb.plans.create"
- PermissionPlansGet Permission = "bb.plans.get"
- PermissionPlansList Permission = "bb.plans.list"
- PermissionPlansUpdate Permission = "bb.plans.update"
- PermissionPoliciesCreate Permission = "bb.policies.create"
- PermissionPoliciesDelete Permission = "bb.policies.delete"
- PermissionPoliciesGet Permission = "bb.policies.get"
- PermissionPoliciesList Permission = "bb.policies.list"
- PermissionPoliciesUpdate Permission = "bb.policies.update"
- PermissionProjectsCreate Permission = "bb.projects.create"
- PermissionProjectsDelete Permission = "bb.projects.delete"
- PermissionProjectsGet Permission = "bb.projects.get"
- PermissionProjectsGetIAMPolicy Permission = "bb.projects.getIamPolicy"
- PermissionProjectsList Permission = "bb.projects.list"
- PermissionProjectsSetIAMPolicy Permission = "bb.projects.setIamPolicy"
- PermissionProjectsUndelete Permission = "bb.projects.undelete"
- PermissionProjectsUpdate Permission = "bb.projects.update"
- PermissionReleasesCheck Permission = "bb.releases.check"
- PermissionReleasesCreate Permission = "bb.releases.create"
- PermissionReleasesDelete Permission = "bb.releases.delete"
- PermissionReleasesGet Permission = "bb.releases.get"
- PermissionReleasesList Permission = "bb.releases.list"
- PermissionReleasesUndelete Permission = "bb.releases.undelete"
- PermissionReleasesUpdate Permission = "bb.releases.update"
- PermissionReviewConfigsCreate Permission = "bb.reviewConfigs.create"
- PermissionReviewConfigsDelete Permission = "bb.reviewConfigs.delete"
- PermissionReviewConfigsGet Permission = "bb.reviewConfigs.get"
- PermissionReviewConfigsList Permission = "bb.reviewConfigs.list"
- PermissionReviewConfigsUpdate Permission = "bb.reviewConfigs.update"
- PermissionRevisionsCreate Permission = "bb.revisions.create"
- PermissionRevisionsDelete Permission = "bb.revisions.delete"
- PermissionRevisionsGet Permission = "bb.revisions.get"
- PermissionRevisionsList Permission = "bb.revisions.list"
- PermissionRolesCreate Permission = "bb.roles.create"
- PermissionRolesDelete Permission = "bb.roles.delete"
- PermissionRolesList Permission = "bb.roles.list"
- PermissionRolesGet Permission = "bb.roles.get"
- PermissionRolesUpdate Permission = "bb.roles.update"
- PermissionRolloutsCreate Permission = "bb.rollouts.create"
- PermissionRolloutsGet Permission = "bb.rollouts.get"
- PermissionRolloutsList Permission = "bb.rollouts.list"
- PermissionSettingsGet Permission = "bb.settings.get"
- PermissionSettingsList Permission = "bb.settings.list"
- PermissionSettingsSet Permission = "bb.settings.set"
- PermissionEnvironmentSettingsGet Permission = "bb.settings.getEnvironment"
- PermissionEnvironmentSettingsSet Permission = "bb.settings.setEnvironment"
- PermissionSheetsCreate Permission = "bb.sheets.create"
- PermissionSheetsGet Permission = "bb.sheets.get"
- PermissionSheetsUpdate Permission = "bb.sheets.update"
- PermissionSQLSelect Permission = "bb.sql.select"
- PermissionSQLDdl Permission = "bb.sql.ddl"
- PermissionSQLDml Permission = "bb.sql.dml"
- PermissionSQLExplain Permission = "bb.sql.explain"
- PermissionSQLInfo Permission = "bb.sql.info"
- PermissionSQLAdmin Permission = "bb.sql.admin"
- PermissionTaskRunsCreate Permission = "bb.taskRuns.create"
- PermissionTaskRunsList Permission = "bb.taskRuns.list"
- PermissionGroupsCreate Permission = "bb.groups.create"
- PermissionGroupsDelete Permission = "bb.groups.delete"
- PermissionGroupsGet Permission = "bb.groups.get"
- PermissionGroupsList Permission = "bb.groups.list"
- PermissionGroupsUpdate Permission = "bb.groups.update"
- PermissionUsersCreate Permission = "bb.users.create"
- PermissionUsersDelete Permission = "bb.users.delete"
- PermissionUsersGet Permission = "bb.users.get"
- PermissionUsersList Permission = "bb.users.list"
- PermissionUsersUndelete Permission = "bb.users.undelete"
- PermissionUsersUpdate Permission = "bb.users.update"
- PermissionUsersUpdateEmail Permission = "bb.users.updateEmail"
- PermissionWorksheetsGet Permission = "bb.worksheets.get"
- PermissionWorksheetsManage Permission = "bb.worksheets.manage"
- PermissionWorkspacesGetIamPolicy Permission = "bb.workspaces.getIamPolicy"
- PermissionWorkspacesSetIamPolicy Permission = "bb.workspaces.setIamPolicy"
+ PermissionAuditLogsExport Permission = "bb.auditLogs.export"
+ PermissionAuditLogsSearch Permission = "bb.auditLogs.search"
+ PermissionChangelogsGet Permission = "bb.changelogs.get"
+ PermissionChangelogsList Permission = "bb.changelogs.list"
+ PermissionDatabaseCatalogsGet Permission = "bb.databaseCatalogs.get"
+ PermissionDatabaseCatalogsUpdate Permission = "bb.databaseCatalogs.update"
+ PermissionDatabaseGroupsCreate Permission = "bb.databaseGroups.create"
+ PermissionDatabaseGroupsDelete Permission = "bb.databaseGroups.delete"
+ PermissionDatabaseGroupsGet Permission = "bb.databaseGroups.get"
+ PermissionDatabaseGroupsList Permission = "bb.databaseGroups.list"
+ PermissionDatabaseGroupsUpdate Permission = "bb.databaseGroups.update"
+ PermissionDatabasesCheck Permission = "bb.databases.check"
+ PermissionDatabasesGet Permission = "bb.databases.get"
+ PermissionDatabasesGetSchema Permission = "bb.databases.getSchema"
+ PermissionDatabasesList Permission = "bb.databases.list"
+ PermissionDatabasesSync Permission = "bb.databases.sync"
+ PermissionDatabasesUpdate Permission = "bb.databases.update"
+ PermissionIdentityProvidersCreate Permission = "bb.identityProviders.create"
+ PermissionIdentityProvidersDelete Permission = "bb.identityProviders.delete"
+ PermissionIdentityProvidersGet Permission = "bb.identityProviders.get"
+ PermissionIdentityProvidersUpdate Permission = "bb.identityProviders.update"
+ PermissionInstancesCreate Permission = "bb.instances.create"
+ PermissionInstancesDelete Permission = "bb.instances.delete"
+ PermissionInstancesGet Permission = "bb.instances.get"
+ PermissionInstancesList Permission = "bb.instances.list"
+ PermissionInstancesSync Permission = "bb.instances.sync"
+ PermissionInstancesUndelete Permission = "bb.instances.undelete"
+ PermissionInstancesUpdate Permission = "bb.instances.update"
+ PermissionInstanceRolesGet Permission = "bb.instanceRoles.get"
+ PermissionInstanceRolesList Permission = "bb.instanceRoles.list"
+ PermissionIssueCommentsCreate Permission = "bb.issueComments.create"
+ PermissionIssueCommentsList Permission = "bb.issueComments.list"
+ PermissionIssueCommentsUpdate Permission = "bb.issueComments.update"
+ PermissionIssuesCreate Permission = "bb.issues.create"
+ PermissionIssuesGet Permission = "bb.issues.get"
+ PermissionIssuesList Permission = "bb.issues.list"
+ PermissionIssuesUpdate Permission = "bb.issues.update"
+ PermissionPlanCheckRunsGet Permission = "bb.planCheckRuns.get"
+ PermissionPlanCheckRunsRun Permission = "bb.planCheckRuns.run"
+ PermissionPlansCreate Permission = "bb.plans.create"
+ PermissionPlansGet Permission = "bb.plans.get"
+ PermissionPlansList Permission = "bb.plans.list"
+ PermissionPlansUpdate Permission = "bb.plans.update"
+ PermissionPoliciesCreate Permission = "bb.policies.create"
+ PermissionPoliciesDelete Permission = "bb.policies.delete"
+ PermissionPoliciesGet Permission = "bb.policies.get"
+ PermissionPoliciesList Permission = "bb.policies.list"
+ PermissionPoliciesUpdate Permission = "bb.policies.update"
+ PermissionProjectsCreate Permission = "bb.projects.create"
+ PermissionProjectsDelete Permission = "bb.projects.delete"
+ PermissionProjectsGet Permission = "bb.projects.get"
+ PermissionProjectsGetIAMPolicy Permission = "bb.projects.getIamPolicy"
+ PermissionProjectsList Permission = "bb.projects.list"
+ PermissionProjectsSetIAMPolicy Permission = "bb.projects.setIamPolicy"
+ PermissionProjectsUndelete Permission = "bb.projects.undelete"
+ PermissionProjectsUpdate Permission = "bb.projects.update"
+ PermissionReleasesCheck Permission = "bb.releases.check"
+ PermissionReleasesCreate Permission = "bb.releases.create"
+ PermissionReleasesDelete Permission = "bb.releases.delete"
+ PermissionReleasesGet Permission = "bb.releases.get"
+ PermissionReleasesList Permission = "bb.releases.list"
+ PermissionReleasesUndelete Permission = "bb.releases.undelete"
+ PermissionReleasesUpdate Permission = "bb.releases.update"
+ PermissionReviewConfigsCreate Permission = "bb.reviewConfigs.create"
+ PermissionReviewConfigsDelete Permission = "bb.reviewConfigs.delete"
+ PermissionReviewConfigsGet Permission = "bb.reviewConfigs.get"
+ PermissionReviewConfigsList Permission = "bb.reviewConfigs.list"
+ PermissionReviewConfigsUpdate Permission = "bb.reviewConfigs.update"
+ PermissionRevisionsCreate Permission = "bb.revisions.create"
+ PermissionRevisionsDelete Permission = "bb.revisions.delete"
+ PermissionRevisionsGet Permission = "bb.revisions.get"
+ PermissionRevisionsList Permission = "bb.revisions.list"
+ PermissionRolesCreate Permission = "bb.roles.create"
+ PermissionRolesDelete Permission = "bb.roles.delete"
+ PermissionRolesList Permission = "bb.roles.list"
+ PermissionRolesGet Permission = "bb.roles.get"
+ PermissionRolesUpdate Permission = "bb.roles.update"
+ PermissionRolloutsCreate Permission = "bb.rollouts.create"
+ PermissionRolloutsGet Permission = "bb.rollouts.get"
+ PermissionRolloutsList Permission = "bb.rollouts.list"
+ PermissionSettingsGet Permission = "bb.settings.get"
+ PermissionSettingsList Permission = "bb.settings.list"
+ PermissionSettingsSet Permission = "bb.settings.set"
+ PermissionEnvironmentSettingsGet Permission = "bb.settings.getEnvironment"
+ PermissionEnvironmentSettingsSet Permission = "bb.settings.setEnvironment"
+ PermissionWorkspaceProfileSettingsGet Permission = "bb.settings.getWorkspaceProfile"
+ PermissionWorkspaceProfileSettingsSet Permission = "bb.settings.setWorkspaceProfile"
+ PermissionSheetsCreate Permission = "bb.sheets.create"
+ PermissionSheetsGet Permission = "bb.sheets.get"
+ PermissionSheetsUpdate Permission = "bb.sheets.update"
+ PermissionSQLSelect Permission = "bb.sql.select"
+ PermissionSQLDdl Permission = "bb.sql.ddl"
+ PermissionSQLDml Permission = "bb.sql.dml"
+ PermissionSQLExplain Permission = "bb.sql.explain"
+ PermissionSQLInfo Permission = "bb.sql.info"
+ PermissionSQLAdmin Permission = "bb.sql.admin"
+ PermissionTaskRunsCreate Permission = "bb.taskRuns.create"
+ PermissionTaskRunsList Permission = "bb.taskRuns.list"
+ PermissionGroupsCreate Permission = "bb.groups.create"
+ PermissionGroupsDelete Permission = "bb.groups.delete"
+ PermissionGroupsGet Permission = "bb.groups.get"
+ PermissionGroupsList Permission = "bb.groups.list"
+ PermissionGroupsUpdate Permission = "bb.groups.update"
+ PermissionUsersCreate Permission = "bb.users.create"
+ PermissionUsersDelete Permission = "bb.users.delete"
+ PermissionUsersGet Permission = "bb.users.get"
+ PermissionUsersList Permission = "bb.users.list"
+ PermissionUsersUndelete Permission = "bb.users.undelete"
+ PermissionUsersUpdate Permission = "bb.users.update"
+ PermissionUsersUpdateEmail Permission = "bb.users.updateEmail"
+ PermissionWorksheetsGet Permission = "bb.worksheets.get"
+ PermissionWorksheetsManage Permission = "bb.worksheets.manage"
+ PermissionWorkspacesGetIamPolicy Permission = "bb.workspaces.getIamPolicy"
+ PermissionWorkspacesSetIamPolicy Permission = "bb.workspaces.setIamPolicy"
)
var allPermissions = func() []Permission {
diff --git a/backend/component/iam/permission.yaml b/backend/component/iam/permission.yaml
index 168e770058..8a1b7d9f2f 100644
--- a/backend/component/iam/permission.yaml
+++ b/backend/component/iam/permission.yaml
@@ -86,9 +86,11 @@ permissions:
- bb.rollouts.list
- bb.settings.get
- bb.settings.getEnvironment
+ - bb.settings.getWorkspaceProfile
- bb.settings.list
- bb.settings.set
- bb.settings.setEnvironment
+ - bb.settings.setWorkspaceProfile
- bb.sheets.create
- bb.sheets.get
- bb.sheets.update
diff --git a/backend/generated-go/v1/actuator_service.pb.go b/backend/generated-go/v1/actuator_service.pb.go
index 66753df733..51a2fdc19e 100644
--- a/backend/generated-go/v1/actuator_service.pb.go
+++ b/backend/generated-go/v1/actuator_service.pb.go
@@ -10,7 +10,6 @@ import (
_ "google.golang.org/genproto/googleapis/api/annotations"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
- durationpb "google.golang.org/protobuf/types/known/durationpb"
emptypb "google.golang.org/protobuf/types/known/emptypb"
fieldmaskpb "google.golang.org/protobuf/types/known/fieldmaskpb"
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
@@ -285,132 +284,6 @@ func (*DeleteCacheRequest) Descriptor() ([]byte, []int) {
return file_v1_actuator_service_proto_rawDescGZIP(), []int{5}
}
-type Restriction struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // Whether self-service user signup is disabled.
- DisallowSignup bool `protobuf:"varint,1,opt,name=disallow_signup,json=disallowSignup,proto3" json:"disallow_signup,omitempty"`
- // Whether two-factor authentication is required for all users.
- Require_2Fa bool `protobuf:"varint,2,opt,name=require_2fa,json=require2fa,proto3" json:"require_2fa,omitempty"`
- // Whether password-based signin is disabled (except for workspace admins).
- DisallowPasswordSignin bool `protobuf:"varint,3,opt,name=disallow_password_signin,json=disallowPasswordSignin,proto3" json:"disallow_password_signin,omitempty"`
- // Password complexity and restriction requirements.
- PasswordRestriction *WorkspaceProfileSetting_PasswordRestriction `protobuf:"bytes,4,opt,name=password_restriction,json=passwordRestriction,proto3" json:"password_restriction,omitempty"`
- // Whether to display watermark on pages.
- Watermark bool `protobuf:"varint,5,opt,name=watermark,proto3" json:"watermark,omitempty"`
- // The workspace database change mode.
- DatabaseChangeMode DatabaseChangeMode `protobuf:"varint,6,opt,name=database_change_mode,json=databaseChangeMode,proto3,enum=bytebase.v1.DatabaseChangeMode" json:"database_change_mode,omitempty"`
- // The session expiration time if not activity detected for the user. Value <= 0 means no limit.
- InactiveSessionTimeout *durationpb.Duration `protobuf:"bytes,7,opt,name=inactive_session_timeout,json=inactiveSessionTimeout,proto3" json:"inactive_session_timeout,omitempty"`
- // The workspace domain, e.g., bytebase.com.
- Domains []string `protobuf:"bytes,8,rep,name=domains,proto3" json:"domains,omitempty"`
- // Only user and group from the domains can be created and login.
- EnforceIdentityDomain bool `protobuf:"varint,9,opt,name=enforce_identity_domain,json=enforceIdentityDomain,proto3" json:"enforce_identity_domain,omitempty"`
- // The max duration for role expired.
- MaximumRoleExpiration *durationpb.Duration `protobuf:"bytes,10,opt,name=maximum_role_expiration,json=maximumRoleExpiration,proto3" json:"maximum_role_expiration,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *Restriction) Reset() {
- *x = Restriction{}
- mi := &file_v1_actuator_service_proto_msgTypes[6]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *Restriction) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*Restriction) ProtoMessage() {}
-
-func (x *Restriction) ProtoReflect() protoreflect.Message {
- mi := &file_v1_actuator_service_proto_msgTypes[6]
- if x != nil {
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- if ms.LoadMessageInfo() == nil {
- ms.StoreMessageInfo(mi)
- }
- return ms
- }
- return mi.MessageOf(x)
-}
-
-// Deprecated: Use Restriction.ProtoReflect.Descriptor instead.
-func (*Restriction) Descriptor() ([]byte, []int) {
- return file_v1_actuator_service_proto_rawDescGZIP(), []int{6}
-}
-
-func (x *Restriction) GetDisallowSignup() bool {
- if x != nil {
- return x.DisallowSignup
- }
- return false
-}
-
-func (x *Restriction) GetRequire_2Fa() bool {
- if x != nil {
- return x.Require_2Fa
- }
- return false
-}
-
-func (x *Restriction) GetDisallowPasswordSignin() bool {
- if x != nil {
- return x.DisallowPasswordSignin
- }
- return false
-}
-
-func (x *Restriction) GetPasswordRestriction() *WorkspaceProfileSetting_PasswordRestriction {
- if x != nil {
- return x.PasswordRestriction
- }
- return nil
-}
-
-func (x *Restriction) GetWatermark() bool {
- if x != nil {
- return x.Watermark
- }
- return false
-}
-
-func (x *Restriction) GetDatabaseChangeMode() DatabaseChangeMode {
- if x != nil {
- return x.DatabaseChangeMode
- }
- return DatabaseChangeMode_DATABASE_CHANGE_MODE_UNSPECIFIED
-}
-
-func (x *Restriction) GetInactiveSessionTimeout() *durationpb.Duration {
- if x != nil {
- return x.InactiveSessionTimeout
- }
- return nil
-}
-
-func (x *Restriction) GetDomains() []string {
- if x != nil {
- return x.Domains
- }
- return nil
-}
-
-func (x *Restriction) GetEnforceIdentityDomain() bool {
- if x != nil {
- return x.EnforceIdentityDomain
- }
- return false
-}
-
-func (x *Restriction) GetMaximumRoleExpiration() *durationpb.Duration {
- if x != nil {
- return x.MaximumRoleExpiration
- }
- return nil
-}
-
// System information and configuration for the Bytebase instance.
// Actuator concept is similar to the Spring Boot Actuator.
type ActuatorInfo struct {
@@ -453,18 +326,13 @@ type ActuatorInfo struct {
EnableSample bool `protobuf:"varint,22,opt,name=enable_sample,json=enableSample,proto3" json:"enable_sample,omitempty"`
// Whether the external URL is set via command-line flag (and thus cannot be changed via UI).
ExternalUrlFromFlag bool `protobuf:"varint,23,opt,name=external_url_from_flag,json=externalUrlFromFlag,proto3" json:"external_url_from_flag,omitempty"`
- // The setting of custom announcement
- Announcement *Announcement `protobuf:"bytes,24,opt,name=announcement,proto3" json:"announcement,omitempty"`
- // Whether to enable metric collection for the workspace.
- EnableMetricCollection bool `protobuf:"varint,25,opt,name=enable_metric_collection,json=enableMetricCollection,proto3" json:"enable_metric_collection,omitempty"`
- Restriction *Restriction `protobuf:"bytes,26,opt,name=restriction,proto3" json:"restriction,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
}
func (x *ActuatorInfo) Reset() {
*x = ActuatorInfo{}
- mi := &file_v1_actuator_service_proto_msgTypes[7]
+ mi := &file_v1_actuator_service_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -476,7 +344,7 @@ func (x *ActuatorInfo) String() string {
func (*ActuatorInfo) ProtoMessage() {}
func (x *ActuatorInfo) ProtoReflect() protoreflect.Message {
- mi := &file_v1_actuator_service_proto_msgTypes[7]
+ mi := &file_v1_actuator_service_proto_msgTypes[6]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -489,7 +357,7 @@ func (x *ActuatorInfo) ProtoReflect() protoreflect.Message {
// Deprecated: Use ActuatorInfo.ProtoReflect.Descriptor instead.
func (*ActuatorInfo) Descriptor() ([]byte, []int) {
- return file_v1_actuator_service_proto_rawDescGZIP(), []int{7}
+ return file_v1_actuator_service_proto_rawDescGZIP(), []int{6}
}
func (x *ActuatorInfo) GetVersion() string {
@@ -625,27 +493,6 @@ func (x *ActuatorInfo) GetExternalUrlFromFlag() bool {
return false
}
-func (x *ActuatorInfo) GetAnnouncement() *Announcement {
- if x != nil {
- return x.Announcement
- }
- return nil
-}
-
-func (x *ActuatorInfo) GetEnableMetricCollection() bool {
- if x != nil {
- return x.EnableMetricCollection
- }
- return false
-}
-
-func (x *ActuatorInfo) GetRestriction() *Restriction {
- if x != nil {
- return x.Restriction
- }
- return nil
-}
-
// User statistics by type and state.
type ActuatorInfo_StatUser struct {
state protoimpl.MessageState `protogen:"open.v1"`
@@ -661,7 +508,7 @@ type ActuatorInfo_StatUser struct {
func (x *ActuatorInfo_StatUser) Reset() {
*x = ActuatorInfo_StatUser{}
- mi := &file_v1_actuator_service_proto_msgTypes[8]
+ mi := &file_v1_actuator_service_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -673,7 +520,7 @@ func (x *ActuatorInfo_StatUser) String() string {
func (*ActuatorInfo_StatUser) ProtoMessage() {}
func (x *ActuatorInfo_StatUser) ProtoReflect() protoreflect.Message {
- mi := &file_v1_actuator_service_proto_msgTypes[8]
+ mi := &file_v1_actuator_service_proto_msgTypes[7]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -686,7 +533,7 @@ func (x *ActuatorInfo_StatUser) ProtoReflect() protoreflect.Message {
// Deprecated: Use ActuatorInfo_StatUser.ProtoReflect.Descriptor instead.
func (*ActuatorInfo_StatUser) Descriptor() ([]byte, []int) {
- return file_v1_actuator_service_proto_rawDescGZIP(), []int{7, 0}
+ return file_v1_actuator_service_proto_rawDescGZIP(), []int{6, 0}
}
func (x *ActuatorInfo_StatUser) GetUserType() UserType {
@@ -714,7 +561,7 @@ var File_v1_actuator_service_proto protoreflect.FileDescriptor
const file_v1_actuator_service_proto_rawDesc = "" +
"\n" +
- "\x19v1/actuator_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a\x18v1/setting_service.proto\x1a\x15v1/user_service.proto\"\x1b\n" +
+ "\x19v1/actuator_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a\x15v1/user_service.proto\"\x1b\n" +
"\x19GetResourcePackageRequest\"%\n" +
"\x0fResourcePackage\x12\x12\n" +
"\x04logo\x18\x01 \x01(\fR\x04logo\"\x14\n" +
@@ -725,20 +572,7 @@ const file_v1_actuator_service_proto_rawDesc = "" +
"\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskB\x03\xe0A\x02R\n" +
"updateMask\x12#\n" +
"\rallow_missing\x18\x03 \x01(\bR\fallowMissing\"\x14\n" +
- "\x12DeleteCacheRequest\"\x9b\x05\n" +
- "\vRestriction\x12,\n" +
- "\x0fdisallow_signup\x18\x01 \x01(\bB\x03\xe0A\x03R\x0edisallowSignup\x12$\n" +
- "\vrequire_2fa\x18\x02 \x01(\bB\x03\xe0A\x03R\n" +
- "require2fa\x12=\n" +
- "\x18disallow_password_signin\x18\x03 \x01(\bB\x03\xe0A\x03R\x16disallowPasswordSignin\x12p\n" +
- "\x14password_restriction\x18\x04 \x01(\v28.bytebase.v1.WorkspaceProfileSetting.PasswordRestrictionB\x03\xe0A\x03R\x13passwordRestriction\x12!\n" +
- "\twatermark\x18\x05 \x01(\bB\x03\xe0A\x03R\twatermark\x12V\n" +
- "\x14database_change_mode\x18\x06 \x01(\x0e2\x1f.bytebase.v1.DatabaseChangeModeB\x03\xe0A\x03R\x12databaseChangeMode\x12X\n" +
- "\x18inactive_session_timeout\x18\a \x01(\v2\x19.google.protobuf.DurationB\x03\xe0A\x03R\x16inactiveSessionTimeout\x12\x1d\n" +
- "\adomains\x18\b \x03(\tB\x03\xe0A\x03R\adomains\x12;\n" +
- "\x17enforce_identity_domain\x18\t \x01(\bB\x03\xe0A\x03R\x15enforceIdentityDomain\x12V\n" +
- "\x17maximum_role_expiration\x18\n" +
- " \x01(\v2\x19.google.protobuf.DurationB\x03\xe0A\x03R\x15maximumRoleExpiration\"\x87\t\n" +
+ "\x12DeleteCacheRequest\"\xc3\a\n" +
"\fActuatorInfo\x12\x1d\n" +
"\aversion\x18\x01 \x01(\tB\x03\xe0A\x03R\aversion\x12\"\n" +
"\n" +
@@ -760,10 +594,7 @@ const file_v1_actuator_service_proto_rawDesc = "" +
"\x18activated_instance_count\x18\x14 \x01(\x05B\x03\xe0A\x03R\x16activatedInstanceCount\x125\n" +
"\x14total_instance_count\x18\x15 \x01(\x05B\x03\xe0A\x03R\x12totalInstanceCount\x12(\n" +
"\renable_sample\x18\x16 \x01(\bB\x03\xe0A\x03R\fenableSample\x128\n" +
- "\x16external_url_from_flag\x18\x17 \x01(\bB\x03\xe0A\x03R\x13externalUrlFromFlag\x12B\n" +
- "\fannouncement\x18\x18 \x01(\v2\x19.bytebase.v1.AnnouncementB\x03\xe0A\x03R\fannouncement\x12=\n" +
- "\x18enable_metric_collection\x18\x19 \x01(\bB\x03\xe0A\x03R\x16enableMetricCollection\x12?\n" +
- "\vrestriction\x18\x1a \x01(\v2\x18.bytebase.v1.RestrictionB\x03\xe0A\x03R\vrestriction\x1a~\n" +
+ "\x16external_url_from_flag\x18\x17 \x01(\bB\x03\xe0A\x03R\x13externalUrlFromFlag\x1a~\n" +
"\bStatUser\x122\n" +
"\tuser_type\x18\x01 \x01(\x0e2\x15.bytebase.v1.UserTypeR\buserType\x12(\n" +
"\x05state\x18\x02 \x01(\x0e2\x12.bytebase.v1.StateR\x05state\x12\x14\n" +
@@ -789,55 +620,44 @@ func file_v1_actuator_service_proto_rawDescGZIP() []byte {
return file_v1_actuator_service_proto_rawDescData
}
-var file_v1_actuator_service_proto_msgTypes = make([]protoimpl.MessageInfo, 9)
+var file_v1_actuator_service_proto_msgTypes = make([]protoimpl.MessageInfo, 8)
var file_v1_actuator_service_proto_goTypes = []any{
- (*GetResourcePackageRequest)(nil), // 0: bytebase.v1.GetResourcePackageRequest
- (*ResourcePackage)(nil), // 1: bytebase.v1.ResourcePackage
- (*SetupSampleRequest)(nil), // 2: bytebase.v1.SetupSampleRequest
- (*GetActuatorInfoRequest)(nil), // 3: bytebase.v1.GetActuatorInfoRequest
- (*UpdateActuatorInfoRequest)(nil), // 4: bytebase.v1.UpdateActuatorInfoRequest
- (*DeleteCacheRequest)(nil), // 5: bytebase.v1.DeleteCacheRequest
- (*Restriction)(nil), // 6: bytebase.v1.Restriction
- (*ActuatorInfo)(nil), // 7: bytebase.v1.ActuatorInfo
- (*ActuatorInfo_StatUser)(nil), // 8: bytebase.v1.ActuatorInfo.StatUser
- (*fieldmaskpb.FieldMask)(nil), // 9: google.protobuf.FieldMask
- (*WorkspaceProfileSetting_PasswordRestriction)(nil), // 10: bytebase.v1.WorkspaceProfileSetting.PasswordRestriction
- (DatabaseChangeMode)(0), // 11: bytebase.v1.DatabaseChangeMode
- (*durationpb.Duration)(nil), // 12: google.protobuf.Duration
- (*timestamppb.Timestamp)(nil), // 13: google.protobuf.Timestamp
- (*Announcement)(nil), // 14: bytebase.v1.Announcement
- (UserType)(0), // 15: bytebase.v1.UserType
- (State)(0), // 16: bytebase.v1.State
- (*emptypb.Empty)(nil), // 17: google.protobuf.Empty
+ (*GetResourcePackageRequest)(nil), // 0: bytebase.v1.GetResourcePackageRequest
+ (*ResourcePackage)(nil), // 1: bytebase.v1.ResourcePackage
+ (*SetupSampleRequest)(nil), // 2: bytebase.v1.SetupSampleRequest
+ (*GetActuatorInfoRequest)(nil), // 3: bytebase.v1.GetActuatorInfoRequest
+ (*UpdateActuatorInfoRequest)(nil), // 4: bytebase.v1.UpdateActuatorInfoRequest
+ (*DeleteCacheRequest)(nil), // 5: bytebase.v1.DeleteCacheRequest
+ (*ActuatorInfo)(nil), // 6: bytebase.v1.ActuatorInfo
+ (*ActuatorInfo_StatUser)(nil), // 7: bytebase.v1.ActuatorInfo.StatUser
+ (*fieldmaskpb.FieldMask)(nil), // 8: google.protobuf.FieldMask
+ (*timestamppb.Timestamp)(nil), // 9: google.protobuf.Timestamp
+ (UserType)(0), // 10: bytebase.v1.UserType
+ (State)(0), // 11: bytebase.v1.State
+ (*emptypb.Empty)(nil), // 12: google.protobuf.Empty
}
var file_v1_actuator_service_proto_depIdxs = []int32{
- 7, // 0: bytebase.v1.UpdateActuatorInfoRequest.actuator:type_name -> bytebase.v1.ActuatorInfo
- 9, // 1: bytebase.v1.UpdateActuatorInfoRequest.update_mask:type_name -> google.protobuf.FieldMask
- 10, // 2: bytebase.v1.Restriction.password_restriction:type_name -> bytebase.v1.WorkspaceProfileSetting.PasswordRestriction
- 11, // 3: bytebase.v1.Restriction.database_change_mode:type_name -> bytebase.v1.DatabaseChangeMode
- 12, // 4: bytebase.v1.Restriction.inactive_session_timeout:type_name -> google.protobuf.Duration
- 12, // 5: bytebase.v1.Restriction.maximum_role_expiration:type_name -> google.protobuf.Duration
- 13, // 6: bytebase.v1.ActuatorInfo.last_active_time:type_name -> google.protobuf.Timestamp
- 8, // 7: bytebase.v1.ActuatorInfo.user_stats:type_name -> bytebase.v1.ActuatorInfo.StatUser
- 14, // 8: bytebase.v1.ActuatorInfo.announcement:type_name -> bytebase.v1.Announcement
- 6, // 9: bytebase.v1.ActuatorInfo.restriction:type_name -> bytebase.v1.Restriction
- 15, // 10: bytebase.v1.ActuatorInfo.StatUser.user_type:type_name -> bytebase.v1.UserType
- 16, // 11: bytebase.v1.ActuatorInfo.StatUser.state:type_name -> bytebase.v1.State
- 3, // 12: bytebase.v1.ActuatorService.GetActuatorInfo:input_type -> bytebase.v1.GetActuatorInfoRequest
- 4, // 13: bytebase.v1.ActuatorService.UpdateActuatorInfo:input_type -> bytebase.v1.UpdateActuatorInfoRequest
- 2, // 14: bytebase.v1.ActuatorService.SetupSample:input_type -> bytebase.v1.SetupSampleRequest
- 5, // 15: bytebase.v1.ActuatorService.DeleteCache:input_type -> bytebase.v1.DeleteCacheRequest
- 0, // 16: bytebase.v1.ActuatorService.GetResourcePackage:input_type -> bytebase.v1.GetResourcePackageRequest
- 7, // 17: bytebase.v1.ActuatorService.GetActuatorInfo:output_type -> bytebase.v1.ActuatorInfo
- 7, // 18: bytebase.v1.ActuatorService.UpdateActuatorInfo:output_type -> bytebase.v1.ActuatorInfo
- 17, // 19: bytebase.v1.ActuatorService.SetupSample:output_type -> google.protobuf.Empty
- 17, // 20: bytebase.v1.ActuatorService.DeleteCache:output_type -> google.protobuf.Empty
- 1, // 21: bytebase.v1.ActuatorService.GetResourcePackage:output_type -> bytebase.v1.ResourcePackage
- 17, // [17:22] is the sub-list for method output_type
- 12, // [12:17] is the sub-list for method input_type
- 12, // [12:12] is the sub-list for extension type_name
- 12, // [12:12] is the sub-list for extension extendee
- 0, // [0:12] is the sub-list for field type_name
+ 6, // 0: bytebase.v1.UpdateActuatorInfoRequest.actuator:type_name -> bytebase.v1.ActuatorInfo
+ 8, // 1: bytebase.v1.UpdateActuatorInfoRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 9, // 2: bytebase.v1.ActuatorInfo.last_active_time:type_name -> google.protobuf.Timestamp
+ 7, // 3: bytebase.v1.ActuatorInfo.user_stats:type_name -> bytebase.v1.ActuatorInfo.StatUser
+ 10, // 4: bytebase.v1.ActuatorInfo.StatUser.user_type:type_name -> bytebase.v1.UserType
+ 11, // 5: bytebase.v1.ActuatorInfo.StatUser.state:type_name -> bytebase.v1.State
+ 3, // 6: bytebase.v1.ActuatorService.GetActuatorInfo:input_type -> bytebase.v1.GetActuatorInfoRequest
+ 4, // 7: bytebase.v1.ActuatorService.UpdateActuatorInfo:input_type -> bytebase.v1.UpdateActuatorInfoRequest
+ 2, // 8: bytebase.v1.ActuatorService.SetupSample:input_type -> bytebase.v1.SetupSampleRequest
+ 5, // 9: bytebase.v1.ActuatorService.DeleteCache:input_type -> bytebase.v1.DeleteCacheRequest
+ 0, // 10: bytebase.v1.ActuatorService.GetResourcePackage:input_type -> bytebase.v1.GetResourcePackageRequest
+ 6, // 11: bytebase.v1.ActuatorService.GetActuatorInfo:output_type -> bytebase.v1.ActuatorInfo
+ 6, // 12: bytebase.v1.ActuatorService.UpdateActuatorInfo:output_type -> bytebase.v1.ActuatorInfo
+ 12, // 13: bytebase.v1.ActuatorService.SetupSample:output_type -> google.protobuf.Empty
+ 12, // 14: bytebase.v1.ActuatorService.DeleteCache:output_type -> google.protobuf.Empty
+ 1, // 15: bytebase.v1.ActuatorService.GetResourcePackage:output_type -> bytebase.v1.ResourcePackage
+ 11, // [11:16] is the sub-list for method output_type
+ 6, // [6:11] is the sub-list for method input_type
+ 6, // [6:6] is the sub-list for extension type_name
+ 6, // [6:6] is the sub-list for extension extendee
+ 0, // [0:6] is the sub-list for field type_name
}
func init() { file_v1_actuator_service_proto_init() }
@@ -847,7 +667,6 @@ func file_v1_actuator_service_proto_init() {
}
file_v1_annotation_proto_init()
file_v1_common_proto_init()
- file_v1_setting_service_proto_init()
file_v1_user_service_proto_init()
type x struct{}
out := protoimpl.TypeBuilder{
@@ -855,7 +674,7 @@ func file_v1_actuator_service_proto_init() {
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_actuator_service_proto_rawDesc), len(file_v1_actuator_service_proto_rawDesc)),
NumEnums: 0,
- NumMessages: 9,
+ NumMessages: 8,
NumExtensions: 0,
NumServices: 1,
},
diff --git a/backend/generated-go/v1/actuator_service_equal.pb.go b/backend/generated-go/v1/actuator_service_equal.pb.go
index 0297ecc33b..62480b412e 100644
--- a/backend/generated-go/v1/actuator_service_equal.pb.go
+++ b/backend/generated-go/v1/actuator_service_equal.pb.go
@@ -84,51 +84,6 @@ func (x *DeleteCacheRequest) Equal(y *DeleteCacheRequest) bool {
return true
}
-func (x *Restriction) Equal(y *Restriction) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.DisallowSignup != y.DisallowSignup {
- return false
- }
- if x.Require_2Fa != y.Require_2Fa {
- return false
- }
- if x.DisallowPasswordSignin != y.DisallowPasswordSignin {
- return false
- }
- if !x.PasswordRestriction.Equal(y.PasswordRestriction) {
- return false
- }
- if x.Watermark != y.Watermark {
- return false
- }
- if x.DatabaseChangeMode != y.DatabaseChangeMode {
- return false
- }
- if p, q := x.InactiveSessionTimeout, y.InactiveSessionTimeout; (p == nil && q != nil) || (p != nil && (q == nil || p.Seconds != q.Seconds || p.Nanos != q.Nanos)) {
- return false
- }
- if len(x.Domains) != len(y.Domains) {
- return false
- }
- for i := 0; i < len(x.Domains); i++ {
- if x.Domains[i] != y.Domains[i] {
- return false
- }
- }
- if x.EnforceIdentityDomain != y.EnforceIdentityDomain {
- return false
- }
- if p, q := x.MaximumRoleExpiration, y.MaximumRoleExpiration; (p == nil && q != nil) || (p != nil && (q == nil || p.Seconds != q.Seconds || p.Nanos != q.Nanos)) {
- return false
- }
- return true
-}
-
func (x *ActuatorInfo_StatUser) Equal(y *ActuatorInfo_StatUser) bool {
if x == y {
return true
@@ -222,14 +177,5 @@ func (x *ActuatorInfo) Equal(y *ActuatorInfo) bool {
if x.ExternalUrlFromFlag != y.ExternalUrlFromFlag {
return false
}
- if !x.Announcement.Equal(y.Announcement) {
- return false
- }
- if x.EnableMetricCollection != y.EnableMetricCollection {
- return false
- }
- if !x.Restriction.Equal(y.Restriction) {
- return false
- }
return true
}
diff --git a/frontend/src/components/EmailInput.vue b/frontend/src/components/EmailInput.vue
index 1a9598d5af..f74a94dc6f 100644
--- a/frontend/src/components/EmailInput.vue
+++ b/frontend/src/components/EmailInput.vue
@@ -24,7 +24,7 @@
<script lang="ts" setup>
import { NInput, NInputGroup, NInputGroupLabel, NSelect } from "naive-ui";
import { computed, reactive, watch, watchEffect } from "vue";
-import { useActuatorV1Store } from "@/store";
+import { useSettingV1Store } from "@/store";
interface LocalState {
// The full email value.
@@ -62,17 +62,16 @@ const state: LocalState = reactive({
shortValue: props.value.split("@")[0],
domain: props.value.split("@")[1],
});
-const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const enforceDomain = computed(() => {
return (
- (actuatorStore.restriction.enforceIdentityDomain ?? false) ||
- props.showDomain
+ settingV1Store.workspaceProfile.enforceIdentityDomain || props.showDomain
);
});
const domainSelectOptions = computed(() => {
- const domains = (actuatorStore.restriction.domains ?? []).filter(
+ const domains = settingV1Store.workspaceProfile.domains.filter(
(domain) => domain && domain.trim() !== ""
);
if (domains.length === 0 && props.fallbackDomain) {
diff --git a/frontend/src/components/ExpirationSelector.vue b/frontend/src/components/ExpirationSelector.vue
index deb9391ba8..5290be7612 100644
--- a/frontend/src/components/ExpirationSelector.vue
+++ b/frontend/src/components/ExpirationSelector.vue
@@ -51,7 +51,7 @@ import dayjs from "dayjs";
import { NDatePicker, NSelect } from "naive-ui";
import { computed, reactive, watch } from "vue";
import { useI18n } from "vue-i18n";
-import { useActuatorV1Store } from "@/store";
+import { useSettingV1Store } from "@/store";
import { PresetRoleType } from "@/types";
interface ExpirationOption {
@@ -74,7 +74,7 @@ const emit = defineEmits<{
}>();
const { t } = useI18n();
-const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
// Remember the last selected expiration option
const lastSelectedExpiration = useLocalStorage<number>(
@@ -105,8 +105,8 @@ const maximumRoleExpiration = computed(() => {
if (props.role === PresetRoleType.PROJECT_OWNER) {
return undefined;
}
- const seconds = actuatorStore.restriction.maximumRoleExpiration?.seconds
- ? Number(actuatorStore.restriction.maximumRoleExpiration.seconds)
+ const seconds = settingV1Store.workspaceProfile.maximumRoleExpiration?.seconds
+ ? Number(settingV1Store.workspaceProfile.maximumRoleExpiration.seconds)
: undefined;
if (!seconds) {
return undefined;
diff --git a/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue b/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue
index 7872dbe2b2..a7a46a5271 100644
--- a/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue
+++ b/frontend/src/components/GeneralSetting/AIAugmentationSetting.vue
@@ -251,7 +251,8 @@ const providerOptions = computed(() =>
})
);
-watchEffect(() => {
+watchEffect(async () => {
+ await settingV1Store.getOrFetchSettingByName(Setting_SettingName.AI);
Object.assign(state, getInitialState());
});
diff --git a/frontend/src/components/GeneralSetting/AccountSetting.vue b/frontend/src/components/GeneralSetting/AccountSetting.vue
index eb4ca93ab7..cecc44b3d0 100644
--- a/frontend/src/components/GeneralSetting/AccountSetting.vue
+++ b/frontend/src/components/GeneralSetting/AccountSetting.vue
@@ -161,11 +161,10 @@ const tokenDurationSettingRef =
const getInitialState = (): LocalState => {
return {
- disallowSignup:
- settingV1Store.workspaceProfileSetting?.disallowSignup ?? false,
- require2fa: settingV1Store.workspaceProfileSetting?.require2fa ?? false,
+ disallowSignup: settingV1Store.workspaceProfile.disallowSignup,
+ require2fa: settingV1Store.workspaceProfile.require2fa,
disallowPasswordSignin:
- settingV1Store.workspaceProfileSetting?.disallowPasswordSignin ?? false,
+ settingV1Store.workspaceProfile.disallowPasswordSignin,
};
};
@@ -212,18 +211,15 @@ const onUpdate = async () => {
require2fa: state.require2fa,
disallowPasswordSignin: state.disallowPasswordSignin,
};
- if (
- state.disallowSignup !==
- settingV1Store.workspaceProfileSetting?.disallowSignup
- ) {
+ if (state.disallowSignup !== settingV1Store.workspaceProfile.disallowSignup) {
updateMaskPaths.push("value.workspace_profile.disallow_signup");
}
- if (state.require2fa !== settingV1Store.workspaceProfileSetting?.require2fa) {
+ if (state.require2fa !== settingV1Store.workspaceProfile.require2fa) {
updateMaskPaths.push("value.workspace_profile.require_2fa");
}
if (
state.disallowPasswordSignin !==
- settingV1Store.workspaceProfileSetting?.disallowPasswordSignin
+ settingV1Store.workspaceProfile.disallowPasswordSignin
) {
updateMaskPaths.push("value.workspace_profile.disallow_password_signin");
}
diff --git a/frontend/src/components/GeneralSetting/AnnouncementSetting.vue b/frontend/src/components/GeneralSetting/AnnouncementSetting.vue
index 5348c73c47..fb78a22b40 100644
--- a/frontend/src/components/GeneralSetting/AnnouncementSetting.vue
+++ b/frontend/src/components/GeneralSetting/AnnouncementSetting.vue
@@ -127,7 +127,7 @@ const hasAnnouncementFeature = featureToRef(
const rawAnnouncement = computed(
() =>
- settingV1Store.workspaceProfileSetting?.announcement ??
+ settingV1Store.workspaceProfile.announcement ??
create(AnnouncementSchema, {
level: Announcement_AlertLevel.INFO,
})
diff --git a/frontend/src/components/GeneralSetting/AuditLogStdoutSetting.vue b/frontend/src/components/GeneralSetting/AuditLogStdoutSetting.vue
index 7bc965a108..6fcacd8032 100644
--- a/frontend/src/components/GeneralSetting/AuditLogStdoutSetting.vue
+++ b/frontend/src/components/GeneralSetting/AuditLogStdoutSetting.vue
@@ -50,8 +50,7 @@ const hasAuditLogFeature = featureToRef(PlanFeature.FEATURE_AUDIT_LOG);
const getInitialState = (): LocalState => {
return {
- enableAuditLogStdout:
- settingV1Store.workspaceProfileSetting?.enableAuditLogStdout ?? false,
+ enableAuditLogStdout: settingV1Store.workspaceProfile.enableAuditLogStdout,
};
};
diff --git a/frontend/src/components/GeneralSetting/BrandingSetting.vue b/frontend/src/components/GeneralSetting/BrandingSetting.vue
index 9dc88db0ff..cbb90d5212 100644
--- a/frontend/src/components/GeneralSetting/BrandingSetting.vue
+++ b/frontend/src/components/GeneralSetting/BrandingSetting.vue
@@ -102,13 +102,13 @@ const convertFileToBase64 = (file: File) =>
const settingV1Store = useSettingV1Store();
const state = reactive<LocalState>({
- logoUrl: settingV1Store.workspaceProfileSetting?.brandingLogo,
+ logoUrl: settingV1Store.workspaceProfile.brandingLogo,
loading: false,
showFeatureModal: false,
});
const allowSave = computed((): boolean => {
- return state.logoUrl !== settingV1Store.workspaceProfileSetting?.brandingLogo;
+ return state.logoUrl !== settingV1Store.workspaceProfile.brandingLogo;
});
const hasBrandingFeature = featureToRef(PlanFeature.FEATURE_CUSTOM_LOGO);
@@ -146,7 +146,6 @@ defineExpose({
title: props.title,
isDirty: allowSave,
update: uploadLogo,
- revert: () =>
- (state.logoUrl = settingV1Store.workspaceProfileSetting?.brandingLogo),
+ revert: () => (state.logoUrl = settingV1Store.workspaceProfile.brandingLogo),
});
</script>
diff --git a/frontend/src/components/GeneralSetting/DomainRestrictionSetting.vue b/frontend/src/components/GeneralSetting/DomainRestrictionSetting.vue
index 8559c41b71..5e443ecd4b 100644
--- a/frontend/src/components/GeneralSetting/DomainRestrictionSetting.vue
+++ b/frontend/src/components/GeneralSetting/DomainRestrictionSetting.vue
@@ -70,10 +70,10 @@ const initialState = computed((): LocalState => {
domains: [],
enableRestriction: false,
};
- if (Array.isArray(settingV1Store.workspaceProfileSetting?.domains)) {
- defaultState.domains = [...settingV1Store.workspaceProfileSetting?.domains];
+ if (Array.isArray(settingV1Store.workspaceProfile.domains)) {
+ defaultState.domains = [...settingV1Store.workspaceProfile.domains];
defaultState.enableRestriction =
- settingV1Store.workspaceProfileSetting?.enforceIdentityDomain || false;
+ settingV1Store.workspaceProfile.enforceIdentityDomain || false;
}
return defaultState;
});
diff --git a/frontend/src/components/GeneralSetting/GeneralSetting.vue b/frontend/src/components/GeneralSetting/GeneralSetting.vue
index c634960899..aa5d4a30c6 100644
--- a/frontend/src/components/GeneralSetting/GeneralSetting.vue
+++ b/frontend/src/components/GeneralSetting/GeneralSetting.vue
@@ -101,16 +101,15 @@ interface LocalState {
const getInitialState = (): LocalState => {
const defaultState: LocalState = {
databaseChangeMode: DatabaseChangeMode.PIPELINE,
- externalUrl: settingV1Store.workspaceProfileSetting?.externalUrl ?? "",
+ externalUrl: settingV1Store.workspaceProfile.externalUrl,
};
if (
- settingV1Store.workspaceProfileSetting &&
[DatabaseChangeMode.PIPELINE, DatabaseChangeMode.EDITOR].includes(
- settingV1Store.workspaceProfileSetting.databaseChangeMode
+ settingV1Store.workspaceProfile.databaseChangeMode
)
) {
defaultState.databaseChangeMode =
- settingV1Store.workspaceProfileSetting.databaseChangeMode;
+ settingV1Store.workspaceProfile.databaseChangeMode;
}
return defaultState;
};
diff --git a/frontend/src/components/GeneralSetting/MaximumRoleExpirationSetting.vue b/frontend/src/components/GeneralSetting/MaximumRoleExpirationSetting.vue
index 7582f63696..8a6e307fb5 100644
--- a/frontend/src/components/GeneralSetting/MaximumRoleExpirationSetting.vue
+++ b/frontend/src/components/GeneralSetting/MaximumRoleExpirationSetting.vue
@@ -53,11 +53,8 @@ const getInitialState = (): LocalState => {
inputValue: DEFAULT_EXPIRATION_DAYS,
neverExpire: true,
};
- const seconds = settingV1Store.workspaceProfileSetting?.maximumRoleExpiration
- ?.seconds
- ? Number(
- settingV1Store.workspaceProfileSetting.maximumRoleExpiration.seconds
- )
+ const seconds = settingV1Store.workspaceProfile.maximumRoleExpiration?.seconds
+ ? Number(settingV1Store.workspaceProfile.maximumRoleExpiration.seconds)
: undefined;
if (seconds && seconds > 0) {
defaultState.inputValue =
diff --git a/frontend/src/components/GeneralSetting/PasswordRestrictionSetting.vue b/frontend/src/components/GeneralSetting/PasswordRestrictionSetting.vue
index a9b117439f..6417208c56 100644
--- a/frontend/src/components/GeneralSetting/PasswordRestrictionSetting.vue
+++ b/frontend/src/components/GeneralSetting/PasswordRestrictionSetting.vue
@@ -189,7 +189,7 @@ const hasPasswordFeature = featureToRef(
const passwordRestrictionSetting = computed(() => {
return (
- settingV1Store.workspaceProfileSetting?.passwordRestriction ??
+ settingV1Store.workspaceProfile.passwordRestriction ??
create(WorkspaceProfileSetting_PasswordRestrictionSchema, {})
);
});
@@ -211,9 +211,6 @@ const onUpdate = async (
defineExpose({
isDirty: computed(() => !isEqual(passwordRestrictionSetting.value, state)),
update: async () => {
- if (!settingV1Store.workspaceProfileSetting) {
- return;
- }
await settingV1Store.updateWorkspaceProfile({
payload: {
passwordRestriction: create(
diff --git a/frontend/src/components/GeneralSetting/ProductImprovementSetting.vue b/frontend/src/components/GeneralSetting/ProductImprovementSetting.vue
index 5f651fd1e2..20e4981f4b 100644
--- a/frontend/src/components/GeneralSetting/ProductImprovementSetting.vue
+++ b/frontend/src/components/GeneralSetting/ProductImprovementSetting.vue
@@ -45,7 +45,7 @@ const settingV1Store = useSettingV1Store();
const getInitialState = (): LocalState => {
return {
enableMetricCollection:
- settingV1Store.workspaceProfileSetting?.enableMetricCollection ?? true,
+ settingV1Store.workspaceProfile.enableMetricCollection,
};
};
diff --git a/frontend/src/components/GeneralSetting/SecuritySetting.vue b/frontend/src/components/GeneralSetting/SecuritySetting.vue
index 24dd3df860..2c7643647c 100644
--- a/frontend/src/components/GeneralSetting/SecuritySetting.vue
+++ b/frontend/src/components/GeneralSetting/SecuritySetting.vue
@@ -83,7 +83,7 @@ const settingRefList = computed(() => [
]);
const initEnableWatermark = computed(() => {
- return settingV1Store.workspaceProfileSetting?.watermark ?? false;
+ return settingV1Store.workspaceProfile.watermark;
});
const enableWatermark = ref(initEnableWatermark.value);
diff --git a/frontend/src/components/GeneralSetting/TokenDurationSetting.vue b/frontend/src/components/GeneralSetting/TokenDurationSetting.vue
index 49dde6a6c1..b1615822a1 100644
--- a/frontend/src/components/GeneralSetting/TokenDurationSetting.vue
+++ b/frontend/src/components/GeneralSetting/TokenDurationSetting.vue
@@ -164,9 +164,9 @@ const getInitialState = (): LocalState => {
};
// Access token duration
- const accessTokenSeconds = settingV1Store.workspaceProfileSetting
- ?.accessTokenDuration?.seconds
- ? Number(settingV1Store.workspaceProfileSetting.accessTokenDuration.seconds)
+ const accessTokenSeconds = settingV1Store.workspaceProfile.accessTokenDuration
+ ?.seconds
+ ? Number(settingV1Store.workspaceProfile.accessTokenDuration.seconds)
: undefined;
if (accessTokenSeconds && accessTokenSeconds > 0) {
if (accessTokenSeconds < 60 * 60) {
@@ -181,11 +181,9 @@ const getInitialState = (): LocalState => {
}
// Refresh token duration
- const refreshTokenSeconds = settingV1Store.workspaceProfileSetting
- ?.refreshTokenDuration?.seconds
- ? Number(
- settingV1Store.workspaceProfileSetting.refreshTokenDuration.seconds
- )
+ const refreshTokenSeconds = settingV1Store.workspaceProfile
+ .refreshTokenDuration?.seconds
+ ? Number(settingV1Store.workspaceProfile.refreshTokenDuration.seconds)
: undefined;
if (refreshTokenSeconds && refreshTokenSeconds > 0) {
if (refreshTokenSeconds < 60 * 60 * 24) {
@@ -201,7 +199,7 @@ const getInitialState = (): LocalState => {
// Inactive timeout
const inactiveTimeoutSeconds = Number(
- settingV1Store.workspaceProfileSetting?.inactiveSessionTimeout?.seconds ?? 0
+ settingV1Store.workspaceProfile.inactiveSessionTimeout?.seconds ?? 0
);
if (inactiveTimeoutSeconds) {
defaultState.inactiveTimeout =
diff --git a/frontend/src/components/Plan/components/PlanDataTable/PlanDataTable.vue b/frontend/src/components/Plan/components/PlanDataTable/PlanDataTable.vue
index e91246052b..cb996e76a3 100644
--- a/frontend/src/components/Plan/components/PlanDataTable/PlanDataTable.vue
+++ b/frontend/src/components/Plan/components/PlanDataTable/PlanDataTable.vue
@@ -48,6 +48,7 @@ const columnList = computed((): DataTableColumn<Plan>[] => {
key: "title",
title: t("issue.table.name"),
ellipsis: true,
+ resizable: true,
render: (plan) => {
const showDraftTag =
enabledNewLayout.value && plan.issue === "" && !plan.hasRollout;
@@ -97,7 +98,9 @@ const columnList = computed((): DataTableColumn<Plan>[] => {
{
key: "creator",
title: t("issue.table.creator"),
- width: 140,
+ width: 200,
+ resizable: true,
+ ellipsis: true,
render: (plan) => {
const creator =
userStore.getUserByIdentifier(plan.creator) ||
diff --git a/frontend/src/components/ProjectWebhookForm.vue b/frontend/src/components/ProjectWebhookForm.vue
index bc05dcc440..e1dc67efad 100644
--- a/frontend/src/components/ProjectWebhookForm.vue
+++ b/frontend/src/components/ProjectWebhookForm.vue
@@ -249,7 +249,7 @@ import {
NRadioGroup,
NTooltip,
} from "naive-ui";
-import { computed, reactive, watch } from "vue";
+import { computed, onMounted, reactive, watch } from "vue";
import { useI18n } from "vue-i18n";
import { useRouter } from "vue-router";
import { BBAttention, BBButtonConfirm } from "@/bbkit";
@@ -308,6 +308,10 @@ const { overrideMainContainerClass } = useBodyLayoutContext();
overrideMainContainerClass("!pb-0");
+onMounted(async () => {
+ await settingStore.getOrFetchSettingByName(Setting_SettingName.APP_IM);
+});
+
const state = reactive<LocalState>({
webhook: cloneDeep(props.webhook),
});
diff --git a/frontend/src/components/ProvideDashboardContext.vue b/frontend/src/components/ProvideDashboardContext.vue
index d6429b9867..82f1bf02fe 100644
--- a/frontend/src/components/ProvideDashboardContext.vue
+++ b/frontend/src/components/ProvideDashboardContext.vue
@@ -13,6 +13,7 @@ import {
useUIStateStore,
} from "@/store";
import { PolicyResourceType } from "@/types/proto-es/v1/org_policy_service_pb";
+import { Setting_SettingName } from "@/types/proto-es/v1/setting_service_pb";
import MaskSpinner from "./misc/MaskSpinner.vue";
const router = useRouter();
@@ -30,7 +31,9 @@ onMounted(async () => {
await Promise.all([
useEnvironmentV1Store().fetchEnvironments(),
- useSettingV1Store().fetchSettingList(),
+ useSettingV1Store().getOrFetchSettingByName(
+ Setting_SettingName.WORKSPACE_PROFILE
+ ),
]);
useUIStateStore().restoreState();
diff --git a/frontend/src/components/SensitiveData/ClassificationView.vue b/frontend/src/components/SensitiveData/ClassificationView.vue
index d15f25b344..1368f81464 100644
--- a/frontend/src/components/SensitiveData/ClassificationView.vue
+++ b/frontend/src/components/SensitiveData/ClassificationView.vue
@@ -156,7 +156,10 @@ const state = reactive<LocalState>({
});
// Initialize state with formerConfig
-watchEffect(() => {
+watchEffect(async () => {
+ await settingStore.getOrFetchSettingByName(
+ Setting_SettingName.DATA_CLASSIFICATION
+ );
const config = formerConfig.value;
Object.assign(state.classification, {
id: config.id,
diff --git a/frontend/src/components/SensitiveData/GlobalMaskingRulesView.vue b/frontend/src/components/SensitiveData/GlobalMaskingRulesView.vue
index 0301ac40c2..b792029cfa 100644
--- a/frontend/src/components/SensitiveData/GlobalMaskingRulesView.vue
+++ b/frontend/src/components/SensitiveData/GlobalMaskingRulesView.vue
@@ -135,7 +135,12 @@ import PermissionGuardWrapper from "@/components/Permission/PermissionGuardWrapp
import type { ResourceSelectOption } from "@/components/v2/Select/RemoteResourceSelector/types";
import { useBodyLayoutContext } from "@/layouts/common";
import type { Factor } from "@/plugins/cel";
-import { featureToRef, pushNotification, usePolicyV1Store } from "@/store";
+import {
+ featureToRef,
+ pushNotification,
+ usePolicyV1Store,
+ useSettingV1Store,
+} from "@/store";
import type {
MaskingRulePolicy_MaskingRule,
Policy,
@@ -146,6 +151,7 @@ import {
PolicyResourceType,
PolicyType,
} from "@/types/proto-es/v1/org_policy_service_pb";
+import { Setting_SettingName } from "@/types/proto-es/v1/setting_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import {
arraySwap,
@@ -219,6 +225,17 @@ const updateList = async () => {
onMounted(async () => {
await updateList();
+ const settingV1Store = useSettingV1Store();
+ await Promise.all([
+ settingV1Store.getOrFetchSettingByName(
+ Setting_SettingName.SEMANTIC_TYPES,
+ true
+ ),
+ settingV1Store.getOrFetchSettingByName(
+ Setting_SettingName.DATA_CLASSIFICATION,
+ true
+ ),
+ ]);
});
const addNewRule = () => {
diff --git a/frontend/src/components/SensitiveData/SemanticTypesView.vue b/frontend/src/components/SensitiveData/SemanticTypesView.vue
index f56a357fdd..45f10a74cb 100644
--- a/frontend/src/components/SensitiveData/SemanticTypesView.vue
+++ b/frontend/src/components/SensitiveData/SemanticTypesView.vue
@@ -93,6 +93,9 @@ const semanticTypeSettingValue = computed(() => {
});
onMounted(async () => {
+ await settingStore.getOrFetchSettingByName(
+ Setting_SettingName.SEMANTIC_TYPES
+ );
state.semanticItemList = semanticTypeSettingValue.value.map(
(semanticType) => {
return {
diff --git a/frontend/src/components/SensitiveData/components/utils.ts b/frontend/src/components/SensitiveData/components/utils.ts
index 69265706e5..a79fb6ed2d 100644
--- a/frontend/src/components/SensitiveData/components/utils.ts
+++ b/frontend/src/components/SensitiveData/components/utils.ts
@@ -5,30 +5,14 @@ import type { Factor, Operator } from "@/plugins/cel";
import { CollectionOperatorList, EqualityOperatorList } from "@/plugins/cel";
import { useSettingV1Store } from "@/store";
import type { Algorithm } from "@/types/proto-es/v1/setting_service_pb";
-import {
- AlgorithmSchema,
- Setting_SettingName,
-} from "@/types/proto-es/v1/setting_service_pb";
+import { AlgorithmSchema } from "@/types/proto-es/v1/setting_service_pb";
import { CEL_ATTRIBUTE_RESOURCE_PROJECT_ID } from "@/utils/cel-attributes";
export const getClassificationLevelOptions = () => {
const settingStore = useSettingV1Store();
- const setting = settingStore.getSettingByName(
- Setting_SettingName.DATA_CLASSIFICATION
- );
- if (!setting || !setting.value) {
- return [];
- }
-
- const config =
- setting.value.value.case === "dataClassification"
- ? setting.value.value.value.configs
- : [];
- if (config.length === 0) {
- return [];
- }
-
- return config[0].levels.map<ResourceSelectOption<unknown>>((level) => ({
+ return settingStore.classification[0].levels.map<
+ ResourceSelectOption<unknown>
+ >((level) => ({
label: level.title,
value: level.id,
}));
diff --git a/frontend/src/components/SensitiveData/useSemanticType.ts b/frontend/src/components/SensitiveData/useSemanticType.ts
index bac77a4076..41f9bbcb08 100644
--- a/frontend/src/components/SensitiveData/useSemanticType.ts
+++ b/frontend/src/components/SensitiveData/useSemanticType.ts
@@ -1,10 +1,17 @@
-import { computed, type MaybeRef, unref } from "vue";
+import { computed, type MaybeRef, unref, watchEffect } from "vue";
import { useSettingV1Store } from "@/store";
import { Setting_SettingName } from "@/types/proto-es/v1/setting_service_pb";
export const useSemanticType = (semanticTypeId: MaybeRef<string>) => {
const settingV1Store = useSettingV1Store();
+ watchEffect(async () => {
+ await settingV1Store.getOrFetchSettingByName(
+ Setting_SettingName.SEMANTIC_TYPES,
+ /* silent */ true
+ );
+ });
+
const semanticTypeList = computed(() => {
const setting = settingV1Store.getSettingByName(
Setting_SettingName.SEMANTIC_TYPES
diff --git a/frontend/src/components/User/Settings/AADSyncDrawer.vue b/frontend/src/components/User/Settings/AADSyncDrawer.vue
index df691ab7c1..6cc3a09506 100644
--- a/frontend/src/components/User/Settings/AADSyncDrawer.vue
+++ b/frontend/src/components/User/Settings/AADSyncDrawer.vue
@@ -132,7 +132,7 @@ const scimTokenFieldRef = ref<HTMLInputElement | null>(null);
const $dialog = useDialog();
const hasPermission = computed(() =>
- hasWorkspacePermissionV2("bb.settings.set")
+ hasWorkspacePermissionV2("bb.settings.setWorkspaceProfile")
);
const workspaceId = computed(() => {
@@ -151,7 +151,7 @@ const scimUrl = computed(() => {
});
const scimToken = computed(() => {
- return settingV1Store.workspaceProfileSetting?.directorySyncToken ?? "";
+ return settingV1Store.workspaceProfile.directorySyncToken;
});
const handleSelect = (component: HTMLInputElement | null) => {
diff --git a/frontend/src/components/User/Settings/CreateUserDrawer.vue b/frontend/src/components/User/Settings/CreateUserDrawer.vue
index eabc2be483..1c9d8c4b6e 100644
--- a/frontend/src/components/User/Settings/CreateUserDrawer.vue
+++ b/frontend/src/components/User/Settings/CreateUserDrawer.vue
@@ -344,7 +344,7 @@ import { Drawer, DrawerContent } from "@/components/v2";
import { RoleSelect } from "@/components/v2/Select";
import {
pushNotification,
- useActuatorV1Store,
+ useSettingV1Store,
useUserStore,
useWorkspaceV1Store,
} from "@/store";
@@ -602,7 +602,7 @@ watch(
);
const passwordRestrictionSetting = computed(
- () => useActuatorV1Store().restriction.passwordRestriction
+ () => useSettingV1Store().workspaceProfile.passwordRestriction
);
const allowConfirm = computed(() => {
diff --git a/frontend/src/components/misc/Watermark.vue b/frontend/src/components/misc/Watermark.vue
index 0d3486b9b5..d4613cfc69 100644
--- a/frontend/src/components/misc/Watermark.vue
+++ b/frontend/src/components/misc/Watermark.vue
@@ -40,6 +40,7 @@ import {
featureToRef,
useActuatorV1Store,
useCurrentUserV1,
+ useSettingV1Store,
} from "@/store";
import { UNKNOWN_USER_NAME } from "@/types";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
@@ -50,6 +51,7 @@ const PADDING = 6;
const currentUserV1 = useCurrentUserV1();
const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const version = computed(
() => actuatorStore.version + "-" + actuatorStore.gitCommitBE.substring(0, 7)
);
@@ -60,7 +62,7 @@ const lines = computed(() => {
const uid = extractUserId(user.name);
if (user.name === UNKNOWN_USER_NAME) return [];
if (!hasWatermarkFeature.value) return [];
- if (!actuatorStore.restriction.watermark) return [];
+ if (!settingV1Store.workspaceProfile.watermark) return [];
const lines: string[] = [];
lines.push(`${user.title} (${uid})`);
diff --git a/frontend/src/components/v2/Form/MissingExternalURLAttention.vue b/frontend/src/components/v2/Form/MissingExternalURLAttention.vue
index b95372a93b..2c862aa6f5 100644
--- a/frontend/src/components/v2/Form/MissingExternalURLAttention.vue
+++ b/frontend/src/components/v2/Form/MissingExternalURLAttention.vue
@@ -12,7 +12,7 @@
>
<template #action>
<NButton
- v-if="hasWorkspacePermissionV2('bb.settings.set')"
+ v-if="hasWorkspacePermissionV2('bb.settings.setWorkspaceProfile')"
type="primary"
@click="configureSetting"
>
diff --git a/frontend/src/composables/usePriorBackupTelemetry.ts b/frontend/src/composables/usePriorBackupTelemetry.ts
index 44ab57320d..647fb3ef87 100644
--- a/frontend/src/composables/usePriorBackupTelemetry.ts
+++ b/frontend/src/composables/usePriorBackupTelemetry.ts
@@ -3,6 +3,7 @@ import {
useActuatorV1Store,
useCurrentUserV1,
useDatabaseV1Store,
+ useSettingV1Store,
} from "@/store";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type { Plan } from "@/types/proto-es/v1/plan_service_pb";
@@ -56,12 +57,13 @@ export async function trackPriorBackupOnTaskRun(
}
// Respect user's metric collection preference
- const actuatorStore = useActuatorV1Store();
- if (actuatorStore.serverInfo?.enableMetricCollection === false) {
+ const settingStore = useSettingV1Store();
+ if (!settingStore.workspaceProfile.enableMetricCollection) {
return;
}
try {
+ const actuatorStore = useActuatorV1Store();
const currentUser = useCurrentUserV1();
const workspaceId = actuatorStore.info?.workspaceId;
diff --git a/frontend/src/customAppProfile.ts b/frontend/src/customAppProfile.ts
index b1924f9be9..cfd4f61198 100644
--- a/frontend/src/customAppProfile.ts
+++ b/frontend/src/customAppProfile.ts
@@ -1,6 +1,6 @@
import { computed } from "vue";
import { locale } from "./plugins/i18n";
-import { useActuatorV1Store } from "./store";
+import { useActuatorV1Store, useSettingV1Store } from "./store";
import { defaultAppProfile } from "./types";
import { DatabaseChangeMode } from "./types/proto-es/v1/setting_service_pb";
@@ -17,9 +17,10 @@ export const overrideAppProfile = () => {
const overrideAppFeatures = () => {
const actuatorStore = useActuatorV1Store();
+ const settingV1Store = useSettingV1Store();
const databaseChangeMode = computed(() => {
- const mode = actuatorStore.restriction.databaseChangeMode;
+ const mode = settingV1Store.workspaceProfile.databaseChangeMode;
if (mode === DatabaseChangeMode.EDITOR) return DatabaseChangeMode.EDITOR;
return DatabaseChangeMode.PIPELINE;
});
diff --git a/frontend/src/layouts/SQLEditorLayout.vue b/frontend/src/layouts/SQLEditorLayout.vue
index e252519839..0c900e4d21 100644
--- a/frontend/src/layouts/SQLEditorLayout.vue
+++ b/frontend/src/layouts/SQLEditorLayout.vue
@@ -27,6 +27,7 @@ import {
useSettingV1Store,
} from "@/store";
import { PolicyResourceType } from "@/types/proto-es/v1/org_policy_service_pb";
+import { Setting_SettingName } from "@/types/proto-es/v1/setting_service_pb";
import { provideSQLEditorContext } from "@/views/sql-editor/context";
import { provideSheetContext } from "@/views/sql-editor/Sheet";
import { provideTabListContext } from "@/views/sql-editor/TabList/context";
@@ -61,7 +62,9 @@ const prepare = async () => {
}),
]);
await Promise.all([
- useSettingV1Store().fetchSettingList(),
+ useSettingV1Store().getOrFetchSettingByName(
+ Setting_SettingName.WORKSPACE_PROFILE
+ ),
useEnvironmentV1Store().fetchEnvironments(),
]);
ready.value = true;
diff --git a/frontend/src/plugins/ai/components/ProvideAIContext.vue b/frontend/src/plugins/ai/components/ProvideAIContext.vue
index da3021ab52..d614a053a9 100644
--- a/frontend/src/plugins/ai/components/ProvideAIContext.vue
+++ b/frontend/src/plugins/ai/components/ProvideAIContext.vue
@@ -6,7 +6,7 @@
import { create } from "@bufbuild/protobuf";
import Emittery from "emittery";
import { storeToRefs } from "pinia";
-import { computed, reactive, ref, toRef } from "vue";
+import { computed, onMounted, reactive, ref, toRef } from "vue";
import { useEmitteryEventListener } from "@/composables/useEmitteryEventListener";
import {
useConnectionOfCurrentSQLEditorTab,
@@ -32,6 +32,11 @@ const state = reactive<LocalState>({
});
const settingV1Store = useSettingV1Store();
+
+onMounted(async () => {
+ await settingV1Store.getOrFetchSettingByName(Setting_SettingName.AI);
+});
+
const aiSetting = computed(() => {
const setting = settingV1Store.getSettingByName(Setting_SettingName.AI);
if (setting?.value?.value?.case === "ai") {
diff --git a/frontend/src/router/dashboard/workspaceSetting.ts b/frontend/src/router/dashboard/workspaceSetting.ts
index 347261aeee..bcf7f3b02a 100644
--- a/frontend/src/router/dashboard/workspaceSetting.ts
+++ b/frontend/src/router/dashboard/workspaceSetting.ts
@@ -42,7 +42,11 @@ const workspaceSettingRoutes: RouteRecordRaw[] = [
name: SETTING_ROUTE_WORKSPACE_GENERAL,
meta: {
title: () => t("settings.sidebar.general"),
- requiredPermissionList: () => ["bb.settings.get", "bb.policies.get"],
+ requiredPermissionList: () => [
+ "bb.settings.get",
+ "bb.settings.getWorkspaceProfile",
+ "bb.policies.get",
+ ],
},
component: () => import("@/views/SettingWorkspaceGeneral.vue"),
props: true,
diff --git a/frontend/src/router/index.ts b/frontend/src/router/index.ts
index ea9f8f2984..d3b5b7d3ab 100644
--- a/frontend/src/router/index.ts
+++ b/frontend/src/router/index.ts
@@ -8,12 +8,12 @@ import {
import {
hasFeature,
useAuthStore,
- useActuatorV1Store,
useRouterStore,
useCurrentUserV1,
useProjectV1Store,
useDatabaseV1Store,
useInstanceV1Store,
+ useSettingV1Store,
} from "@/store";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { isAuthRelatedRoute } from "@/utils/auth";
@@ -97,9 +97,9 @@ router.beforeEach((to, from, next) => {
return;
}
- const actuatorStore = useActuatorV1Store();
const authStore = useAuthStore();
const routerStore = useRouterStore();
+ const settingV1Store = useSettingV1Store();
// Allow access to 2FA setup and password reset for logged-in users
if (
@@ -197,7 +197,7 @@ router.beforeEach((to, from, next) => {
const currentUserV1 = useCurrentUserV1();
if (
hasFeature(PlanFeature.FEATURE_TWO_FA) &&
- actuatorStore.restriction.require2fa &&
+ settingV1Store.workspaceProfile.require2fa &&
currentUserV1.value &&
!currentUserV1.value.mfaEnabled &&
to.name !== AUTH_2FA_SETUP_MODULE // Prevent redirect loop
diff --git a/frontend/src/router/setup.ts b/frontend/src/router/setup.ts
index e12f68333d..ceb02760f9 100644
--- a/frontend/src/router/setup.ts
+++ b/frontend/src/router/setup.ts
@@ -14,7 +14,13 @@ const setupRoutes: RouteRecordRaw[] = [
name: SETUP_MODULE,
meta: {
title: () => t("setup.self"),
- requiredPermissionList: () => ["bb.settings.get", "bb.settings.set"],
+ requiredPermissionList: () => [
+ "bb.settings.get",
+ "bb.settings.setWorkspaceProfile",
+ "bb.projects.create",
+ "bb.roles.list",
+ "bb.workspaces.getIamPolicy",
+ ],
},
component: () => import("@/views/Setup/Setup.vue"),
},
diff --git a/frontend/src/store/modules/v1/actuator.ts b/frontend/src/store/modules/v1/actuator.ts
index f91808b6ed..2f1d94f24e 100644
--- a/frontend/src/store/modules/v1/actuator.ts
+++ b/frontend/src/store/modules/v1/actuator.ts
@@ -1,4 +1,3 @@
-import { create } from "@bufbuild/protobuf";
import { useLocalStorage } from "@vueuse/core";
import { defineStore } from "pinia";
import semver from "semver";
@@ -16,7 +15,6 @@ import type {
ActuatorInfo,
ResourcePackage,
} from "@/types/proto-es/v1/actuator_service_pb";
-import { RestrictionSchema } from "@/types/proto-es/v1/actuator_service_pb";
import { State } from "@/types/proto-es/v1/common_pb";
import { UserType } from "@/types/proto-es/v1/user_service_pb";
import { semverCompare } from "@/utils";
@@ -93,10 +91,6 @@ export const useActuatorV1Store = defineStore("actuator_v1", () => {
return url === "" || url === EXTERNAL_URL_PLACEHOLDER;
});
- const restriction = computed(
- () => serverInfo.value?.restriction ?? create(RestrictionSchema, {})
- );
-
const hasNewRelease = computed(() => {
return (
(serverInfo.value?.version === "development" &&
@@ -293,7 +287,6 @@ export const useActuatorV1Store = defineStore("actuator_v1", () => {
needAdminSetup,
needConfigureExternalUrl,
hasNewRelease,
- restriction,
activatedInstanceCount,
totalInstanceCount,
inactiveUserCount,
diff --git a/frontend/src/store/modules/v1/setting.ts b/frontend/src/store/modules/v1/setting.ts
index ca08098712..3fd4d3db3e 100644
--- a/frontend/src/store/modules/v1/setting.ts
+++ b/frontend/src/store/modules/v1/setting.ts
@@ -2,7 +2,7 @@ import { create } from "@bufbuild/protobuf";
import type { FieldMask } from "@bufbuild/protobuf/wkt";
import { createContextValues } from "@connectrpc/connect";
import { defineStore } from "pinia";
-import { computed } from "vue";
+import { computed, reactive } from "vue";
import { settingServiceClientConnect } from "@/connect";
import { silentContextKey } from "@/connect/context-key";
import { settingNamePrefix } from "@/store/modules/v1/common";
@@ -22,28 +22,22 @@ import {
import { hasWorkspacePermissionV2 } from "@/utils";
import { useActuatorV1Store } from "./actuator";
-interface SettingState {
- settingMapByName: Map<string, Setting>;
-}
+export const useSettingV1Store = defineStore("setting_v1", () => {
+ const settingMapByName = reactive(new Map<string, Setting>());
-export const useSettingV1Store = defineStore("setting_v1", {
- state: (): SettingState => ({
- settingMapByName: new Map(),
- }),
- getters: {
- workspaceProfileSetting(state): WorkspaceProfileSetting | undefined {
- const setting = state.settingMapByName.get(
- `${settingNamePrefix}${Setting_SettingName[Setting_SettingName.WORKSPACE_PROFILE]}`
- );
- if (!setting?.value?.value) return undefined;
- const value = setting.value.value;
- if (value.case === "workspaceProfile") {
- return value.value;
- }
- return undefined;
- },
- classification(): DataClassificationSetting_DataClassificationConfig[] {
- const setting = this.settingMapByName.get(
+ const workspaceProfile = computed((): WorkspaceProfileSetting => {
+ const setting = settingMapByName.get(
+ `${settingNamePrefix}${Setting_SettingName[Setting_SettingName.WORKSPACE_PROFILE]}`
+ );
+ if (setting?.value?.value.case === "workspaceProfile") {
+ return setting.value.value.value;
+ }
+ return create(WorkspaceProfileSettingSchema, {});
+ });
+
+ const classification = computed(
+ (): DataClassificationSetting_DataClassificationConfig[] => {
+ const setting = settingMapByName.get(
`${settingNamePrefix}${Setting_SettingName[Setting_SettingName.DATA_CLASSIFICATION]}`
);
if (!setting?.value?.value) return [];
@@ -52,123 +46,130 @@ export const useSettingV1Store = defineStore("setting_v1", {
return value.value.configs;
}
return [];
- },
- },
- actions: {
- getProjectClassification(
- classificationId: string
- ): DataClassificationSetting_DataClassificationConfig | undefined {
- const setting = this.settingMapByName.get(
- `${settingNamePrefix}${Setting_SettingName[Setting_SettingName.DATA_CLASSIFICATION]}`
- );
- if (!setting?.value?.value) return undefined;
- const value = setting.value.value;
- if (value.case === "dataClassification") {
- return value.value.configs.find(
- (config) => config.id === classificationId
- );
- }
- return undefined;
- },
- async fetchSettingByName(
- name: Setting_SettingName,
- silent = false
- ): Promise<Setting | undefined> {
- try {
- const request = create(GetSettingRequestSchema, {
- name: `${settingNamePrefix}${Setting_SettingName[name]}`,
- });
- const response = await settingServiceClientConnect.getSetting(request, {
- contextValues: createContextValues().set(silentContextKey, silent),
- });
- this.settingMapByName.set(response.name, response);
- return response;
- } catch {
- return;
- }
- },
- getOrFetchSettingByName(
- name: Setting_SettingName,
- silent = false
- ): Promise<Setting | undefined> | Setting | undefined {
- const setting = this.getSettingByName(name);
- if (setting) {
- return setting;
- }
- return this.fetchSettingByName(name, silent);
- },
- getSettingByName(name: Setting_SettingName): Setting | undefined {
- return this.settingMapByName.get(
- `${settingNamePrefix}${Setting_SettingName[name]}`
- );
- },
- async fetchSettingList() {
- if (!hasWorkspacePermissionV2("bb.settings.list")) {
- return;
- }
- const request = create(ListSettingsRequestSchema, {});
- const response = await settingServiceClientConnect.listSettings(request);
- for (const setting of response.settings) {
- this.settingMapByName.set(setting.name, setting);
- }
- },
- async upsertSetting({
- name,
- value,
- validateOnly = false,
- updateMask,
- }: {
- name: Setting_SettingName;
- value: SettingValue;
- validateOnly?: boolean;
- updateMask?: FieldMask | undefined;
- }): Promise<Setting> {
- const setting = create(SettingSchema, {
+ }
+ );
+
+ const getProjectClassification = (
+ classificationId: string
+ ): DataClassificationSetting_DataClassificationConfig | undefined => {
+ return classification.value.find(
+ (config) => config.id === classificationId
+ );
+ };
+
+ const fetchSettingByName = async (
+ name: Setting_SettingName,
+ silent = false
+ ): Promise<Setting | undefined> => {
+ try {
+ const request = create(GetSettingRequestSchema, {
name: `${settingNamePrefix}${Setting_SettingName[name]}`,
- value,
});
-
- const request = create(UpdateSettingRequestSchema, {
- setting,
- validateOnly,
- allowMissing: true,
- updateMask: updateMask,
+ const response = await settingServiceClientConnect.getSetting(request, {
+ contextValues: createContextValues().set(silentContextKey, silent),
});
- const response = await settingServiceClientConnect.updateSetting(request);
- this.settingMapByName.set(response.name, response);
+ settingMapByName.set(response.name, response);
return response;
- },
- async updateWorkspaceProfile({
- payload,
- updateMask,
- }: {
- payload: Partial<WorkspaceProfileSetting>;
- updateMask: FieldMask;
- }): Promise<void> {
- if (!this.workspaceProfileSetting) {
- return;
+ } catch {
+ return;
+ }
+ };
+
+ const getSettingByName = (name: Setting_SettingName): Setting | undefined => {
+ return settingMapByName.get(
+ `${settingNamePrefix}${Setting_SettingName[name]}`
+ );
+ };
+
+ const getOrFetchSettingByName = (
+ name: Setting_SettingName,
+ silent = false
+ ): Promise<Setting | undefined> | Setting | undefined => {
+ const setting = getSettingByName(name);
+ if (setting) {
+ return setting;
+ }
+ return fetchSettingByName(name, silent);
+ };
+
+ const fetchSettingList = async () => {
+ if (!hasWorkspacePermissionV2("bb.settings.list")) {
+ return;
+ }
+ const request = create(ListSettingsRequestSchema, {});
+ const response = await settingServiceClientConnect.listSettings(request);
+ for (const setting of response.settings) {
+ settingMapByName.set(setting.name, setting);
+ }
+ };
+
+ const upsertSetting = async ({
+ name,
+ value,
+ validateOnly = false,
+ updateMask,
+ }: {
+ name: Setting_SettingName;
+ value: SettingValue;
+ validateOnly?: boolean;
+ updateMask?: FieldMask | undefined;
+ }): Promise<Setting> => {
+ const setting = create(SettingSchema, {
+ name: `${settingNamePrefix}${Setting_SettingName[name]}`,
+ value,
+ });
+
+ const request = create(UpdateSettingRequestSchema, {
+ setting,
+ validateOnly,
+ allowMissing: true,
+ updateMask: updateMask,
+ });
+ const response = await settingServiceClientConnect.updateSetting(request);
+ settingMapByName.set(response.name, response);
+ return response;
+ };
+
+ const updateWorkspaceProfile = async ({
+ payload,
+ updateMask,
+ }: {
+ payload: Partial<WorkspaceProfileSetting>;
+ updateMask: FieldMask;
+ }): Promise<void> => {
+ const profileSetting: WorkspaceProfileSetting = create(
+ WorkspaceProfileSettingSchema,
+ {
+ ...workspaceProfile.value,
+ ...payload,
}
- const profileSetting: WorkspaceProfileSetting = create(
- WorkspaceProfileSettingSchema,
- {
- ...this.workspaceProfileSetting,
- ...payload,
- }
- );
- await this.upsertSetting({
- name: Setting_SettingName.WORKSPACE_PROFILE,
- value: create(SettingValueSchema, {
- value: {
- case: "workspaceProfile",
- value: profileSetting,
- },
- }),
- updateMask: updateMask,
- });
- // Refresh the latest server info.
- await useActuatorV1Store().fetchServerInfo();
- },
- },
+ );
+ await upsertSetting({
+ name: Setting_SettingName.WORKSPACE_PROFILE,
+ value: create(SettingValueSchema, {
+ value: {
+ case: "workspaceProfile",
+ value: profileSetting,
+ },
+ }),
+ updateMask: updateMask,
+ });
+ // Refresh the latest server info.
+ await useActuatorV1Store().fetchServerInfo();
+ };
+
+ return {
+ settingMapByName,
+ workspaceProfile,
+ classification,
+ getProjectClassification,
+ fetchSettingByName,
+ getSettingByName,
+ getOrFetchSettingByName,
+ fetchSettingList,
+ upsertSetting,
+ updateWorkspaceProfile,
+ };
});
export const useSettingByName = (name: Setting_SettingName) => {
diff --git a/frontend/src/types/iam/permission-generated.ts b/frontend/src/types/iam/permission-generated.ts
index 13eeb9d76a..cdd4c22cf3 100644
--- a/frontend/src/types/iam/permission-generated.ts
+++ b/frontend/src/types/iam/permission-generated.ts
@@ -89,9 +89,11 @@ export type Permission =
| "bb.rollouts.list"
| "bb.settings.get"
| "bb.settings.getEnvironment"
+ | "bb.settings.getWorkspaceProfile"
| "bb.settings.list"
| "bb.settings.set"
| "bb.settings.setEnvironment"
+ | "bb.settings.setWorkspaceProfile"
| "bb.sheets.create"
| "bb.sheets.get"
| "bb.sheets.update"
diff --git a/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts b/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts
index 68b6518a09..9e65b85987 100644
--- a/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts
@@ -4,8 +4,7 @@
import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
import type { Message } from "@bufbuild/protobuf";
-import type { Duration, EmptySchema, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
-import type { Announcement, DatabaseChangeMode, WorkspaceProfileSetting_PasswordRestriction } from "./setting_service_pb";
+import type { EmptySchema, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
import type { UserType } from "./user_service_pb";
import type { State } from "./common_pb";
@@ -125,87 +124,6 @@ export declare type DeleteCacheRequest = Message<"bytebase.v1.DeleteCacheRequest
*/
export declare const DeleteCacheRequestSchema: GenMessage<DeleteCacheRequest>;
-/**
- * @generated from message bytebase.v1.Restriction
- */
-export declare type Restriction = Message<"bytebase.v1.Restriction"> & {
- /**
- * Whether self-service user signup is disabled.
- *
- * @generated from field: bool disallow_signup = 1;
- */
- disallowSignup: boolean;
-
- /**
- * Whether two-factor authentication is required for all users.
- *
- * @generated from field: bool require_2fa = 2;
- */
- require2fa: boolean;
-
- /**
- * Whether password-based signin is disabled (except for workspace admins).
- *
- * @generated from field: bool disallow_password_signin = 3;
- */
- disallowPasswordSignin: boolean;
-
- /**
- * Password complexity and restriction requirements.
- *
- * @generated from field: bytebase.v1.WorkspaceProfileSetting.PasswordRestriction password_restriction = 4;
- */
- passwordRestriction?: WorkspaceProfileSetting_PasswordRestriction;
-
- /**
- * Whether to display watermark on pages.
- *
- * @generated from field: bool watermark = 5;
- */
- watermark: boolean;
-
- /**
- * The workspace database change mode.
- *
- * @generated from field: bytebase.v1.DatabaseChangeMode database_change_mode = 6;
- */
- databaseChangeMode: DatabaseChangeMode;
-
- /**
- * The session expiration time if not activity detected for the user. Value <= 0 means no limit.
- *
- * @generated from field: google.protobuf.Duration inactive_session_timeout = 7;
- */
- inactiveSessionTimeout?: Duration;
-
- /**
- * The workspace domain, e.g., bytebase.com.
- *
- * @generated from field: repeated string domains = 8;
- */
- domains: string[];
-
- /**
- * Only user and group from the domains can be created and login.
- *
- * @generated from field: bool enforce_identity_domain = 9;
- */
- enforceIdentityDomain: boolean;
-
- /**
- * The max duration for role expired.
- *
- * @generated from field: google.protobuf.Duration maximum_role_expiration = 10;
- */
- maximumRoleExpiration?: Duration;
-};
-
-/**
- * Describes the message bytebase.v1.Restriction.
- * Use `create(RestrictionSchema)` to create a new message.
- */
-export declare const RestrictionSchema: GenMessage<Restriction>;
-
/**
* System information and configuration for the Bytebase instance.
* Actuator concept is similar to the Spring Boot Actuator.
@@ -345,25 +263,6 @@ export declare type ActuatorInfo = Message<"bytebase.v1.ActuatorInfo"> & {
* @generated from field: bool external_url_from_flag = 23;
*/
externalUrlFromFlag: boolean;
-
- /**
- * The setting of custom announcement
- *
- * @generated from field: bytebase.v1.Announcement announcement = 24;
- */
- announcement?: Announcement;
-
- /**
- * Whether to enable metric collection for the workspace.
- *
- * @generated from field: bool enable_metric_collection = 25;
- */
- enableMetricCollection: boolean;
-
- /**
- * @generated from field: bytebase.v1.Restriction restriction = 26;
- */
- restriction?: Restriction;
};
/**
diff --git a/frontend/src/types/proto-es/v1/actuator_service_pb.js b/frontend/src/types/proto-es/v1/actuator_service_pb.js
index 12c584d0db..af378aa362 100644
--- a/frontend/src/types/proto-es/v1/actuator_service_pb.js
+++ b/frontend/src/types/proto-es/v1/actuator_service_pb.js
@@ -6,17 +6,16 @@ import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2
import { file_google_api_annotations } from "../google/api/annotations_pb";
import { file_google_api_client } from "../google/api/client_pb";
import { file_google_api_field_behavior } from "../google/api/field_behavior_pb";
-import { file_google_protobuf_duration, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
import { file_v1_annotation } from "./annotation_pb";
import { file_v1_common } from "./common_pb";
-import { file_v1_setting_service } from "./setting_service_pb";
import { file_v1_user_service } from "./user_service_pb";
/**
* Describes the file v1/actuator_service.proto.
*/
export const file_v1_actuator_service = /*@__PURE__*/
- fileDesc("Chl2MS9hY3R1YXRvcl9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSIbChlHZXRSZXNvdXJjZVBhY2thZ2VSZXF1ZXN0Ih8KD1Jlc291cmNlUGFja2FnZRIMCgRsb2dvGAEgASgMIhQKElNldHVwU2FtcGxlUmVxdWVzdCIYChZHZXRBY3R1YXRvckluZm9SZXF1ZXN0IpoBChlVcGRhdGVBY3R1YXRvckluZm9SZXF1ZXN0EjAKCGFjdHVhdG9yGAEgASgLMhkuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvQgPgQQISNAoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrQgPgQQISFQoNYWxsb3dfbWlzc2luZxgDIAEoCCIUChJEZWxldGVDYWNoZVJlcXVlc3Qi5AMKC1Jlc3RyaWN0aW9uEhwKD2Rpc2FsbG93X3NpZ251cBgBIAEoCEID4EEDEhgKC3JlcXVpcmVfMmZhGAIgASgIQgPgQQMSJQoYZGlzYWxsb3dfcGFzc3dvcmRfc2lnbmluGAMgASgIQgPgQQMSWwoUcGFzc3dvcmRfcmVzdHJpY3Rpb24YBCABKAsyOC5ieXRlYmFzZS52MS5Xb3Jrc3BhY2VQcm9maWxlU2V0dGluZy5QYXNzd29yZFJlc3RyaWN0aW9uQgPgQQMSFgoJd2F0ZXJtYXJrGAUgASgIQgPgQQMSQgoUZGF0YWJhc2VfY2hhbmdlX21vZGUYBiABKA4yHy5ieXRlYmFzZS52MS5EYXRhYmFzZUNoYW5nZU1vZGVCA+BBAxJAChhpbmFjdGl2ZV9zZXNzaW9uX3RpbWVvdXQYByABKAsyGS5nb29nbGUucHJvdG9idWYuRHVyYXRpb25CA+BBAxIUCgdkb21haW5zGAggAygJQgPgQQMSJAoXZW5mb3JjZV9pZGVudGl0eV9kb21haW4YCSABKAhCA+BBAxI/ChdtYXhpbXVtX3JvbGVfZXhwaXJhdGlvbhgKIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbkID4EEDIs8GCgxBY3R1YXRvckluZm8SFAoHdmVyc2lvbhgBIAEoCUID4EEDEhcKCmdpdF9jb21taXQYAiABKAlCA+BBAxIVCghyZWFkb25seRgDIAEoCEID4EEDEhEKBHNhYXMYBCABKAhCA+BBAxIRCgRkZW1vGAUgASgIQgPgQQMSEQoEaG9zdBgGIAEoCUID4EEDEhEKBHBvcnQYByABKAlCA+BBAxIZCgxleHRlcm5hbF91cmwYCCABKAlCA+BBAxIdChBuZWVkX2FkbWluX3NldHVwGAkgASgIQgPgQQMSOQoQbGFzdF9hY3RpdmVfdGltZRgLIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxIZCgx3b3Jrc3BhY2VfaWQYDSABKAlCA+BBAxINCgVkZWJ1ZxgOIAEoCBIgChN1bmxpY2Vuc2VkX2ZlYXR1cmVzGA8gAygJQgPgQQMSEwoGZG9ja2VyGBIgASgIQgPgQQMSOwoKdXNlcl9zdGF0cxgTIAMoCzIiLmJ5dGViYXNlLnYxLkFjdHVhdG9ySW5mby5TdGF0VXNlckID4EEDEiUKGGFjdGl2YXRlZF9pbnN0YW5jZV9jb3VudBgUIAEoBUID4EEDEiEKFHRvdGFsX2luc3RhbmNlX2NvdW50GBUgASgFQgPgQQMSGgoNZW5hYmxlX3NhbXBsZRgWIAEoCEID4EEDEiMKFmV4dGVybmFsX3VybF9mcm9tX2ZsYWcYFyABKAhCA+BBAxI0Cgxhbm5vdW5jZW1lbnQYGCABKAsyGS5ieXRlYmFzZS52MS5Bbm5vdW5jZW1lbnRCA+BBAxIlChhlbmFibGVfbWV0cmljX2NvbGxlY3Rpb24YGSABKAhCA+BBAxIyCgtyZXN0cmljdGlvbhgaIAEoCzIYLmJ5dGViYXNlLnYxLlJlc3RyaWN0aW9uQgPgQQMaZgoIU3RhdFVzZXISKAoJdXNlcl90eXBlGAEgASgOMhUuYnl0ZWJhc2UudjEuVXNlclR5cGUSIQoFc3RhdGUYAiABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZRINCgVjb3VudBgDIAEoBUoECAoQC0oECAwQDUoECBAQEUoECBEQEjKkBQoPQWN0dWF0b3JTZXJ2aWNlEnMKD0dldEFjdHVhdG9ySW5mbxIjLmJ5dGViYXNlLnYxLkdldEFjdHVhdG9ySW5mb1JlcXVlc3QaGS5ieXRlYmFzZS52MS5BY3R1YXRvckluZm8iINpBAIDqMAGC0+STAhMSES92MS9hY3R1YXRvci9pbmZvEqoBChJVcGRhdGVBY3R1YXRvckluZm8SJi5ieXRlYmFzZS52MS5VcGRhdGVBY3R1YXRvckluZm9SZXF1ZXN0GhkuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvIlHaQRRhY3R1YXRvcix1cGRhdGVfbWFza4rqMA9iYi5zZXR0aW5ncy5zZXSQ6jABgtPkkwIdOghhY3R1YXRvcjIRL3YxL2FjdHVhdG9yL2luZm8SggEKC1NldHVwU2FtcGxlEh8uYnl0ZWJhc2UudjEuU2V0dXBTYW1wbGVSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5IjqK6jASYmIucHJvamVjdHMuY3JlYXRlkOowAYLT5JMCGiIYL3YxL2FjdHVhdG9yOnNldHVwU2FtcGxlEmYKC0RlbGV0ZUNhY2hlEh8uYnl0ZWJhc2UudjEuRGVsZXRlQ2FjaGVSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5Ih6A6jABgtPkkwIUKhIvdjEvYWN0dWF0b3IvY2FjaGUSgQEKEkdldFJlc291cmNlUGFja2FnZRImLmJ5dGViYXNlLnYxLkdldFJlc291cmNlUGFja2FnZVJlcXVlc3QaHC5ieXRlYmFzZS52MS5SZXNvdXJjZVBhY2thZ2UiJdpBAIDqMAGC0+STAhgSFi92MS9hY3R1YXRvci9yZXNvdXJjZXNCqgEKD2NvbS5ieXRlYmFzZS52MUIUQWN0dWF0b3JTZXJ2aWNlUHJvdG9QAVo0Z2l0aHViLmNvbS9ieXRlYmFzZS9ieXRlYmFzZS9iYWNrZW5kL2dlbmVyYXRlZC1nby92MaICA0JYWKoCC0J5dGViYXNlLlYxygILQnl0ZWJhc2VcVjHiAhdCeXRlYmFzZVxWMVxHUEJNZXRhZGF0YeoCDEJ5dGViYXNlOjpWMWIGcHJvdG8z", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_protobuf_duration, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_setting_service, file_v1_user_service]);
+ fileDesc("Chl2MS9hY3R1YXRvcl9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSIbChlHZXRSZXNvdXJjZVBhY2thZ2VSZXF1ZXN0Ih8KD1Jlc291cmNlUGFja2FnZRIMCgRsb2dvGAEgASgMIhQKElNldHVwU2FtcGxlUmVxdWVzdCIYChZHZXRBY3R1YXRvckluZm9SZXF1ZXN0IpoBChlVcGRhdGVBY3R1YXRvckluZm9SZXF1ZXN0EjAKCGFjdHVhdG9yGAEgASgLMhkuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvQgPgQQISNAoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrQgPgQQISFQoNYWxsb3dfbWlzc2luZxgDIAEoCCIUChJEZWxldGVDYWNoZVJlcXVlc3QivgUKDEFjdHVhdG9ySW5mbxIUCgd2ZXJzaW9uGAEgASgJQgPgQQMSFwoKZ2l0X2NvbW1pdBgCIAEoCUID4EEDEhUKCHJlYWRvbmx5GAMgASgIQgPgQQMSEQoEc2FhcxgEIAEoCEID4EEDEhEKBGRlbW8YBSABKAhCA+BBAxIRCgRob3N0GAYgASgJQgPgQQMSEQoEcG9ydBgHIAEoCUID4EEDEhkKDGV4dGVybmFsX3VybBgIIAEoCUID4EEDEh0KEG5lZWRfYWRtaW5fc2V0dXAYCSABKAhCA+BBAxI5ChBsYXN0X2FjdGl2ZV90aW1lGAsgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEhkKDHdvcmtzcGFjZV9pZBgNIAEoCUID4EEDEg0KBWRlYnVnGA4gASgIEiAKE3VubGljZW5zZWRfZmVhdHVyZXMYDyADKAlCA+BBAxITCgZkb2NrZXIYEiABKAhCA+BBAxI7Cgp1c2VyX3N0YXRzGBMgAygLMiIuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvLlN0YXRVc2VyQgPgQQMSJQoYYWN0aXZhdGVkX2luc3RhbmNlX2NvdW50GBQgASgFQgPgQQMSIQoUdG90YWxfaW5zdGFuY2VfY291bnQYFSABKAVCA+BBAxIaCg1lbmFibGVfc2FtcGxlGBYgASgIQgPgQQMSIwoWZXh0ZXJuYWxfdXJsX2Zyb21fZmxhZxgXIAEoCEID4EEDGmYKCFN0YXRVc2VyEigKCXVzZXJfdHlwZRgBIAEoDjIVLmJ5dGViYXNlLnYxLlVzZXJUeXBlEiEKBXN0YXRlGAIgASgOMhIuYnl0ZWJhc2UudjEuU3RhdGUSDQoFY291bnQYAyABKAVKBAgKEAtKBAgMEA1KBAgQEBFKBAgREBIypAUKD0FjdHVhdG9yU2VydmljZRJzCg9HZXRBY3R1YXRvckluZm8SIy5ieXRlYmFzZS52MS5HZXRBY3R1YXRvckluZm9SZXF1ZXN0GhkuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvIiDaQQCA6jABgtPkkwITEhEvdjEvYWN0dWF0b3IvaW5mbxKqAQoSVXBkYXRlQWN0dWF0b3JJbmZvEiYuYnl0ZWJhc2UudjEuVXBkYXRlQWN0dWF0b3JJbmZvUmVxdWVzdBoZLmJ5dGViYXNlLnYxLkFjdHVhdG9ySW5mbyJR2kEUYWN0dWF0b3IsdXBkYXRlX21hc2uK6jAPYmIuc2V0dGluZ3Muc2V0kOowAYLT5JMCHToIYWN0dWF0b3IyES92MS9hY3R1YXRvci9pbmZvEoIBCgtTZXR1cFNhbXBsZRIfLmJ5dGViYXNlLnYxLlNldHVwU2FtcGxlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSI6iuowEmJiLnByb2plY3RzLmNyZWF0ZZDqMAGC0+STAhoiGC92MS9hY3R1YXRvcjpzZXR1cFNhbXBsZRJmCgtEZWxldGVDYWNoZRIfLmJ5dGViYXNlLnYxLkRlbGV0ZUNhY2hlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSIegOowAYLT5JMCFCoSL3YxL2FjdHVhdG9yL2NhY2hlEoEBChJHZXRSZXNvdXJjZVBhY2thZ2USJi5ieXRlYmFzZS52MS5HZXRSZXNvdXJjZVBhY2thZ2VSZXF1ZXN0GhwuYnl0ZWJhc2UudjEuUmVzb3VyY2VQYWNrYWdlIiXaQQCA6jABgtPkkwIYEhYvdjEvYWN0dWF0b3IvcmVzb3VyY2VzQqoBCg9jb20uYnl0ZWJhc2UudjFCFEFjdHVhdG9yU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_user_service]);
/**
* Describes the message bytebase.v1.GetResourcePackageRequest.
@@ -60,26 +59,19 @@ export const UpdateActuatorInfoRequestSchema = /*@__PURE__*/
export const DeleteCacheRequestSchema = /*@__PURE__*/
messageDesc(file_v1_actuator_service, 5);
-/**
- * Describes the message bytebase.v1.Restriction.
- * Use `create(RestrictionSchema)` to create a new message.
- */
-export const RestrictionSchema = /*@__PURE__*/
- messageDesc(file_v1_actuator_service, 6);
-
/**
* Describes the message bytebase.v1.ActuatorInfo.
* Use `create(ActuatorInfoSchema)` to create a new message.
*/
export const ActuatorInfoSchema = /*@__PURE__*/
- messageDesc(file_v1_actuator_service, 7);
+ messageDesc(file_v1_actuator_service, 6);
/**
* Describes the message bytebase.v1.ActuatorInfo.StatUser.
* Use `create(ActuatorInfo_StatUserSchema)` to create a new message.
*/
export const ActuatorInfo_StatUserSchema = /*@__PURE__*/
- messageDesc(file_v1_actuator_service, 7, 0);
+ messageDesc(file_v1_actuator_service, 6, 0);
/**
* ActuatorService manages system health and operational information.
diff --git a/frontend/src/views/BannerAnnouncement.vue b/frontend/src/views/BannerAnnouncement.vue
index 4d12734936..56f305dca0 100644
--- a/frontend/src/views/BannerAnnouncement.vue
+++ b/frontend/src/views/BannerAnnouncement.vue
@@ -19,14 +19,14 @@
<script lang="ts" setup>
import { computed } from "vue";
-import { hasFeature, useActuatorV1Store } from "@/store";
+import { hasFeature, useSettingV1Store } from "@/store";
import { Announcement_AlertLevel } from "@/types/proto-es/v1/setting_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { urlfy } from "@/utils";
-const actuatorStore = useActuatorV1Store();
+const settingStore = useSettingV1Store();
-const announcement = computed(() => actuatorStore.serverInfo?.announcement);
+const announcement = computed(() => settingStore.workspaceProfile.announcement);
const showBanner = computed(() => {
return (
diff --git a/frontend/src/views/BannerExternalUrl.vue b/frontend/src/views/BannerExternalUrl.vue
index 4f0c86895e..d9c00645d9 100644
--- a/frontend/src/views/BannerExternalUrl.vue
+++ b/frontend/src/views/BannerExternalUrl.vue
@@ -44,6 +44,6 @@ import { hasWorkspacePermissionV2 } from "@/utils";
const show = ref(true);
const hasPermission = computed(() =>
- hasWorkspacePermissionV2("bb.settings.set")
+ hasWorkspacePermissionV2("bb.settings.setWorkspaceProfile")
);
</script>
diff --git a/frontend/src/views/EnvironmentDashboard.vue b/frontend/src/views/EnvironmentDashboard.vue
index 7e98dfa844..8a48cec0ef 100644
--- a/frontend/src/views/EnvironmentDashboard.vue
+++ b/frontend/src/views/EnvironmentDashboard.vue
@@ -260,7 +260,6 @@ const doCreate = async (params: {
color: environment.color,
tags: environment.tags,
});
- await environmentV1Store.fetchEnvironments();
// Only persist rollout policy if user customized it from the defaults
// Otherwise, let the backend return defaults dynamically via GetPolicy API
diff --git a/frontend/src/views/ProfileDashboard.vue b/frontend/src/views/ProfileDashboard.vue
index 74893eca55..2083e3b131 100644
--- a/frontend/src/views/ProfileDashboard.vue
+++ b/frontend/src/views/ProfileDashboard.vue
@@ -244,8 +244,8 @@ import {
featureToRef,
hasFeature,
pushNotification,
- useActuatorV1Store,
useCurrentUserV1,
+ useSettingV1Store,
useUserStore,
useWorkspaceV1Store,
} from "@/store";
@@ -278,7 +278,7 @@ const props = defineProps<{
const { t } = useI18n();
const router = useRouter();
-const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const currentUser = useCurrentUserV1();
const userStore = useUserStore();
const workspaceStore = useWorkspaceV1Store();
@@ -295,7 +295,7 @@ const editNameTextField = ref<InstanceType<typeof NInput>>();
const userPasswordRef = ref<InstanceType<typeof UserPassword>>();
const passwordRestrictionSetting = computed(
- () => actuatorStore.restriction.passwordRestriction
+ () => settingV1Store.workspaceProfile.passwordRestriction
);
const keyboardHandler = (e: KeyboardEvent) => {
@@ -465,7 +465,7 @@ const enable2FA = () => {
const disable2FA = () => {
if (
- actuatorStore.restriction.require2fa &&
+ settingV1Store.workspaceProfile.require2fa &&
!hasWorkspacePermissionV2("bb.policies.update")
) {
pushNotification({
diff --git a/frontend/src/views/SettingWorkspaceGeneral.vue b/frontend/src/views/SettingWorkspaceGeneral.vue
index f139a6cb9e..e00336dabf 100644
--- a/frontend/src/views/SettingWorkspaceGeneral.vue
+++ b/frontend/src/views/SettingWorkspaceGeneral.vue
@@ -3,43 +3,43 @@
<GeneralSetting
ref="generalSettingRef"
:title="$t('common.general')"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
<BrandingSetting
ref="brandingSettingRef"
:title="$t('settings.general.workspace.branding')"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
<AccountSetting
ref="accountSettingRef"
:title="$t('settings.general.workspace.account')"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
<SecuritySetting
ref="securitySettingRef"
:title="$t('settings.general.workspace.security')"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
<AIAugmentationSetting
ref="aiAugmentationSettingRef"
:title="$t('settings.general.workspace.ai-assistant.self')"
- :allow-edit="allowEdit"
+ :allow-edit="hasSettingPermission"
/>
<AnnouncementSetting
ref="announcementSettingRef"
:title="$t('settings.general.workspace.announcement.self')"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
<ProductImprovementSetting
ref="productImprovementSettingRef"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
<AuditLogStdoutSetting
ref="auditLogStdoutSettingRef"
- :allow-edit="allowEdit"
+ :allow-edit="hasWorkspaceProfilePermission"
/>
- <div v-if="allowEdit && isDirty" class="sticky bottom-0 z-10">
+ <div v-if="isDirty" class="sticky bottom-0 z-10">
<div
class="flex justify-between w-full py-4 border-t border-block-border bg-white"
>
@@ -72,10 +72,7 @@ import {
import { useRouteChangeGuard } from "@/composables/useRouteChangeGuard";
import { useBodyLayoutContext } from "@/layouts/common";
import { pushNotification } from "@/store";
-
-defineProps<{
- allowEdit: boolean;
-}>();
+import { hasWorkspacePermissionV2 } from "@/utils";
const route = useRoute();
const { t } = useI18n();
@@ -92,6 +89,13 @@ const productImprovementSettingRef =
const auditLogStdoutSettingRef =
ref<InstanceType<typeof AuditLogStdoutSetting>>();
+const hasWorkspaceProfilePermission = computed(() =>
+ hasWorkspacePermissionV2("bb.settings.setWorkspaceProfile")
+);
+const hasSettingPermission = computed(() =>
+ hasWorkspacePermissionV2("bb.settings.set")
+);
+
const settingRefList = computed(() => {
return [
accountSettingRef,
diff --git a/frontend/src/views/SettingWorkspaceIM.vue b/frontend/src/views/SettingWorkspaceIM.vue
index 30869bc895..d2e1919812 100644
--- a/frontend/src/views/SettingWorkspaceIM.vue
+++ b/frontend/src/views/SettingWorkspaceIM.vue
@@ -272,7 +272,7 @@ import { FieldMaskSchema } from "@bufbuild/protobuf/wkt";
import { isEqual } from "lodash-es";
import { PlusIcon, Trash2Icon } from "lucide-vue-next";
import { NButton, NEmpty, NPopconfirm, NSelect } from "naive-ui";
-import { computed, reactive, watch } from "vue";
+import { computed, onMounted, reactive, watch } from "vue";
import { useI18n } from "vue-i18n";
import BBTextField from "@/bbkit/BBTextField.vue";
import LearnMoreLink from "@/components/LearnMoreLink.vue";
@@ -660,6 +660,10 @@ const renderOption = ({ value }: { value: WebhookType }) => {
);
};
+onMounted(async () => {
+ await settingStore.getOrFetchSettingByName(Setting_SettingName.APP_IM);
+});
+
watch(
() => imSetting.value,
(setting) => {
diff --git a/frontend/src/views/SettingWorkspaceUsers.vue b/frontend/src/views/SettingWorkspaceUsers.vue
index 159aaa0baa..f93612a58f 100644
--- a/frontend/src/views/SettingWorkspaceUsers.vue
+++ b/frontend/src/views/SettingWorkspaceUsers.vue
@@ -94,13 +94,13 @@
:permissions="['bb.groups.create']"
>
<NPopover
- :disabled="slotProps.disabled || actuatorStore.restriction.domains.length > 0"
+ :disabled="slotProps.disabled || settingV1Store.workspaceProfile.domains.length > 0"
>
<template #trigger>
<NButton
:disabled="
slotProps.disabled ||
- actuatorStore.restriction.domains.length === 0 ||
+ settingV1Store.workspaceProfile.domains.length === 0 ||
!hasUserGroupFeature
"
@click="handleCreateGroup"
@@ -233,6 +233,7 @@ import {
featureToRef,
useActuatorV1Store,
useGroupStore,
+ useSettingV1Store,
useSubscriptionV1Store,
useUIStateStore,
useUserStore,
@@ -281,6 +282,7 @@ const userStore = useUserStore();
const groupStore = useGroupStore();
const uiStateStore = useUIStateStore();
const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const subscriptionV1Store = useSubscriptionV1Store();
const userPagedTable = ref<ComponentExposed<typeof PagedTable<User>>>();
const groupPagedTable = ref<ComponentExposed<typeof PagedTable<Group>>>();
diff --git a/frontend/src/views/Setup/Setup.vue b/frontend/src/views/Setup/Setup.vue
index 7a477fa0cc..5cbf3554df 100644
--- a/frontend/src/views/Setup/Setup.vue
+++ b/frontend/src/views/Setup/Setup.vue
@@ -1,58 +1,30 @@
<template>
- <AdminSetup v-if="ready" />
- <MaskSpinner v-else class="bg-white!" />
- <AuthFooter />
+ <RoutePermissionGuard :routes="setupRoutes">
+ <AdminSetup v-if="ready" />
+ <MaskSpinner v-else class="bg-white!" />
+ <AuthFooter />
+ </RoutePermissionGuard>
</template>
<script lang="ts" setup>
-import { onMounted, ref, watch } from "vue";
-import {
- type RouteLocationNormalizedLoadedGeneric,
- useRouter,
-} from "vue-router";
+import { onMounted, ref } from "vue";
+import { useRouter } from "vue-router";
import MaskSpinner from "@/components/misc/MaskSpinner.vue";
-import { WORKSPACE_ROUTE_403 } from "@/router/dashboard/workspaceRoutes";
+import RoutePermissionGuard from "@/components/Permission/RoutePermissionGuard.vue";
+import setupRoutes from "@/router/setup";
import { useRoleStore, useWorkspaceV1Store } from "@/store";
-import { hasWorkspacePermissionV2 } from "@/utils";
import AuthFooter from "@/views/auth/AuthFooter.vue";
import AdminSetup from "./AdminSetup.vue";
const router = useRouter();
const ready = ref<boolean>(false);
-const checkPermissions = (route: RouteLocationNormalizedLoadedGeneric) => {
- if (!route.meta.requiredPermissionList) {
- return true;
- }
- const requiredPermissionList = route.meta.requiredPermissionList();
- if (!requiredPermissionList.every(hasWorkspacePermissionV2)) {
- return false;
- }
- return true;
-};
-
onMounted(async () => {
await router.isReady();
-
// Prepare roles and workspace IAM policy.
await Promise.all([
useRoleStore().fetchRoleList(),
useWorkspaceV1Store().fetchIamPolicy(),
]);
-
- watch(
- router.currentRoute,
- (route) => {
- if (!checkPermissions(route)) {
- ready.value = false;
- router.push({
- name: WORKSPACE_ROUTE_403,
- });
- return;
- }
- ready.value = true;
- },
- { immediate: true, flush: "post" }
- );
});
</script>
diff --git a/frontend/src/views/auth/InactiveRemindModal.vue b/frontend/src/views/auth/InactiveRemindModal.vue
index d7f86d7372..aa34cabd27 100644
--- a/frontend/src/views/auth/InactiveRemindModal.vue
+++ b/frontend/src/views/auth/InactiveRemindModal.vue
@@ -39,10 +39,10 @@ import { computed, onUnmounted, ref, watch } from "vue";
import { BBModal } from "@/bbkit";
import { useCurrentTimestamp } from "@/composables/useCurrentTimestamp";
import { useLastActivity } from "@/composables/useLastActivity";
-import { useActuatorV1Store, useAuthStore } from "@/store";
+import { useAuthStore, useSettingV1Store } from "@/store";
const authStore = useAuthStore();
-const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const timer = ref<NodeJS.Timeout | undefined>();
// Show the modal 3min before the inactiveTimeout threshold.
@@ -53,7 +53,7 @@ const logout = () => {
};
const inactiveTimeoutInSeconds = computed(() =>
- Number(actuatorStore.restriction.inactiveSessionTimeout?.seconds ?? 0)
+ Number(settingV1Store.workspaceProfile.inactiveSessionTimeout?.seconds ?? 0)
);
const { lastActivityTs } = useLastActivity();
diff --git a/frontend/src/views/auth/PasswordReset.vue b/frontend/src/views/auth/PasswordReset.vue
index 711754fcf6..df1dd530a0 100644
--- a/frontend/src/views/auth/PasswordReset.vue
+++ b/frontend/src/views/auth/PasswordReset.vue
@@ -43,9 +43,9 @@ import { useRouter } from "vue-router";
import UserPassword from "@/components/User/Settings/UserPassword.vue";
import {
pushNotification,
- useActuatorV1Store,
useAuthStore,
useCurrentUserV1,
+ useSettingV1Store,
useUserStore,
} from "@/store";
import type { User } from "@/types/proto-es/v1/user_service_pb";
@@ -69,7 +69,7 @@ const userPasswordRef = ref<InstanceType<typeof UserPassword>>();
const router = useRouter();
const passwordRestrictionSetting = computed(
- () => useActuatorV1Store().restriction.passwordRestriction
+ () => useSettingV1Store().workspaceProfile.passwordRestriction
);
const redirectQuery = computed(() => {
diff --git a/frontend/src/views/auth/Signin.vue b/frontend/src/views/auth/Signin.vue
index 8c569d4efb..872c6a2189 100644
--- a/frontend/src/views/auth/Signin.vue
+++ b/frontend/src/views/auth/Signin.vue
@@ -13,7 +13,7 @@
pane-style="padding: 12px 0 0 0"
>
<NTabPane
- v-if="!restriction.disallowPasswordSignin"
+ v-if="!workspaceProfile.disallowPasswordSignin"
name="standard"
tab="Standard"
>
@@ -194,6 +194,7 @@ import {
useActuatorV1Store,
useAuthStore,
useIdentityProviderStore,
+ useSettingV1Store,
} from "@/store";
import { idpNamePrefix } from "@/store/modules/v1/common";
import {
@@ -227,6 +228,7 @@ interface LocalState {
const router = useRouter();
const route = useRoute();
const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const authStore = useAuthStore();
const identityProviderStore = useIdentityProviderStore();
@@ -237,10 +239,11 @@ const state = reactive<LocalState>({
isLoading: false,
});
const initialized = ref(false);
-const { isDemo, restriction } = storeToRefs(actuatorStore);
+const { isDemo } = storeToRefs(actuatorStore);
+const { workspaceProfile } = storeToRefs(settingV1Store);
const disallowSignup = computed(
- () => !props.allowSignup || restriction.value.disallowSignup
+ () => !props.allowSignup || workspaceProfile.value.disallowSignup
);
const separatedIdentityProviderList = computed(() =>
@@ -256,13 +259,13 @@ const groupedIdentityProviderList = computed(() =>
const showSignInForm = computed(() => {
return (
- !restriction.value.disallowPasswordSignin ||
+ !workspaceProfile.value.disallowPasswordSignin ||
groupedIdentityProviderList.value.length > 0
);
});
const defaultTabValue = computed(() => {
- if (!restriction.value.disallowPasswordSignin) {
+ if (!workspaceProfile.value.disallowPasswordSignin) {
return "standard";
}
if (groupedIdentityProviderList.value.length > 0) {
diff --git a/frontend/src/views/auth/Signup.vue b/frontend/src/views/auth/Signup.vue
index 1f714d7779..598d10a56c 100644
--- a/frontend/src/views/auth/Signup.vue
+++ b/frontend/src/views/auth/Signup.vue
@@ -48,7 +48,7 @@
v-model:password="state.password"
v-model:password-confirm="state.passwordConfirm"
:show-learn-more="false"
- :password-restriction="restriction.passwordRestriction"
+ :password-restriction="workspaceProfile.passwordRestriction"
/>
<div>
@@ -148,7 +148,7 @@ import BytebaseLogo from "@/components/BytebaseLogo.vue";
import RequiredStar from "@/components/RequiredStar.vue";
import UserPassword from "@/components/User/Settings/UserPassword.vue";
import { AUTH_SIGNIN_MODULE } from "@/router/auth";
-import { useActuatorV1Store, useAuthStore } from "@/store";
+import { useActuatorV1Store, useAuthStore, useSettingV1Store } from "@/store";
import type { User } from "@/types/proto-es/v1/user_service_pb";
import { isValidEmail } from "@/utils";
import AuthFooter from "./AuthFooter.vue";
@@ -164,6 +164,7 @@ interface LocalState {
}
const actuatorStore = useActuatorV1Store();
+const settingV1Store = useSettingV1Store();
const userPasswordRef = ref<InstanceType<typeof UserPassword>>();
const state = reactive<LocalState>({
@@ -176,7 +177,8 @@ const state = reactive<LocalState>({
isLoading: false,
});
-const { needAdminSetup, restriction } = storeToRefs(actuatorStore);
+const { needAdminSetup } = storeToRefs(actuatorStore);
+const { workspaceProfile } = storeToRefs(settingV1Store);
const allowSignup = computed(() => {
return (
@@ -186,7 +188,7 @@ const allowSignup = computed(() => {
!userPasswordRef.value?.passwordHint &&
!userPasswordRef.value?.passwordMismatch &&
state.acceptTermsAndPolicy &&
- !restriction.value.disallowSignup
+ !workspaceProfile.value.disallowSignup
);
});
diff --git a/frontend/src/views/sql-editor/EditorCommon/OpenAIButton/OpenAIButton.vue b/frontend/src/views/sql-editor/EditorCommon/OpenAIButton/OpenAIButton.vue
index c9b8e952f9..948efb3fb8 100644
--- a/frontend/src/views/sql-editor/EditorCommon/OpenAIButton/OpenAIButton.vue
+++ b/frontend/src/views/sql-editor/EditorCommon/OpenAIButton/OpenAIButton.vue
@@ -51,7 +51,7 @@
<script setup lang="ts">
import { NButton, NPopover, NPopselect, type SelectOption } from "naive-ui";
-import { computed } from "vue";
+import { computed, onMounted } from "vue";
import { useI18n } from "vue-i18n";
import { useRouter } from "vue-router";
import type { ChatAction } from "@/plugins/ai";
@@ -82,6 +82,10 @@ const router = useRouter();
const tabStore = useSQLEditorTabStore();
const settingV1Store = useSettingV1Store();
+onMounted(async () => {
+ await settingV1Store.getOrFetchSettingByName(Setting_SettingName.AI);
+});
+
const openAIEnabled = computed(() => {
const setting = settingV1Store.getSettingByName(Setting_SettingName.AI);
return setting?.value?.value?.case === "ai"
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 70c4479a07..223dec47a2 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -7808,19 +7808,6 @@ components:
readOnly: true
type: boolean
description: Whether the external URL is set via command-line flag (and thus cannot be changed via UI).
- announcement:
- readOnly: true
- allOf:
- - $ref: '#/components/schemas/Announcement'
- description: The setting of custom announcement
- enableMetricCollection:
- readOnly: true
- type: boolean
- description: Whether to enable metric collection for the workspace.
- restriction:
- readOnly: true
- allOf:
- - $ref: '#/components/schemas/Restriction'
description: |-
System information and configuration for the Bytebase instance.
Actuator concept is similar to the Spring Boot Actuator.
@@ -8870,64 +8857,6 @@ components:
`all_affected_rows` is the affected rows of each command.
`all_affected_rows` may be unavailable if the database driver doesn't support it. Caller should fallback to `affected_rows` in that case.
description: Command execution response.
- Constant:
- type: object
- properties:
- nullValue:
- enum:
- - NULL_VALUE
- type: string
- description: null value.
- format: enum
- boolValue:
- type: boolean
- description: boolean value.
- int64Value:
- type: string
- description: int64 value.
- uint64Value:
- type: string
- description: uint64 value.
- doubleValue:
- type: number
- description: double value.
- format: double
- stringValue:
- type: string
- description: string value.
- bytesValue:
- type: string
- description: bytes value.
- format: bytes
- durationValue:
- pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
- type: string
- description: |-
- protobuf.Duration value.
-
- Deprecated: duration is no longer considered a builtin cel type.
- timestampValue:
- type: string
- description: |-
- protobuf.Timestamp value.
-
- Deprecated: timestamp is no longer considered a builtin cel type.
- format: date-time
- description: |-
- Represents a primitive literal.
-
- Named 'Constant' here for backwards compatibility.
-
- This is similar as the primitives supported in the well-known type
- `google.protobuf.Value`, but richer so it can represent CEL's full range of
- primitives.
-
- Lists and structs are not included as constants as these aggregate types may
- contain [Expr][google.api.expr.v1alpha1.Expr] elements which require
- evaluation and are thus not constant.
-
- Examples of literals include: `"hello"`, `b'bytes'`, `1u`, `4.2`, `-2`,
- `true`, `null`.
Content_Part:
type: object
properties:
@@ -8978,35 +8907,6 @@ components:
allOf:
- $ref: '#/components/schemas/Sheet'
description: The sheet to create.
- CreateStruct_Entry:
- type: object
- properties:
- id:
- type: string
- description: |-
- Required. An id assigned to this node by the parser which is unique
- in a given expression tree. This is used to associate type
- information and other attributes to the node.
- fieldKey:
- type: string
- description: The field key for a message creator statement.
- mapKey:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: The key expression for a map creation statement.
- value:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: |-
- Required. The value assigned to the key.
-
- If the optional_entry field is true, the expression must resolve to an
- optional-typed value. If the optional value is present, the key will be
- set; however, if the optional value is absent, the key will be unset.
- optionalEntry:
- type: boolean
- description: Whether the key-value pair is optional.
- description: Represents an entry.
DataClassificationConfig_DataClassification:
type: object
properties:
@@ -9894,266 +9794,59 @@ components:
Expr:
type: object
properties:
- id:
+ expression:
type: string
description: |-
- Required. An id assigned to this node by the parser which is unique in a
- given expression tree. This is used to associate type information and other
- attributes to a node in the parse tree.
- constExpr:
- allOf:
- - $ref: '#/components/schemas/Constant'
- description: A literal expression.
- identExpr:
- allOf:
- - $ref: '#/components/schemas/Expr_Ident'
- description: An identifier expression.
- selectExpr:
- allOf:
- - $ref: '#/components/schemas/Expr_Select'
- description: A field selection expression, e.g. `request.auth`.
- callExpr:
- allOf:
- - $ref: '#/components/schemas/Expr_Call'
- description: A call expression, including calls to predefined functions and operators.
- listExpr:
- allOf:
- - $ref: '#/components/schemas/Expr_CreateList'
- description: A list creation expression.
- structExpr:
- allOf:
- - $ref: '#/components/schemas/Expr_CreateStruct'
- description: A map or message creation expression.
- comprehensionExpr:
- allOf:
- - $ref: '#/components/schemas/Expr_Comprehension'
- description: A comprehension expression.
- description: |-
- An abstract representation of a common expression.
-
- Expressions are abstractly represented as a collection of identifiers,
- select statements, function calls, literals, and comprehensions. All
- operators with the exception of the '.' operator are modelled as function
- calls. This makes it easy to represent new operators into the existing AST.
-
- All references within expressions must resolve to a
- [Decl][google.api.expr.v1alpha1.Decl] provided at type-check for an
- expression to be valid. A reference may either be a bare identifier `name` or
- a qualified identifier `google.api.name`. References may either refer to a
- value or a function declaration.
-
- For example, the expression `google.api.name.startsWith('expr')` references
- the declaration `google.api.name` within a
- [Expr.Select][google.api.expr.v1alpha1.Expr.Select] expression, and the
- function declaration `startsWith`.
- Expr_Call:
- type: object
- properties:
- target:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: |-
- The target of an method call-style expression. For example, `x` in
- `x.f()`.
- function:
- type: string
- description: Required. The name of the function or method being called.
- args:
- type: array
- items:
- $ref: '#/components/schemas/Expr'
- description: The arguments.
- description: |-
- A call expression, including calls to predefined functions and operators.
-
- For example, `value == 10`, `size(map_value)`.
- Expr_Comprehension:
- type: object
- properties:
- iterVar:
+ Textual representation of an expression in Common Expression Language
+ syntax.
+ title:
type: string
description: |-
- The name of the first iteration variable.
- When the iter_range is a list, this variable is the list element.
- When the iter_range is a map, this variable is the map entry key.
- iterVar2:
+ Optional. Title for the expression, i.e. a short string describing
+ its purpose. This can be used e.g. in UIs which allow to enter the
+ expression.
+ description:
type: string
description: |-
- The name of the second iteration variable, empty if not set.
- When the iter_range is a list, this variable is the integer index.
- When the iter_range is a map, this variable is the map entry value.
- This field is only set for comprehension v2 macros.
- iterRange:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: The range over which the comprehension iterates.
- accuVar:
+ Optional. Description of the expression. This is a longer text which
+ describes the expression, e.g. when hovered over it in a UI.
+ location:
type: string
- description: The name of the variable used for accumulation of the result.
- accuInit:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: The initial value of the accumulator.
- loopCondition:
- allOf:
- - $ref: '#/components/schemas/Expr'
description: |-
- An expression which can contain iter_var, iter_var2, and accu_var.
-
- Returns false when the result has been computed and may be used as
- a hint to short-circuit the remainder of the comprehension.
- loopStep:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: |-
- An expression which can contain iter_var, iter_var2, and accu_var.
-
- Computes the next value of accu_var.
- result:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: |-
- An expression which can contain accu_var.
-
- Computes the result.
+ Optional. String indicating the location of the expression for error
+ reporting, e.g. a file name and a position in the file.
description: |-
- A comprehension expression applied to a list or map.
-
- Comprehensions are not part of the core syntax, but enabled with macros.
- A macro matches a specific call signature within a parsed AST and replaces
- the call with an alternate AST block. Macro expansion happens at parse
- time.
-
- The following macros are supported within CEL:
-
- Aggregate type macros may be applied to all elements in a list or all keys
- in a map:
-
- * `all`, `exists`, `exists_one` - test a predicate expression against
- the inputs and return `true` if the predicate is satisfied for all,
- any, or only one value `list.all(x, x < 10)`.
- * `filter` - test a predicate expression against the inputs and return
- the subset of elements which satisfy the predicate:
- `payments.filter(p, p > 1000)`.
- * `map` - apply an expression to all elements in the input and return the
- output aggregate type: `[1, 2, 3].map(i, i * i)`.
+ Represents a textual expression in the Common Expression Language (CEL)
+ syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ are documented at https://github.com/google/cel-spec.
- The `has(m.x)` macro tests whether the property `x` is present in struct
- `m`. The semantics of this macro depend on the type of `m`. For proto2
- messages `has(m.x)` is defined as 'defined, but not set`. For proto3, the
- macro tests whether the property is set to its default. For map and struct
- types, the macro tests whether the property `x` is defined on `m`.
+ Example (Comparison):
- Comprehensions for the standard environment macros evaluation can be best
- visualized as the following pseudocode:
-
- ```
- let `accu_var` = `accu_init`
- for (let `iter_var` in `iter_range`) {
- if (!`loop_condition`) {
- break
- }
- `accu_var` = `loop_step`
- }
- return `result`
- ```
-
- Comprehensions for the optional V2 macros which support map-to-map
- translation differ slightly from the standard environment macros in that
- they expose both the key or index in addition to the value for each list
- or map entry:
-
- ```
- let `accu_var` = `accu_init`
- for (let `iter_var`, `iter_var2` in `iter_range`) {
- if (!`loop_condition`) {
- break
- }
- `accu_var` = `loop_step`
- }
- return `result`
- ```
- Expr_CreateList:
- type: object
- properties:
- elements:
- type: array
- items:
- $ref: '#/components/schemas/Expr'
- description: The elements part of the list.
- optionalIndices:
- type: array
- items:
- type: integer
- format: int32
- description: |-
- The indices within the elements list which are marked as optional
- elements.
+ title: "Summary size limit"
+ description: "Determines if a summary is less than 100 chars"
+ expression: "document.summary.size() < 100"
- When an optional-typed value is present, the value it contains
- is included in the list. If the optional-typed value is absent, the list
- element is omitted from the CreateList result.
- description: |-
- A list creation expression.
+ Example (Equality):
- Lists may either be homogenous, e.g. `[1, 2, 3]`, or heterogeneous, e.g.
- `dyn([1, 'hello', 2.0])`
- Expr_CreateStruct:
- type: object
- properties:
- messageName:
- type: string
- description: |-
- The type name of the message to be created, empty when creating map
- literals.
- entries:
- type: array
- items:
- $ref: '#/components/schemas/CreateStruct_Entry'
- description: The entries in the creation expression.
- description: |-
- A map or message creation expression.
+ title: "Requestor is owner"
+ description: "Determines if requestor is the document owner"
+ expression: "document.owner == request.auth.claims.email"
- Maps are constructed as `{'key_name': 'value'}`. Message construction is
- similar, but prefixed with a type name and composed of field ids:
- `types.MyType{field_id: 'value'}`.
- Expr_Ident:
- type: object
- properties:
- name:
- type: string
- description: |-
- Required. Holds a single, unqualified identifier, possibly preceded by a
- '.'.
+ Example (Logic):
- Qualified names are represented by the
- [Expr.Select][google.api.expr.v1alpha1.Expr.Select] expression.
- description: An identifier expression. e.g. `request`.
- Expr_Select:
- type: object
- properties:
- operand:
- allOf:
- - $ref: '#/components/schemas/Expr'
- description: |-
- Required. The target of the selection expression.
+ title: "Public documents"
+ description: "Determine whether the document should be publicly visible"
+ expression: "document.type != 'private' && document.type != 'internal'"
- For example, in the select expression `request.auth`, the `request`
- portion of the expression is the `operand`.
- field:
- type: string
- description: |-
- Required. The name of the field to select.
+ Example (Data Manipulation):
- For example, in the select expression `request.auth`, the `auth` portion
- of the expression would be the `field`.
- testOnly:
- type: boolean
- description: |-
- Whether the select is to be interpreted as a field presence test.
+ title: "Notification string"
+ description: "Create a notification string with a timestamp."
+ expression: "'New message received at ' + string(document.create_time)"
- This results from the macro `has(request.auth)`.
- description: A field selection expression. e.g. `request.auth`.
+ The exact variables and functions that may be referenced within an expression
+ are determined by the service that evaluates it. See the service
+ documentation for additional information.
ExtensionMetadata:
type: object
properties:
@@ -12654,59 +12347,6 @@ components:
description: The branding logo.
format: bytes
description: Custom branding resources for the Bytebase instance.
- Restriction:
- type: object
- properties:
- disallowSignup:
- readOnly: true
- type: boolean
- description: Whether self-service user signup is disabled.
- require2fa:
- readOnly: true
- type: boolean
- description: Whether two-factor authentication is required for all users.
- disallowPasswordSignin:
- readOnly: true
- type: boolean
- description: Whether password-based signin is disabled (except for workspace admins).
- passwordRestriction:
- readOnly: true
- allOf:
- - $ref: '#/components/schemas/WorkspaceProfileSetting_PasswordRestriction'
- description: Password complexity and restriction requirements.
- watermark:
- readOnly: true
- type: boolean
- description: Whether to display watermark on pages.
- databaseChangeMode:
- readOnly: true
- enum:
- - DATABASE_CHANGE_MODE_UNSPECIFIED
- - PIPELINE
- - EDITOR
- type: string
- description: The workspace database change mode.
- format: enum
- inactiveSessionTimeout:
- readOnly: true
- pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
- type: string
- description: The session expiration time if not activity detected for the user. Value <= 0 means no limit.
- domains:
- readOnly: true
- type: array
- items:
- type: string
- description: The workspace domain, e.g., bytebase.com.
- enforceIdentityDomain:
- readOnly: true
- type: boolean
- description: Only user and group from the domains can be created and login.
- maximumRoleExpiration:
- readOnly: true
- pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
- type: string
- description: The max duration for role expired.
Result_SqlReviewReport:
type: object
properties:
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index d7f6fe95d2..c94da3f6cf 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -23,89 +23,6 @@
- [VCSType](#bytebase-v1-VCSType)
- [WebhookType](#bytebase-v1-WebhookType)
-- [v1/issue_service.proto](#v1_issue_service-proto)
- - [ApprovalFlow](#bytebase-v1-ApprovalFlow)
- - [ApprovalTemplate](#bytebase-v1-ApprovalTemplate)
- - [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest)
- - [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest)
- - [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse)
- - [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest)
- - [CreateIssueRequest](#bytebase-v1-CreateIssueRequest)
- - [GetIssueRequest](#bytebase-v1-GetIssueRequest)
- - [GrantRequest](#bytebase-v1-GrantRequest)
- - [Issue](#bytebase-v1-Issue)
- - [Issue.Approver](#bytebase-v1-Issue-Approver)
- - [IssueComment](#bytebase-v1-IssueComment)
- - [IssueComment.Approval](#bytebase-v1-IssueComment-Approval)
- - [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate)
- - [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate)
- - [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest)
- - [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse)
- - [ListIssuesRequest](#bytebase-v1-ListIssuesRequest)
- - [ListIssuesResponse](#bytebase-v1-ListIssuesResponse)
- - [RejectIssueRequest](#bytebase-v1-RejectIssueRequest)
- - [RequestIssueRequest](#bytebase-v1-RequestIssueRequest)
- - [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest)
- - [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse)
- - [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest)
- - [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest)
-
- - [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus)
- - [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status)
- - [Issue.Type](#bytebase-v1-Issue-Type)
- - [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status)
- - [IssueStatus](#bytebase-v1-IssueStatus)
-
- - [IssueService](#bytebase-v1-IssueService)
-
-- [v1/setting_service.proto](#v1_setting_service-proto)
- - [AISetting](#bytebase-v1-AISetting)
- - [Algorithm](#bytebase-v1-Algorithm)
- - [Algorithm.FullMask](#bytebase-v1-Algorithm-FullMask)
- - [Algorithm.InnerOuterMask](#bytebase-v1-Algorithm-InnerOuterMask)
- - [Algorithm.MD5Mask](#bytebase-v1-Algorithm-MD5Mask)
- - [Algorithm.RangeMask](#bytebase-v1-Algorithm-RangeMask)
- - [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice)
- - [Announcement](#bytebase-v1-Announcement)
- - [AppIMSetting](#bytebase-v1-AppIMSetting)
- - [AppIMSetting.DingTalk](#bytebase-v1-AppIMSetting-DingTalk)
- - [AppIMSetting.Feishu](#bytebase-v1-AppIMSetting-Feishu)
- - [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting)
- - [AppIMSetting.Lark](#bytebase-v1-AppIMSetting-Lark)
- - [AppIMSetting.Slack](#bytebase-v1-AppIMSetting-Slack)
- - [AppIMSetting.Teams](#bytebase-v1-AppIMSetting-Teams)
- - [AppIMSetting.Wecom](#bytebase-v1-AppIMSetting-Wecom)
- - [DataClassificationSetting](#bytebase-v1-DataClassificationSetting)
- - [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig)
- - [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry)
- - [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification)
- - [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level)
- - [EnvironmentSetting](#bytebase-v1-EnvironmentSetting)
- - [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment)
- - [EnvironmentSetting.Environment.TagsEntry](#bytebase-v1-EnvironmentSetting-Environment-TagsEntry)
- - [GetSettingRequest](#bytebase-v1-GetSettingRequest)
- - [GetSettingResponse](#bytebase-v1-GetSettingResponse)
- - [ListSettingsRequest](#bytebase-v1-ListSettingsRequest)
- - [ListSettingsResponse](#bytebase-v1-ListSettingsResponse)
- - [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting)
- - [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType)
- - [Setting](#bytebase-v1-Setting)
- - [SettingValue](#bytebase-v1-SettingValue)
- - [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest)
- - [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting)
- - [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule)
- - [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting)
- - [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction)
-
- - [AISetting.Provider](#bytebase-v1-AISetting-Provider)
- - [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType)
- - [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel)
- - [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode)
- - [Setting.SettingName](#bytebase-v1-Setting-SettingName)
- - [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source)
-
- - [SettingService](#bytebase-v1-SettingService)
-
- [v1/user_service.proto](#v1_user_service-proto)
- [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest)
- [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse)
@@ -133,7 +50,6 @@
- [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest)
- [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest)
- [ResourcePackage](#bytebase-v1-ResourcePackage)
- - [Restriction](#bytebase-v1-Restriction)
- [SetupSampleRequest](#bytebase-v1-SetupSampleRequest)
- [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest)
@@ -381,6 +297,41 @@
- [IdentityProviderService](#bytebase-v1-IdentityProviderService)
+- [v1/issue_service.proto](#v1_issue_service-proto)
+ - [ApprovalFlow](#bytebase-v1-ApprovalFlow)
+ - [ApprovalTemplate](#bytebase-v1-ApprovalTemplate)
+ - [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest)
+ - [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest)
+ - [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse)
+ - [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest)
+ - [CreateIssueRequest](#bytebase-v1-CreateIssueRequest)
+ - [GetIssueRequest](#bytebase-v1-GetIssueRequest)
+ - [GrantRequest](#bytebase-v1-GrantRequest)
+ - [Issue](#bytebase-v1-Issue)
+ - [Issue.Approver](#bytebase-v1-Issue-Approver)
+ - [IssueComment](#bytebase-v1-IssueComment)
+ - [IssueComment.Approval](#bytebase-v1-IssueComment-Approval)
+ - [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate)
+ - [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate)
+ - [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest)
+ - [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse)
+ - [ListIssuesRequest](#bytebase-v1-ListIssuesRequest)
+ - [ListIssuesResponse](#bytebase-v1-ListIssuesResponse)
+ - [RejectIssueRequest](#bytebase-v1-RejectIssueRequest)
+ - [RequestIssueRequest](#bytebase-v1-RequestIssueRequest)
+ - [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest)
+ - [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse)
+ - [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest)
+ - [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest)
+
+ - [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus)
+ - [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status)
+ - [Issue.Type](#bytebase-v1-Issue-Type)
+ - [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status)
+ - [IssueStatus](#bytebase-v1-IssueStatus)
+
+ - [IssueService](#bytebase-v1-IssueService)
+
- [v1/org_policy_service.proto](#v1_org_policy_service-proto)
- [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest)
- [DataSourceQueryPolicy](#bytebase-v1-DataSourceQueryPolicy)
@@ -624,6 +575,54 @@
- [RolloutService](#bytebase-v1-RolloutService)
+- [v1/setting_service.proto](#v1_setting_service-proto)
+ - [AISetting](#bytebase-v1-AISetting)
+ - [Algorithm](#bytebase-v1-Algorithm)
+ - [Algorithm.FullMask](#bytebase-v1-Algorithm-FullMask)
+ - [Algorithm.InnerOuterMask](#bytebase-v1-Algorithm-InnerOuterMask)
+ - [Algorithm.MD5Mask](#bytebase-v1-Algorithm-MD5Mask)
+ - [Algorithm.RangeMask](#bytebase-v1-Algorithm-RangeMask)
+ - [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice)
+ - [Announcement](#bytebase-v1-Announcement)
+ - [AppIMSetting](#bytebase-v1-AppIMSetting)
+ - [AppIMSetting.DingTalk](#bytebase-v1-AppIMSetting-DingTalk)
+ - [AppIMSetting.Feishu](#bytebase-v1-AppIMSetting-Feishu)
+ - [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting)
+ - [AppIMSetting.Lark](#bytebase-v1-AppIMSetting-Lark)
+ - [AppIMSetting.Slack](#bytebase-v1-AppIMSetting-Slack)
+ - [AppIMSetting.Teams](#bytebase-v1-AppIMSetting-Teams)
+ - [AppIMSetting.Wecom](#bytebase-v1-AppIMSetting-Wecom)
+ - [DataClassificationSetting](#bytebase-v1-DataClassificationSetting)
+ - [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig)
+ - [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry)
+ - [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification)
+ - [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level)
+ - [EnvironmentSetting](#bytebase-v1-EnvironmentSetting)
+ - [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment)
+ - [EnvironmentSetting.Environment.TagsEntry](#bytebase-v1-EnvironmentSetting-Environment-TagsEntry)
+ - [GetSettingRequest](#bytebase-v1-GetSettingRequest)
+ - [GetSettingResponse](#bytebase-v1-GetSettingResponse)
+ - [ListSettingsRequest](#bytebase-v1-ListSettingsRequest)
+ - [ListSettingsResponse](#bytebase-v1-ListSettingsResponse)
+ - [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting)
+ - [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType)
+ - [Setting](#bytebase-v1-Setting)
+ - [SettingValue](#bytebase-v1-SettingValue)
+ - [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest)
+ - [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting)
+ - [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule)
+ - [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting)
+ - [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction)
+
+ - [AISetting.Provider](#bytebase-v1-AISetting-Provider)
+ - [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType)
+ - [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel)
+ - [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode)
+ - [Setting.SettingName](#bytebase-v1-Setting-SettingName)
+ - [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source)
+
+ - [SettingService](#bytebase-v1-SettingService)
+
- [v1/sheet_service.proto](#v1_sheet_service-proto)
- [BatchCreateSheetsRequest](#bytebase-v1-BatchCreateSheetsRequest)
- [BatchCreateSheetsResponse](#bytebase-v1-BatchCreateSheetsResponse)
@@ -902,1295 +901,1245 @@ Webhook integration type.
-<a name="v1_issue_service-proto"></a>
+<a name="v1_user_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/issue_service.proto
+## v1/user_service.proto
-<a name="bytebase-v1-ApprovalFlow"></a>
+<a name="bytebase-v1-BatchGetUsersRequest"></a>
-### ApprovalFlow
+### BatchGetUsersRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [string](#string) | repeated | The roles required for approval in order. |
+| names | [string](#string) | repeated | The user names to retrieve. Format: users/{email} |
-<a name="bytebase-v1-ApprovalTemplate"></a>
+<a name="bytebase-v1-BatchGetUsersResponse"></a>
-### ApprovalTemplate
+### BatchGetUsersResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| flow | [ApprovalFlow](#bytebase-v1-ApprovalFlow) | | The approval flow definition. |
-| title | [string](#string) | | The title of the approval template. |
-| description | [string](#string) | | The description of the approval template. |
+| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
-<a name="bytebase-v1-ApproveIssueRequest"></a>
+<a name="bytebase-v1-CreateUserRequest"></a>
-### ApproveIssueRequest
+### CreateUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to add an approver. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the approval decision. |
+| user | [User](#bytebase-v1-User) | | The user to create. |
-<a name="bytebase-v1-BatchUpdateIssuesStatusRequest"></a>
+<a name="bytebase-v1-DeleteUserRequest"></a>
-### BatchUpdateIssuesStatusRequest
+### DeleteUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all issues being updated. Format: projects/{project} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the status of databases for now. |
-| issues | [string](#string) | repeated | The list of issues to update. Format: projects/{project}/issues/{issue} |
-| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The new status. |
-| reason | [string](#string) | | The reason for the status change. |
+| name | [string](#string) | | The name of the user to delete. Format: users/{email} |
-<a name="bytebase-v1-BatchUpdateIssuesStatusResponse"></a>
+<a name="bytebase-v1-GetUserRequest"></a>
-### BatchUpdateIssuesStatusResponse
+### GetUserRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the user to retrieve. Format: users/{email} |
-<a name="bytebase-v1-CreateIssueCommentRequest"></a>
-### CreateIssueCommentRequest
+
+<a name="bytebase-v1-ListUsersRequest"></a>
+
+### ListUsersRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to create. |
+| page_size | [int32](#int32) | | The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 10 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListUsers` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted users if specified. |
+| filter | [string](#string) | | Filter is used to filter users returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator. - user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - state: check State enum for values, support &#34;==&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+For example: name == &#34;ed&#34; name.matches(&#34;ed&#34;) email == &#34;[email protected]&#34; email.matches(&#34;ed&#34;) user_type == &#34;SERVICE_ACCOUNT&#34; user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;] !(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]) state == &#34;DELETED&#34; project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; (name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; |
-<a name="bytebase-v1-CreateIssueRequest"></a>
-### CreateIssueRequest
+
+
+<a name="bytebase-v1-ListUsersResponse"></a>
+
+### ListUsersResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
-| issue | [Issue](#bytebase-v1-Issue) | | The issue to create. |
+| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-GetIssueRequest"></a>
+<a name="bytebase-v1-UndeleteUserRequest"></a>
-### GetIssueRequest
+### UndeleteUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to retrieve. Format: projects/{project}/issues/{issue} |
-| force | [bool](#bool) | | If set to true, bypass cache and fetch the latest data. |
+| name | [string](#string) | | The name of the deleted user. Format: users/{email} |
-<a name="bytebase-v1-GrantRequest"></a>
+<a name="bytebase-v1-UpdateEmailRequest"></a>
-### GrantRequest
+### UpdateEmailRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [string](#string) | | The requested role. Format: roles/EXPORTER. |
-| user | [string](#string) | | The user to be granted. Format: users/{email}. |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition for the role. Same as the condition in IAM Binding message. |
-| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for which the grant is valid. |
+| name | [string](#string) | | The name of the user whose email to update. Format: users/{email} Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. |
+| email | [string](#string) | | The new email address. |
-<a name="bytebase-v1-Issue"></a>
+<a name="bytebase-v1-UpdateUserRequest"></a>
-### Issue
+### UpdateUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue. Format: projects/{project}/issues/{issue} |
-| title | [string](#string) | | The title of the issue. |
-| description | [string](#string) | | The description of the issue. |
-| type | [Issue.Type](#bytebase-v1-Issue-Type) | | |
-| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The status of the issue. |
-| approvers | [Issue.Approver](#bytebase-v1-Issue-Approver) | repeated | |
-| approval_template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | The approval template for the issue. |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| plan | [string](#string) | | The plan associated with the issue. Can be empty. Format: projects/{project}/plans/{plan} |
-| grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. |
-| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. |
-| approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | |
+| user | [User](#bytebase-v1-User) | | The user to update.
+
+The user&#39;s `name` field is used to identify the user to update. Format: users/{email} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
+| regenerate_temp_mfa_secret | [bool](#bool) | | The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user. This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. |
+| regenerate_recovery_codes | [bool](#bool) | | The regenerate_recovery_codes flag means to regenerate recovery codes for user. |
+| allow_missing | [bool](#bool) | | If set to true, and the user is not found, a new user will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-Issue-Approver"></a>
+<a name="bytebase-v1-User"></a>
+
+### User
-### Issue.Approver
-Approvers and their approval status for the issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status) | | The new status. |
-| principal | [string](#string) | | Format: users/[email protected] |
+| name | [string](#string) | | The name of the user. Format: users/{email} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |
+| email | [string](#string) | | The email address of the user, used for login and notifications. |
+| title | [string](#string) | | The display title or full name of the user. |
+| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |
+| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |
+| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. |
+| mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. |
+| temp_otp_secret | [string](#string) | | Temporary OTP secret used during MFA setup and regeneration. |
+| temp_recovery_codes | [string](#string) | repeated | Temporary recovery codes used during MFA setup and regeneration. |
+| temp_otp_secret_created_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. |
+| phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |
+| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. |
+| groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |
+| workload_identity_config | [WorkloadIdentityConfig](#bytebase-v1-WorkloadIdentityConfig) | | Workload Identity configuration (only for WORKLOAD_IDENTITY type) |
-<a name="bytebase-v1-IssueComment"></a>
+<a name="bytebase-v1-User-Profile"></a>
+
+### User.Profile
-### IssueComment
-A comment on an issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} |
-| comment | [string](#string) | | The text content of the comment. |
-| payload | [string](#string) | | TODO: use struct message instead. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| creator | [string](#string) | | Format: users/{email} |
-| approval | [IssueComment.Approval](#bytebase-v1-IssueComment-Approval) | | Approval event. |
-| issue_update | [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate) | | Issue update event. |
-| plan_spec_update | [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate) | | Plan spec update event. |
+| last_login_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the user successfully logged in. |
+| last_change_password_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the user changed their password. |
+| source | [string](#string) | | source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. |
-<a name="bytebase-v1-IssueComment-Approval"></a>
+<a name="bytebase-v1-WorkloadIdentityConfig"></a>
-### IssueComment.Approval
-Approval event information.
+### WorkloadIdentityConfig
+WorkloadIdentityConfig for API layer
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |
-
-
-
-
-
-
-<a name="bytebase-v1-IssueComment-IssueUpdate"></a>
+| provider_type | [WorkloadIdentityConfig.ProviderType](#bytebase-v1-WorkloadIdentityConfig-ProviderType) | | Platform type (currently only GITHUB is supported) |
+| issuer_url | [string](#string) | | OIDC Issuer URL (auto-filled based on provider_type, can be overridden) |
+| allowed_audiences | [string](#string) | repeated | Allowed audiences for token validation |
+| subject_pattern | [string](#string) | | Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) |
-### IssueComment.IssueUpdate
-Issue update event information.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| from_title | [string](#string) | optional | |
-| to_title | [string](#string) | optional | |
-| from_description | [string](#string) | optional | |
-| to_description | [string](#string) | optional | |
-| from_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
-| to_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
-| from_labels | [string](#string) | repeated | |
-| to_labels | [string](#string) | repeated | |
+
+<a name="bytebase-v1-UserType"></a>
+### UserType
-<a name="bytebase-v1-IssueComment-PlanSpecUpdate"></a>
-### IssueComment.PlanSpecUpdate
-Plan spec update event information (tracks sheet changes to plan specs).
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| USER_TYPE_UNSPECIFIED | 0 | Unspecified user type. |
+| USER | 1 | Regular human user account. |
+| SYSTEM_BOT | 2 | System-managed bot account for automated operations. |
+| SERVICE_ACCOUNT | 3 | Service account for API integrations. |
+| WORKLOAD_IDENTITY | 4 | External CI/CD workload identity. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| spec | [string](#string) | | The spec that was updated. Format: projects/{project}/plans/{plan}/specs/{spec} |
-| from_sheet | [string](#string) | optional | The previous sheet. Format: projects/{project}/sheets/{sheet} |
-| to_sheet | [string](#string) | optional | The new sheet. Format: projects/{project}/sheets/{sheet} |
+<a name="bytebase-v1-WorkloadIdentityConfig-ProviderType"></a>
+### WorkloadIdentityConfig.ProviderType
+ProviderType identifies the CI/CD platform.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PROVIDER_TYPE_UNSPECIFIED | 0 | |
+| GITHUB | 1 | |
+| GITLAB | 2 | |
+
-<a name="bytebase-v1-ListIssueCommentsRequest"></a>
+
-### ListIssueCommentsRequest
+<a name="bytebase-v1-UserService"></a>
+### UserService
+UserService manages user accounts and authentication.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{projects}/issues/{issue} |
-| page_size | [int32](#int32) | | The maximum number of issue comments to return. The service may return fewer than this value. If unspecified, at most 10 issue comments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListIssueComments` call. Provide this to retrieve the subsequent page.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetUser | [GetUserRequest](#bytebase-v1-GetUserRequest) | [User](#bytebase-v1-User) | Get the user. Any authenticated user can get the user. Permissions required: bb.users.get |
+| BatchGetUsers | [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest) | [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse) | Get the users in batch. Any authenticated user can batch get users. Permissions required: bb.users.get |
+| GetCurrentUser | [.google.protobuf.Empty](#google-protobuf-Empty) | [User](#bytebase-v1-User) | Get the current authenticated user. Permissions required: None |
+| ListUsers | [ListUsersRequest](#bytebase-v1-ListUsersRequest) | [ListUsersResponse](#bytebase-v1-ListUsersResponse) | List all users. Any authenticated user can list users. Permissions required: bb.users.list |
+| CreateUser | [CreateUserRequest](#bytebase-v1-CreateUserRequest) | [User](#bytebase-v1-User) | Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up. Permissions required: bb.users.create (only when Disallow Signup is enabled) |
+| UpdateUser | [UpdateUserRequest](#bytebase-v1-UpdateUserRequest) | [User](#bytebase-v1-User) | Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user. Note: Email updates are not supported through this API. Use UpdateEmail instead. Permissions required: bb.users.update (or self) |
+| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |
+| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |
+| UpdateEmail | [UpdateEmailRequest](#bytebase-v1-UpdateEmailRequest) | [User](#bytebase-v1-User) | Updates a user&#39;s email address. Permissions required: bb.users.updateEmail |
-When paginating, all other parameters provided to `ListIssueComments` must match the call that provided the page token. |
+
+<a name="v1_actuator_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/actuator_service.proto
-<a name="bytebase-v1-ListIssueCommentsResponse"></a>
-### ListIssueCommentsResponse
+<a name="bytebase-v1-ActuatorInfo"></a>
+### ActuatorInfo
+System information and configuration for the Bytebase instance.
+Actuator concept is similar to the Spring Boot Actuator.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | The issue comments from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
+| version | [string](#string) | | The Bytebase server version. |
+| git_commit | [string](#string) | | The git commit hash of the build. |
+| readonly | [bool](#bool) | | Whether the Bytebase instance is running in read-only mode. |
+| saas | [bool](#bool) | | Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. |
+| demo | [bool](#bool) | | Whether the Bytebase instance is running in demo mode. |
+| host | [string](#string) | | The host address of the Bytebase instance. |
+| port | [string](#string) | | The port number of the Bytebase instance. |
+| external_url | [string](#string) | | The external URL where users or webhook callbacks access Bytebase. |
+| need_admin_setup | [bool](#bool) | | Whether the Bytebase instance requires initial admin setup. |
+| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |
+| workspace_id | [string](#string) | | The unique identifier for the workspace. |
+| debug | [bool](#bool) | | Whether debug mode is enabled. |
+| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |
+| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |
+| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |
+| activated_instance_count | [int32](#int32) | | The number of activated database instances. |
+| total_instance_count | [int32](#int32) | | The total number of database instances. |
+| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |
+| external_url_from_flag | [bool](#bool) | | Whether the external URL is set via command-line flag (and thus cannot be changed via UI). |
-<a name="bytebase-v1-ListIssuesRequest"></a>
-### ListIssuesRequest
+<a name="bytebase-v1-ActuatorInfo-StatUser"></a>
+### ActuatorInfo.StatUser
+User statistics by type and state.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
-| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListIssues` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListIssues` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter issues returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values. - create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values. - labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator. - approval_status: issue approval status, support &#34;==&#34; operator. - current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
-
-For example: creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;] status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34; labels in [&#34;label1&#34;, &#34;label2&#34;] create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; |
-| query | [string](#string) | | Query is the query statement. |
+| user_type | [UserType](#bytebase-v1-UserType) | | The type of user. |
+| state | [State](#bytebase-v1-State) | | The state of the user. |
+| count | [int32](#int32) | | The count of users matching this type and state. |
-<a name="bytebase-v1-ListIssuesResponse"></a>
+<a name="bytebase-v1-DeleteCacheRequest"></a>
-### ListIssuesResponse
+### DeleteCacheRequest
+Request message for deleting cache.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+<a name="bytebase-v1-GetActuatorInfoRequest"></a>
+### GetActuatorInfoRequest
+Request message for getting actuator information.
-<a name="bytebase-v1-RejectIssueRequest"></a>
-### RejectIssueRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to add a rejection. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the rejection decision. |
+<a name="bytebase-v1-GetResourcePackageRequest"></a>
+### GetResourcePackageRequest
+Request message for getting branding resources.
-<a name="bytebase-v1-RequestIssueRequest"></a>
-### RequestIssueRequest
+<a name="bytebase-v1-ResourcePackage"></a>
+### ResourcePackage
+Custom branding resources for the Bytebase instance.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to request a issue. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the request. |
-
-
-
-
-
+| logo | [bytes](#bytes) | | The branding logo. |
-<a name="bytebase-v1-SearchIssuesRequest"></a>
-### SearchIssuesRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} Use &#34;projects/-&#34; to list all issues from all projects. |
-| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchIssues` call. Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided to `SearchIssues` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter issues returned in the list. Check the filter field in the ListIssuesRequest message. |
-| query | [string](#string) | | Query is the query statement. |
+<a name="bytebase-v1-SetupSampleRequest"></a>
+### SetupSampleRequest
+Request message for setting up sample data.
-<a name="bytebase-v1-SearchIssuesResponse"></a>
-### SearchIssuesResponse
+<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>
+### UpdateActuatorInfoRequest
+Request message for updating actuator information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| actuator | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | | The actuator to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the actuator is not found, a new actuator will be created. In this situation, `update_mask` is ignored. |
+
-<a name="bytebase-v1-UpdateIssueCommentRequest"></a>
+
-### UpdateIssueCommentRequest
+
+<a name="bytebase-v1-ActuatorService"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, `update_mask` is ignored. |
+### ActuatorService
+ActuatorService manages system health and operational information.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetActuatorInfo | [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Gets system information and health status of the Bytebase instance. Permissions required: None |
+| UpdateActuatorInfo | [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Updates system configuration settings for the Bytebase instance. Permissions required: bb.settings.set |
+| SetupSample | [SetupSampleRequest](#bytebase-v1-SetupSampleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Sets up sample data for demonstration and testing purposes. Permissions required: bb.projects.create |
+| DeleteCache | [DeleteCacheRequest](#bytebase-v1-DeleteCacheRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Clears the system cache to force data refresh. Permissions required: None |
+| GetResourcePackage | [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest) | [ResourcePackage](#bytebase-v1-ResourcePackage) | Gets custom branding resources such as logos. Permissions required: None |
+
+
+<a name="v1_iam_policy-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/iam_policy.proto
-<a name="bytebase-v1-UpdateIssueRequest"></a>
-### UpdateIssueRequest
+<a name="bytebase-v1-Binding"></a>
+### Binding
+Binding associates members with a role and optional conditions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issue | [Issue](#bytebase-v1-Issue) | | The issue to update.
-
-The issue&#39;s `name` field is used to identify the issue to update. Format: projects/{project}/issues/{issue} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the issue is not found, a new issue will be created. In this situation, `update_mask` is ignored. |
-
+| role | [string](#string) | | The role that is assigned to the members. Format: roles/{role} |
+| members | [string](#string) | repeated | Specifies the principals requesting access for a Bytebase resource. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this binding, only used in the project IAM policy. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Support variables: resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
+For example: resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;] resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;] request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) |
+| parsed_expr | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | | The parsed expression of the condition. |
-
-<a name="bytebase-v1-Issue-ApprovalStatus"></a>
-### Issue.ApprovalStatus
-The overall approval status for the issue.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| APPROVAL_STATUS_UNSPECIFIED | 0 | Unspecified approval status. |
-| CHECKING | 1 | Approval checks are being evaluated. |
-| PENDING | 2 | Approval is pending. |
-| APPROVED | 3 | Issue has been approved. |
-| REJECTED | 4 | Issue has been rejected. |
-| SKIPPED | 5 | Approval was skipped. |
+<a name="bytebase-v1-BindingDelta"></a>
+### BindingDelta
+A single change to a binding.
-<a name="bytebase-v1-Issue-Approver-Status"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| action | [BindingDelta.Action](#bytebase-v1-BindingDelta-Action) | | The action that was performed on a Binding. |
+| role | [string](#string) | | Role that is assigned to `members`. For example, `roles/projectOwner`. |
+| member | [string](#string) | | Follows the same format of Binding.members. |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this binding. |
-### Issue.Approver.Status
-The approval status of an approver.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Awaiting approval. |
-| APPROVED | 2 | Approved. |
-| REJECTED | 3 | Rejected. |
-<a name="bytebase-v1-Issue-Type"></a>
-### Issue.Type
-The type of issue.
+<a name="bytebase-v1-GetIamPolicyRequest"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified issue type. |
-| DATABASE_CHANGE | 1 | Database schema or data change. |
-| GRANT_REQUEST | 2 | Database access grant request. |
-| DATABASE_EXPORT | 3 | Database data export request. |
+### GetIamPolicyRequest
+Request message for getting an IAM policy.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| resource | [string](#string) | | The name of the resource to get the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
-<a name="bytebase-v1-IssueComment-Approval-Status"></a>
-### IssueComment.Approval.Status
-Approval status values.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Approval pending. |
-| APPROVED | 2 | Approved. |
-| REJECTED | 3 | Rejected. |
-<a name="bytebase-v1-IssueStatus"></a>
+<a name="bytebase-v1-IamPolicy"></a>
-### IssueStatus
-The status of an issue.
+### IamPolicy
+IAM policy that binds members to roles.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| ISSUE_STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| OPEN | 1 | Issue is open and active. |
-| DONE | 2 | Issue is completed. |
-| CANCELED | 3 | Issue is canceled. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| bindings | [Binding](#bytebase-v1-Binding) | repeated | Collection of binding. A binding binds one or more project members to a single project role. |
+| etag | [string](#string) | | The current etag of the policy. If an etag is provided and does not match the current etag of the policy, the call will be blocked and an ABORTED error will be returned. |
-
-
-<a name="bytebase-v1-IssueService"></a>
-### IssueService
-IssueService manages issues for tracking database changes and tasks.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetIssue | [GetIssueRequest](#bytebase-v1-GetIssueRequest) | [Issue](#bytebase-v1-Issue) | Retrieves an issue by name. Permissions required: bb.issues.get |
-| CreateIssue | [CreateIssueRequest](#bytebase-v1-CreateIssueRequest) | [Issue](#bytebase-v1-Issue) | Creates a new issue for database changes or tasks. Permissions required: bb.issues.create |
-| ListIssues | [ListIssuesRequest](#bytebase-v1-ListIssuesRequest) | [ListIssuesResponse](#bytebase-v1-ListIssuesResponse) | Lists issues in a project. Permissions required: bb.issues.list |
-| SearchIssues | [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest) | [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse) | Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query. Permissions required: bb.issues.get |
-| UpdateIssue | [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest) | [Issue](#bytebase-v1-Issue) | Updates an issue&#39;s properties such as title, description, or labels. Permissions required: bb.issues.update |
-| ListIssueComments | [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest) | [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse) | Lists comments on an issue. Permissions required: bb.issueComments.list |
-| CreateIssueComment | [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Adds a comment to an issue. Permissions required: bb.issueComments.create |
-| UpdateIssueComment | [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Updates an existing issue comment. Permissions required: bb.issueComments.update |
-| BatchUpdateIssuesStatus | [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest) | [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse) | Updates the status of multiple issues in a single operation. Permissions required: bb.issues.update |
-| ApproveIssue | [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest) | [Issue](#bytebase-v1-Issue) | Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
-| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
-| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
+<a name="bytebase-v1-PolicyDelta"></a>
-
+### PolicyDelta
+Describes changes between two IAM policies.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| binding_deltas | [BindingDelta](#bytebase-v1-BindingDelta) | repeated | The delta for Bindings between two policies. |
-<a name="v1_setting_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/setting_service.proto
-<a name="bytebase-v1-AISetting"></a>
-### AISetting
+<a name="bytebase-v1-SetIamPolicyRequest"></a>
+### SetIamPolicyRequest
+Request message for setting an IAM policy.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| enabled | [bool](#bool) | | |
-| provider | [AISetting.Provider](#bytebase-v1-AISetting-Provider) | | |
-| endpoint | [string](#string) | | |
-| api_key | [string](#string) | | |
-| model | [string](#string) | | |
-| version | [string](#string) | | |
+| resource | [string](#string) | | The name of the resource to set the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
+| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | |
+| etag | [string](#string) | | The current etag of the policy. |
+
+
-<a name="bytebase-v1-Algorithm"></a>
+<a name="bytebase-v1-BindingDelta-Action"></a>
-### Algorithm
+### BindingDelta.Action
+Type of action performed on a binding.
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ACTION_UNSPECIFIED | 0 | Unspecified action. |
+| ADD | 1 | Add a binding. |
+| REMOVE | 2 | Remove a binding. |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| full_mask | [Algorithm.FullMask](#bytebase-v1-Algorithm-FullMask) | | |
-| range_mask | [Algorithm.RangeMask](#bytebase-v1-Algorithm-RangeMask) | | |
-| md5_mask | [Algorithm.MD5Mask](#bytebase-v1-Algorithm-MD5Mask) | | |
-| inner_outer_mask | [Algorithm.InnerOuterMask](#bytebase-v1-Algorithm-InnerOuterMask) | | |
+
+
+
+<a name="v1_audit_log_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/audit_log_service.proto
-<a name="bytebase-v1-Algorithm-FullMask"></a>
-### Algorithm.FullMask
+<a name="bytebase-v1-AuditData"></a>
+### AuditData
+Additional audit data specific to certain operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| substitution | [string](#string) | | substitution is the string used to replace the original value, the max length of the string is 16 bytes. |
-
+| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |
-<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>
-### Algorithm.InnerOuterMask
+<a name="bytebase-v1-AuditLog"></a>
+### AuditLog
+Audit log entry recording system activity or API call.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| prefix_len | [int32](#int32) | | |
-| suffix_len | [int32](#int32) | | |
-| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |
-| substitution | [string](#string) | | |
-
+| name | [string](#string) | | The name of the log. Formats: - projects/{project}/auditLogs/{uid} - workspaces/{workspace}/auditLogs/{uid} |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The timestamp when the audit log was created. |
+| user | [string](#string) | | The user who performed the action. Format: users/{email} |
+| method | [string](#string) | | The method or action being audited. For example: /bytebase.v1.SQLService/Query or bb.project.repository.push |
+| severity | [AuditLog.Severity](#bytebase-v1-AuditLog-Severity) | | The severity level of this audit log entry. |
+| resource | [string](#string) | | The resource associated with this audit log. |
+| request | [string](#string) | | The request payload in JSON format. |
+| response | [string](#string) | | The response payload in JSON format. Some fields may be omitted if they are too large or contain sensitive information. |
+| status | [google.rpc.Status](#google-rpc-Status) | | The status of the operation. |
+| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration of the operation. |
+| service_data | [google.protobuf.Any](#google-protobuf-Any) | | Service-specific metadata about the request, response, and activities. |
+| request_metadata | [RequestMetadata](#bytebase-v1-RequestMetadata) | | Metadata about the request context. |
-<a name="bytebase-v1-Algorithm-MD5Mask"></a>
-### Algorithm.MD5Mask
+<a name="bytebase-v1-ExportAuditLogsRequest"></a>
+### ExportAuditLogsRequest
+Request message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |
-
+| parent | [string](#string) | | |
+| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. Check the filter field in the SearchAuditLogsRequest message. |
+| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
+| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The export format. |
+| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
+| page_token | [string](#string) | | A page token, received from a previous `ExportAuditLogs` call. Provide this to retrieve the subsequent page. |
-<a name="bytebase-v1-Algorithm-RangeMask"></a>
-### Algorithm.RangeMask
+<a name="bytebase-v1-ExportAuditLogsResponse"></a>
+### ExportAuditLogsResponse
+Response message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| slices | [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice) | repeated | We store it as a repeated field to face the fact that the original value may have multiple parts should be masked. But frontend can be started with a single rule easily. |
-
+| content | [bytes](#bytes) | | The exported audit log content in the requested format. |
+| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
-<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>
-### Algorithm.RangeMask.Slice
+<a name="bytebase-v1-RequestMetadata"></a>
+### RequestMetadata
+Metadata about the incoming request.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start | [int32](#int32) | | start is the start character index (0-based) of the original value, should be less than end. Uses character indices (not byte offsets) for display-oriented masking. Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). |
-| end | [int32](#int32) | | end is the end character index (exclusive) of the original value. Uses character indices (not byte offsets) for display-oriented masking. |
-| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |
-
+| caller_ip | [string](#string) | | The IP address of the request originator. |
+| caller_supplied_user_agent | [string](#string) | | The user agent string provided by the caller. This is supplied by the client and is not authenticated. |
-<a name="bytebase-v1-Announcement"></a>
-### Announcement
+<a name="bytebase-v1-SearchAuditLogsRequest"></a>
+### SearchAuditLogsRequest
+Request message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel) | | The alert level of announcement |
-| text | [string](#string) | | The text of announcement |
-| link | [string](#string) | | The optional link, user can follow the link to check extra details |
+| parent | [string](#string) | | |
+| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator. - severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values. - user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator. - create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
+For example: - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; |
+| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
+| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchLogs` call. Provide this to retrieve the subsequent page. |
-<a name="bytebase-v1-AppIMSetting"></a>
-### AppIMSetting
+<a name="bytebase-v1-SearchAuditLogsResponse"></a>
+
+### SearchAuditLogsResponse
+Response message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |
-
-
+| audit_logs | [AuditLog](#bytebase-v1-AuditLog) | repeated | |
+| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
-<a name="bytebase-v1-AppIMSetting-DingTalk"></a>
-### AppIMSetting.DingTalk
+
+<a name="bytebase-v1-AuditLog-Severity"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| client_id | [string](#string) | | |
-| client_secret | [string](#string) | | |
-| robot_code | [string](#string) | | |
+### AuditLog.Severity
+Severity level for audit log entries.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SEVERITY_UNSPECIFIED | 0 | Unspecified severity level. |
+| DEBUG | 1 | Debug-level information. |
+| INFO | 2 | Informational messages. |
+| NOTICE | 3 | Notable events. |
+| WARNING | 4 | Warning conditions. |
+| ERROR | 5 | Error conditions. |
+| CRITICAL | 6 | Critical conditions. |
+| ALERT | 7 | Action must be taken immediately. |
+| EMERGENCY | 8 | System is unusable. |
+
+
-<a name="bytebase-v1-AppIMSetting-Feishu"></a>
+<a name="bytebase-v1-AuditLogService"></a>
-### AppIMSetting.Feishu
+### AuditLogService
+AuditLogService manages audit logs for system activities and API calls.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| SearchAuditLogs | [SearchAuditLogsRequest](#bytebase-v1-SearchAuditLogsRequest) | [SearchAuditLogsResponse](#bytebase-v1-SearchAuditLogsResponse) | Searches audit logs with optional filtering and pagination. Permissions required: bb.auditLogs.search |
+| ExportAuditLogs | [ExportAuditLogsRequest](#bytebase-v1-ExportAuditLogsRequest) | [ExportAuditLogsResponse](#bytebase-v1-ExportAuditLogsResponse) | Exports audit logs in a specified format for external analysis. Permissions required: bb.auditLogs.export |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| app_id | [string](#string) | | |
-| app_secret | [string](#string) | | |
+<a name="v1_auth_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/auth_service.proto
-<a name="bytebase-v1-AppIMSetting-IMSetting"></a>
+<a name="bytebase-v1-ExchangeTokenRequest"></a>
-### AppIMSetting.IMSetting
+### ExchangeTokenRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [WebhookType](#bytebase-v1-WebhookType) | | |
-| slack | [AppIMSetting.Slack](#bytebase-v1-AppIMSetting-Slack) | | |
-| feishu | [AppIMSetting.Feishu](#bytebase-v1-AppIMSetting-Feishu) | | |
-| wecom | [AppIMSetting.Wecom](#bytebase-v1-AppIMSetting-Wecom) | | |
-| lark | [AppIMSetting.Lark](#bytebase-v1-AppIMSetting-Lark) | | |
-| dingtalk | [AppIMSetting.DingTalk](#bytebase-v1-AppIMSetting-DingTalk) | | |
-| teams | [AppIMSetting.Teams](#bytebase-v1-AppIMSetting-Teams) | | |
+| token | [string](#string) | | External OIDC token (JWT) from CI/CD platform. |
+| email | [string](#string) | | Workload Identity email for identifying which identity to authenticate as. Format: {name}@workload.bytebase.com |
-<a name="bytebase-v1-AppIMSetting-Lark"></a>
+<a name="bytebase-v1-ExchangeTokenResponse"></a>
-### AppIMSetting.Lark
+### ExchangeTokenResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| app_id | [string](#string) | | |
-| app_secret | [string](#string) | | |
-
+| access_token | [string](#string) | | Bytebase access token. |
-<a name="bytebase-v1-AppIMSetting-Slack"></a>
-### AppIMSetting.Slack
+<a name="bytebase-v1-IdentityProviderContext"></a>
+### IdentityProviderContext
+Context for identity provider authentication.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | |
+| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |
+| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |
-<a name="bytebase-v1-AppIMSetting-Teams"></a>
+<a name="bytebase-v1-LoginRequest"></a>
-### AppIMSetting.Teams
+### LoginRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| tenant_id | [string](#string) | | Azure AD tenant ID (Directory ID). |
-| client_id | [string](#string) | | Azure AD application (client) ID. |
-| client_secret | [string](#string) | | Azure AD client secret. |
+| email | [string](#string) | | User&#39;s email address. |
+| password | [string](#string) | | User&#39;s password for authentication. |
+| web | [bool](#bool) | | If true, sets access token and refresh token as HTTP-only cookies instead of returning the token in the response body. Use for browser-based clients. |
+| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
+| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is used to get the user information from identity provider. |
+| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
+| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user&#39;s identity with MFA. |
+| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user&#39;s identity by MFA. |
-<a name="bytebase-v1-AppIMSetting-Wecom"></a>
+<a name="bytebase-v1-LoginResponse"></a>
-### AppIMSetting.Wecom
+### LoginResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| corp_id | [string](#string) | | |
-| agent_id | [string](#string) | | |
-| secret | [string](#string) | | |
-
-
-
-
+| token | [string](#string) | | Access token for authenticated requests. Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. |
+| mfa_temp_token | [string](#string) | optional | Temporary token for MFA verification. |
+| require_reset_password | [bool](#bool) | | Whether user must reset password before continuing. |
+| user | [User](#bytebase-v1-User) | | The user from the successful login. |
-<a name="bytebase-v1-DataClassificationSetting"></a>
-### DataClassificationSetting
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |
+<a name="bytebase-v1-LogoutRequest"></a>
+### LogoutRequest
+Request to logout current user session.
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>
-### DataClassificationSetting.DataClassificationConfig
+<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>
+### OAuth2IdentityProviderContext
+OAuth2 authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | id is the uuid for classification. Each project can chose one classification config. |
-| title | [string](#string) | | |
-| levels | [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level) | repeated | levels is user defined level list for classification. The order for the level decides its priority. |
-| classification | [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry) | repeated | classification is the id - DataClassification map. The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
-
+| code | [string](#string) | | Authorization code from OAuth2 provider. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>
-### DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+<a name="bytebase-v1-OIDCIdentityProviderContext"></a>
+### OIDCIdentityProviderContext
+OpenID Connect authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |
-
-
-
-
+| code | [string](#string) | | Authorization code from OIDC provider. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>
-### DataClassificationSetting.DataClassificationConfig.DataClassification
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
-| title | [string](#string) | | |
-| description | [string](#string) | | |
-| level_id | [string](#string) | optional | |
+<a name="bytebase-v1-RefreshRequest"></a>
+### RefreshRequest
+Request to refresh the access token.
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>
-### DataClassificationSetting.DataClassificationConfig.Level
+<a name="bytebase-v1-RefreshResponse"></a>
+### RefreshResponse
+Response from refreshing the access token.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| title | [string](#string) | | |
-| description | [string](#string) | | |
+
+
+
-<a name="bytebase-v1-EnvironmentSetting"></a>
-### EnvironmentSetting
+<a name="bytebase-v1-AuthService"></a>
+### AuthService
+AuthService handles user authentication operations.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |
+| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |
+| ExchangeToken | [ExchangeTokenRequest](#bytebase-v1-ExchangeTokenRequest) | [ExchangeTokenResponse](#bytebase-v1-ExchangeTokenResponse) | Exchanges an external OIDC token for a Bytebase access token. Used by CI/CD pipelines with Workload Identity Federation. Permissions required: None (validates via OIDC token) |
+| Refresh | [RefreshRequest](#bytebase-v1-RefreshRequest) | [RefreshResponse](#bytebase-v1-RefreshResponse) | Refreshes the access token using the refresh token cookie. Permissions required: None (validates via refresh token cookie) |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |
+
+<a name="v1_cel_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/cel_service.proto
-<a name="bytebase-v1-EnvironmentSetting-Environment"></a>
-### EnvironmentSetting.Environment
+<a name="bytebase-v1-BatchDeparseRequest"></a>
+### BatchDeparseRequest
+Request message for batch deparsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the environment. Format: environments/{environment}. Output only. |
-| id | [string](#string) | | The resource id of the environment. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-| title | [string](#string) | | The display name of the environment. |
-| tags | [EnvironmentSetting.Environment.TagsEntry](#bytebase-v1-EnvironmentSetting-Environment-TagsEntry) | repeated | |
-| color | [string](#string) | | |
-
+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |
-<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>
-### EnvironmentSetting.Environment.TagsEntry
+<a name="bytebase-v1-BatchDeparseResponse"></a>
+### BatchDeparseResponse
+Response message for batch deparsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |
-<a name="bytebase-v1-GetSettingRequest"></a>
+<a name="bytebase-v1-BatchParseRequest"></a>
-### GetSettingRequest
-The request message for getting a setting.
+### BatchParseRequest
+Request message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the setting. |
+| expressions | [string](#string) | repeated | The CEL expression strings to parse. |
-<a name="bytebase-v1-GetSettingResponse"></a>
+<a name="bytebase-v1-BatchParseResponse"></a>
-### GetSettingResponse
-The response message for getting a setting.
+### BatchParseResponse
+Response message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| setting | [Setting](#bytebase-v1-Setting) | | |
+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |
+
-<a name="bytebase-v1-ListSettingsRequest"></a>
+
-### ListSettingsRequest
+
+<a name="bytebase-v1-CelService"></a>
+
+### CelService
+CelService manages CEL (Common Expression Language) parsing and formatting operations.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Parses multiple CEL expression strings into AST representations. Permissions required: None |
+| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Converts multiple CEL AST representations back into expression strings. Permissions required: None |
+
+
+<a name="v1_database_catalog_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/database_catalog_service.proto
-<a name="bytebase-v1-ListSettingsResponse"></a>
-### ListSettingsResponse
+<a name="bytebase-v1-ColumnCatalog"></a>
+
+### ColumnCatalog
+Column metadata within a table.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |
+| name | [string](#string) | | The column name. |
+| semantic_type | [string](#string) | | The semantic type describing the data purpose. |
+| labels | [ColumnCatalog.LabelsEntry](#bytebase-v1-ColumnCatalog-LabelsEntry) | repeated | User-defined labels for this column. |
+| classification | [string](#string) | | The data classification level for this column. |
+| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | optional | Object schema for complex column types like JSON. |
-<a name="bytebase-v1-SemanticTypeSetting"></a>
+<a name="bytebase-v1-ColumnCatalog-LabelsEntry"></a>
-### SemanticTypeSetting
+### ColumnCatalog.LabelsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |
-
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>
-### SemanticTypeSetting.SemanticType
+<a name="bytebase-v1-DatabaseCatalog"></a>
+### DatabaseCatalog
+Catalog metadata for a database including schemas, tables, and columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | id is the uuid for semantic type. |
-| title | [string](#string) | | the title of the semantic type, it should not be empty. |
-| description | [string](#string) | | the description of the semantic type, it can be empty. |
-| algorithm | [Algorithm](#bytebase-v1-Algorithm) | | |
-| icon | [string](#string) | | icon is the icon for semantic type, it can be emoji or base64 encoded image. |
+| name | [string](#string) | | The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog |
+| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | The schemas in the database. |
-<a name="bytebase-v1-Setting"></a>
+<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>
-### Setting
-The schema of setting.
+### GetDatabaseCatalogRequest
+Request message for getting a database catalog.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the setting. Format: settings/{setting} Example: &#34;settings/SEMANTIC_TYPES&#34; |
-| value | [SettingValue](#bytebase-v1-SettingValue) | | The configuration value of the setting. |
+| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |
-<a name="bytebase-v1-SettingValue"></a>
+<a name="bytebase-v1-ObjectSchema"></a>
-### SettingValue
-The data in setting value.
+### ObjectSchema
+Schema definition for object-type columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| app_im | [AppIMSetting](#bytebase-v1-AppIMSetting) | | |
-| workspace_profile | [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting) | | |
-| workspace_approval | [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting) | | |
-| data_classification | [DataClassificationSetting](#bytebase-v1-DataClassificationSetting) | | |
-| semantic_type | [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting) | | |
-| ai | [AISetting](#bytebase-v1-AISetting) | | |
-| environment | [EnvironmentSetting](#bytebase-v1-EnvironmentSetting) | | |
+| type | [ObjectSchema.Type](#bytebase-v1-ObjectSchema-Type) | | The data type of this object. |
+| struct_kind | [ObjectSchema.StructKind](#bytebase-v1-ObjectSchema-StructKind) | | Struct schema. |
+| array_kind | [ObjectSchema.ArrayKind](#bytebase-v1-ObjectSchema-ArrayKind) | | Array schema. |
+| semantic_type | [string](#string) | | The semantic type of this object. |
-<a name="bytebase-v1-UpdateSettingRequest"></a>
+<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>
-### UpdateSettingRequest
-The request message for updating or creating a setting.
+### ObjectSchema.ArrayKind
+Array type with element schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| setting | [Setting](#bytebase-v1-Setting) | | The setting to update. |
-| validate_only | [bool](#bool) | | validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true. |
-| allow_missing | [bool](#bool) | | |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | |
-
+| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |
-<a name="bytebase-v1-WorkspaceApprovalSetting"></a>
-### WorkspaceApprovalSetting
+<a name="bytebase-v1-ObjectSchema-StructKind"></a>
+### ObjectSchema.StructKind
+Structure type with named properties.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |
+| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |
-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>
+<a name="bytebase-v1-ObjectSchema-StructKind-PropertiesEntry"></a>
-### WorkspaceApprovalSetting.Rule
+### ObjectSchema.StructKind.PropertiesEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with the rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-The `source` field filters which rules apply. The `condition` field then evaluates with full context.
-
-All supported variables: statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values. statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-
-When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*) When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
-
-For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100 resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; |
-| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |
-
+| key | [string](#string) | | |
+| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |
-<a name="bytebase-v1-WorkspaceProfileSetting"></a>
-### WorkspaceProfileSetting
+<a name="bytebase-v1-SchemaCatalog"></a>
+### SchemaCatalog
+Schema metadata within a database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| external_url | [string](#string) | | The external URL is used for sso authentication callback. |
-| disallow_signup | [bool](#bool) | | Disallow self-service signup, users can only be invited by the owner. |
-| require_2fa | [bool](#bool) | | Require 2FA for all users. |
-| refresh_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for refresh token. Default is 7 days. |
-| access_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for access token. Default is 1 hour. |
-| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
-| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
-| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
-| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
-| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
-| disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |
-| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
-| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. |
-| enable_audit_log_stdout | [bool](#bool) | | Whether to enable audit logging to stdout in structured JSON format. Requires TEAM or ENTERPRISE license. |
-| watermark | [bool](#bool) | | Whether to display watermark on pages. Requires ENTERPRISE license. |
-| directory_sync_token | [string](#string) | | The token for directory sync authentication. |
-| branding_logo | [string](#string) | | The branding logo as a data URI (e.g. data:image/png;base64,...). |
-| password_restriction | [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction) | | Password restriction settings. |
-
+| name | [string](#string) | | The schema name. |
+| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |
-<a name="bytebase-v1-WorkspaceProfileSetting-PasswordRestriction"></a>
-### WorkspaceProfileSetting.PasswordRestriction
+<a name="bytebase-v1-TableCatalog"></a>
+### TableCatalog
+Table metadata within a schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| min_length | [int32](#int32) | | min_length is the minimum length for password, should no less than 8. |
-| require_number | [bool](#bool) | | require_number requires the password must contains at least one number. |
-| require_letter | [bool](#bool) | | require_letter requires the password must contains at least one letter, regardless of upper case or lower case |
-| require_uppercase_letter | [bool](#bool) | | require_uppercase_letter requires the password must contains at least one upper case letter. |
-| require_special_character | [bool](#bool) | | require_special_character requires the password must contains at least one special character. |
-| require_reset_password_for_first_login | [bool](#bool) | | require_reset_password_for_first_login requires users to reset their password after the 1st login. |
-| password_rotation | [google.protobuf.Duration](#google-protobuf-Duration) | | password_rotation requires users to reset their password after the duration. |
-
-
-
-
-
-
-
-
-<a name="bytebase-v1-AISetting-Provider"></a>
-
-### AISetting.Provider
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| PROVIDER_UNSPECIFIED | 0 | |
-| OPEN_AI | 1 | |
-| CLAUDE | 2 | |
-| GEMINI | 3 | |
-| AZURE_OPENAI | 4 | |
-
+| name | [string](#string) | | The table name. |
+| columns | [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns) | | Regular table columns. |
+| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | | Object schema for JSON/XML columns. |
+| classification | [string](#string) | | The data classification level for this table. |
-<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>
-### Algorithm.InnerOuterMask.MaskType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| MASK_TYPE_UNSPECIFIED | 0 | |
-| INNER | 1 | |
-| OUTER | 2 | |
+<a name="bytebase-v1-TableCatalog-Columns"></a>
+### TableCatalog.Columns
+Column list for regular tables.
-<a name="bytebase-v1-Announcement-AlertLevel"></a>
-### Announcement.AlertLevel
-We support three levels of AlertLevel: INFO, WARNING, and ERROR.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| ALERT_LEVEL_UNSPECIFIED | 0 | |
-| INFO | 1 | |
-| WARNING | 2 | |
-| CRITICAL | 3 | |
-<a name="bytebase-v1-DatabaseChangeMode"></a>
-### DatabaseChangeMode
+<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| DATABASE_CHANGE_MODE_UNSPECIFIED | 0 | |
-| PIPELINE | 1 | A more advanced database change process, including custom approval workflows and other advanced features. Default to this mode. |
-| EDITOR | 2 | A simple database change process in SQL editor. Users can execute SQL directly. |
+### UpdateDatabaseCatalogRequest
+Request message for updating a database catalog.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.
-<a name="bytebase-v1-Setting-SettingName"></a>
+The catalog&#39;s `name` field is used to identify the database catalog to update. Format: instances/{instance}/databases/{database}/catalog |
+| allow_missing | [bool](#bool) | | If set to true, and the database catalog is not found, a new database catalog will be created. In this situation, `update_mask` is ignored. |
-### Setting.SettingName
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SETTING_NAME_UNSPECIFIED | 0 | |
-| WORKSPACE_PROFILE | 1 | |
-| WORKSPACE_APPROVAL | 2 | |
-| APP_IM | 3 | |
-| AI | 4 | |
-| DATA_CLASSIFICATION | 5 | |
-| SEMANTIC_TYPES | 6 | |
-| ENVIRONMENT | 7 | |
+
-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>
-### WorkspaceApprovalSetting.Rule.Source
+<a name="bytebase-v1-ObjectSchema-Type"></a>
+### ObjectSchema.Type
+Object schema data types.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| SOURCE_UNSPECIFIED | 0 | |
-| CHANGE_DATABASE | 1 | |
-| CREATE_DATABASE | 2 | |
-| EXPORT_DATA | 3 | |
-| REQUEST_ROLE | 4 | |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| STRING | 1 | String type. |
+| NUMBER | 2 | Number type. |
+| BOOLEAN | 3 | Boolean type. |
+| OBJECT | 4 | Object/struct type. |
+| ARRAY | 5 | Array type. |
@@ -2198,254 +2147,258 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.
-<a name="bytebase-v1-SettingService"></a>
+<a name="bytebase-v1-DatabaseCatalogService"></a>
-### SettingService
-SettingService manages workspace-level settings and configurations.
+### DatabaseCatalogService
+DatabaseCatalogService manages database schema metadata and classification.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| ListSettings | [ListSettingsRequest](#bytebase-v1-ListSettingsRequest) | [ListSettingsResponse](#bytebase-v1-ListSettingsResponse) | Lists all workspace settings. Permissions required: bb.settings.list |
-| GetSetting | [GetSettingRequest](#bytebase-v1-GetSettingRequest) | [Setting](#bytebase-v1-Setting) | Retrieves a workspace setting by name. Permissions required: bb.settings.get |
-| UpdateSetting | [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest) | [Setting](#bytebase-v1-Setting) | Updates a workspace setting. Permissions required: bb.settings.set |
+| GetDatabaseCatalog | [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Gets the catalog metadata for a database. Permissions required: bb.databaseCatalogs.get |
+| UpdateDatabaseCatalog | [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Updates catalog metadata such as classifications and labels. Permissions required: bb.databaseCatalogs.update |
-<a name="v1_user_service-proto"></a>
+<a name="v1_database_group_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/user_service.proto
-
+## v1/database_group_service.proto
-<a name="bytebase-v1-BatchGetUsersRequest"></a>
-### BatchGetUsersRequest
+<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>
+### CreateDatabaseGroupRequest
+Request message for creating a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The user names to retrieve. Format: users/{email} |
+| parent | [string](#string) | | The parent resource where this database group will be created. Format: projects/{project} |
+| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to create. |
+| database_group_id | [string](#string) | | The ID to use for the database group, which will become the final component of the database group&#39;s resource name.
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| validate_only | [bool](#bool) | | If set, validate the create request and preview the full database group response, but do not actually create it. |
-<a name="bytebase-v1-BatchGetUsersResponse"></a>
-### BatchGetUsersResponse
+<a name="bytebase-v1-DatabaseGroup"></a>
+### DatabaseGroup
+A group of databases matched by expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
+| name | [string](#string) | | The name of the database group. Format: projects/{project}/databaseGroups/{databaseGroup} |
+| title | [string](#string) | | The short name used in actual databases specified by users. |
+| database_expr | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this database group. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Support variables: resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations. resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_labels: the database labels. Support map access operations. All variables should join with &#34;&amp;&amp;&#34; condition.
+For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;) resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; |
+| matched_databases | [DatabaseGroup.Database](#bytebase-v1-DatabaseGroup-Database) | repeated | The list of databases that match the database group condition. |
-<a name="bytebase-v1-CreateUserRequest"></a>
-### CreateUserRequest
+<a name="bytebase-v1-DatabaseGroup-Database"></a>
+### DatabaseGroup.Database
+A database within a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| user | [User](#bytebase-v1-User) | | The user to create. |
+| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |
-<a name="bytebase-v1-DeleteUserRequest"></a>
-
-### DeleteUserRequest
+<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>
+### DeleteDatabaseGroupRequest
+Request message for deleting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user to delete. Format: users/{email} |
-
+| name | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |
-<a name="bytebase-v1-GetUserRequest"></a>
-### GetUserRequest
+<a name="bytebase-v1-GetDatabaseGroupRequest"></a>
+### GetDatabaseGroupRequest
+Request message for getting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user to retrieve. Format: users/{email} |
-
+| name | [string](#string) | | The name of the database group to retrieve. Format: projects/{project}/databaseGroups/{databaseGroup} |
+| view | [DatabaseGroupView](#bytebase-v1-DatabaseGroupView) | | The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. |
-<a name="bytebase-v1-ListUsersRequest"></a>
-### ListUsersRequest
+<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>
+### ListDatabaseGroupsRequest
+Request message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 10 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListUsers` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted users if specified. |
-| filter | [string](#string) | | Filter is used to filter users returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator. - user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - state: check State enum for values, support &#34;==&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-
-For example: name == &#34;ed&#34; name.matches(&#34;ed&#34;) email == &#34;[email protected]&#34; email.matches(&#34;ed&#34;) user_type == &#34;SERVICE_ACCOUNT&#34; user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;] !(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]) state == &#34;DELETED&#34; project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; (name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; |
-
+| parent | [string](#string) | | The parent resource whose database groups are to be listed. Format: projects/{project} |
+| view | [DatabaseGroupView](#bytebase-v1-DatabaseGroupView) | | The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. |
-<a name="bytebase-v1-ListUsersResponse"></a>
-### ListUsersResponse
+<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>
+### ListDatabaseGroupsResponse
+Response message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
+| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |
-<a name="bytebase-v1-UndeleteUserRequest"></a>
-### UndeleteUserRequest
+<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>
+### UpdateDatabaseGroupRequest
+Request message for updating a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted user. Format: users/{email} |
-
-
-
+| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.
+The database group&#39;s `name` field is used to identify the database group to update. Format: projects/{project}/databaseGroups/{databaseGroup} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the database group is not found, a new database group will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-UpdateEmailRequest"></a>
-### UpdateEmailRequest
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user whose email to update. Format: users/{email} Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. |
-| email | [string](#string) | | The new email address. |
+<a name="bytebase-v1-DatabaseGroupView"></a>
+### DatabaseGroupView
+View options for database group responses.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DATABASE_GROUP_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
+| DATABASE_GROUP_VIEW_BASIC | 1 | Include basic information about the database group, but exclude the list of matched databases and unmatched databases. |
+| DATABASE_GROUP_VIEW_FULL | 2 | Include everything. |
+
-<a name="bytebase-v1-UpdateUserRequest"></a>
+
-### UpdateUserRequest
+<a name="bytebase-v1-DatabaseGroupService"></a>
+### DatabaseGroupService
+DatabaseGroupService manages database groups for organizing databases by criteria.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| user | [User](#bytebase-v1-User) | | The user to update.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| ListDatabaseGroups | [ListDatabaseGroupsRequest](#bytebase-v1-ListDatabaseGroupsRequest) | [ListDatabaseGroupsResponse](#bytebase-v1-ListDatabaseGroupsResponse) | Lists database groups in a project. Permissions required: bb.databaseGroups.list |
+| GetDatabaseGroup | [GetDatabaseGroupRequest](#bytebase-v1-GetDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Gets a database group by name. Permissions required: bb.databaseGroups.get |
+| CreateDatabaseGroup | [CreateDatabaseGroupRequest](#bytebase-v1-CreateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Creates a new database group. Permissions required: bb.databaseGroups.create |
+| UpdateDatabaseGroup | [UpdateDatabaseGroupRequest](#bytebase-v1-UpdateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Updates a database group. Permissions required: bb.databaseGroups.update When allow_missing=true, also requires: bb.databaseGroups.create |
+| DeleteDatabaseGroup | [DeleteDatabaseGroupRequest](#bytebase-v1-DeleteDatabaseGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a database group. Permissions required: bb.databaseGroups.delete |
-The user&#39;s `name` field is used to identify the user to update. Format: users/{email} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
-| regenerate_temp_mfa_secret | [bool](#bool) | | The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user. This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. |
-| regenerate_recovery_codes | [bool](#bool) | | The regenerate_recovery_codes flag means to regenerate recovery codes for user. |
-| allow_missing | [bool](#bool) | | If set to true, and the user is not found, a new user will be created. In this situation, `update_mask` is ignored. |
+
+<a name="v1_instance_role_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/instance_role_service.proto
-<a name="bytebase-v1-User"></a>
-### User
+<a name="bytebase-v1-InstanceRole"></a>
+### InstanceRole
+InstanceRole is the API message for instance role.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user. Format: users/{email} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |
-| email | [string](#string) | | The email address of the user, used for login and notifications. |
-| title | [string](#string) | | The display title or full name of the user. |
-| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |
-| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |
-| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. |
-| mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. |
-| temp_otp_secret | [string](#string) | | Temporary OTP secret used during MFA setup and regeneration. |
-| temp_recovery_codes | [string](#string) | repeated | Temporary recovery codes used during MFA setup and regeneration. |
-| temp_otp_secret_created_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. |
-| phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |
-| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. |
-| groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |
-| workload_identity_config | [WorkloadIdentityConfig](#bytebase-v1-WorkloadIdentityConfig) | | Workload Identity configuration (only for WORKLOAD_IDENTITY type) |
+| name | [string](#string) | | The name of the role. Format: instances/{instance}/roles/{role} The role name is the unique name for the role. |
+| role_name | [string](#string) | | The role name. It&#39;s unique within the instance. |
+| password | [string](#string) | optional | The role password. |
+| connection_limit | [int32](#int32) | optional | The connection count limit for this role. |
+| valid_until | [string](#string) | optional | The expiration for the role&#39;s password. |
+| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |
-<a name="bytebase-v1-User-Profile"></a>
+<a name="bytebase-v1-ListInstanceRolesRequest"></a>
-### User.Profile
+### ListInstanceRolesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| last_login_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the user successfully logged in. |
-| last_change_password_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the user changed their password. |
-| source | [string](#string) | | source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. |
+| parent | [string](#string) | | The parent, which owns this collection of roles. Format: instances/{instance} |
+| page_size | [int32](#int32) | | Not used. The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 10 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | Not used. A page token, received from a previous `ListInstanceRoles` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListInstanceRoles` must match the call that provided the page token. |
+| refresh | [bool](#bool) | | Refresh will refresh and return the latest data. |
-<a name="bytebase-v1-WorkloadIdentityConfig"></a>
-### WorkloadIdentityConfig
-WorkloadIdentityConfig for API layer
+<a name="bytebase-v1-ListInstanceRolesResponse"></a>
+
+### ListInstanceRolesResponse
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| provider_type | [WorkloadIdentityConfig.ProviderType](#bytebase-v1-WorkloadIdentityConfig-ProviderType) | | Platform type (currently only GITHUB is supported) |
-| issuer_url | [string](#string) | | OIDC Issuer URL (auto-filled based on provider_type, can be overridden) |
-| allowed_audiences | [string](#string) | repeated | Allowed audiences for token validation |
-| subject_pattern | [string](#string) | | Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) |
+| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | The roles from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
@@ -2453,1982 +2406,2029 @@ WorkloadIdentityConfig for API layer
-
-<a name="bytebase-v1-UserType"></a>
-
-### UserType
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| USER_TYPE_UNSPECIFIED | 0 | Unspecified user type. |
-| USER | 1 | Regular human user account. |
-| SYSTEM_BOT | 2 | System-managed bot account for automated operations. |
-| SERVICE_ACCOUNT | 3 | Service account for API integrations. |
-| WORKLOAD_IDENTITY | 4 | External CI/CD workload identity. |
-
-
-
-<a name="bytebase-v1-WorkloadIdentityConfig-ProviderType"></a>
-
-### WorkloadIdentityConfig.ProviderType
-ProviderType identifies the CI/CD platform.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| PROVIDER_TYPE_UNSPECIFIED | 0 | |
-| GITHUB | 1 | |
-| GITLAB | 2 | |
-
-
-<a name="bytebase-v1-UserService"></a>
+<a name="bytebase-v1-InstanceRoleService"></a>
-### UserService
-UserService manages user accounts and authentication.
+### InstanceRoleService
+InstanceRoleService manages database roles within instances.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetUser | [GetUserRequest](#bytebase-v1-GetUserRequest) | [User](#bytebase-v1-User) | Get the user. Any authenticated user can get the user. Permissions required: bb.users.get |
-| BatchGetUsers | [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest) | [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse) | Get the users in batch. Any authenticated user can batch get users. Permissions required: bb.users.get |
-| GetCurrentUser | [.google.protobuf.Empty](#google-protobuf-Empty) | [User](#bytebase-v1-User) | Get the current authenticated user. Permissions required: None |
-| ListUsers | [ListUsersRequest](#bytebase-v1-ListUsersRequest) | [ListUsersResponse](#bytebase-v1-ListUsersResponse) | List all users. Any authenticated user can list users. Permissions required: bb.users.list |
-| CreateUser | [CreateUserRequest](#bytebase-v1-CreateUserRequest) | [User](#bytebase-v1-User) | Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up. Permissions required: bb.users.create (only when Disallow Signup is enabled) |
-| UpdateUser | [UpdateUserRequest](#bytebase-v1-UpdateUserRequest) | [User](#bytebase-v1-User) | Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user. Note: Email updates are not supported through this API. Use UpdateEmail instead. Permissions required: bb.users.update (or self) |
-| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |
-| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |
-| UpdateEmail | [UpdateEmailRequest](#bytebase-v1-UpdateEmailRequest) | [User](#bytebase-v1-User) | Updates a user&#39;s email address. Permissions required: bb.users.updateEmail |
+| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |
-<a name="v1_actuator_service-proto"></a>
+<a name="v1_instance_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/actuator_service.proto
+## v1/instance_service.proto
-<a name="bytebase-v1-ActuatorInfo"></a>
+<a name="bytebase-v1-AddDataSourceRequest"></a>
+
+### AddDataSourceRequest
-### ActuatorInfo
-System information and configuration for the Bytebase instance.
-Actuator concept is similar to the Spring Boot Actuator.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| version | [string](#string) | | The Bytebase server version. |
-| git_commit | [string](#string) | | The git commit hash of the build. |
-| readonly | [bool](#bool) | | Whether the Bytebase instance is running in read-only mode. |
-| saas | [bool](#bool) | | Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. |
-| demo | [bool](#bool) | | Whether the Bytebase instance is running in demo mode. |
-| host | [string](#string) | | The host address of the Bytebase instance. |
-| port | [string](#string) | | The port number of the Bytebase instance. |
-| external_url | [string](#string) | | The external URL where users or webhook callbacks access Bytebase. |
-| need_admin_setup | [bool](#bool) | | Whether the Bytebase instance requires initial admin setup. |
-| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |
-| workspace_id | [string](#string) | | The unique identifier for the workspace. |
-| debug | [bool](#bool) | | Whether debug mode is enabled. |
-| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |
-| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |
-| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |
-| activated_instance_count | [int32](#int32) | | The number of activated database instances. |
-| total_instance_count | [int32](#int32) | | The total number of database instances. |
-| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |
-| external_url_from_flag | [bool](#bool) | | Whether the external URL is set via command-line flag (and thus cannot be changed via UI). |
-| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
-| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
-| restriction | [Restriction](#bytebase-v1-Restriction) | | |
+| name | [string](#string) | | The name of the instance to add a data source to. Format: instances/{instance} |
+| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. Only READ_ONLY data source can be added. |
+| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
-<a name="bytebase-v1-ActuatorInfo-StatUser"></a>
+<a name="bytebase-v1-BatchSyncInstancesRequest"></a>
+
+### BatchSyncInstancesRequest
-### ActuatorInfo.StatUser
-User statistics by type and state.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| user_type | [UserType](#bytebase-v1-UserType) | | The type of user. |
-| state | [State](#bytebase-v1-State) | | The state of the user. |
-| count | [int32](#int32) | | The count of users matching this type and state. |
+| requests | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | repeated | The request message specifying the instances to sync. A maximum of 1000 instances can be synced in a batch. |
-<a name="bytebase-v1-DeleteCacheRequest"></a>
+<a name="bytebase-v1-BatchSyncInstancesResponse"></a>
-### DeleteCacheRequest
-Request message for deleting cache.
+### BatchSyncInstancesResponse
-<a name="bytebase-v1-GetActuatorInfoRequest"></a>
-### GetActuatorInfoRequest
-Request message for getting actuator information.
+<a name="bytebase-v1-BatchUpdateInstancesRequest"></a>
+### BatchUpdateInstancesRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |
-<a name="bytebase-v1-GetResourcePackageRequest"></a>
-### GetResourcePackageRequest
-Request message for getting branding resources.
+<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>
+### BatchUpdateInstancesResponse
-<a name="bytebase-v1-ResourcePackage"></a>
-
-### ResourcePackage
-Custom branding resources for the Bytebase instance.
-
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| logo | [bytes](#bytes) | | The branding logo. |
+| instances | [Instance](#bytebase-v1-Instance) | repeated | |
-<a name="bytebase-v1-Restriction"></a>
+<a name="bytebase-v1-CreateInstanceRequest"></a>
-### Restriction
+### CreateInstanceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |
-| require_2fa | [bool](#bool) | | Whether two-factor authentication is required for all users. |
-| disallow_password_signin | [bool](#bool) | | Whether password-based signin is disabled (except for workspace admins). |
-| password_restriction | [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction) | | Password complexity and restriction requirements. |
-| watermark | [bool](#bool) | | Whether to display watermark on pages. |
-| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
-| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. |
-| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
-| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
-| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
-
-
-
-
-
+| instance | [Instance](#bytebase-v1-Instance) | | The instance to create. |
+| instance_id | [string](#string) | | The ID to use for the instance, which will become the final component of the instance&#39;s resource name.
-<a name="bytebase-v1-SetupSampleRequest"></a>
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
-### SetupSampleRequest
-Request message for setting up sample data.
+<a name="bytebase-v1-DataSource"></a>
-<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>
+### DataSource
-### UpdateActuatorInfoRequest
-Request message for updating actuator information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| actuator | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | | The actuator to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the actuator is not found, a new actuator will be created. In this situation, `update_mask` is ignored. |
-
-
+| id | [string](#string) | | The unique identifier for this data source. |
+| type | [DataSourceType](#bytebase-v1-DataSourceType) | | The type of data source (ADMIN or READ_ONLY). |
+| username | [string](#string) | | The username for database authentication. |
+| password | [string](#string) | | The password for database authentication. |
+| use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use system default SSL configuration. |
+| ssl_ca | [string](#string) | | The SSL certificate authority certificate. |
+| ssl_cert | [string](#string) | | The SSL client certificate. |
+| ssl_key | [string](#string) | | The SSL client private key. |
+| verify_tls_certificate | [bool](#bool) | | verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). |
+| host | [string](#string) | | The hostname or IP address of the database server. |
+| port | [string](#string) | | The port number of the database server. |
+| database | [string](#string) | | The name of the database to connect to. |
+| srv | [bool](#bool) | | srv, authentication_database and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record. |
+| authentication_database | [string](#string) | | authentication_database is the database name to authenticate against, which stores the user credentials. |
+| replica_set | [string](#string) | | replica_set is used for MongoDB replica set. |
+| sid | [string](#string) | | sid and service_name are used for Oracle. |
+| service_name | [string](#string) | | |
+| ssh_host | [string](#string) | | Connection over SSH. The hostname of the SSH server agent. Required. |
+| ssh_port | [string](#string) | | The port of the SSH server agent. It&#39;s 22 typically. Required. |
+| ssh_user | [string](#string) | | The user to login the server. Required. |
+| ssh_password | [string](#string) | | The password to login the server. If it&#39;s empty string, no password is required. |
+| ssh_private_key | [string](#string) | | The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). |
+| authentication_private_key | [string](#string) | | PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required. Used for authentication when connecting to the data source. |
+| authentication_private_key_passphrase | [string](#string) | | Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. |
+| external_secret | [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret) | | |
+| authentication_type | [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType) | | |
+| azure_credential | [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential) | | |
+| aws_credential | [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential) | | |
+| gcp_credential | [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential) | | |
+| sasl_config | [SASLConfig](#bytebase-v1-SASLConfig) | | |
+| additional_addresses | [DataSource.Address](#bytebase-v1-DataSource-Address) | repeated | additional_addresses is used for MongoDB replica set. |
+| direct_connection | [bool](#bool) | | direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. |
+| region | [string](#string) | | region is the location of where the DB is, works for AWS RDS. For example, us-east-1. |
+| warehouse_id | [string](#string) | | warehouse_id is used by Databricks. |
+| master_name | [string](#string) | | master_name is the master name used by connecting redis-master via redis sentinel. |
+| master_username | [string](#string) | | master_username and master_password are master credentials used by redis sentinel mode. |
+| master_password | [string](#string) | | |
+| redis_type | [DataSource.RedisType](#bytebase-v1-DataSource-RedisType) | | |
+| cluster | [string](#string) | | Cluster is the cluster name for the data source. Used by CockroachDB. |
+| extra_connection_parameters | [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry) | repeated | Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write |
-
-
-
+<a name="bytebase-v1-DataSource-AWSCredential"></a>
-<a name="bytebase-v1-ActuatorService"></a>
+### DataSource.AWSCredential
-### ActuatorService
-ActuatorService manages system health and operational information.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetActuatorInfo | [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Gets system information and health status of the Bytebase instance. Permissions required: None |
-| UpdateActuatorInfo | [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Updates system configuration settings for the Bytebase instance. Permissions required: bb.settings.set |
-| SetupSample | [SetupSampleRequest](#bytebase-v1-SetupSampleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Sets up sample data for demonstration and testing purposes. Permissions required: bb.projects.create |
-| DeleteCache | [DeleteCacheRequest](#bytebase-v1-DeleteCacheRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Clears the system cache to force data refresh. Permissions required: None |
-| GetResourcePackage | [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest) | [ResourcePackage](#bytebase-v1-ResourcePackage) | Gets custom branding resources such as logos. Permissions required: None |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| access_key_id | [string](#string) | | |
+| secret_access_key | [string](#string) | | |
+| session_token | [string](#string) | | |
+| role_arn | [string](#string) | | ARN of IAM role to assume for cross-account access. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html |
+| external_id | [string](#string) | | Optional external ID for additional security when assuming role. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html |
-<a name="v1_iam_policy-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/iam_policy.proto
+<a name="bytebase-v1-DataSource-Address"></a>
-<a name="bytebase-v1-Binding"></a>
+### DataSource.Address
-### Binding
-Binding associates members with a role and optional conditions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [string](#string) | | The role that is assigned to the members. Format: roles/{role} |
-| members | [string](#string) | repeated | Specifies the principals requesting access for a Bytebase resource. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this binding, only used in the project IAM policy. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables: resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
+| host | [string](#string) | | |
+| port | [string](#string) | | |
-For example: resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;] resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;] request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) |
-| parsed_expr | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | | The parsed expression of the condition. |
+<a name="bytebase-v1-DataSource-AzureCredential"></a>
-<a name="bytebase-v1-BindingDelta"></a>
+### DataSource.AzureCredential
-### BindingDelta
-A single change to a binding.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| action | [BindingDelta.Action](#bytebase-v1-BindingDelta-Action) | | The action that was performed on a Binding. |
-| role | [string](#string) | | Role that is assigned to `members`. For example, `roles/projectOwner`. |
-| member | [string](#string) | | Follows the same format of Binding.members. |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this binding. |
+| tenant_id | [string](#string) | | |
+| client_id | [string](#string) | | |
+| client_secret | [string](#string) | | |
-<a name="bytebase-v1-GetIamPolicyRequest"></a>
+<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>
+
+### DataSource.ExtraConnectionParametersEntry
-### GetIamPolicyRequest
-Request message for getting an IAM policy.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| resource | [string](#string) | | The name of the resource to get the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-IamPolicy"></a>
+<a name="bytebase-v1-DataSource-GCPCredential"></a>
+
+### DataSource.GCPCredential
-### IamPolicy
-IAM policy that binds members to roles.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| bindings | [Binding](#bytebase-v1-Binding) | repeated | Collection of binding. A binding binds one or more project members to a single project role. |
-| etag | [string](#string) | | The current etag of the policy. If an etag is provided and does not match the current etag of the policy, the call will be blocked and an ABORTED error will be returned. |
+| content | [string](#string) | | |
-<a name="bytebase-v1-PolicyDelta"></a>
+<a name="bytebase-v1-DataSourceExternalSecret"></a>
+
+### DataSourceExternalSecret
-### PolicyDelta
-Describes changes between two IAM policies.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| binding_deltas | [BindingDelta](#bytebase-v1-BindingDelta) | repeated | The delta for Bindings between two policies. |
+| secret_type | [DataSourceExternalSecret.SecretType](#bytebase-v1-DataSourceExternalSecret-SecretType) | | The type of external secret store. |
+| url | [string](#string) | | The URL of the external secret store. |
+| auth_type | [DataSourceExternalSecret.AuthType](#bytebase-v1-DataSourceExternalSecret-AuthType) | | The authentication method for accessing the secret store. |
+| app_role | [DataSourceExternalSecret.AppRoleAuthOption](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption) | | AppRole authentication configuration. |
+| token | [string](#string) | | Token for direct authentication. |
+| engine_name | [string](#string) | | engine name is the name for secret engine. |
+| secret_name | [string](#string) | | the secret name in the engine to store the password. |
+| password_key_name | [string](#string) | | the key name for the password. |
+| skip_vault_tls_verification | [bool](#bool) | | TLS configuration for connecting to Vault server. These fields are separate from the database TLS configuration in DataSource. skip_vault_tls_verification disables TLS certificate verification for Vault connections. Default is false (verification enabled) for security. Only set to true for development or when certificates cannot be properly validated. |
+| vault_ssl_ca | [string](#string) | | CA certificate for Vault server verification. |
+| vault_ssl_cert | [string](#string) | | Client certificate for mutual TLS authentication with Vault. |
+| vault_ssl_key | [string](#string) | | Client private key for mutual TLS authentication with Vault. |
-<a name="bytebase-v1-SetIamPolicyRequest"></a>
+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption"></a>
+
+### DataSourceExternalSecret.AppRoleAuthOption
-### SetIamPolicyRequest
-Request message for setting an IAM policy.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| resource | [string](#string) | | The name of the resource to set the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
-| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | |
-| etag | [string](#string) | | The current etag of the policy. |
-
-
-
+| role_id | [string](#string) | | The role ID for Vault AppRole authentication. |
+| secret_id | [string](#string) | | the secret id for the role without ttl. |
+| type | [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType) | | The type of secret for AppRole authentication. |
+| mount_path | [string](#string) | | The path where the approle auth method is mounted. |
-
-<a name="bytebase-v1-BindingDelta-Action"></a>
-### BindingDelta.Action
-Type of action performed on a binding.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| ACTION_UNSPECIFIED | 0 | Unspecified action. |
-| ADD | 1 | Add a binding. |
-| REMOVE | 2 | Remove a binding. |
+<a name="bytebase-v1-DeleteInstanceRequest"></a>
+### DeleteInstanceRequest
-
-
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the instance to delete. Format: instances/{instance} |
+| force | [bool](#bool) | | If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. |
+| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted instance and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted instances. The instance must already be soft-deleted for this to work. |
-<a name="v1_audit_log_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/audit_log_service.proto
+<a name="bytebase-v1-GetInstanceRequest"></a>
-<a name="bytebase-v1-AuditData"></a>
+### GetInstanceRequest
-### AuditData
-Additional audit data specific to certain operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |
+| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |
-<a name="bytebase-v1-AuditLog"></a>
+<a name="bytebase-v1-Instance"></a>
+
+### Instance
-### AuditLog
-Audit log entry recording system activity or API call.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the log. Formats: - projects/{project}/auditLogs/{uid} - workspaces/{workspace}/auditLogs/{uid} |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The timestamp when the audit log was created. |
-| user | [string](#string) | | The user who performed the action. Format: users/{email} |
-| method | [string](#string) | | The method or action being audited. For example: /bytebase.v1.SQLService/Query or bb.project.repository.push |
-| severity | [AuditLog.Severity](#bytebase-v1-AuditLog-Severity) | | The severity level of this audit log entry. |
-| resource | [string](#string) | | The resource associated with this audit log. |
-| request | [string](#string) | | The request payload in JSON format. |
-| response | [string](#string) | | The response payload in JSON format. Some fields may be omitted if they are too large or contain sensitive information. |
-| status | [google.rpc.Status](#google-rpc-Status) | | The status of the operation. |
-| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration of the operation. |
-| service_data | [google.protobuf.Any](#google-protobuf-Any) | | Service-specific metadata about the request, response, and activities. |
-| request_metadata | [RequestMetadata](#bytebase-v1-RequestMetadata) | | Metadata about the request context. |
+| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |
+| title | [string](#string) | | The display title of the instance. |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
+| engine_version | [string](#string) | | The version of the database engine. |
+| external_link | [string](#string) | | External URL to the database instance console. |
+| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. |
+| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
+| activation | [bool](#bool) | | Whether the instance is activated for use. |
+| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. |
+| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |
+| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas &amp; databases. |
+| last_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the instance was synced. |
+| labels | [Instance.LabelsEntry](#bytebase-v1-Instance-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the instance. For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } |
-<a name="bytebase-v1-ExportAuditLogsRequest"></a>
+<a name="bytebase-v1-Instance-LabelsEntry"></a>
+
+### Instance.LabelsEntry
-### ExportAuditLogsRequest
-Request message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | |
-| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. Check the filter field in the SearchAuditLogsRequest message. |
-| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
-| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The export format. |
-| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
-| page_token | [string](#string) | | A page token, received from a previous `ExportAuditLogs` call. Provide this to retrieve the subsequent page. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-ExportAuditLogsResponse"></a>
+<a name="bytebase-v1-InstanceResource"></a>
+
+### InstanceResource
-### ExportAuditLogsResponse
-Response message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [bytes](#bytes) | | The exported audit log content in the requested format. |
-| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
+| title | [string](#string) | | The display title of the instance. |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
+| engine_version | [string](#string) | | The version of the database engine. |
+| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for the instance. |
+| activation | [bool](#bool) | | Whether the instance is activated. |
+| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
+| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-<a name="bytebase-v1-RequestMetadata"></a>
+<a name="bytebase-v1-KerberosConfig"></a>
+
+### KerberosConfig
-### RequestMetadata
-Metadata about the incoming request.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| caller_ip | [string](#string) | | The IP address of the request originator. |
-| caller_supplied_user_agent | [string](#string) | | The user agent string provided by the caller. This is supplied by the client and is not authenticated. |
+| primary | [string](#string) | | The primary component of the Kerberos principal. |
+| instance | [string](#string) | | The instance component of the Kerberos principal. |
+| realm | [string](#string) | | The Kerberos realm. |
+| keytab | [bytes](#bytes) | | The keytab file contents for authentication. |
+| kdc_host | [string](#string) | | The hostname of the Key Distribution Center (KDC). |
+| kdc_port | [string](#string) | | The port of the Key Distribution Center (KDC). |
+| kdc_transport_protocol | [string](#string) | | The transport protocol for KDC communication (tcp or udp). |
-<a name="bytebase-v1-SearchAuditLogsRequest"></a>
+<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>
+
+### ListInstanceDatabaseRequest
-### SearchAuditLogsRequest
-Request message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | |
-| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator. - severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values. - user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator. - create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
+| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
+| instance | [Instance](#bytebase-v1-Instance) | optional | The target instance. We need to set this field if the target instance is not created yet. |
-For example: - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; |
-| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
-| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchLogs` call. Provide this to retrieve the subsequent page. |
+<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>
-<a name="bytebase-v1-SearchAuditLogsResponse"></a>
+### ListInstanceDatabaseResponse
-### SearchAuditLogsResponse
-Response message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| audit_logs | [AuditLog](#bytebase-v1-AuditLog) | repeated | |
-| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
-
-
-
-
-
-
+| databases | [string](#string) | repeated | All database name list in the instance. |
-<a name="bytebase-v1-AuditLog-Severity"></a>
-### AuditLog.Severity
-Severity level for audit log entries.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SEVERITY_UNSPECIFIED | 0 | Unspecified severity level. |
-| DEBUG | 1 | Debug-level information. |
-| INFO | 2 | Informational messages. |
-| NOTICE | 3 | Notable events. |
-| WARNING | 4 | Warning conditions. |
-| ERROR | 5 | Error conditions. |
-| CRITICAL | 6 | Critical conditions. |
-| ALERT | 7 | Action must be taken immediately. |
-| EMERGENCY | 8 | System is unusable. |
-
+<a name="bytebase-v1-ListInstancesRequest"></a>
-
+### ListInstancesRequest
-<a name="bytebase-v1-AuditLogService"></a>
-### AuditLogService
-AuditLogService manages audit logs for system activities and API calls.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| page_size | [int32](#int32) | | The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 10 instances will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListInstances` call. Provide this to retrieve the subsequent page.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| SearchAuditLogs | [SearchAuditLogsRequest](#bytebase-v1-SearchAuditLogsRequest) | [SearchAuditLogsResponse](#bytebase-v1-SearchAuditLogsResponse) | Searches audit logs with optional filtering and pagination. Permissions required: bb.auditLogs.search |
-| ExportAuditLogs | [ExportAuditLogsRequest](#bytebase-v1-ExportAuditLogsRequest) | [ExportAuditLogsResponse](#bytebase-v1-ExportAuditLogsResponse) | Exports audit logs in a specified format for external analysis. Permissions required: bb.auditLogs.export |
+When paginating, all other parameters provided to `ListInstances` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted instances if specified. |
+| filter | [string](#string) | | Filter the instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
+Supported filters: - name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator. - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - state: the instance state, check State enum for values, support &#34;==&#34; operator. - engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator. - port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
+For example: name == &#34;sample instance&#34; name.matches(&#34;sample&#34;) resource_id == &#34;sample-instance&#34; resource_id.matches(&#34;sample&#34;) state == &#34;DELETED&#34; environment == &#34;environments/test&#34; environment == &#34;&#34; (find instances which environment is not set) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) host == &#34;127.0.0.1&#34; host.matches(&#34;127.0&#34;) port == &#34;54321&#34; port.matches(&#34;543&#34;) labels.org_group == &#34;infrastructure&#34; labels.environment in [&#34;prod&#34;, &#34;production&#34;] project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34; host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; |
+| order_by | [string](#string) | | The order by of instances. Support title, environment. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title desc, environment asc&#34; |
-<a name="v1_auth_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/auth_service.proto
-<a name="bytebase-v1-ExchangeTokenRequest"></a>
+<a name="bytebase-v1-ListInstancesResponse"></a>
-### ExchangeTokenRequest
+### ListInstancesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | External OIDC token (JWT) from CI/CD platform. |
-| email | [string](#string) | | Workload Identity email for identifying which identity to authenticate as. Format: {name}@workload.bytebase.com |
+| instances | [Instance](#bytebase-v1-Instance) | repeated | The instances from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-ExchangeTokenResponse"></a>
+<a name="bytebase-v1-RemoveDataSourceRequest"></a>
-### ExchangeTokenResponse
+### RemoveDataSourceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| access_token | [string](#string) | | Bytebase access token. |
+| name | [string](#string) | | The name of the instance to remove a data source from. Format: instances/{instance} |
+| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. Only READ_ONLY data source can be removed. |
-<a name="bytebase-v1-IdentityProviderContext"></a>
+<a name="bytebase-v1-SASLConfig"></a>
+
+### SASLConfig
-### IdentityProviderContext
-Context for identity provider authentication.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |
-| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |
+| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |
-<a name="bytebase-v1-LoginRequest"></a>
+<a name="bytebase-v1-SyncInstanceRequest"></a>
-### LoginRequest
+### SyncInstanceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| email | [string](#string) | | User&#39;s email address. |
-| password | [string](#string) | | User&#39;s password for authentication. |
-| web | [bool](#bool) | | If true, sets access token and refresh token as HTTP-only cookies instead of returning the token in the response body. Use for browser-based clients. |
-| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
-| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is used to get the user information from identity provider. |
-| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
-| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user&#39;s identity with MFA. |
-| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user&#39;s identity by MFA. |
+| name | [string](#string) | | The name of instance. Format: instances/{instance} |
+| enable_full_sync | [bool](#bool) | | When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only the instance metadata (such as the database list) and any newly discovered databases will be synced. |
-<a name="bytebase-v1-LoginResponse"></a>
+<a name="bytebase-v1-SyncInstanceResponse"></a>
-### LoginResponse
+### SyncInstanceResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | Access token for authenticated requests. Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. |
-| mfa_temp_token | [string](#string) | optional | Temporary token for MFA verification. |
-| require_reset_password | [bool](#bool) | | Whether user must reset password before continuing. |
-| user | [User](#bytebase-v1-User) | | The user from the successful login. |
+| databases | [string](#string) | repeated | All database name list in the instance. |
-<a name="bytebase-v1-LogoutRequest"></a>
+<a name="bytebase-v1-UndeleteInstanceRequest"></a>
+
+### UndeleteInstanceRequest
+
-### LogoutRequest
-Request to logout current user session.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |
-<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>
-### OAuth2IdentityProviderContext
-OAuth2 authentication context.
+<a name="bytebase-v1-UpdateDataSourceRequest"></a>
+
+### UpdateDataSourceRequest
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorization code from OAuth2 provider. |
+| name | [string](#string) | | The name of the instance to update a data source. Format: instances/{instance} |
+| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
+| allow_missing | [bool](#bool) | | If set to true, and the data source is not found, a new data source will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-OIDCIdentityProviderContext"></a>
+<a name="bytebase-v1-UpdateInstanceRequest"></a>
+
+### UpdateInstanceRequest
-### OIDCIdentityProviderContext
-OpenID Connect authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorization code from OIDC provider. |
+| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.
+The instance&#39;s `name` field is used to identify the instance to update. Format: instances/{instance} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the instance is not found, a new instance will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-RefreshRequest"></a>
+
-### RefreshRequest
-Request to refresh the access token.
+<a name="bytebase-v1-DataSource-AuthenticationType"></a>
+### DataSource.AuthenticationType
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| AUTHENTICATION_UNSPECIFIED | 0 | |
+| PASSWORD | 1 | |
+| GOOGLE_CLOUD_SQL_IAM | 2 | |
+| AWS_RDS_IAM | 3 | |
+| AZURE_IAM | 4 | |
-<a name="bytebase-v1-RefreshResponse"></a>
-### RefreshResponse
-Response from refreshing the access token.
+<a name="bytebase-v1-DataSource-RedisType"></a>
+### DataSource.RedisType
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| REDIS_TYPE_UNSPECIFIED | 0 | |
+| STANDALONE | 1 | |
+| SENTINEL | 2 | |
+| CLUSTER | 3 | |
-
-
+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>
-
+### DataSourceExternalSecret.AppRoleAuthOption.SecretType
-<a name="bytebase-v1-AuthService"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
+| PLAIN | 1 | Plain text secret. |
+| ENVIRONMENT | 2 | Secret from environment variable. |
-### AuthService
-AuthService handles user authentication operations.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |
-| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |
-| ExchangeToken | [ExchangeTokenRequest](#bytebase-v1-ExchangeTokenRequest) | [ExchangeTokenResponse](#bytebase-v1-ExchangeTokenResponse) | Exchanges an external OIDC token for a Bytebase access token. Used by CI/CD pipelines with Workload Identity Federation. Permissions required: None (validates via OIDC token) |
-| Refresh | [RefreshRequest](#bytebase-v1-RefreshRequest) | [RefreshResponse](#bytebase-v1-RefreshResponse) | Refreshes the access token using the refresh token cookie. Permissions required: None (validates via refresh token cookie) |
-
+<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></a>
+### DataSourceExternalSecret.AuthType
-<a name="v1_cel_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| AUTH_TYPE_UNSPECIFIED | 0 | Unspecified authentication type. |
+| TOKEN | 1 | ref: https://developer.hashicorp.com/vault/docs/auth/token |
+| VAULT_APP_ROLE | 2 | ref: https://developer.hashicorp.com/vault/docs/auth/approle |
-## v1/cel_service.proto
+<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>
-<a name="bytebase-v1-BatchDeparseRequest"></a>
+### DataSourceExternalSecret.SecretType
-### BatchDeparseRequest
-Request message for batch deparsing CEL expressions.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
+| VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 |
+| AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html |
+| GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |
+| AZURE_KEY_VAULT | 4 | ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |
+<a name="bytebase-v1-DataSourceType"></a>
+### DataSourceType
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DATA_SOURCE_UNSPECIFIED | 0 | Unspecified data source type. |
+| ADMIN | 1 | Admin data source with write permissions. |
+| READ_ONLY | 2 | Read-only data source for query operations. |
-<a name="bytebase-v1-BatchDeparseResponse"></a>
-### BatchDeparseResponse
-Response message for batch deparsing CEL expressions.
+
+
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |
+<a name="bytebase-v1-InstanceService"></a>
+### InstanceService
+InstanceService manages database instances and their connections.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Gets a database instance by name. Permissions required: bb.instances.get |
+| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Lists all database instances. Permissions required: bb.instances.list |
+| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Creates a new database instance. Permissions required: bb.instances.create |
+| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Updates a database instance. Permissions required: bb.instances.update |
+| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete |
+| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Restores a soft-deleted database instance. Permissions required: bb.instances.undelete |
+| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync |
+| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Lists all databases within an instance without creating them. Permissions required: bb.instances.get |
+| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Syncs multiple instances in a single request. Permissions required: bb.instances.sync |
+| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Updates multiple instances in a single request. Permissions required: bb.instances.update |
+| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Adds a read-only data source to an instance. Permissions required: bb.instances.update |
+| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Removes a read-only data source from an instance. Permissions required: bb.instances.update |
+| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Updates a data source configuration. Permissions required: bb.instances.update |
+
-<a name="bytebase-v1-BatchParseRequest"></a>
+<a name="v1_database_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/database_service.proto
+
+
+
+<a name="bytebase-v1-BatchGetDatabasesRequest"></a>
+
+### BatchGetDatabasesRequest
-### BatchParseRequest
-Request message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [string](#string) | repeated | The CEL expression strings to parse. |
+| parent | [string](#string) | | The parent resource shared by all databases being retrieved. - projects/{project}: batch get databases in a project; - instances/{instances}: batch get databases in a instance; Use &#34;-&#34; as wildcard to batch get databases across parent. |
+| names | [string](#string) | repeated | The list of database names to retrieve. |
-<a name="bytebase-v1-BatchParseResponse"></a>
+<a name="bytebase-v1-BatchGetDatabasesResponse"></a>
+
+### BatchGetDatabasesResponse
-### BatchParseResponse
-Response message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |
+| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-
-
+<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>
-
+### BatchSyncDatabasesRequest
-<a name="bytebase-v1-CelService"></a>
-### CelService
-CelService manages CEL (Common Expression Language) parsing and formatting operations.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource shared by all databases being updated. Format: instances/{instance} If the operation spans parents, a dash (-) may be accepted as a wildcard. |
+| names | [string](#string) | repeated | The list of database names to sync. |
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Parses multiple CEL expression strings into AST representations. Permissions required: None |
-| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Converts multiple CEL AST representations back into expression strings. Permissions required: None |
-
-<a name="v1_database_catalog_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/database_catalog_service.proto
+<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>
+### BatchSyncDatabasesResponse
-<a name="bytebase-v1-ColumnCatalog"></a>
-### ColumnCatalog
-Column metadata within a table.
+
+
+
+
+<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>
+
+### BatchUpdateDatabasesRequest
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The column name. |
-| semantic_type | [string](#string) | | The semantic type describing the data purpose. |
-| labels | [ColumnCatalog.LabelsEntry](#bytebase-v1-ColumnCatalog-LabelsEntry) | repeated | User-defined labels for this column. |
-| classification | [string](#string) | | The data classification level for this column. |
-| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | optional | Object schema for complex column types like JSON. |
+| parent | [string](#string) | | The parent resource shared by all databases being updated. Format: instances/{instance} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the project of databases for now. |
+| requests | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | repeated | The request message specifying the resources to update. A maximum of 1000 databases can be modified in a batch. |
-<a name="bytebase-v1-ColumnCatalog-LabelsEntry"></a>
+<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>
-### ColumnCatalog.LabelsEntry
+### BatchUpdateDatabasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |
-<a name="bytebase-v1-DatabaseCatalog"></a>
+<a name="bytebase-v1-BoundingBox"></a>
-### DatabaseCatalog
-Catalog metadata for a database including schemas, tables, and columns.
+### BoundingBox
+BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog |
-| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | The schemas in the database. |
+| xmin | [double](#double) | | Minimum X coordinate |
+| ymin | [double](#double) | | Minimum Y coordinate |
+| xmax | [double](#double) | | Maximum X coordinate |
+| ymax | [double](#double) | | Maximum Y coordinate |
-<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>
+<a name="bytebase-v1-Changelog"></a>
+
+### Changelog
-### GetDatabaseCatalogRequest
-Request message for getting a database catalog.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |
+| name | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |
+| schema | [string](#string) | | |
+| schema_size | [int64](#int64) | | |
+| task_run | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| plan_title | [string](#string) | | The title of the plan associated with this changelog&#39;s task run. This field is populated by deriving the plan from task_run for display purposes. |
+| type | [Changelog.Type](#bytebase-v1-Changelog-Type) | | |
-<a name="bytebase-v1-ObjectSchema"></a>
+<a name="bytebase-v1-CheckConstraintMetadata"></a>
-### ObjectSchema
-Schema definition for object-type columns.
+### CheckConstraintMetadata
+CheckConstraintMetadata is the metadata for check constraints.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [ObjectSchema.Type](#bytebase-v1-ObjectSchema-Type) | | The data type of this object. |
-| struct_kind | [ObjectSchema.StructKind](#bytebase-v1-ObjectSchema-StructKind) | | Struct schema. |
-| array_kind | [ObjectSchema.ArrayKind](#bytebase-v1-ObjectSchema-ArrayKind) | | Array schema. |
-| semantic_type | [string](#string) | | The semantic type of this object. |
+| name | [string](#string) | | The name is the name of a check constraint. |
+| expression | [string](#string) | | The expression is the expression of a check constraint. |
-<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>
+<a name="bytebase-v1-ColumnMetadata"></a>
-### ObjectSchema.ArrayKind
-Array type with element schema.
+### ColumnMetadata
+ColumnMetadata is the metadata for columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |
+| name | [string](#string) | | The name is the name of a column. |
+| position | [int32](#int32) | | The position is the position in columns. |
+| has_default | [bool](#bool) | | |
+| default | [string](#string) | | The default value of column. |
+| default_on_null | [bool](#bool) | | Oracle specific metadata. The default_on_null is the default on null of a column. |
+| on_update | [string](#string) | | The on_update is the on update action of a column. For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with CURRENT_TIMESTAMP as on update value. |
+| nullable | [bool](#bool) | | The nullable is the nullable of a column. |
+| type | [string](#string) | | The type is the type of a column. |
+| character_set | [string](#string) | | The character_set is the character_set of a column. |
+| collation | [string](#string) | | The collation is the collation of a column. |
+| comment | [string](#string) | | The comment is the comment of a column. |
+| generation | [GenerationMetadata](#bytebase-v1-GenerationMetadata) | | The generation is the generation of a column. |
+| is_identity | [bool](#bool) | | |
+| identity_generation | [ColumnMetadata.IdentityGeneration](#bytebase-v1-ColumnMetadata-IdentityGeneration) | | The identity_generation is for identity columns, PG only. |
+| identity_seed | [int64](#int64) | | The identity_seed is for identity columns, MSSQL only. |
+| identity_increment | [int64](#int64) | | The identity_increment is for identity columns, MSSQL only. |
+| default_constraint_name | [string](#string) | | The default_constraint_name is the name of the default constraint, MSSQL only. In MSSQL, default values are implemented as named constraints. When modifying or dropping a column&#39;s default value, you must reference the constraint by name. This field stores the actual constraint name from the database.
+Example: A column definition like: CREATE TABLE employees ( status NVARCHAR(20) DEFAULT &#39;active&#39; )
+Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39; or a user-defined name if specified: ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
+To modify the default, you must first drop the existing constraint by name: ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760 ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
+This field is populated when syncing from the database. When empty (e.g., when parsing from SQL files), the system cannot automatically drop the constraint. |
-<a name="bytebase-v1-ObjectSchema-StructKind"></a>
-### ObjectSchema.StructKind
-Structure type with named properties.
+
+
+
+<a name="bytebase-v1-Database"></a>
+
+### Database
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |
+| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} {database} is the database name in the instance. |
+| state | [State](#bytebase-v1-State) | | The existence of a database. |
+| successful_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The latest synchronization time. |
+| project | [string](#string) | | The project for a database. Format: projects/{project} |
+| schema_version | [string](#string) | | The version of database schema. |
+| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
+| effective_environment | [string](#string) | optional | The effective environment based on environment tag above and environment tag on the instance. Inheritance follows https://cloud.google.com/resource-manager/docs/tags/tags-overview. |
+| labels | [Database.LabelsEntry](#bytebase-v1-Database-LabelsEntry) | repeated | Labels will be used for deployment and policy control. |
+| instance_resource | [InstanceResource](#bytebase-v1-InstanceResource) | | The instance resource. |
+| backup_available | [bool](#bool) | | The database is available for DML prior backup. |
+| drifted | [bool](#bool) | | The schema is drifted from the source of truth. |
-<a name="bytebase-v1-ObjectSchema-StructKind-PropertiesEntry"></a>
+<a name="bytebase-v1-Database-LabelsEntry"></a>
-### ObjectSchema.StructKind.PropertiesEntry
+### Database.LabelsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| key | [string](#string) | | |
-| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-SchemaCatalog"></a>
+<a name="bytebase-v1-DatabaseMetadata"></a>
-### SchemaCatalog
-Schema metadata within a database.
+### DatabaseMetadata
+DatabaseMetadata is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The schema name. |
-| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |
+| name | [string](#string) | | The database metadata name.
+
+Format: instances/{instance}/databases/{database}/metadata |
+| schemas | [SchemaMetadata](#bytebase-v1-SchemaMetadata) | repeated | The schemas is the list of schemas in a database. |
+| character_set | [string](#string) | | The character_set is the character set of a database. |
+| collation | [string](#string) | | The collation is the collation of a database. |
+| extensions | [ExtensionMetadata](#bytebase-v1-ExtensionMetadata) | repeated | The extensions is the list of extensions in a database. |
+| owner | [string](#string) | | The owner of the database. |
+| search_path | [string](#string) | | The search_path is the search path of a PostgreSQL database. |
-<a name="bytebase-v1-TableCatalog"></a>
+<a name="bytebase-v1-DatabaseSDLSchema"></a>
-### TableCatalog
-Table metadata within a schema.
+### DatabaseSDLSchema
+DatabaseSDLSchema contains the schema in SDL format.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The table name. |
-| columns | [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns) | | Regular table columns. |
-| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | | Object schema for JSON/XML columns. |
-| classification | [string](#string) | | The data classification level for this table. |
+| schema | [bytes](#bytes) | | The SDL schema content. - For SINGLE_FILE format: contains the complete SDL schema as a text string. - For MULTI_FILE format: contains the ZIP archive as binary data. |
+| content_type | [string](#string) | | The MIME type of the schema content. Indicates how the client should interpret the schema field. Examples: - &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format - &#34;application/zip&#34; for MULTI_FILE format |
-<a name="bytebase-v1-TableCatalog-Columns"></a>
+<a name="bytebase-v1-DatabaseSchema"></a>
-### TableCatalog.Columns
-Column list for regular tables.
+### DatabaseSchema
+DatabaseSchema is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |
+| schema | [string](#string) | | The schema dump from database. |
-<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>
+<a name="bytebase-v1-DependencyColumn"></a>
-### UpdateDatabaseCatalogRequest
-Request message for updating a database catalog.
+### DependencyColumn
+DependencyColumn is the metadata for dependency columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.
+| schema | [string](#string) | | The schema is the schema of a reference column. |
+| table | [string](#string) | | The table is the table of a reference column. |
+| column | [string](#string) | | The column is the name of a reference column. |
-The catalog&#39;s `name` field is used to identify the database catalog to update. Format: instances/{instance}/databases/{database}/catalog |
-| allow_missing | [bool](#bool) | | If set to true, and the database catalog is not found, a new database catalog will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-DependencyTable"></a>
+### DependencyTable
-<a name="bytebase-v1-ObjectSchema-Type"></a>
-### ObjectSchema.Type
-Object schema data types.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| STRING | 1 | String type. |
-| NUMBER | 2 | Number type. |
-| BOOLEAN | 3 | Boolean type. |
-| OBJECT | 4 | Object/struct type. |
-| ARRAY | 5 | Array type. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| schema | [string](#string) | | The schema is the schema of a reference table. |
+| table | [string](#string) | | The table is the name of a reference table. |
-
-
-<a name="bytebase-v1-DatabaseCatalogService"></a>
-### DatabaseCatalogService
-DatabaseCatalogService manages database schema metadata and classification.
+<a name="bytebase-v1-DiffSchemaRequest"></a>
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetDatabaseCatalog | [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Gets the catalog metadata for a database. Permissions required: bb.databaseCatalogs.get |
-| UpdateDatabaseCatalog | [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Updates catalog metadata such as classifications and labels. Permissions required: bb.databaseCatalogs.update |
+### DiffSchemaRequest
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database or changelog. Format: database: instances/{instance}/databases/{database} changelog: instances/{instance}/databases/{database}/changelogs/{changelog} |
+| schema | [string](#string) | | The target schema. |
+| changelog | [string](#string) | | The resource name of the changelog Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-<a name="v1_database_group_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/database_group_service.proto
-<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>
-### CreateDatabaseGroupRequest
-Request message for creating a database group.
+<a name="bytebase-v1-DiffSchemaResponse"></a>
+
+### DiffSchemaResponse
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource where this database group will be created. Format: projects/{project} |
-| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to create. |
-| database_group_id | [string](#string) | | The ID to use for the database group, which will become the final component of the database group&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-| validate_only | [bool](#bool) | | If set, validate the create request and preview the full database group response, but do not actually create it. |
+| diff | [string](#string) | | |
-<a name="bytebase-v1-DatabaseGroup"></a>
+<a name="bytebase-v1-DimensionConstraint"></a>
-### DatabaseGroup
-A group of databases matched by expressions.
+### DimensionConstraint
+DimensionConstraint defines constraints for a spatial dimension.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database group. Format: projects/{project}/databaseGroups/{databaseGroup} |
-| title | [string](#string) | | The short name used in actual databases specified by users. |
-| database_expr | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this database group. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables: resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations. resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_labels: the database labels. Support map access operations. All variables should join with &#34;&amp;&amp;&#34; condition.
-
-For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;) resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; |
-| matched_databases | [DatabaseGroup.Database](#bytebase-v1-DatabaseGroup-Database) | repeated | The list of databases that match the database group condition. |
+| dimension | [string](#string) | | Dimension name/type (X, Y, Z, M, etc.) |
+| min_value | [double](#double) | | Minimum value for this dimension |
+| max_value | [double](#double) | | Maximum value for this dimension |
+| tolerance | [double](#double) | | Tolerance for this dimension |
-<a name="bytebase-v1-DatabaseGroup-Database"></a>
+<a name="bytebase-v1-DimensionalConfig"></a>
-### DatabaseGroup.Database
-A database within a database group.
+### DimensionalConfig
+DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |
+| dimensions | [int32](#int32) | | Number of dimensions (2-4, default 2) |
+| data_type | [string](#string) | | Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) |
+| srid | [int32](#int32) | | Spatial reference system identifier (SRID) |
+| constraints | [DimensionConstraint](#bytebase-v1-DimensionConstraint) | repeated | Coordinate system constraints |
-<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>
+<a name="bytebase-v1-EnumTypeMetadata"></a>
+
+### EnumTypeMetadata
-### DeleteDatabaseGroupRequest
-Request message for deleting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |
+| name | [string](#string) | | The name of a type. |
+| values | [string](#string) | repeated | The enum values of a type. |
+| comment | [string](#string) | | The comment describing the enum type. |
+| skip_dump | [bool](#bool) | | Whether to skip this enum type during schema dump operations. |
-<a name="bytebase-v1-GetDatabaseGroupRequest"></a>
+<a name="bytebase-v1-EventMetadata"></a>
+
+### EventMetadata
-### GetDatabaseGroupRequest
-Request message for getting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database group to retrieve. Format: projects/{project}/databaseGroups/{databaseGroup} |
-| view | [DatabaseGroupView](#bytebase-v1-DatabaseGroupView) | | The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. |
+| name | [string](#string) | | The name of the event. |
+| definition | [string](#string) | | The schedule of the event. |
+| time_zone | [string](#string) | | The time zone of the event. |
+| sql_mode | [string](#string) | | The SQL mode setting for the event. |
+| character_set_client | [string](#string) | | The character set used by the client creating the event. |
+| collation_connection | [string](#string) | | The collation used for the connection when creating the event. |
+| comment | [string](#string) | | The comment is the comment of an event. |
-<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>
+<a name="bytebase-v1-ExtensionMetadata"></a>
-### ListDatabaseGroupsRequest
-Request message for listing database groups.
+### ExtensionMetadata
+ExtensionMetadata is the metadata for extensions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource whose database groups are to be listed. Format: projects/{project} |
-| view | [DatabaseGroupView](#bytebase-v1-DatabaseGroupView) | | The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. |
+| name | [string](#string) | | The name is the name of an extension. |
+| schema | [string](#string) | | The schema is the extension that is installed to. But the extension usage is not limited to the schema. |
+| version | [string](#string) | | The version is the version of an extension. |
+| description | [string](#string) | | The description is the description of an extension. |
-<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>
+<a name="bytebase-v1-ExternalTableMetadata"></a>
+
+### ExternalTableMetadata
-### ListDatabaseGroupsResponse
-Response message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |
+| name | [string](#string) | | The name is the name of a external table. |
+| external_server_name | [string](#string) | | The external_server_name is the name of the external server. |
+| external_database_name | [string](#string) | | The external_database_name is the name of the external database. |
+| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a foreign table. |
-<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>
+<a name="bytebase-v1-ForeignKeyMetadata"></a>
-### UpdateDatabaseGroupRequest
-Request message for updating a database group.
+### ForeignKeyMetadata
+ForeignKeyMetadata is the metadata for foreign keys.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.
+| name | [string](#string) | | The name is the name of a foreign key. |
+| columns | [string](#string) | repeated | The columns are the ordered referencing columns of a foreign key. |
+| referenced_schema | [string](#string) | | The referenced_schema is the referenced schema name of a foreign key. It is an empty string for databases without such concept such as MySQL. |
+| referenced_table | [string](#string) | | The referenced_table is the referenced table name of a foreign key. |
+| referenced_columns | [string](#string) | repeated | The referenced_columns are the ordered referenced columns of a foreign key. |
+| on_delete | [string](#string) | | The on_delete is the on delete action of a foreign key. |
+| on_update | [string](#string) | | The on_update is the on update action of a foreign key. |
+| match_type | [string](#string) | | The match_type is the match type of a foreign key. The match_type is the PostgreSQL specific field. It&#39;s empty string for other databases. |
-The database group&#39;s `name` field is used to identify the database group to update. Format: projects/{project}/databaseGroups/{databaseGroup} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the database group is not found, a new database group will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-FunctionMetadata"></a>
+### FunctionMetadata
+FunctionMetadata is the metadata for functions.
-<a name="bytebase-v1-DatabaseGroupView"></a>
-### DatabaseGroupView
-View options for database group responses.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name is the name of a function. |
+| definition | [string](#string) | | The definition is the definition of a function. |
+| signature | [string](#string) | | The signature is the name with the number and type of input arguments the function takes. |
+| character_set_client | [string](#string) | | MySQL specific metadata. |
+| collation_connection | [string](#string) | | |
+| database_collation | [string](#string) | | |
+| sql_mode | [string](#string) | | |
+| comment | [string](#string) | | |
+| dependency_tables | [DependencyTable](#bytebase-v1-DependencyTable) | repeated | The dependency_tables is the list of dependency tables of a function. For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. |
+| skip_dump | [bool](#bool) | | |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| DATABASE_GROUP_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
-| DATABASE_GROUP_VIEW_BASIC | 1 | Include basic information about the database group, but exclude the list of matched databases and unmatched databases. |
-| DATABASE_GROUP_VIEW_FULL | 2 | Include everything. |
-
-
-<a name="bytebase-v1-DatabaseGroupService"></a>
+<a name="bytebase-v1-GenerationMetadata"></a>
-### DatabaseGroupService
-DatabaseGroupService manages database groups for organizing databases by criteria.
+### GenerationMetadata
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| ListDatabaseGroups | [ListDatabaseGroupsRequest](#bytebase-v1-ListDatabaseGroupsRequest) | [ListDatabaseGroupsResponse](#bytebase-v1-ListDatabaseGroupsResponse) | Lists database groups in a project. Permissions required: bb.databaseGroups.list |
-| GetDatabaseGroup | [GetDatabaseGroupRequest](#bytebase-v1-GetDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Gets a database group by name. Permissions required: bb.databaseGroups.get |
-| CreateDatabaseGroup | [CreateDatabaseGroupRequest](#bytebase-v1-CreateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Creates a new database group. Permissions required: bb.databaseGroups.create |
-| UpdateDatabaseGroup | [UpdateDatabaseGroupRequest](#bytebase-v1-UpdateDatabaseGroupRequest) | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | Updates a database group. Permissions required: bb.databaseGroups.update When allow_missing=true, also requires: bb.databaseGroups.create |
-| DeleteDatabaseGroup | [DeleteDatabaseGroupRequest](#bytebase-v1-DeleteDatabaseGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a database group. Permissions required: bb.databaseGroups.delete |
-
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |
+| expression | [string](#string) | | |
-<a name="v1_instance_role_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/instance_role_service.proto
+<a name="bytebase-v1-GetChangelogRequest"></a>
-<a name="bytebase-v1-InstanceRole"></a>
+### GetChangelogRequest
-### InstanceRole
-InstanceRole is the API message for instance role.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role. Format: instances/{instance}/roles/{role} The role name is the unique name for the role. |
-| role_name | [string](#string) | | The role name. It&#39;s unique within the instance. |
-| password | [string](#string) | optional | The role password. |
-| connection_limit | [int32](#int32) | optional | The connection count limit for this role. |
-| valid_until | [string](#string) | optional | The expiration for the role&#39;s password. |
-| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |
+| name | [string](#string) | | The name of the changelog to retrieve. Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
+| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
-<a name="bytebase-v1-ListInstanceRolesRequest"></a>
+<a name="bytebase-v1-GetDatabaseMetadataRequest"></a>
-### ListInstanceRolesRequest
+### GetDatabaseMetadataRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of roles. Format: instances/{instance} |
-| page_size | [int32](#int32) | | Not used. The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 10 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | Not used. A page token, received from a previous `ListInstanceRoles` call. Provide this to retrieve the subsequent page.
+| name | [string](#string) | | The name of the database to retrieve metadata. Format: instances/{instance}/databases/{database}/metadata |
+| filter | [string](#string) | | Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-When paginating, all other parameters provided to `ListInstanceRoles` must match the call that provided the page token. |
-| refresh | [bool](#bool) | | Refresh will refresh and return the latest data. |
+Supported filter: - schema: the schema name, support &#34;==&#34; operator. - table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+
+For example: schema == &#34;schema-a&#34; table == &#34;table-a&#34; table.matches(&#34;table-a&#34;) schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;) The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;. The column masking level will only be returned when a table filter is used. |
+| limit | [int32](#int32) | | Limit the response size of returned table metadata per schema. For example, if the database has 3 schemas, and each schema has 100 tables, if limit is 20, then only 20 tables will be returned for each schema, total 60 tables. Default 0, means no limit. |
-<a name="bytebase-v1-ListInstanceRolesResponse"></a>
+<a name="bytebase-v1-GetDatabaseRequest"></a>
-### ListInstanceRolesResponse
+### GetDatabaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | The roles from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
-
-
+| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |
-
-
-
-<a name="bytebase-v1-InstanceRoleService"></a>
+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>
-### InstanceRoleService
-InstanceRoleService manages database roles within instances.
+### GetDatabaseSDLSchemaRequest
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database to retrieve SDL schema. Format: instances/{instance}/databases/{database}/sdlSchema |
+| format | [GetDatabaseSDLSchemaRequest.SDLFormat](#bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat) | | The format of the SDL schema output. |
-<a name="v1_instance_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/instance_service.proto
-<a name="bytebase-v1-AddDataSourceRequest"></a>
+<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>
-### AddDataSourceRequest
+### GetDatabaseSchemaRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to add a data source to. Format: instances/{instance} |
-| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. Only READ_ONLY data source can be added. |
-| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
+| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |
-<a name="bytebase-v1-BatchSyncInstancesRequest"></a>
+<a name="bytebase-v1-GetSchemaStringRequest"></a>
-### BatchSyncInstancesRequest
+### GetSchemaStringRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| requests | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | repeated | The request message specifying the instances to sync. A maximum of 1000 instances can be synced in a batch. |
+| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} |
+| type | [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType) | | |
+| schema | [string](#string) | | It&#39;s empty for DATABASE. |
+| object | [string](#string) | | It&#39;s empty for DATABASE and SCHEMA. |
+| metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED. Also the schema and object are empty. |
-<a name="bytebase-v1-BatchSyncInstancesResponse"></a>
+<a name="bytebase-v1-GetSchemaStringResponse"></a>
-### BatchSyncInstancesResponse
+### GetSchemaStringResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| schema_string | [string](#string) | | |
-<a name="bytebase-v1-BatchUpdateInstancesRequest"></a>
-### BatchUpdateInstancesRequest
+<a name="bytebase-v1-GridLevel"></a>
+
+### GridLevel
+GridLevel defines a tessellation grid level with its density.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |
-
+| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |
+| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |
-<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>
-### BatchUpdateInstancesResponse
+<a name="bytebase-v1-IndexMetadata"></a>
+### IndexMetadata
+IndexMetadata is the metadata for indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instances | [Instance](#bytebase-v1-Instance) | repeated | |
+| name | [string](#string) | | The name is the name of an index. |
+| expressions | [string](#string) | repeated | The expressions are the ordered columns or expressions of an index. This could refer to a column or an expression. |
+| key_length | [int64](#int64) | repeated | The key_lengths are the ordered key lengths of an index. If the key length is not specified, it&#39;s -1. |
+| descending | [bool](#bool) | repeated | The descending is the ordered descending of an index. |
+| type | [string](#string) | | The type is the type of an index. |
+| unique | [bool](#bool) | | The unique is whether the index is unique. |
+| primary | [bool](#bool) | | The primary is whether the index is a primary key index. |
+| visible | [bool](#bool) | | The visible is whether the index is visible. |
+| comment | [string](#string) | | The comment is the comment of an index. |
+| definition | [string](#string) | | The definition of an index. |
+| parent_index_schema | [string](#string) | | The schema name of the parent index. |
+| parent_index_name | [string](#string) | | The index name of the parent index. |
+| granularity | [int64](#int64) | | The number of granules in the block. It&#39;s a ClickHouse specific field. |
+| is_constraint | [bool](#bool) | | It&#39;s a PostgreSQL specific field. The unique constraint and unique index are not the same thing in PostgreSQL. |
+| spatial_config | [SpatialIndexConfig](#bytebase-v1-SpatialIndexConfig) | | Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. |
+| opclass_names | [string](#string) | repeated | https://www.postgresql.org/docs/current/catalog-pg-opclass.html Name of the operator class for each column. (PostgreSQL specific). |
+| opclass_defaults | [bool](#bool) | repeated | True if the operator class is the default. (PostgreSQL specific). |
-<a name="bytebase-v1-CreateInstanceRequest"></a>
+<a name="bytebase-v1-ListChangelogsRequest"></a>
-### CreateInstanceRequest
+### ListChangelogsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instance | [Instance](#bytebase-v1-Instance) | | The instance to create. |
-| instance_id | [string](#string) | | The ID to use for the instance, which will become the final component of the instance&#39;s resource name.
+| parent | [string](#string) | | The parent of the changelogs. Format: instances/{instance}/databases/{database} |
+| page_size | [int32](#int32) | | The maximum number of changelogs to return. The service may return fewer than this value. If unspecified, at most 10 changelogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from the previous call. Provide this to retrieve the subsequent page.
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
+When paginating, all other parameters provided must match the call that provided the page token. |
+| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
+| filter | [string](#string) | | Filter is used to filter changelogs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values. type: the changelog type, support &#34;in&#34; and &#34;==&#34; operation. check Changelog.Type for available values.
+Example: status == &#34;DONE&#34; type in [&#34;BASELINE&#34;, &#34;MIGRATE&#34;] status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; |
-<a name="bytebase-v1-DataSource"></a>
-### DataSource
+<a name="bytebase-v1-ListChangelogsResponse"></a>
+
+### ListChangelogsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | The unique identifier for this data source. |
-| type | [DataSourceType](#bytebase-v1-DataSourceType) | | The type of data source (ADMIN or READ_ONLY). |
-| username | [string](#string) | | The username for database authentication. |
-| password | [string](#string) | | The password for database authentication. |
-| use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use system default SSL configuration. |
-| ssl_ca | [string](#string) | | The SSL certificate authority certificate. |
-| ssl_cert | [string](#string) | | The SSL client certificate. |
-| ssl_key | [string](#string) | | The SSL client private key. |
-| verify_tls_certificate | [bool](#bool) | | verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). |
-| host | [string](#string) | | The hostname or IP address of the database server. |
-| port | [string](#string) | | The port number of the database server. |
-| database | [string](#string) | | The name of the database to connect to. |
-| srv | [bool](#bool) | | srv, authentication_database and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record. |
-| authentication_database | [string](#string) | | authentication_database is the database name to authenticate against, which stores the user credentials. |
-| replica_set | [string](#string) | | replica_set is used for MongoDB replica set. |
-| sid | [string](#string) | | sid and service_name are used for Oracle. |
-| service_name | [string](#string) | | |
-| ssh_host | [string](#string) | | Connection over SSH. The hostname of the SSH server agent. Required. |
-| ssh_port | [string](#string) | | The port of the SSH server agent. It&#39;s 22 typically. Required. |
-| ssh_user | [string](#string) | | The user to login the server. Required. |
-| ssh_password | [string](#string) | | The password to login the server. If it&#39;s empty string, no password is required. |
-| ssh_private_key | [string](#string) | | The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). |
-| authentication_private_key | [string](#string) | | PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required. Used for authentication when connecting to the data source. |
-| authentication_private_key_passphrase | [string](#string) | | Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. |
-| external_secret | [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret) | | |
-| authentication_type | [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType) | | |
-| azure_credential | [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential) | | |
-| aws_credential | [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential) | | |
-| gcp_credential | [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential) | | |
-| sasl_config | [SASLConfig](#bytebase-v1-SASLConfig) | | |
-| additional_addresses | [DataSource.Address](#bytebase-v1-DataSource-Address) | repeated | additional_addresses is used for MongoDB replica set. |
-| direct_connection | [bool](#bool) | | direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. |
-| region | [string](#string) | | region is the location of where the DB is, works for AWS RDS. For example, us-east-1. |
-| warehouse_id | [string](#string) | | warehouse_id is used by Databricks. |
-| master_name | [string](#string) | | master_name is the master name used by connecting redis-master via redis sentinel. |
-| master_username | [string](#string) | | master_username and master_password are master credentials used by redis sentinel mode. |
-| master_password | [string](#string) | | |
-| redis_type | [DataSource.RedisType](#bytebase-v1-DataSource-RedisType) | | |
-| cluster | [string](#string) | | Cluster is the cluster name for the data source. Used by CockroachDB. |
-| extra_connection_parameters | [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry) | repeated | Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write |
+| changelogs | [Changelog](#bytebase-v1-Changelog) | repeated | The list of changelogs. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-DataSource-AWSCredential"></a>
+<a name="bytebase-v1-ListDatabasesRequest"></a>
-### DataSource.AWSCredential
+### ListDatabasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| access_key_id | [string](#string) | | |
-| secret_access_key | [string](#string) | | |
-| session_token | [string](#string) | | |
-| role_arn | [string](#string) | | ARN of IAM role to assume for cross-account access. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html |
-| external_id | [string](#string) | | Optional external ID for additional security when assuming role. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html |
-
-
-
-
-
-
-<a name="bytebase-v1-DataSource-Address"></a>
+| parent | [string](#string) | | - projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission. - workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission. - instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission |
+| page_size | [int32](#int32) | | The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.
-### DataSource.Address
+When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - name: the database name, support &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator. - drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator. - table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator. - labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+For example: environment == &#34;environments/{environment resource id}&#34; environment == &#34;&#34; (find databases which environment is not set) project == &#34;projects/{project resource id}&#34; instance == &#34;instances/{instance resource id}&#34; name.matches(&#34;database name&#34;) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) exclude_unassigned == true drifted == true table == &#34;sample&#34; table.matches(&#34;sam&#34;) labels.environment == &#34;production&#34; labels.region == &#34;asia&#34; labels.region in [&#34;asia&#34;, &#34;europe&#34;]
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| host | [string](#string) | | |
-| port | [string](#string) | | |
+You can combine filter conditions like: environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) |
+| show_deleted | [bool](#bool) | | Show deleted database if specified. |
+| order_by | [string](#string) | | The order by of databases. Support name, project, instance. The default sorting order is ascending. For example: - order_by = &#34;name&#34; - order by name ascending - order_by = &#34;name desc&#34; - order_by = &#34;name desc, project asc&#34; |
-<a name="bytebase-v1-DataSource-AzureCredential"></a>
+<a name="bytebase-v1-ListDatabasesResponse"></a>
-### DataSource.AzureCredential
+### ListDatabasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| tenant_id | [string](#string) | | |
-| client_id | [string](#string) | | |
-| client_secret | [string](#string) | | |
-
+| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>
-### DataSource.ExtraConnectionParametersEntry
+<a name="bytebase-v1-MaterializedViewMetadata"></a>
+### MaterializedViewMetadata
+MaterializedViewMetadata is the metadata for materialized views.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
-
+| name | [string](#string) | | The name is the name of a materialized view. |
+| definition | [string](#string) | | The definition is the definition of a materialized view. |
+| comment | [string](#string) | | The comment is the comment of a materialized view. |
+| dependency_columns | [DependencyColumn](#bytebase-v1-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a materialized view. |
+| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The columns is the ordered list of columns in a table. |
+| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | The indexes is the list of indexes in a table. |
+| skip_dump | [bool](#bool) | | |
-<a name="bytebase-v1-DataSource-GCPCredential"></a>
-### DataSource.GCPCredential
+<a name="bytebase-v1-PackageMetadata"></a>
+### PackageMetadata
+PackageMetadata is the metadata for packages.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [string](#string) | | |
-
+| name | [string](#string) | | The name is the name of a package. |
+| definition | [string](#string) | | The definition is the definition of a package. |
-<a name="bytebase-v1-DataSourceExternalSecret"></a>
-### DataSourceExternalSecret
+<a name="bytebase-v1-ProcedureMetadata"></a>
+### ProcedureMetadata
+ProcedureMetadata is the metadata for procedures.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| secret_type | [DataSourceExternalSecret.SecretType](#bytebase-v1-DataSourceExternalSecret-SecretType) | | The type of external secret store. |
-| url | [string](#string) | | The URL of the external secret store. |
-| auth_type | [DataSourceExternalSecret.AuthType](#bytebase-v1-DataSourceExternalSecret-AuthType) | | The authentication method for accessing the secret store. |
-| app_role | [DataSourceExternalSecret.AppRoleAuthOption](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption) | | AppRole authentication configuration. |
-| token | [string](#string) | | Token for direct authentication. |
-| engine_name | [string](#string) | | engine name is the name for secret engine. |
-| secret_name | [string](#string) | | the secret name in the engine to store the password. |
-| password_key_name | [string](#string) | | the key name for the password. |
-| skip_vault_tls_verification | [bool](#bool) | | TLS configuration for connecting to Vault server. These fields are separate from the database TLS configuration in DataSource. skip_vault_tls_verification disables TLS certificate verification for Vault connections. Default is false (verification enabled) for security. Only set to true for development or when certificates cannot be properly validated. |
-| vault_ssl_ca | [string](#string) | | CA certificate for Vault server verification. |
-| vault_ssl_cert | [string](#string) | | Client certificate for mutual TLS authentication with Vault. |
-| vault_ssl_key | [string](#string) | | Client private key for mutual TLS authentication with Vault. |
-
+| name | [string](#string) | | The name is the name of a procedure. |
+| definition | [string](#string) | | The definition is the definition of a procedure. |
+| signature | [string](#string) | | The signature is the name with the number and type of input arguments the procedure takes. |
+| character_set_client | [string](#string) | | MySQL specific metadata. |
+| collation_connection | [string](#string) | | |
+| database_collation | [string](#string) | | |
+| sql_mode | [string](#string) | | |
+| comment | [string](#string) | | The comment is the comment of a procedure. |
+| skip_dump | [bool](#bool) | | |
-<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption"></a>
-### DataSourceExternalSecret.AppRoleAuthOption
+<a name="bytebase-v1-SchemaMetadata"></a>
+### SchemaMetadata
+SchemaMetadata is the metadata for schemas.
+This is the concept of schema in Postgres, but it&#39;s a no-op for MySQL.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role_id | [string](#string) | | The role ID for Vault AppRole authentication. |
-| secret_id | [string](#string) | | the secret id for the role without ttl. |
-| type | [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType) | | The type of secret for AppRole authentication. |
-| mount_path | [string](#string) | | The path where the approle auth method is mounted. |
+| name | [string](#string) | | The name is the schema name. It is an empty string for databases without such concept such as MySQL. |
+| tables | [TableMetadata](#bytebase-v1-TableMetadata) | repeated | The tables is the list of tables in a schema. |
+| external_tables | [ExternalTableMetadata](#bytebase-v1-ExternalTableMetadata) | repeated | The external_tables is the list of external tables in a schema. |
+| views | [ViewMetadata](#bytebase-v1-ViewMetadata) | repeated | The views is the list of views in a schema. |
+| functions | [FunctionMetadata](#bytebase-v1-FunctionMetadata) | repeated | The functions is the list of functions in a schema. |
+| procedures | [ProcedureMetadata](#bytebase-v1-ProcedureMetadata) | repeated | The procedures is the list of procedures in a schema. |
+| streams | [StreamMetadata](#bytebase-v1-StreamMetadata) | repeated | The streams is the list of streams in a schema, currently, only used for Snowflake. |
+| tasks | [TaskMetadata](#bytebase-v1-TaskMetadata) | repeated | The routines is the list of routines in a schema, currently, only used for Snowflake. |
+| materialized_views | [MaterializedViewMetadata](#bytebase-v1-MaterializedViewMetadata) | repeated | The materialized_views is the list of materialized views in a schema. |
+| packages | [PackageMetadata](#bytebase-v1-PackageMetadata) | repeated | The packages is the list of packages in a schema. |
+| owner | [string](#string) | | The owner of the schema. |
+| sequences | [SequenceMetadata](#bytebase-v1-SequenceMetadata) | repeated | The sequences is the list of sequences in a schema, sorted by name. |
+| events | [EventMetadata](#bytebase-v1-EventMetadata) | repeated | The events is the list of scheduled events in a schema. |
+| enum_types | [EnumTypeMetadata](#bytebase-v1-EnumTypeMetadata) | repeated | The enum_types is the list of user-defined enum types in a schema. |
+| skip_dump | [bool](#bool) | | Whether to skip this schema during schema dump operations. |
+| comment | [string](#string) | | The comment is the comment of a schema. |
-<a name="bytebase-v1-DeleteInstanceRequest"></a>
+<a name="bytebase-v1-SequenceMetadata"></a>
-### DeleteInstanceRequest
+### SequenceMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to delete. Format: instances/{instance} |
-| force | [bool](#bool) | | If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. |
-| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted instance and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted instances. The instance must already be soft-deleted for this to work. |
-
+| name | [string](#string) | | The name of a sequence. |
+| data_type | [string](#string) | | The data type of a sequence. |
+| start | [string](#string) | | The start value of a sequence. |
+| min_value | [string](#string) | | The minimum value of a sequence. |
+| max_value | [string](#string) | | The maximum value of a sequence. |
+| increment | [string](#string) | | Increment value of a sequence. |
+| cycle | [bool](#bool) | | Cycle is whether the sequence cycles. |
+| cache_size | [string](#string) | | Cache size of a sequence. |
+| last_value | [string](#string) | | Last value of a sequence. |
+| owner_table | [string](#string) | | The owner table of the sequence. |
+| owner_column | [string](#string) | | The owner column of the sequence. |
+| comment | [string](#string) | | The comment describing the sequence. |
+| skip_dump | [bool](#bool) | | Whether to skip this sequence during schema dump operations. |
-<a name="bytebase-v1-GetInstanceRequest"></a>
-### GetInstanceRequest
+<a name="bytebase-v1-SpatialIndexConfig"></a>
+### SpatialIndexConfig
+SpatialIndexConfig defines the spatial index configuration for spatial databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |
+| method | [string](#string) | | Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) |
+| tessellation | [TessellationConfig](#bytebase-v1-TessellationConfig) | | Tessellation configuration for grid-based spatial indexes |
+| storage | [StorageConfig](#bytebase-v1-StorageConfig) | | Storage and performance configuration |
+| dimensional | [DimensionalConfig](#bytebase-v1-DimensionalConfig) | | Dimensional configuration |
-<a name="bytebase-v1-Instance"></a>
-
-### Instance
+<a name="bytebase-v1-StorageConfig"></a>
+### StorageConfig
+StorageConfig defines storage and performance parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |
-| title | [string](#string) | | The display title of the instance. |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
-| engine_version | [string](#string) | | The version of the database engine. |
-| external_link | [string](#string) | | External URL to the database instance console. |
-| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. |
-| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-| activation | [bool](#bool) | | Whether the instance is activated for use. |
-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. |
-| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |
-| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas &amp; databases. |
-| last_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the instance was synced. |
-| labels | [Instance.LabelsEntry](#bytebase-v1-Instance-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the instance. For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } |
+| fillfactor | [int32](#int32) | | Fill factor percentage (1-100) |
+| buffering | [string](#string) | | Buffering mode for PostgreSQL (auto, on, off) |
+| tablespace | [string](#string) | | Tablespace configuration for Oracle |
+| work_tablespace | [string](#string) | | |
+| sdo_level | [int32](#int32) | | |
+| commit_interval | [int32](#int32) | | |
+| pad_index | [bool](#bool) | | SQL Server specific parameters |
+| sort_in_tempdb | [string](#string) | | ON, OFF |
+| drop_existing | [bool](#bool) | | |
+| online | [bool](#bool) | | |
+| allow_row_locks | [bool](#bool) | | |
+| allow_page_locks | [bool](#bool) | | |
+| maxdop | [int32](#int32) | | |
+| data_compression | [string](#string) | | NONE, ROW, PAGE |
-<a name="bytebase-v1-Instance-LabelsEntry"></a>
+<a name="bytebase-v1-StreamMetadata"></a>
-### Instance.LabelsEntry
+### StreamMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| name | [string](#string) | | The name is the name of a stream. |
+| table_name | [string](#string) | | The table_name is the name of the table/view that the stream is created on. |
+| owner | [string](#string) | | The owner of the stream. |
+| comment | [string](#string) | | The comment of the stream. |
+| type | [StreamMetadata.Type](#bytebase-v1-StreamMetadata-Type) | | The type of the stream. |
+| stale | [bool](#bool) | | Indicates whether the stream was last read before the `stale_after` time. |
+| mode | [StreamMetadata.Mode](#bytebase-v1-StreamMetadata-Mode) | | The mode of the stream. |
+| definition | [string](#string) | | The definition of the stream. |
-<a name="bytebase-v1-InstanceResource"></a>
+<a name="bytebase-v1-SyncDatabaseRequest"></a>
-### InstanceResource
+### SyncDatabaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| title | [string](#string) | | The display title of the instance. |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
-| engine_version | [string](#string) | | The version of the database engine. |
-| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for the instance. |
-| activation | [bool](#bool) | | Whether the instance is activated. |
-| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
-| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-
-
-
+| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |
-<a name="bytebase-v1-KerberosConfig"></a>
-### KerberosConfig
+<a name="bytebase-v1-SyncDatabaseResponse"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| primary | [string](#string) | | The primary component of the Kerberos principal. |
-| instance | [string](#string) | | The instance component of the Kerberos principal. |
-| realm | [string](#string) | | The Kerberos realm. |
-| keytab | [bytes](#bytes) | | The keytab file contents for authentication. |
-| kdc_host | [string](#string) | | The hostname of the Key Distribution Center (KDC). |
-| kdc_port | [string](#string) | | The port of the Key Distribution Center (KDC). |
-| kdc_transport_protocol | [string](#string) | | The transport protocol for KDC communication (tcp or udp). |
+### SyncDatabaseResponse
-<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>
-### ListInstanceDatabaseRequest
+<a name="bytebase-v1-TableMetadata"></a>
+### TableMetadata
+TableMetadata is the metadata for tables.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
-| instance | [Instance](#bytebase-v1-Instance) | optional | The target instance. We need to set this field if the target instance is not created yet. |
-
+| name | [string](#string) | | The name is the name of a table. |
+| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. |
+| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | The indexes is the list of indexes in a table. |
+| engine | [string](#string) | | The engine is the engine of a table. |
+| collation | [string](#string) | | The collation is the collation of a table. |
+| charset | [string](#string) | | The character set of table. |
+| row_count | [int64](#int64) | | The row_count is the estimated number of rows of a table. |
+| data_size | [int64](#int64) | | The data_size is the estimated data size of a table. |
+| index_size | [int64](#int64) | | The index_size is the estimated index size of a table. |
+| data_free | [int64](#int64) | | The data_free is the estimated free data size of a table. |
+| create_options | [string](#string) | | The create_options is the create option of a table. |
+| comment | [string](#string) | | The comment is the comment of a table. |
+| foreign_keys | [ForeignKeyMetadata](#bytebase-v1-ForeignKeyMetadata) | repeated | The foreign_keys is the list of foreign keys in a table. |
+| partitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The partitions is the list of partitions in a table. |
+| check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | The check_constraints is the list of check constraints in a table. |
+| owner | [string](#string) | | The owner of the table. |
+| sorting_keys | [string](#string) | repeated | The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field. Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by |
+| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The triggers is the list of triggers associated with the table. |
+| skip_dump | [bool](#bool) | | Whether to skip this table during schema dump operations. |
+| sharding_info | [string](#string) | | https://docs.pingcap.com/tidb/stable/information-schema-tables/ |
+| primary_key_type | [string](#string) | | https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes CLUSTERED or NONCLUSTERED. |
-<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>
-### ListInstanceDatabaseResponse
+<a name="bytebase-v1-TablePartitionMetadata"></a>
+### TablePartitionMetadata
+TablePartitionMetadata is the metadata for table partitions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [string](#string) | repeated | All database name list in the instance. |
+| name | [string](#string) | | The name is the name of a table partition. |
+| type | [TablePartitionMetadata.Type](#bytebase-v1-TablePartitionMetadata-Type) | | The type of a table partition. |
+| expression | [string](#string) | | The expression is the expression of a table partition. For PostgreSQL, the expression is the text of {FOR VALUES partition_bound_spec}, see https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL, the expression is the `expr` or `column_list` of the following syntax. PARTITION BY { [LINEAR] HASH(expr) | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) | RANGE{(expr) | COLUMNS(column_list)} | LIST{(expr) | COLUMNS(column_list)} }. |
+| value | [string](#string) | | The value is the value of a table partition. For MySQL, the value is for RANGE and LIST partition types, - For a RANGE partition, it contains the value set in the partition&#39;s VALUES LESS THAN clause, which can be either an integer or MAXVALUE. - For a LIST partition, this column contains the values defined in the partition&#39;s VALUES IN clause, which is a list of comma-separated integer values. - For others, it&#39;s an empty string. |
+| use_default | [string](#string) | | The use_default is whether the users use the default partition, it stores the different value for different database engines. For MySQL, it&#39;s [INT] type, 0 means not use default partition, otherwise, it&#39;s equals to number in syntax [SUB]PARTITION {number}. |
+| subpartitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The subpartitions is the list of subpartitions in a table partition. |
+| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | |
+| check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | |
-<a name="bytebase-v1-ListInstancesRequest"></a>
+<a name="bytebase-v1-TaskMetadata"></a>
-### ListInstancesRequest
+### TaskMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 10 instances will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListInstances` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListInstances` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted instances if specified. |
-| filter | [string](#string) | | Filter the instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator. - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - state: the instance state, check State enum for values, support &#34;==&#34; operator. - engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator. - port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example: name == &#34;sample instance&#34; name.matches(&#34;sample&#34;) resource_id == &#34;sample-instance&#34; resource_id.matches(&#34;sample&#34;) state == &#34;DELETED&#34; environment == &#34;environments/test&#34; environment == &#34;&#34; (find instances which environment is not set) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) host == &#34;127.0.0.1&#34; host.matches(&#34;127.0&#34;) port == &#34;54321&#34; port.matches(&#34;543&#34;) labels.org_group == &#34;infrastructure&#34; labels.environment in [&#34;prod&#34;, &#34;production&#34;] project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34; host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; |
-| order_by | [string](#string) | | The order by of instances. Support title, environment. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title desc, environment asc&#34; |
-
+| name | [string](#string) | | The name is the name of a task. |
+| id | [string](#string) | | The id is the snowflake-generated id of a task. Example: 01ad32a0-1bb6-5e93-0000-000000000001 |
+| owner | [string](#string) | | The owner of the task. |
+| comment | [string](#string) | | The comment of the task. |
+| warehouse | [string](#string) | | The warehouse of the task. |
+| schedule | [string](#string) | | The schedule interval of the task. |
+| predecessors | [string](#string) | repeated | The predecessor tasks of the task. |
+| state | [TaskMetadata.State](#bytebase-v1-TaskMetadata-State) | | The state of the task. |
+| condition | [string](#string) | | The condition of the task. |
+| definition | [string](#string) | | The definition of the task. |
-<a name="bytebase-v1-ListInstancesResponse"></a>
-### ListInstancesResponse
+<a name="bytebase-v1-TessellationConfig"></a>
+### TessellationConfig
+TessellationConfig defines tessellation parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instances | [Instance](#bytebase-v1-Instance) | repeated | The instances from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| scheme | [string](#string) | | Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) |
+| grid_levels | [GridLevel](#bytebase-v1-GridLevel) | repeated | Grid levels and densities for multi-level tessellation |
+| cells_per_object | [int32](#int32) | | Number of cells per object (1-8192 for SQL Server) |
+| bounding_box | [BoundingBox](#bytebase-v1-BoundingBox) | | Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) |
-<a name="bytebase-v1-RemoveDataSourceRequest"></a>
+<a name="bytebase-v1-TriggerMetadata"></a>
-### RemoveDataSourceRequest
+### TriggerMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to remove a data source from. Format: instances/{instance} |
-| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. Only READ_ONLY data source can be removed. |
+| name | [string](#string) | | The name is the name of the trigger. |
+| event | [string](#string) | | The event is the event of the trigger, such as INSERT, UPDATE, DELETE, TRUNCATE. |
+| timing | [string](#string) | | The timing is the timing of the trigger, such as BEFORE, AFTER. |
+| body | [string](#string) | | The body is the body of the trigger. |
+| sql_mode | [string](#string) | | The SQL mode setting for the trigger. |
+| character_set_client | [string](#string) | | The character set used by the client creating the trigger. |
+| collation_connection | [string](#string) | | The collation used for the connection when creating the trigger. |
+| comment | [string](#string) | | The comment describing the trigger. |
+| skip_dump | [bool](#bool) | | Whether to skip this trigger during schema dump operations. |
-<a name="bytebase-v1-SASLConfig"></a>
+<a name="bytebase-v1-UpdateDatabaseRequest"></a>
-### SASLConfig
+### UpdateDatabaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |
+| database | [Database](#bytebase-v1-Database) | | The database to update.
+The database&#39;s `name` field is used to identify the database to update. Format: instances/{instance}/databases/{database} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the database is not found, a new database will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-SyncInstanceRequest"></a>
-### SyncInstanceRequest
+<a name="bytebase-v1-ViewMetadata"></a>
+### ViewMetadata
+ViewMetadata is the metadata for views.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of instance. Format: instances/{instance} |
-| enable_full_sync | [bool](#bool) | | When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only the instance metadata (such as the database list) and any newly discovered databases will be synced. |
-
+| name | [string](#string) | | The name is the name of a view. |
+| definition | [string](#string) | | The definition is the definition of a view. |
+| comment | [string](#string) | | The comment is the comment of a view. |
+| dependency_columns | [DependencyColumn](#bytebase-v1-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a view. |
+| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. |
+| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The triggers is the list of triggers in a view. |
+| skip_dump | [bool](#bool) | | |
-<a name="bytebase-v1-SyncInstanceResponse"></a>
+
-### SyncInstanceResponse
+<a name="bytebase-v1-Changelog-Status"></a>
+### Changelog.Status
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| databases | [string](#string) | repeated | All database name list in the instance. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | |
+| PENDING | 1 | |
+| DONE | 2 | |
+| FAILED | 3 | |
+<a name="bytebase-v1-Changelog-Type"></a>
+### Changelog.Type
-<a name="bytebase-v1-UndeleteInstanceRequest"></a>
-### UndeleteInstanceRequest
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| BASELINE | 1 | |
+| MIGRATE | 2 | |
+| SDL | 3 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |
+<a name="bytebase-v1-ChangelogView"></a>
+### ChangelogView
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| CHANGELOG_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
+| CHANGELOG_VIEW_BASIC | 1 | |
+| CHANGELOG_VIEW_FULL | 2 | |
-<a name="bytebase-v1-UpdateDataSourceRequest"></a>
+<a name="bytebase-v1-ColumnMetadata-IdentityGeneration"></a>
-### UpdateDataSourceRequest
+### ColumnMetadata.IdentityGeneration
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDENTITY_GENERATION_UNSPECIFIED | 0 | |
+| ALWAYS | 1 | |
+| BY_DEFAULT | 2 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to update a data source. Format: instances/{instance} |
-| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
-| allow_missing | [bool](#bool) | | If set to true, and the data source is not found, a new data source will be created. In this situation, `update_mask` is ignored. |
+<a name="bytebase-v1-GenerationMetadata-Type"></a>
+### GenerationMetadata.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| VIRTUAL | 1 | |
+| STORED | 2 | |
-<a name="bytebase-v1-UpdateInstanceRequest"></a>
-### UpdateInstanceRequest
+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat"></a>
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.
-
-The instance&#39;s `name` field is used to identify the instance to update. Format: instances/{instance} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the instance is not found, a new instance will be created. In this situation, `update_mask` is ignored. |
-
-
-
-
-
-
-
-
-<a name="bytebase-v1-DataSource-AuthenticationType"></a>
-
-### DataSource.AuthenticationType
-
+### GetDatabaseSDLSchemaRequest.SDLFormat
+SDLFormat specifies the output format for SDL schema.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| AUTHENTICATION_UNSPECIFIED | 0 | |
-| PASSWORD | 1 | |
-| GOOGLE_CLOUD_SQL_IAM | 2 | |
-| AWS_RDS_IAM | 3 | |
-| AZURE_IAM | 4 | |
+| SDL_FORMAT_UNSPECIFIED | 0 | Unspecified format. Defaults to SINGLE_FILE. |
+| SINGLE_FILE | 1 | Single file format: returns the complete SDL schema as a single file. |
+| MULTI_FILE | 2 | Multi-file format: returns the SDL schema as a ZIP archive containing multiple files organized by schema objects (tables, views, functions, etc.). |
-<a name="bytebase-v1-DataSource-RedisType"></a>
+<a name="bytebase-v1-GetSchemaStringRequest-ObjectType"></a>
-### DataSource.RedisType
+### GetSchemaStringRequest.ObjectType
| Name | Number | Description |
| ---- | ------ | ----------- |
-| REDIS_TYPE_UNSPECIFIED | 0 | |
-| STANDALONE | 1 | |
-| SENTINEL | 2 | |
-| CLUSTER | 3 | |
+| OBJECT_TYPE_UNSPECIFIED | 0 | |
+| DATABASE | 1 | |
+| SCHEMA | 2 | |
+| TABLE | 3 | |
+| VIEW | 4 | |
+| MATERIALIZED_VIEW | 5 | |
+| FUNCTION | 6 | |
+| PROCEDURE | 7 | |
+| SEQUENCE | 8 | |
-<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>
+<a name="bytebase-v1-StreamMetadata-Mode"></a>
-### DataSourceExternalSecret.AppRoleAuthOption.SecretType
+### StreamMetadata.Mode
| Name | Number | Description |
| ---- | ------ | ----------- |
-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
-| PLAIN | 1 | Plain text secret. |
-| ENVIRONMENT | 2 | Secret from environment variable. |
+| MODE_UNSPECIFIED | 0 | |
+| DEFAULT | 1 | |
+| APPEND_ONLY | 2 | |
+| INSERT_ONLY | 3 | |
-<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></a>
+<a name="bytebase-v1-StreamMetadata-Type"></a>
-### DataSourceExternalSecret.AuthType
+### StreamMetadata.Type
| Name | Number | Description |
| ---- | ------ | ----------- |
-| AUTH_TYPE_UNSPECIFIED | 0 | Unspecified authentication type. |
-| TOKEN | 1 | ref: https://developer.hashicorp.com/vault/docs/auth/token |
-| VAULT_APP_ROLE | 2 | ref: https://developer.hashicorp.com/vault/docs/auth/approle |
-
+| TYPE_UNSPECIFIED | 0 | |
+| DELTA | 1 | |
-<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>
-### DataSourceExternalSecret.SecretType
+<a name="bytebase-v1-TablePartitionMetadata-Type"></a>
+### TablePartitionMetadata.Type
+Type is the type of a table partition, some database engines may not
+support all types. Only avilable for the following database engines now:
+MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,
+LINEAR_KEY
+(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:
+RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,
+LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)
| Name | Number | Description |
| ---- | ------ | ----------- |
-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
-| VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 |
-| AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html |
-| GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |
-| AZURE_KEY_VAULT | 4 | ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets |
+| TYPE_UNSPECIFIED | 0 | |
+| RANGE | 1 | |
+| RANGE_COLUMNS | 2 | |
+| LIST | 3 | |
+| LIST_COLUMNS | 4 | |
+| HASH | 5 | |
+| LINEAR_HASH | 6 | |
+| KEY | 7 | |
+| LINEAR_KEY | 8 | |
-<a name="bytebase-v1-DataSourceType"></a>
+<a name="bytebase-v1-TaskMetadata-State"></a>
-### DataSourceType
+### TaskMetadata.State
| Name | Number | Description |
| ---- | ------ | ----------- |
-| DATA_SOURCE_UNSPECIFIED | 0 | Unspecified data source type. |
-| ADMIN | 1 | Admin data source with write permissions. |
-| READ_ONLY | 2 | Read-only data source for query operations. |
+| STATE_UNSPECIFIED | 0 | |
+| STARTED | 1 | |
+| SUSPENDED | 2 | |
@@ -4436,1544 +4436,1466 @@ The instance&#39;s `name` field is used to identify the instance to update. Form
-<a name="bytebase-v1-InstanceService"></a>
+<a name="bytebase-v1-DatabaseService"></a>
-### InstanceService
-InstanceService manages database instances and their connections.
+### DatabaseService
+DatabaseService manages databases and their schemas.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Gets a database instance by name. Permissions required: bb.instances.get |
-| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Lists all database instances. Permissions required: bb.instances.list |
-| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Creates a new database instance. Permissions required: bb.instances.create |
-| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Updates a database instance. Permissions required: bb.instances.update |
-| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete |
-| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Restores a soft-deleted database instance. Permissions required: bb.instances.undelete |
-| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync |
-| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Lists all databases within an instance without creating them. Permissions required: bb.instances.get |
-| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Syncs multiple instances in a single request. Permissions required: bb.instances.sync |
-| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Updates multiple instances in a single request. Permissions required: bb.instances.update |
-| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Adds a read-only data source to an instance. Permissions required: bb.instances.update |
-| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Removes a read-only data source from an instance. Permissions required: bb.instances.update |
-| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Updates a data source configuration. Permissions required: bb.instances.update |
+| GetDatabase | [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest) | [Database](#bytebase-v1-Database) | Retrieves a database by name. Permissions required: bb.databases.get |
+| BatchGetDatabases | [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest) | [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse) | Retrieves multiple databases by their names. Permissions required: bb.databases.get |
+| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Lists databases in a project, instance, or workspace. Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent) |
+| UpdateDatabase | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | [Database](#bytebase-v1-Database) | Updates database properties such as labels and project assignment. Permissions required: bb.databases.update |
+| BatchUpdateDatabases | [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest) | [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse) | Updates multiple databases in a single batch operation. Permissions required: bb.databases.update |
+| SyncDatabase | [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest) | [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse) | Synchronizes database schema from the instance. Permissions required: bb.databases.sync |
+| BatchSyncDatabases | [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest) | [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse) | Synchronizes multiple databases in a single batch operation. Permissions required: bb.databases.sync |
+| GetDatabaseMetadata | [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest) | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | Retrieves database metadata including tables, columns, and indexes. Permissions required: bb.databases.getSchema |
+| GetDatabaseSchema | [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest) | [DatabaseSchema](#bytebase-v1-DatabaseSchema) | Retrieves database schema as DDL statements. Permissions required: bb.databases.getSchema |
+| GetDatabaseSDLSchema | [GetDatabaseSDLSchemaRequest](#bytebase-v1-GetDatabaseSDLSchemaRequest) | [DatabaseSDLSchema](#bytebase-v1-DatabaseSDLSchema) | Retrieves database schema in SDL (Schema Definition Language) format. Permissions required: bb.databases.getSchema |
+| DiffSchema | [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest) | [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse) | Compares and generates migration statements between two schemas. Permissions required: bb.databases.get |
+| ListChangelogs | [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest) | [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse) | Lists migration history for a database. Permissions required: bb.changelogs.list |
+| GetChangelog | [GetChangelogRequest](#bytebase-v1-GetChangelogRequest) | [Changelog](#bytebase-v1-Changelog) | Retrieves a specific changelog entry. Permissions required: bb.changelogs.get |
+| GetSchemaString | [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest) | [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse) | Generates schema DDL for a database object. Permissions required: bb.databases.getSchema |
-<a name="v1_database_service-proto"></a>
+<a name="v1_group_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/database_service.proto
-
+## v1/group_service.proto
-<a name="bytebase-v1-BatchGetDatabasesRequest"></a>
-### BatchGetDatabasesRequest
+<a name="bytebase-v1-BatchGetGroupsRequest"></a>
+### BatchGetGroupsRequest
+Request message for batch getting groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all databases being retrieved. - projects/{project}: batch get databases in a project; - instances/{instances}: batch get databases in a instance; Use &#34;-&#34; as wildcard to batch get databases across parent. |
-| names | [string](#string) | repeated | The list of database names to retrieve. |
-
+| names | [string](#string) | repeated | The group names to retrieve. Format: groups/{email} |
-<a name="bytebase-v1-BatchGetDatabasesResponse"></a>
-### BatchGetDatabasesResponse
+<a name="bytebase-v1-BatchGetGroupsResponse"></a>
+### BatchGetGroupsResponse
+Response message for batch getting groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-
+| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |
-<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>
-### BatchSyncDatabasesRequest
+<a name="bytebase-v1-CreateGroupRequest"></a>
+### CreateGroupRequest
+Request message for creating a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all databases being updated. Format: instances/{instance} If the operation spans parents, a dash (-) may be accepted as a wildcard. |
-| names | [string](#string) | repeated | The list of database names to sync. |
+| group | [Group](#bytebase-v1-Group) | | The group to create. |
+| group_email | [string](#string) | | The email to use for the group, which will become the final component of the group&#39;s resource name. |
-<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>
+<a name="bytebase-v1-DeleteGroupRequest"></a>
-### BatchSyncDatabasesResponse
+### DeleteGroupRequest
+Request message for deleting a group.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the group to delete. Format: groups/{email} |
-<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>
-### BatchUpdateDatabasesRequest
+<a name="bytebase-v1-GetGroupRequest"></a>
+### GetGroupRequest
+Request message for getting a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all databases being updated. Format: instances/{instance} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the project of databases for now. |
-| requests | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | repeated | The request message specifying the resources to update. A maximum of 1000 databases can be modified in a batch. |
-
+| name | [string](#string) | | The name of the group to retrieve. Format: groups/{email} |
-<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>
-### BatchUpdateDatabasesResponse
+<a name="bytebase-v1-Group"></a>
+### Group
+A group of users within the workspace.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |
+| name | [string](#string) | | The name of the group to retrieve. Format: groups/{group}, the group should be email or uuid. |
+| title | [string](#string) | | The display title of the group. |
+| description | [string](#string) | | The description of the group. |
+| members | [GroupMember](#bytebase-v1-GroupMember) | repeated | The members of the group. |
+| source | [string](#string) | | The source system where the group originated (e.g., Entra ID for SCIM sync). |
+| email | [string](#string) | | The unique email for the group. |
-<a name="bytebase-v1-BoundingBox"></a>
+<a name="bytebase-v1-GroupMember"></a>
-### BoundingBox
-BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.
+### GroupMember
+A member of a group with a role.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| xmin | [double](#double) | | Minimum X coordinate |
-| ymin | [double](#double) | | Minimum Y coordinate |
-| xmax | [double](#double) | | Maximum X coordinate |
-| ymax | [double](#double) | | Maximum Y coordinate |
+| member | [string](#string) | | Member is the principal who belong to this group.
+Format: users/[email protected] |
+| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | The member&#39;s role in the group. |
-<a name="bytebase-v1-Changelog"></a>
-### Changelog
+<a name="bytebase-v1-ListGroupsRequest"></a>
+### ListGroupsRequest
+Request message for listing groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |
-| schema | [string](#string) | | |
-| schema_size | [int64](#int64) | | |
-| task_run | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| plan_title | [string](#string) | | The title of the plan associated with this changelog&#39;s task run. This field is populated by deriving the plan from task_run for display purposes. |
-| type | [Changelog.Type](#bytebase-v1-Changelog-Type) | | |
+| page_size | [int32](#int32) | | The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 10 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter groups returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+For example: title == &#34;dba&#34; email == &#34;[email protected]&#34; title.matches(&#34;dba&#34;) email.matches(&#34;dba&#34;) project == &#34;projects/sample-project&#34; You can combine filter conditions like: title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) |
-<a name="bytebase-v1-CheckConstraintMetadata"></a>
-### CheckConstraintMetadata
-CheckConstraintMetadata is the metadata for check constraints.
+<a name="bytebase-v1-ListGroupsResponse"></a>
+
+### ListGroupsResponse
+Response message for listing groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a check constraint. |
-| expression | [string](#string) | | The expression is the expression of a check constraint. |
+| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-ColumnMetadata"></a>
+<a name="bytebase-v1-UpdateGroupRequest"></a>
-### ColumnMetadata
-ColumnMetadata is the metadata for columns.
+### UpdateGroupRequest
+Request message for updating a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a column. |
-| position | [int32](#int32) | | The position is the position in columns. |
-| has_default | [bool](#bool) | | |
-| default | [string](#string) | | The default value of column. |
-| default_on_null | [bool](#bool) | | Oracle specific metadata. The default_on_null is the default on null of a column. |
-| on_update | [string](#string) | | The on_update is the on update action of a column. For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with CURRENT_TIMESTAMP as on update value. |
-| nullable | [bool](#bool) | | The nullable is the nullable of a column. |
-| type | [string](#string) | | The type is the type of a column. |
-| character_set | [string](#string) | | The character_set is the character_set of a column. |
-| collation | [string](#string) | | The collation is the collation of a column. |
-| comment | [string](#string) | | The comment is the comment of a column. |
-| generation | [GenerationMetadata](#bytebase-v1-GenerationMetadata) | | The generation is the generation of a column. |
-| is_identity | [bool](#bool) | | |
-| identity_generation | [ColumnMetadata.IdentityGeneration](#bytebase-v1-ColumnMetadata-IdentityGeneration) | | The identity_generation is for identity columns, PG only. |
-| identity_seed | [int64](#int64) | | The identity_seed is for identity columns, MSSQL only. |
-| identity_increment | [int64](#int64) | | The identity_increment is for identity columns, MSSQL only. |
-| default_constraint_name | [string](#string) | | The default_constraint_name is the name of the default constraint, MSSQL only. In MSSQL, default values are implemented as named constraints. When modifying or dropping a column&#39;s default value, you must reference the constraint by name. This field stores the actual constraint name from the database.
-
-Example: A column definition like: CREATE TABLE employees ( status NVARCHAR(20) DEFAULT &#39;active&#39; )
-
-Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39; or a user-defined name if specified: ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
-
-To modify the default, you must first drop the existing constraint by name: ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760 ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
-
-This field is populated when syncing from the database. When empty (e.g., when parsing from SQL files), the system cannot automatically drop the constraint. |
+| group | [Group](#bytebase-v1-Group) | | The group to update.
+The group&#39;s `name` field is used to identify the group to update. Format: groups/{email} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the group is not found, a new group will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-Database"></a>
+
-### Database
+<a name="bytebase-v1-GroupMember-Role"></a>
+### GroupMember.Role
+The role of a group member.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} {database} is the database name in the instance. |
-| state | [State](#bytebase-v1-State) | | The existence of a database. |
-| successful_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The latest synchronization time. |
-| project | [string](#string) | | The project for a database. Format: projects/{project} |
-| schema_version | [string](#string) | | The version of database schema. |
-| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-| effective_environment | [string](#string) | optional | The effective environment based on environment tag above and environment tag on the instance. Inheritance follows https://cloud.google.com/resource-manager/docs/tags/tags-overview. |
-| labels | [Database.LabelsEntry](#bytebase-v1-Database-LabelsEntry) | repeated | Labels will be used for deployment and policy control. |
-| instance_resource | [InstanceResource](#bytebase-v1-InstanceResource) | | The instance resource. |
-| backup_available | [bool](#bool) | | The database is available for DML prior backup. |
-| drifted | [bool](#bool) | | The schema is drifted from the source of truth. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ROLE_UNSPECIFIED | 0 | Unspecified role. |
+| OWNER | 1 | Group owner. |
+| MEMBER | 2 | Group member. |
+
+
+<a name="bytebase-v1-GroupService"></a>
-<a name="bytebase-v1-Database-LabelsEntry"></a>
+### GroupService
+GroupService manages user groups for organizing users and permissions.
-### Database.LabelsEntry
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetGroup | [GetGroupRequest](#bytebase-v1-GetGroupRequest) | [Group](#bytebase-v1-Group) | Gets a group by name. Permissions required: bb.groups.get |
+| BatchGetGroups | [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest) | [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse) | Gets multiple groups in a single request. Permissions required: bb.groups.get |
+| ListGroups | [ListGroupsRequest](#bytebase-v1-ListGroupsRequest) | [ListGroupsResponse](#bytebase-v1-ListGroupsResponse) | Lists all groups in the workspace. Permissions required: bb.groups.list |
+| CreateGroup | [CreateGroupRequest](#bytebase-v1-CreateGroupRequest) | [Group](#bytebase-v1-Group) | Creates a new group. Permissions required: bb.groups.create |
+| UpdateGroup | [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest) | [Group](#bytebase-v1-Group) | Updates a group. Group owners or users with bb.groups.update permission can update. Permissions required: bb.groups.update OR caller is group owner When allow_missing=true, also requires: bb.groups.create |
+| DeleteGroup | [DeleteGroupRequest](#bytebase-v1-DeleteGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a group. Group owners or users with bb.groups.delete permission can delete. Permissions required: bb.groups.delete OR caller is group owner |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+<a name="v1_idp_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/idp_service.proto
+<a name="bytebase-v1-CreateIdentityProviderRequest"></a>
-<a name="bytebase-v1-DatabaseMetadata"></a>
+### CreateIdentityProviderRequest
-### DatabaseMetadata
-DatabaseMetadata is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The database metadata name.
+| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to create. |
+| identity_provider_id | [string](#string) | | The ID to use for the identity provider, which will become the final component of the identity provider&#39;s resource name.
-Format: instances/{instance}/databases/{database}/metadata |
-| schemas | [SchemaMetadata](#bytebase-v1-SchemaMetadata) | repeated | The schemas is the list of schemas in a database. |
-| character_set | [string](#string) | | The character_set is the character set of a database. |
-| collation | [string](#string) | | The collation is the collation of a database. |
-| extensions | [ExtensionMetadata](#bytebase-v1-ExtensionMetadata) | repeated | The extensions is the list of extensions in a database. |
-| owner | [string](#string) | | The owner of the database. |
-| search_path | [string](#string) | | The search_path is the search path of a PostgreSQL database. |
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| validate_only | [bool](#bool) | | If set to true, the request will be validated without actually creating the identity provider. |
-<a name="bytebase-v1-DatabaseSDLSchema"></a>
+<a name="bytebase-v1-DeleteIdentityProviderRequest"></a>
+
+### DeleteIdentityProviderRequest
-### DatabaseSDLSchema
-DatabaseSDLSchema contains the schema in SDL format.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [bytes](#bytes) | | The SDL schema content. - For SINGLE_FILE format: contains the complete SDL schema as a text string. - For MULTI_FILE format: contains the ZIP archive as binary data. |
-| content_type | [string](#string) | | The MIME type of the schema content. Indicates how the client should interpret the schema field. Examples: - &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format - &#34;application/zip&#34; for MULTI_FILE format |
+| name | [string](#string) | | The name of the identity provider to delete. Format: idps/{identity_provider} |
-<a name="bytebase-v1-DatabaseSchema"></a>
+<a name="bytebase-v1-FieldMapping"></a>
-### DatabaseSchema
-DatabaseSchema is the metadata for databases.
+### FieldMapping
+FieldMapping saves the field names from user info API of identity provider.
+As we save all raw json string of user info response data into `principal.idp_user_info`,
+we can extract the relevant data based with `FieldMapping`.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema dump from database. |
+| identifier | [string](#string) | | Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. |
+| display_name | [string](#string) | | DisplayName is the field name of display name in 3rd-party idp user info. Optional. |
+| phone | [string](#string) | | Phone is the field name of primary phone in 3rd-party idp user info. Optional. |
+| groups | [string](#string) | | Groups is the field name of groups in 3rd-party idp user info. Optional. Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ |
-<a name="bytebase-v1-DependencyColumn"></a>
+<a name="bytebase-v1-GetIdentityProviderRequest"></a>
+
+### GetIdentityProviderRequest
-### DependencyColumn
-DependencyColumn is the metadata for dependency columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema is the schema of a reference column. |
-| table | [string](#string) | | The table is the table of a reference column. |
-| column | [string](#string) | | The column is the name of a reference column. |
+| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |
-<a name="bytebase-v1-DependencyTable"></a>
+<a name="bytebase-v1-IdentityProvider"></a>
-### DependencyTable
+### IdentityProvider
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema is the schema of a reference table. |
-| table | [string](#string) | | The table is the name of a reference table. |
+| name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
+| title | [string](#string) | | The display title of the identity provider. |
+| domain | [string](#string) | | The domain for email matching when using this identity provider. |
+| type | [IdentityProviderType](#bytebase-v1-IdentityProviderType) | | The type of identity provider protocol. |
+| config | [IdentityProviderConfig](#bytebase-v1-IdentityProviderConfig) | | The configuration details for the identity provider. |
-<a name="bytebase-v1-DiffSchemaRequest"></a>
+<a name="bytebase-v1-IdentityProviderConfig"></a>
-### DiffSchemaRequest
+### IdentityProviderConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database or changelog. Format: database: instances/{instance}/databases/{database} changelog: instances/{instance}/databases/{database}/changelogs/{changelog} |
-| schema | [string](#string) | | The target schema. |
-| changelog | [string](#string) | | The resource name of the changelog Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-
+| oauth2_config | [OAuth2IdentityProviderConfig](#bytebase-v1-OAuth2IdentityProviderConfig) | | OAuth2 protocol configuration. |
+| oidc_config | [OIDCIdentityProviderConfig](#bytebase-v1-OIDCIdentityProviderConfig) | | OIDC protocol configuration. |
+| ldap_config | [LDAPIdentityProviderConfig](#bytebase-v1-LDAPIdentityProviderConfig) | | LDAP protocol configuration. |
-<a name="bytebase-v1-DiffSchemaResponse"></a>
-### DiffSchemaResponse
+<a name="bytebase-v1-LDAPIdentityProviderConfig"></a>
+### LDAPIdentityProviderConfig
+LDAPIdentityProviderConfig is the structure for LDAP identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| diff | [string](#string) | | |
+| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., &#34;ldap.example.com&#34;. |
+| port | [int32](#int32) | | Port is the port number of the LDAP server, e.g., 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS. |
+| skip_tls_verify | [bool](#bool) | | SkipTLSVerify controls whether to skip TLS certificate verification. |
+| bind_dn | [string](#string) | | BindDN is the DN of the user to bind as a service account to perform search requests. |
+| bind_password | [string](#string) | | BindPassword is the password of the user to bind as a service account. |
+| base_dn | [string](#string) | | BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. |
+| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. |
+| security_protocol | [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol) | | SecurityProtocol is the security protocol to be used for establishing connections with the LDAP server. |
+| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | FieldMapping is the mapping of the user attributes returned by the LDAP server. |
-<a name="bytebase-v1-DimensionConstraint"></a>
+<a name="bytebase-v1-ListIdentityProvidersRequest"></a>
-### DimensionConstraint
-DimensionConstraint defines constraints for a spatial dimension.
+### ListIdentityProvidersRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| dimension | [string](#string) | | Dimension name/type (X, Y, Z, M, etc.) |
-| min_value | [double](#double) | | Minimum value for this dimension |
-| max_value | [double](#double) | | Maximum value for this dimension |
-| tolerance | [double](#double) | | Tolerance for this dimension |
+<a name="bytebase-v1-ListIdentityProvidersResponse"></a>
-<a name="bytebase-v1-DimensionalConfig"></a>
+### ListIdentityProvidersResponse
-### DimensionalConfig
-DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| dimensions | [int32](#int32) | | Number of dimensions (2-4, default 2) |
-| data_type | [string](#string) | | Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) |
-| srid | [int32](#int32) | | Spatial reference system identifier (SRID) |
-| constraints | [DimensionConstraint](#bytebase-v1-DimensionConstraint) | repeated | Coordinate system constraints |
-
+| identity_providers | [IdentityProvider](#bytebase-v1-IdentityProvider) | repeated | The identity providers from the specified request. |
-<a name="bytebase-v1-EnumTypeMetadata"></a>
-### EnumTypeMetadata
+<a name="bytebase-v1-OAuth2IdentityProviderConfig"></a>
+### OAuth2IdentityProviderConfig
+OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of a type. |
-| values | [string](#string) | repeated | The enum values of a type. |
-| comment | [string](#string) | | The comment describing the enum type. |
-| skip_dump | [bool](#bool) | | Whether to skip this enum type during schema dump operations. |
+| auth_url | [string](#string) | | The authorization endpoint URL for OAuth2 flow. |
+| token_url | [string](#string) | | The token endpoint URL for exchanging authorization code. |
+| user_info_url | [string](#string) | | The user information endpoint URL. |
+| client_id | [string](#string) | | The OAuth2 client identifier. |
+| client_secret | [string](#string) | | The OAuth2 client secret for authentication. |
+| scopes | [string](#string) | repeated | The list of OAuth2 scopes to request. |
+| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OAuth2 response. |
+| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |
+| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. |
-<a name="bytebase-v1-EventMetadata"></a>
+<a name="bytebase-v1-OAuth2IdentityProviderTestRequestContext"></a>
-### EventMetadata
+### OAuth2IdentityProviderTestRequestContext
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the event. |
-| definition | [string](#string) | | The schedule of the event. |
-| time_zone | [string](#string) | | The time zone of the event. |
-| sql_mode | [string](#string) | | The SQL mode setting for the event. |
-| character_set_client | [string](#string) | | The character set used by the client creating the event. |
-| collation_connection | [string](#string) | | The collation used for the connection when creating the event. |
-| comment | [string](#string) | | The comment is the comment of an event. |
+| code | [string](#string) | | Authorize code from website. |
-<a name="bytebase-v1-ExtensionMetadata"></a>
+<a name="bytebase-v1-OIDCIdentityProviderConfig"></a>
-### ExtensionMetadata
-ExtensionMetadata is the metadata for extensions.
+### OIDCIdentityProviderConfig
+OIDCIdentityProviderConfig is the structure for OIDC identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of an extension. |
-| schema | [string](#string) | | The schema is the extension that is installed to. But the extension usage is not limited to the schema. |
-| version | [string](#string) | | The version is the version of an extension. |
-| description | [string](#string) | | The description is the description of an extension. |
+| issuer | [string](#string) | | The OIDC issuer URL for the identity provider. |
+| client_id | [string](#string) | | The OIDC client identifier. |
+| client_secret | [string](#string) | | The OIDC client secret for authentication. |
+| scopes | [string](#string) | repeated | The scopes that the OIDC provider supports. Should be fetched from the well-known configuration file of the OIDC provider. |
+| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OIDC claims. |
+| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |
+| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. |
+| auth_endpoint | [string](#string) | | The authorization endpoint of the OIDC provider. Should be fetched from the well-known configuration file of the OIDC provider. |
-<a name="bytebase-v1-ExternalTableMetadata"></a>
+<a name="bytebase-v1-OIDCIdentityProviderTestRequestContext"></a>
-### ExternalTableMetadata
+### OIDCIdentityProviderTestRequestContext
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a external table. |
-| external_server_name | [string](#string) | | The external_server_name is the name of the external server. |
-| external_database_name | [string](#string) | | The external_database_name is the name of the external database. |
-| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a foreign table. |
+| code | [string](#string) | | Authorize code from OIDC provider. |
-<a name="bytebase-v1-ForeignKeyMetadata"></a>
+<a name="bytebase-v1-TestIdentityProviderRequest"></a>
+
+### TestIdentityProviderRequest
-### ForeignKeyMetadata
-ForeignKeyMetadata is the metadata for foreign keys.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a foreign key. |
-| columns | [string](#string) | repeated | The columns are the ordered referencing columns of a foreign key. |
-| referenced_schema | [string](#string) | | The referenced_schema is the referenced schema name of a foreign key. It is an empty string for databases without such concept such as MySQL. |
-| referenced_table | [string](#string) | | The referenced_table is the referenced table name of a foreign key. |
-| referenced_columns | [string](#string) | repeated | The referenced_columns are the ordered referenced columns of a foreign key. |
-| on_delete | [string](#string) | | The on_delete is the on delete action of a foreign key. |
-| on_update | [string](#string) | | The on_update is the on update action of a foreign key. |
-| match_type | [string](#string) | | The match_type is the match type of a foreign key. The match_type is the PostgreSQL specific field. It&#39;s empty string for other databases. |
+| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to test connection including uncreated. |
+| oauth2_context | [OAuth2IdentityProviderTestRequestContext](#bytebase-v1-OAuth2IdentityProviderTestRequestContext) | | |
+| oidc_context | [OIDCIdentityProviderTestRequestContext](#bytebase-v1-OIDCIdentityProviderTestRequestContext) | | OIDC authentication context for test connection. |
-<a name="bytebase-v1-FunctionMetadata"></a>
+<a name="bytebase-v1-TestIdentityProviderResponse"></a>
+
+### TestIdentityProviderResponse
-### FunctionMetadata
-FunctionMetadata is the metadata for functions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a function. |
-| definition | [string](#string) | | The definition is the definition of a function. |
-| signature | [string](#string) | | The signature is the name with the number and type of input arguments the function takes. |
-| character_set_client | [string](#string) | | MySQL specific metadata. |
-| collation_connection | [string](#string) | | |
-| database_collation | [string](#string) | | |
-| sql_mode | [string](#string) | | |
-| comment | [string](#string) | | |
-| dependency_tables | [DependencyTable](#bytebase-v1-DependencyTable) | repeated | The dependency_tables is the list of dependency tables of a function. For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. |
-| skip_dump | [bool](#bool) | | |
+| claims | [TestIdentityProviderResponse.ClaimsEntry](#bytebase-v1-TestIdentityProviderResponse-ClaimsEntry) | repeated | The map of claims returned by the identity provider. |
+| user_info | [TestIdentityProviderResponse.UserInfoEntry](#bytebase-v1-TestIdentityProviderResponse-UserInfoEntry) | repeated | The matched user info from the claims. |
-<a name="bytebase-v1-GenerationMetadata"></a>
+<a name="bytebase-v1-TestIdentityProviderResponse-ClaimsEntry"></a>
-### GenerationMetadata
+### TestIdentityProviderResponse.ClaimsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |
-| expression | [string](#string) | | |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-GetChangelogRequest"></a>
+<a name="bytebase-v1-TestIdentityProviderResponse-UserInfoEntry"></a>
-### GetChangelogRequest
+### TestIdentityProviderResponse.UserInfoEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the changelog to retrieve. Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-GetDatabaseMetadataRequest"></a>
+<a name="bytebase-v1-UpdateIdentityProviderRequest"></a>
-### GetDatabaseMetadataRequest
+### UpdateIdentityProviderRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve metadata. Format: instances/{instance}/databases/{database}/metadata |
-| filter | [string](#string) | | Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to update.
-Supported filter: - schema: the schema name, support &#34;==&#34; operator. - table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+The identity provider&#39;s `name` field is used to identify the identity provider to update. Format: idps/{identity_provider} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the identity provider is not found, a new identity provider will be created. In this situation, `update_mask` is ignored. |
-For example: schema == &#34;schema-a&#34; table == &#34;table-a&#34; table.matches(&#34;table-a&#34;) schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;) The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;. The column masking level will only be returned when a table filter is used. |
-| limit | [int32](#int32) | | Limit the response size of returned table metadata per schema. For example, if the database has 3 schemas, and each schema has 100 tables, if limit is 20, then only 20 tables will be returned for each schema, total 60 tables. Default 0, means no limit. |
+
-<a name="bytebase-v1-GetDatabaseRequest"></a>
+<a name="bytebase-v1-IdentityProviderType"></a>
-### GetDatabaseRequest
+### IdentityProviderType
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDENTITY_PROVIDER_TYPE_UNSPECIFIED | 0 | Unspecified identity provider type. |
+| OAUTH2 | 1 | OAuth 2.0 authentication protocol. |
+| OIDC | 2 | OpenID Connect authentication protocol. |
+| LDAP | 3 | LDAP directory service authentication. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |
+<a name="bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol"></a>
+### LDAPIdentityProviderConfig.SecurityProtocol
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECURITY_PROTOCOL_UNSPECIFIED | 0 | |
+| START_TLS | 1 | StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS. |
+| LDAPS | 2 | LDAPS is the security protocol that uses TLS from the beginning. |
-<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>
-### GetDatabaseSDLSchemaRequest
+<a name="bytebase-v1-OAuth2AuthStyle"></a>
+### OAuth2AuthStyle
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve SDL schema. Format: instances/{instance}/databases/{database}/sdlSchema |
-| format | [GetDatabaseSDLSchemaRequest.SDLFormat](#bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat) | | The format of the SDL schema output. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | |
+| IN_PARAMS | 1 | IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body as application/x-www-form-urlencoded parameters. |
+| IN_HEADER | 2 | IN_HEADER sends the client_id and client_password using HTTP Basic Authorization. This is an optional style described in the OAuth2 RFC 6749 section 2.3.1. |
+
+
-<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>
+<a name="bytebase-v1-IdentityProviderService"></a>
-### GetDatabaseSchemaRequest
+### IdentityProviderService
+IdentityProviderService manages external identity providers for SSO authentication.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetIdentityProvider | [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Gets an identity provider by name. Permissions required: bb.identityProviders.get |
+| ListIdentityProviders | [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest) | [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse) | Lists all configured identity providers (public endpoint for login page). Permissions required: None |
+| CreateIdentityProvider | [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Creates a new identity provider. Permissions required: bb.identityProviders.create |
+| UpdateIdentityProvider | [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Updates an identity provider. Permissions required: bb.identityProviders.update When allow_missing=true, also requires: bb.identityProviders.create |
+| DeleteIdentityProvider | [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an identity provider. Permissions required: bb.identityProviders.delete |
+| TestIdentityProvider | [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest) | [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse) | Tests the connection and configuration of an identity provider. Permissions required: bb.identityProviders.update |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |
+<a name="v1_issue_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/issue_service.proto
-<a name="bytebase-v1-GetSchemaStringRequest"></a>
+<a name="bytebase-v1-ApprovalFlow"></a>
-### GetSchemaStringRequest
+### ApprovalFlow
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} |
-| type | [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType) | | |
-| schema | [string](#string) | | It&#39;s empty for DATABASE. |
-| object | [string](#string) | | It&#39;s empty for DATABASE and SCHEMA. |
-| metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED. Also the schema and object are empty. |
+| roles | [string](#string) | repeated | The roles required for approval in order. |
-<a name="bytebase-v1-GetSchemaStringResponse"></a>
+<a name="bytebase-v1-ApprovalTemplate"></a>
-### GetSchemaStringResponse
+### ApprovalTemplate
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema_string | [string](#string) | | |
+| flow | [ApprovalFlow](#bytebase-v1-ApprovalFlow) | | The approval flow definition. |
+| title | [string](#string) | | The title of the approval template. |
+| description | [string](#string) | | The description of the approval template. |
-<a name="bytebase-v1-GridLevel"></a>
+<a name="bytebase-v1-ApproveIssueRequest"></a>
+
+### ApproveIssueRequest
-### GridLevel
-GridLevel defines a tessellation grid level with its density.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |
-| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |
+| name | [string](#string) | | The name of the issue to add an approver. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the approval decision. |
-<a name="bytebase-v1-IndexMetadata"></a>
+<a name="bytebase-v1-BatchUpdateIssuesStatusRequest"></a>
+
+### BatchUpdateIssuesStatusRequest
-### IndexMetadata
-IndexMetadata is the metadata for indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of an index. |
-| expressions | [string](#string) | repeated | The expressions are the ordered columns or expressions of an index. This could refer to a column or an expression. |
-| key_length | [int64](#int64) | repeated | The key_lengths are the ordered key lengths of an index. If the key length is not specified, it&#39;s -1. |
-| descending | [bool](#bool) | repeated | The descending is the ordered descending of an index. |
-| type | [string](#string) | | The type is the type of an index. |
-| unique | [bool](#bool) | | The unique is whether the index is unique. |
-| primary | [bool](#bool) | | The primary is whether the index is a primary key index. |
-| visible | [bool](#bool) | | The visible is whether the index is visible. |
-| comment | [string](#string) | | The comment is the comment of an index. |
-| definition | [string](#string) | | The definition of an index. |
-| parent_index_schema | [string](#string) | | The schema name of the parent index. |
-| parent_index_name | [string](#string) | | The index name of the parent index. |
-| granularity | [int64](#int64) | | The number of granules in the block. It&#39;s a ClickHouse specific field. |
-| is_constraint | [bool](#bool) | | It&#39;s a PostgreSQL specific field. The unique constraint and unique index are not the same thing in PostgreSQL. |
-| spatial_config | [SpatialIndexConfig](#bytebase-v1-SpatialIndexConfig) | | Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. |
-| opclass_names | [string](#string) | repeated | https://www.postgresql.org/docs/current/catalog-pg-opclass.html Name of the operator class for each column. (PostgreSQL specific). |
-| opclass_defaults | [bool](#bool) | repeated | True if the operator class is the default. (PostgreSQL specific). |
+| parent | [string](#string) | | The parent resource shared by all issues being updated. Format: projects/{project} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the status of databases for now. |
+| issues | [string](#string) | repeated | The list of issues to update. Format: projects/{project}/issues/{issue} |
+| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The new status. |
+| reason | [string](#string) | | The reason for the status change. |
-<a name="bytebase-v1-ListChangelogsRequest"></a>
+<a name="bytebase-v1-BatchUpdateIssuesStatusResponse"></a>
-### ListChangelogsRequest
+### BatchUpdateIssuesStatusResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent of the changelogs. Format: instances/{instance}/databases/{database} |
-| page_size | [int32](#int32) | | The maximum number of changelogs to return. The service may return fewer than this value. If unspecified, at most 10 changelogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from the previous call. Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided must match the call that provided the page token. |
-| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
-| filter | [string](#string) | | Filter is used to filter changelogs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-Supported filter: status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values. type: the changelog type, support &#34;in&#34; and &#34;==&#34; operation. check Changelog.Type for available values.
-Example: status == &#34;DONE&#34; type in [&#34;BASELINE&#34;, &#34;MIGRATE&#34;] status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; |
+<a name="bytebase-v1-CreateIssueCommentRequest"></a>
+### CreateIssueCommentRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
+| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to create. |
-<a name="bytebase-v1-ListChangelogsResponse"></a>
-### ListChangelogsResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| changelogs | [Changelog](#bytebase-v1-Changelog) | repeated | The list of changelogs. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+<a name="bytebase-v1-CreateIssueRequest"></a>
+### CreateIssueRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
+| issue | [Issue](#bytebase-v1-Issue) | | The issue to create. |
-<a name="bytebase-v1-ListDatabasesRequest"></a>
-### ListDatabasesRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | - projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission. - workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission. - instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission |
-| page_size | [int32](#int32) | | The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+<a name="bytebase-v1-GetIssueRequest"></a>
-Supported filter: - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - name: the database name, support &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator. - drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator. - table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator. - labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+### GetIssueRequest
-For example: environment == &#34;environments/{environment resource id}&#34; environment == &#34;&#34; (find databases which environment is not set) project == &#34;projects/{project resource id}&#34; instance == &#34;instances/{instance resource id}&#34; name.matches(&#34;database name&#34;) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) exclude_unassigned == true drifted == true table == &#34;sample&#34; table.matches(&#34;sam&#34;) labels.environment == &#34;production&#34; labels.region == &#34;asia&#34; labels.region in [&#34;asia&#34;, &#34;europe&#34;]
-You can combine filter conditions like: environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) |
-| show_deleted | [bool](#bool) | | Show deleted database if specified. |
-| order_by | [string](#string) | | The order by of databases. Support name, project, instance. The default sorting order is ascending. For example: - order_by = &#34;name&#34; - order by name ascending - order_by = &#34;name desc&#34; - order_by = &#34;name desc, project asc&#34; |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the issue to retrieve. Format: projects/{project}/issues/{issue} |
+| force | [bool](#bool) | | If set to true, bypass cache and fetch the latest data. |
-<a name="bytebase-v1-ListDatabasesResponse"></a>
-### ListDatabasesResponse
+<a name="bytebase-v1-GrantRequest"></a>
+
+### GrantRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| role | [string](#string) | | The requested role. Format: roles/EXPORTER. |
+| user | [string](#string) | | The user to be granted. Format: users/{email}. |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition for the role. Same as the condition in IAM Binding message. |
+| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for which the grant is valid. |
-<a name="bytebase-v1-MaterializedViewMetadata"></a>
+<a name="bytebase-v1-Issue"></a>
+
+### Issue
-### MaterializedViewMetadata
-MaterializedViewMetadata is the metadata for materialized views.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a materialized view. |
-| definition | [string](#string) | | The definition is the definition of a materialized view. |
-| comment | [string](#string) | | The comment is the comment of a materialized view. |
-| dependency_columns | [DependencyColumn](#bytebase-v1-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a materialized view. |
-| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The columns is the ordered list of columns in a table. |
-| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | The indexes is the list of indexes in a table. |
-| skip_dump | [bool](#bool) | | |
+| name | [string](#string) | | The name of the issue. Format: projects/{project}/issues/{issue} |
+| title | [string](#string) | | The title of the issue. |
+| description | [string](#string) | | The description of the issue. |
+| type | [Issue.Type](#bytebase-v1-Issue-Type) | | |
+| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The status of the issue. |
+| approvers | [Issue.Approver](#bytebase-v1-Issue-Approver) | repeated | |
+| approval_template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | The approval template for the issue. |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| plan | [string](#string) | | The plan associated with the issue. Can be empty. Format: projects/{project}/plans/{plan} |
+| grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. |
+| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. |
+| approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | |
-<a name="bytebase-v1-PackageMetadata"></a>
+<a name="bytebase-v1-Issue-Approver"></a>
-### PackageMetadata
-PackageMetadata is the metadata for packages.
+### Issue.Approver
+Approvers and their approval status for the issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a package. |
-| definition | [string](#string) | | The definition is the definition of a package. |
+| status | [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status) | | The new status. |
+| principal | [string](#string) | | Format: users/[email protected] |
-<a name="bytebase-v1-ProcedureMetadata"></a>
+<a name="bytebase-v1-IssueComment"></a>
-### ProcedureMetadata
-ProcedureMetadata is the metadata for procedures.
+### IssueComment
+A comment on an issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a procedure. |
-| definition | [string](#string) | | The definition is the definition of a procedure. |
-| signature | [string](#string) | | The signature is the name with the number and type of input arguments the procedure takes. |
-| character_set_client | [string](#string) | | MySQL specific metadata. |
-| collation_connection | [string](#string) | | |
-| database_collation | [string](#string) | | |
-| sql_mode | [string](#string) | | |
-| comment | [string](#string) | | The comment is the comment of a procedure. |
-| skip_dump | [bool](#bool) | | |
+| name | [string](#string) | | Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} |
+| comment | [string](#string) | | The text content of the comment. |
+| payload | [string](#string) | | TODO: use struct message instead. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| creator | [string](#string) | | Format: users/{email} |
+| approval | [IssueComment.Approval](#bytebase-v1-IssueComment-Approval) | | Approval event. |
+| issue_update | [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate) | | Issue update event. |
+| plan_spec_update | [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate) | | Plan spec update event. |
-<a name="bytebase-v1-SchemaMetadata"></a>
+<a name="bytebase-v1-IssueComment-Approval"></a>
-### SchemaMetadata
-SchemaMetadata is the metadata for schemas.
-This is the concept of schema in Postgres, but it&#39;s a no-op for MySQL.
+### IssueComment.Approval
+Approval event information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the schema name. It is an empty string for databases without such concept such as MySQL. |
-| tables | [TableMetadata](#bytebase-v1-TableMetadata) | repeated | The tables is the list of tables in a schema. |
-| external_tables | [ExternalTableMetadata](#bytebase-v1-ExternalTableMetadata) | repeated | The external_tables is the list of external tables in a schema. |
-| views | [ViewMetadata](#bytebase-v1-ViewMetadata) | repeated | The views is the list of views in a schema. |
-| functions | [FunctionMetadata](#bytebase-v1-FunctionMetadata) | repeated | The functions is the list of functions in a schema. |
-| procedures | [ProcedureMetadata](#bytebase-v1-ProcedureMetadata) | repeated | The procedures is the list of procedures in a schema. |
-| streams | [StreamMetadata](#bytebase-v1-StreamMetadata) | repeated | The streams is the list of streams in a schema, currently, only used for Snowflake. |
-| tasks | [TaskMetadata](#bytebase-v1-TaskMetadata) | repeated | The routines is the list of routines in a schema, currently, only used for Snowflake. |
-| materialized_views | [MaterializedViewMetadata](#bytebase-v1-MaterializedViewMetadata) | repeated | The materialized_views is the list of materialized views in a schema. |
-| packages | [PackageMetadata](#bytebase-v1-PackageMetadata) | repeated | The packages is the list of packages in a schema. |
-| owner | [string](#string) | | The owner of the schema. |
-| sequences | [SequenceMetadata](#bytebase-v1-SequenceMetadata) | repeated | The sequences is the list of sequences in a schema, sorted by name. |
-| events | [EventMetadata](#bytebase-v1-EventMetadata) | repeated | The events is the list of scheduled events in a schema. |
-| enum_types | [EnumTypeMetadata](#bytebase-v1-EnumTypeMetadata) | repeated | The enum_types is the list of user-defined enum types in a schema. |
-| skip_dump | [bool](#bool) | | Whether to skip this schema during schema dump operations. |
-| comment | [string](#string) | | The comment is the comment of a schema. |
-
+| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |
-<a name="bytebase-v1-SequenceMetadata"></a>
-### SequenceMetadata
+<a name="bytebase-v1-IssueComment-IssueUpdate"></a>
+### IssueComment.IssueUpdate
+Issue update event information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of a sequence. |
-| data_type | [string](#string) | | The data type of a sequence. |
-| start | [string](#string) | | The start value of a sequence. |
-| min_value | [string](#string) | | The minimum value of a sequence. |
-| max_value | [string](#string) | | The maximum value of a sequence. |
-| increment | [string](#string) | | Increment value of a sequence. |
-| cycle | [bool](#bool) | | Cycle is whether the sequence cycles. |
-| cache_size | [string](#string) | | Cache size of a sequence. |
-| last_value | [string](#string) | | Last value of a sequence. |
-| owner_table | [string](#string) | | The owner table of the sequence. |
-| owner_column | [string](#string) | | The owner column of the sequence. |
-| comment | [string](#string) | | The comment describing the sequence. |
-| skip_dump | [bool](#bool) | | Whether to skip this sequence during schema dump operations. |
+| from_title | [string](#string) | optional | |
+| to_title | [string](#string) | optional | |
+| from_description | [string](#string) | optional | |
+| to_description | [string](#string) | optional | |
+| from_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
+| to_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
+| from_labels | [string](#string) | repeated | |
+| to_labels | [string](#string) | repeated | |
-<a name="bytebase-v1-SpatialIndexConfig"></a>
+<a name="bytebase-v1-IssueComment-PlanSpecUpdate"></a>
-### SpatialIndexConfig
-SpatialIndexConfig defines the spatial index configuration for spatial databases.
+### IssueComment.PlanSpecUpdate
+Plan spec update event information (tracks sheet changes to plan specs).
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| method | [string](#string) | | Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) |
-| tessellation | [TessellationConfig](#bytebase-v1-TessellationConfig) | | Tessellation configuration for grid-based spatial indexes |
-| storage | [StorageConfig](#bytebase-v1-StorageConfig) | | Storage and performance configuration |
-| dimensional | [DimensionalConfig](#bytebase-v1-DimensionalConfig) | | Dimensional configuration |
+| spec | [string](#string) | | The spec that was updated. Format: projects/{project}/plans/{plan}/specs/{spec} |
+| from_sheet | [string](#string) | optional | The previous sheet. Format: projects/{project}/sheets/{sheet} |
+| to_sheet | [string](#string) | optional | The new sheet. Format: projects/{project}/sheets/{sheet} |
-<a name="bytebase-v1-StorageConfig"></a>
+<a name="bytebase-v1-ListIssueCommentsRequest"></a>
+
+### ListIssueCommentsRequest
-### StorageConfig
-StorageConfig defines storage and performance parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| fillfactor | [int32](#int32) | | Fill factor percentage (1-100) |
-| buffering | [string](#string) | | Buffering mode for PostgreSQL (auto, on, off) |
-| tablespace | [string](#string) | | Tablespace configuration for Oracle |
-| work_tablespace | [string](#string) | | |
-| sdo_level | [int32](#int32) | | |
-| commit_interval | [int32](#int32) | | |
-| pad_index | [bool](#bool) | | SQL Server specific parameters |
-| sort_in_tempdb | [string](#string) | | ON, OFF |
-| drop_existing | [bool](#bool) | | |
-| online | [bool](#bool) | | |
-| allow_row_locks | [bool](#bool) | | |
-| allow_page_locks | [bool](#bool) | | |
-| maxdop | [int32](#int32) | | |
-| data_compression | [string](#string) | | NONE, ROW, PAGE |
+| parent | [string](#string) | | Format: projects/{projects}/issues/{issue} |
+| page_size | [int32](#int32) | | The maximum number of issue comments to return. The service may return fewer than this value. If unspecified, at most 10 issue comments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListIssueComments` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListIssueComments` must match the call that provided the page token. |
-<a name="bytebase-v1-StreamMetadata"></a>
+<a name="bytebase-v1-ListIssueCommentsResponse"></a>
-### StreamMetadata
+### ListIssueCommentsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a stream. |
-| table_name | [string](#string) | | The table_name is the name of the table/view that the stream is created on. |
-| owner | [string](#string) | | The owner of the stream. |
-| comment | [string](#string) | | The comment of the stream. |
-| type | [StreamMetadata.Type](#bytebase-v1-StreamMetadata-Type) | | The type of the stream. |
-| stale | [bool](#bool) | | Indicates whether the stream was last read before the `stale_after` time. |
-| mode | [StreamMetadata.Mode](#bytebase-v1-StreamMetadata-Mode) | | The mode of the stream. |
-| definition | [string](#string) | | The definition of the stream. |
+| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | The issue comments from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-SyncDatabaseRequest"></a>
+<a name="bytebase-v1-ListIssuesRequest"></a>
-### SyncDatabaseRequest
+### ListIssuesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
+| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListIssues` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListIssues` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter issues returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filters: - creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values. - create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values. - labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator. - approval_status: issue approval status, support &#34;==&#34; operator. - current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
+For example: creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;] status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34; labels in [&#34;label1&#34;, &#34;label2&#34;] create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; |
+| query | [string](#string) | | Query is the query statement. |
-<a name="bytebase-v1-SyncDatabaseResponse"></a>
-### SyncDatabaseResponse
+<a name="bytebase-v1-ListIssuesResponse"></a>
+### ListIssuesResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-TableMetadata"></a>
-### TableMetadata
-TableMetadata is the metadata for tables.
+
+
+
+<a name="bytebase-v1-RejectIssueRequest"></a>
+
+### RejectIssueRequest
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a table. |
-| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. |
-| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | The indexes is the list of indexes in a table. |
-| engine | [string](#string) | | The engine is the engine of a table. |
-| collation | [string](#string) | | The collation is the collation of a table. |
-| charset | [string](#string) | | The character set of table. |
-| row_count | [int64](#int64) | | The row_count is the estimated number of rows of a table. |
-| data_size | [int64](#int64) | | The data_size is the estimated data size of a table. |
-| index_size | [int64](#int64) | | The index_size is the estimated index size of a table. |
-| data_free | [int64](#int64) | | The data_free is the estimated free data size of a table. |
-| create_options | [string](#string) | | The create_options is the create option of a table. |
-| comment | [string](#string) | | The comment is the comment of a table. |
-| foreign_keys | [ForeignKeyMetadata](#bytebase-v1-ForeignKeyMetadata) | repeated | The foreign_keys is the list of foreign keys in a table. |
-| partitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The partitions is the list of partitions in a table. |
-| check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | The check_constraints is the list of check constraints in a table. |
-| owner | [string](#string) | | The owner of the table. |
-| sorting_keys | [string](#string) | repeated | The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field. Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by |
-| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The triggers is the list of triggers associated with the table. |
-| skip_dump | [bool](#bool) | | Whether to skip this table during schema dump operations. |
-| sharding_info | [string](#string) | | https://docs.pingcap.com/tidb/stable/information-schema-tables/ |
-| primary_key_type | [string](#string) | | https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes CLUSTERED or NONCLUSTERED. |
+| name | [string](#string) | | The name of the issue to add a rejection. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the rejection decision. |
-<a name="bytebase-v1-TablePartitionMetadata"></a>
+<a name="bytebase-v1-RequestIssueRequest"></a>
+
+### RequestIssueRequest
-### TablePartitionMetadata
-TablePartitionMetadata is the metadata for table partitions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a table partition. |
-| type | [TablePartitionMetadata.Type](#bytebase-v1-TablePartitionMetadata-Type) | | The type of a table partition. |
-| expression | [string](#string) | | The expression is the expression of a table partition. For PostgreSQL, the expression is the text of {FOR VALUES partition_bound_spec}, see https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL, the expression is the `expr` or `column_list` of the following syntax. PARTITION BY { [LINEAR] HASH(expr) | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) | RANGE{(expr) | COLUMNS(column_list)} | LIST{(expr) | COLUMNS(column_list)} }. |
-| value | [string](#string) | | The value is the value of a table partition. For MySQL, the value is for RANGE and LIST partition types, - For a RANGE partition, it contains the value set in the partition&#39;s VALUES LESS THAN clause, which can be either an integer or MAXVALUE. - For a LIST partition, this column contains the values defined in the partition&#39;s VALUES IN clause, which is a list of comma-separated integer values. - For others, it&#39;s an empty string. |
-| use_default | [string](#string) | | The use_default is whether the users use the default partition, it stores the different value for different database engines. For MySQL, it&#39;s [INT] type, 0 means not use default partition, otherwise, it&#39;s equals to number in syntax [SUB]PARTITION {number}. |
-| subpartitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The subpartitions is the list of subpartitions in a table partition. |
-| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | |
-| check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | |
+| name | [string](#string) | | The name of the issue to request a issue. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the request. |
-<a name="bytebase-v1-TaskMetadata"></a>
+<a name="bytebase-v1-SearchIssuesRequest"></a>
-### TaskMetadata
+### SearchIssuesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a task. |
-| id | [string](#string) | | The id is the snowflake-generated id of a task. Example: 01ad32a0-1bb6-5e93-0000-000000000001 |
-| owner | [string](#string) | | The owner of the task. |
-| comment | [string](#string) | | The comment of the task. |
-| warehouse | [string](#string) | | The warehouse of the task. |
-| schedule | [string](#string) | | The schedule interval of the task. |
-| predecessors | [string](#string) | repeated | The predecessor tasks of the task. |
-| state | [TaskMetadata.State](#bytebase-v1-TaskMetadata-State) | | The state of the task. |
-| condition | [string](#string) | | The condition of the task. |
-| definition | [string](#string) | | The definition of the task. |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} Use &#34;projects/-&#34; to list all issues from all projects. |
+| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchIssues` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchIssues` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter issues returned in the list. Check the filter field in the ListIssuesRequest message. |
+| query | [string](#string) | | Query is the query statement. |
-<a name="bytebase-v1-TessellationConfig"></a>
+<a name="bytebase-v1-SearchIssuesResponse"></a>
+
+### SearchIssuesResponse
-### TessellationConfig
-TessellationConfig defines tessellation parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| scheme | [string](#string) | | Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) |
-| grid_levels | [GridLevel](#bytebase-v1-GridLevel) | repeated | Grid levels and densities for multi-level tessellation |
-| cells_per_object | [int32](#int32) | | Number of cells per object (1-8192 for SQL Server) |
-| bounding_box | [BoundingBox](#bytebase-v1-BoundingBox) | | Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) |
+| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-TriggerMetadata"></a>
+<a name="bytebase-v1-UpdateIssueCommentRequest"></a>
-### TriggerMetadata
+### UpdateIssueCommentRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of the trigger. |
-| event | [string](#string) | | The event is the event of the trigger, such as INSERT, UPDATE, DELETE, TRUNCATE. |
-| timing | [string](#string) | | The timing is the timing of the trigger, such as BEFORE, AFTER. |
-| body | [string](#string) | | The body is the body of the trigger. |
-| sql_mode | [string](#string) | | The SQL mode setting for the trigger. |
-| character_set_client | [string](#string) | | The character set used by the client creating the trigger. |
-| collation_connection | [string](#string) | | The collation used for the connection when creating the trigger. |
-| comment | [string](#string) | | The comment describing the trigger. |
-| skip_dump | [bool](#bool) | | Whether to skip this trigger during schema dump operations. |
+| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
+| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-UpdateDatabaseRequest"></a>
+<a name="bytebase-v1-UpdateIssueRequest"></a>
-### UpdateDatabaseRequest
+### UpdateIssueRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| database | [Database](#bytebase-v1-Database) | | The database to update.
+| issue | [Issue](#bytebase-v1-Issue) | | The issue to update.
-The database&#39;s `name` field is used to identify the database to update. Format: instances/{instance}/databases/{database} |
+The issue&#39;s `name` field is used to identify the issue to update. Format: projects/{project}/issues/{issue} |
| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the database is not found, a new database will be created. In this situation, `update_mask` is ignored. |
-
+| allow_missing | [bool](#bool) | | If set to true, and the issue is not found, a new issue will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-ViewMetadata"></a>
-
-### ViewMetadata
-ViewMetadata is the metadata for views.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a view. |
-| definition | [string](#string) | | The definition is the definition of a view. |
-| comment | [string](#string) | | The comment is the comment of a view. |
-| dependency_columns | [DependencyColumn](#bytebase-v1-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a view. |
-| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. |
-| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The triggers is the list of triggers in a view. |
-| skip_dump | [bool](#bool) | | |
-
+
+<a name="bytebase-v1-Issue-ApprovalStatus"></a>
+### Issue.ApprovalStatus
+The overall approval status for the issue.
-
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| APPROVAL_STATUS_UNSPECIFIED | 0 | Unspecified approval status. |
+| CHECKING | 1 | Approval checks are being evaluated. |
+| PENDING | 2 | Approval is pending. |
+| APPROVED | 3 | Issue has been approved. |
+| REJECTED | 4 | Issue has been rejected. |
+| SKIPPED | 5 | Approval was skipped. |
-<a name="bytebase-v1-Changelog-Status"></a>
-### Changelog.Status
+<a name="bytebase-v1-Issue-Approver-Status"></a>
+### Issue.Approver.Status
+The approval status of an approver.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | |
-| PENDING | 1 | |
-| DONE | 2 | |
-| FAILED | 3 | |
-
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Awaiting approval. |
+| APPROVED | 2 | Approved. |
+| REJECTED | 3 | Rejected. |
-<a name="bytebase-v1-Changelog-Type"></a>
-### Changelog.Type
+<a name="bytebase-v1-Issue-Type"></a>
+### Issue.Type
+The type of issue.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| BASELINE | 1 | |
-| MIGRATE | 2 | |
-| SDL | 3 | |
-
+| TYPE_UNSPECIFIED | 0 | Unspecified issue type. |
+| DATABASE_CHANGE | 1 | Database schema or data change. |
+| GRANT_REQUEST | 2 | Database access grant request. |
+| DATABASE_EXPORT | 3 | Database data export request. |
-<a name="bytebase-v1-ChangelogView"></a>
-### ChangelogView
+<a name="bytebase-v1-IssueComment-Approval-Status"></a>
+### IssueComment.Approval.Status
+Approval status values.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| CHANGELOG_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
-| CHANGELOG_VIEW_BASIC | 1 | |
-| CHANGELOG_VIEW_FULL | 2 | |
-
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Approval pending. |
+| APPROVED | 2 | Approved. |
+| REJECTED | 3 | Rejected. |
-<a name="bytebase-v1-ColumnMetadata-IdentityGeneration"></a>
-### ColumnMetadata.IdentityGeneration
+<a name="bytebase-v1-IssueStatus"></a>
+### IssueStatus
+The status of an issue.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| IDENTITY_GENERATION_UNSPECIFIED | 0 | |
-| ALWAYS | 1 | |
-| BY_DEFAULT | 2 | |
+| ISSUE_STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| OPEN | 1 | Issue is open and active. |
+| DONE | 2 | Issue is completed. |
+| CANCELED | 3 | Issue is canceled. |
+
-<a name="bytebase-v1-GenerationMetadata-Type"></a>
+
-### GenerationMetadata.Type
+<a name="bytebase-v1-IssueService"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| VIRTUAL | 1 | |
-| STORED | 2 | |
+### IssueService
+IssueService manages issues for tracking database changes and tasks.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetIssue | [GetIssueRequest](#bytebase-v1-GetIssueRequest) | [Issue](#bytebase-v1-Issue) | Retrieves an issue by name. Permissions required: bb.issues.get |
+| CreateIssue | [CreateIssueRequest](#bytebase-v1-CreateIssueRequest) | [Issue](#bytebase-v1-Issue) | Creates a new issue for database changes or tasks. Permissions required: bb.issues.create |
+| ListIssues | [ListIssuesRequest](#bytebase-v1-ListIssuesRequest) | [ListIssuesResponse](#bytebase-v1-ListIssuesResponse) | Lists issues in a project. Permissions required: bb.issues.list |
+| SearchIssues | [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest) | [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse) | Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query. Permissions required: bb.issues.get |
+| UpdateIssue | [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest) | [Issue](#bytebase-v1-Issue) | Updates an issue&#39;s properties such as title, description, or labels. Permissions required: bb.issues.update |
+| ListIssueComments | [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest) | [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse) | Lists comments on an issue. Permissions required: bb.issueComments.list |
+| CreateIssueComment | [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Adds a comment to an issue. Permissions required: bb.issueComments.create |
+| UpdateIssueComment | [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Updates an existing issue comment. Permissions required: bb.issueComments.update |
+| BatchUpdateIssuesStatus | [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest) | [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse) | Updates the status of multiple issues in a single operation. Permissions required: bb.issues.update |
+| ApproveIssue | [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest) | [Issue](#bytebase-v1-Issue) | Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
+| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
+| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
+
-<a name="bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat"></a>
-### GetDatabaseSDLSchemaRequest.SDLFormat
-SDLFormat specifies the output format for SDL schema.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SDL_FORMAT_UNSPECIFIED | 0 | Unspecified format. Defaults to SINGLE_FILE. |
-| SINGLE_FILE | 1 | Single file format: returns the complete SDL schema as a single file. |
-| MULTI_FILE | 2 | Multi-file format: returns the SDL schema as a ZIP archive containing multiple files organized by schema objects (tables, views, functions, etc.). |
+<a name="v1_org_policy_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/org_policy_service.proto
-<a name="bytebase-v1-GetSchemaStringRequest-ObjectType"></a>
-### GetSchemaStringRequest.ObjectType
+<a name="bytebase-v1-CreatePolicyRequest"></a>
+### CreatePolicyRequest
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| OBJECT_TYPE_UNSPECIFIED | 0 | |
-| DATABASE | 1 | |
-| SCHEMA | 2 | |
-| TABLE | 3 | |
-| VIEW | 4 | |
-| MATERIALIZED_VIEW | 5 | |
-| FUNCTION | 6 | |
-| PROCEDURE | 7 | |
-| SEQUENCE | 8 | |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
+| policy | [Policy](#bytebase-v1-Policy) | | The policy to create. |
+| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy to create. |
-<a name="bytebase-v1-StreamMetadata-Mode"></a>
-### StreamMetadata.Mode
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| MODE_UNSPECIFIED | 0 | |
-| DEFAULT | 1 | |
-| APPEND_ONLY | 2 | |
-| INSERT_ONLY | 3 | |
+<a name="bytebase-v1-DataSourceQueryPolicy"></a>
-<a name="bytebase-v1-StreamMetadata-Type"></a>
+### DataSourceQueryPolicy
+Policy for controlling which data sources can be queried in the SQL editor.
-### StreamMetadata.Type
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| admin_data_source_restriction | [DataSourceQueryPolicy.Restriction](#bytebase-v1-DataSourceQueryPolicy-Restriction) | | Restriction for admin data source queries. |
+| disallow_ddl | [bool](#bool) | | Disallow running DDL statements in the SQL editor. |
+| disallow_dml | [bool](#bool) | | Disallow running DML statements in the SQL editor. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| DELTA | 1 | |
-<a name="bytebase-v1-TablePartitionMetadata-Type"></a>
-### TablePartitionMetadata.Type
-Type is the type of a table partition, some database engines may not
-support all types. Only avilable for the following database engines now:
-MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,
-LINEAR_KEY
-(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:
-RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,
-LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| RANGE | 1 | |
-| RANGE_COLUMNS | 2 | |
-| LIST | 3 | |
-| LIST_COLUMNS | 4 | |
-| HASH | 5 | |
-| LINEAR_HASH | 6 | |
-| KEY | 7 | |
-| LINEAR_KEY | 8 | |
+<a name="bytebase-v1-DeletePolicyRequest"></a>
+### DeletePolicyRequest
-<a name="bytebase-v1-TaskMetadata-State"></a>
-### TaskMetadata.State
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATE_UNSPECIFIED | 0 | |
-| STARTED | 1 | |
-| SUSPENDED | 2 | |
-
-
+<a name="bytebase-v1-GetPolicyRequest"></a>
-<a name="bytebase-v1-DatabaseService"></a>
+### GetPolicyRequest
-### DatabaseService
-DatabaseService manages databases and their schemas.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetDatabase | [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest) | [Database](#bytebase-v1-Database) | Retrieves a database by name. Permissions required: bb.databases.get |
-| BatchGetDatabases | [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest) | [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse) | Retrieves multiple databases by their names. Permissions required: bb.databases.get |
-| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Lists databases in a project, instance, or workspace. Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent) |
-| UpdateDatabase | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | [Database](#bytebase-v1-Database) | Updates database properties such as labels and project assignment. Permissions required: bb.databases.update |
-| BatchUpdateDatabases | [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest) | [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse) | Updates multiple databases in a single batch operation. Permissions required: bb.databases.update |
-| SyncDatabase | [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest) | [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse) | Synchronizes database schema from the instance. Permissions required: bb.databases.sync |
-| BatchSyncDatabases | [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest) | [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse) | Synchronizes multiple databases in a single batch operation. Permissions required: bb.databases.sync |
-| GetDatabaseMetadata | [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest) | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | Retrieves database metadata including tables, columns, and indexes. Permissions required: bb.databases.getSchema |
-| GetDatabaseSchema | [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest) | [DatabaseSchema](#bytebase-v1-DatabaseSchema) | Retrieves database schema as DDL statements. Permissions required: bb.databases.getSchema |
-| GetDatabaseSDLSchema | [GetDatabaseSDLSchemaRequest](#bytebase-v1-GetDatabaseSDLSchemaRequest) | [DatabaseSDLSchema](#bytebase-v1-DatabaseSDLSchema) | Retrieves database schema in SDL (Schema Definition Language) format. Permissions required: bb.databases.getSchema |
-| DiffSchema | [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest) | [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse) | Compares and generates migration statements between two schemas. Permissions required: bb.databases.get |
-| ListChangelogs | [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest) | [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse) | Lists migration history for a database. Permissions required: bb.changelogs.list |
-| GetChangelog | [GetChangelogRequest](#bytebase-v1-GetChangelogRequest) | [Changelog](#bytebase-v1-Changelog) | Retrieves a specific changelog entry. Permissions required: bb.changelogs.get |
-| GetSchemaString | [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest) | [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse) | Generates schema DDL for a database object. Permissions required: bb.databases.getSchema |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the policy to retrieve. Format: {resource type}/{resource id}/policies/{policy type} |
-<a name="v1_group_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/group_service.proto
+<a name="bytebase-v1-ListPoliciesRequest"></a>
-<a name="bytebase-v1-BatchGetGroupsRequest"></a>
+### ListPoliciesRequest
-### BatchGetGroupsRequest
-Request message for batch getting groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The group names to retrieve. Format: groups/{email} |
+| parent | [string](#string) | | The parent, which owns this collection of policies. Format: {resource type}/{resource id} |
+| policy_type | [PolicyType](#bytebase-v1-PolicyType) | optional | Filter by specific policy type. |
+| show_deleted | [bool](#bool) | | Show deleted policies if specified. |
-<a name="bytebase-v1-BatchGetGroupsResponse"></a>
+<a name="bytebase-v1-ListPoliciesResponse"></a>
+
+### ListPoliciesResponse
-### BatchGetGroupsResponse
-Response message for batch getting groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |
+| policies | [Policy](#bytebase-v1-Policy) | repeated | The policies from the specified request. |
-<a name="bytebase-v1-CreateGroupRequest"></a>
+<a name="bytebase-v1-MaskingExemptionPolicy"></a>
-### CreateGroupRequest
-Request message for creating a group.
+### MaskingExemptionPolicy
+MaskingExemptionPolicy is the allowlist of users who can access sensitive data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| group | [Group](#bytebase-v1-Group) | | The group to create. |
-| group_email | [string](#string) | | The email to use for the group, which will become the final component of the group&#39;s resource name. |
+| exemptions | [MaskingExemptionPolicy.Exemption](#bytebase-v1-MaskingExemptionPolicy-Exemption) | repeated | |
-<a name="bytebase-v1-DeleteGroupRequest"></a>
+<a name="bytebase-v1-MaskingExemptionPolicy-Exemption"></a>
+
+### MaskingExemptionPolicy.Exemption
-### DeleteGroupRequest
-Request message for deleting a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the group to delete. Format: groups/{email} |
+| members | [string](#string) | repeated | Specifies the principals who are exempt from masking. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this exception policy instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec If the condition is empty, means the user can access all databases without expiration.
+Support variables: resource.instance_id: the instance resource id. Only support &#34;==&#34; operation. resource.database_name: the database name. Only support &#34;==&#34; operation. resource.schema_name: the schema name. Only support &#34;==&#34; operation. resource.table_name: the table name. Only support &#34;==&#34; operation. resource.column_name: the column name. Only support &#34;==&#34; operation. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)` All variables should join with &#34;&amp;&amp;&#34; condition.
+For example: resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;) resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; |
-<a name="bytebase-v1-GetGroupRequest"></a>
-### GetGroupRequest
-Request message for getting a group.
+
+<a name="bytebase-v1-MaskingRulePolicy"></a>
+
+### MaskingRulePolicy
+Policy for configuring data masking rules.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the group to retrieve. Format: groups/{email} |
+| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |
-<a name="bytebase-v1-Group"></a>
+<a name="bytebase-v1-MaskingRulePolicy-MaskingRule"></a>
-### Group
-A group of users within the workspace.
+### MaskingRulePolicy.MaskingRule
+A rule that defines when and how to mask data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the group to retrieve. Format: groups/{group}, the group should be email or uuid. |
-| title | [string](#string) | | The display title of the group. |
-| description | [string](#string) | | The description of the group. |
-| members | [GroupMember](#bytebase-v1-GroupMember) | repeated | The members of the group. |
-| source | [string](#string) | | The source system where the group originated (e.g., Entra ID for SCIM sync). |
-| email | [string](#string) | | The unique email for the group. |
+| id | [string](#string) | | A unique identifier for the rule in UUID format. |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition for the masking rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Support variables: resource.environment_id: the environment resource id. resource.project_id: the project resource id. resource.instance_id: the instance resource id. resource.database_name: the database name. resource.table_name: the table name. resource.column_name: the column name. resource.classification_level: the classification level.
+
+Each variable support following operations: ==: the value equals the target. !=: the value not equals the target. in: the value matches one of the targets. !(in): the value not matches any of the targets.
+For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34; resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;] resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;]) resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) |
+| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). |
-<a name="bytebase-v1-GroupMember"></a>
-### GroupMember
-A member of a group with a role.
+
+<a name="bytebase-v1-Policy"></a>
+
+### Policy
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| member | [string](#string) | | Member is the principal who belong to this group.
+| name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
+| inherit_from_parent | [bool](#bool) | | Whether this policy inherits from its parent resource. |
+| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy. |
+| rollout_policy | [RolloutPolicy](#bytebase-v1-RolloutPolicy) | | |
+| masking_rule_policy | [MaskingRulePolicy](#bytebase-v1-MaskingRulePolicy) | | |
+| masking_exemption_policy | [MaskingExemptionPolicy](#bytebase-v1-MaskingExemptionPolicy) | | |
+| tag_policy | [TagPolicy](#bytebase-v1-TagPolicy) | | |
+| data_source_query_policy | [DataSourceQueryPolicy](#bytebase-v1-DataSourceQueryPolicy) | | |
+| query_data_policy | [QueryDataPolicy](#bytebase-v1-QueryDataPolicy) | | |
+| enforce | [bool](#bool) | | Whether the policy is enforced. |
+| resource_type | [PolicyResourceType](#bytebase-v1-PolicyResourceType) | | The resource type for the policy. |
-Format: users/[email protected] |
-| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | The member&#39;s role in the group. |
+<a name="bytebase-v1-QueryDataPolicy"></a>
-<a name="bytebase-v1-ListGroupsRequest"></a>
+### QueryDataPolicy
+QueryDataPolicy is the policy configuration for querying data.
-### ListGroupsRequest
-Request message for listing groups.
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The query timeout duration. |
+| disable_export | [bool](#bool) | | Disable data export in the SQL editor. |
+| maximum_result_size | [int64](#int64) | | The maximum result size limit in bytes. The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. |
+| maximum_result_rows | [int32](#int32) | | The maximum number of rows to return. The default value is -1, means no limit. |
+| disable_copy_data | [bool](#bool) | | Disable copying query results. |
+
+
+
+
+
+
+<a name="bytebase-v1-RolloutPolicy"></a>
+
+### RolloutPolicy
+Rollout policy configuration.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 10 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page.
+| automatic | [bool](#bool) | | Whether rollout is automatic without manual approval. |
+| roles | [string](#string) | repeated | The roles that can approve rollout execution. |
-When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter groups returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-Supported filter: - title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-For example: title == &#34;dba&#34; email == &#34;[email protected]&#34; title.matches(&#34;dba&#34;) email.matches(&#34;dba&#34;) project == &#34;projects/sample-project&#34; You can combine filter conditions like: title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) |
+<a name="bytebase-v1-TagPolicy"></a>
+
+### TagPolicy
+Policy for tagging resources with metadata.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| tags | [TagPolicy.TagsEntry](#bytebase-v1-TagPolicy-TagsEntry) | repeated | tags is the key - value map for resources. for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; |
+
-<a name="bytebase-v1-ListGroupsResponse"></a>
-### ListGroupsResponse
-Response message for listing groups.
+
+<a name="bytebase-v1-TagPolicy-TagsEntry"></a>
+
+### TagPolicy.TagsEntry
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-UpdateGroupRequest"></a>
+<a name="bytebase-v1-UpdatePolicyRequest"></a>
+
+### UpdatePolicyRequest
-### UpdateGroupRequest
-Request message for updating a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| group | [Group](#bytebase-v1-Group) | | The group to update.
+| policy | [Policy](#bytebase-v1-Policy) | | The policy to update.
-The group&#39;s `name` field is used to identify the group to update. Format: groups/{email} |
+The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the group is not found, a new group will be created. In this situation, `update_mask` is ignored. |
+| allow_missing | [bool](#bool) | | If set to true, and the policy is not found, a new policy will be created. In this situation, `update_mask` is ignored. |
@@ -5982,16 +5904,47 @@ The group&#39;s `name` field is used to identify the group to update. Format: gr
-<a name="bytebase-v1-GroupMember-Role"></a>
+<a name="bytebase-v1-DataSourceQueryPolicy-Restriction"></a>
-### GroupMember.Role
-The role of a group member.
+### DataSourceQueryPolicy.Restriction
+Restriction level for admin data source access.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| ROLE_UNSPECIFIED | 0 | Unspecified role. |
-| OWNER | 1 | Group owner. |
-| MEMBER | 2 | Group member. |
+| RESTRICTION_UNSPECIFIED | 0 | Unspecified restriction. |
+| FALLBACK | 1 | Allow querying admin data sources when there is no read-only data source. |
+| DISALLOW | 2 | Disallow querying admin data sources. |
+
+
+
+<a name="bytebase-v1-PolicyResourceType"></a>
+
+### PolicyResourceType
+The resource type that a policy can be attached to.
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| RESOURCE_TYPE_UNSPECIFIED | 0 | Unspecified resource type. |
+| WORKSPACE | 1 | Workspace-level policy. |
+| ENVIRONMENT | 2 | Environment-level policy. |
+| PROJECT | 3 | Project-level policy. |
+
+
+
+<a name="bytebase-v1-PolicyType"></a>
+
+### PolicyType
+The type of organizational policy.
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |
+| MASKING_RULE | 1 | Data masking rule policy. |
+| MASKING_EXEMPTION | 2 | Data masking exemption policy. |
+| ROLLOUT_POLICY | 3 | Rollout deployment policy. |
+| TAG | 4 | Resource tag policy. |
+| DATA_SOURCE_QUERY | 5 | Data source query restrictions policy. |
+| DATA_QUERY | 6 | Query data access policy. |
@@ -5999,1817 +5952,1808 @@ The role of a group member.
-<a name="bytebase-v1-GroupService"></a>
+<a name="bytebase-v1-OrgPolicyService"></a>
-### GroupService
-GroupService manages user groups for organizing users and permissions.
+### OrgPolicyService
+OrgPolicyService manages organizational policies at various resource levels.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetGroup | [GetGroupRequest](#bytebase-v1-GetGroupRequest) | [Group](#bytebase-v1-Group) | Gets a group by name. Permissions required: bb.groups.get |
-| BatchGetGroups | [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest) | [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse) | Gets multiple groups in a single request. Permissions required: bb.groups.get |
-| ListGroups | [ListGroupsRequest](#bytebase-v1-ListGroupsRequest) | [ListGroupsResponse](#bytebase-v1-ListGroupsResponse) | Lists all groups in the workspace. Permissions required: bb.groups.list |
-| CreateGroup | [CreateGroupRequest](#bytebase-v1-CreateGroupRequest) | [Group](#bytebase-v1-Group) | Creates a new group. Permissions required: bb.groups.create |
-| UpdateGroup | [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest) | [Group](#bytebase-v1-Group) | Updates a group. Group owners or users with bb.groups.update permission can update. Permissions required: bb.groups.update OR caller is group owner When allow_missing=true, also requires: bb.groups.create |
-| DeleteGroup | [DeleteGroupRequest](#bytebase-v1-DeleteGroupRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a group. Group owners or users with bb.groups.delete permission can delete. Permissions required: bb.groups.delete OR caller is group owner |
+| GetPolicy | [GetPolicyRequest](#bytebase-v1-GetPolicyRequest) | [Policy](#bytebase-v1-Policy) | Retrieves a policy by name. Permissions required: bb.policies.get |
+| ListPolicies | [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest) | [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse) | Lists policies at a specified resource level. Permissions required: bb.policies.list |
+| CreatePolicy | [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Creates a new organizational policy. Permissions required: bb.policies.create |
+| UpdatePolicy | [UpdatePolicyRequest](#bytebase-v1-UpdatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Updates an existing organizational policy. Permissions required: bb.policies.update |
+| DeletePolicy | [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an organizational policy. Permissions required: bb.policies.delete |
-<a name="v1_idp_service-proto"></a>
+<a name="v1_sql_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/idp_service.proto
+## v1/sql_service.proto
-<a name="bytebase-v1-CreateIdentityProviderRequest"></a>
+<a name="bytebase-v1-AICompletionRequest"></a>
-### CreateIdentityProviderRequest
+### AICompletionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to create. |
-| identity_provider_id | [string](#string) | | The ID to use for the identity provider, which will become the final component of the identity provider&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-| validate_only | [bool](#bool) | | If set to true, the request will be validated without actually creating the identity provider. |
+| messages | [AICompletionRequest.Message](#bytebase-v1-AICompletionRequest-Message) | repeated | |
-<a name="bytebase-v1-DeleteIdentityProviderRequest"></a>
+<a name="bytebase-v1-AICompletionRequest-Message"></a>
-### DeleteIdentityProviderRequest
+### AICompletionRequest.Message
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the identity provider to delete. Format: idps/{identity_provider} |
+| role | [string](#string) | | |
+| content | [string](#string) | | |
-<a name="bytebase-v1-FieldMapping"></a>
+<a name="bytebase-v1-AICompletionResponse"></a>
+
+### AICompletionResponse
-### FieldMapping
-FieldMapping saves the field names from user info API of identity provider.
-As we save all raw json string of user info response data into `principal.idp_user_info`,
-we can extract the relevant data based with `FieldMapping`.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identifier | [string](#string) | | Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. |
-| display_name | [string](#string) | | DisplayName is the field name of display name in 3rd-party idp user info. Optional. |
-| phone | [string](#string) | | Phone is the field name of primary phone in 3rd-party idp user info. Optional. |
-| groups | [string](#string) | | Groups is the field name of groups in 3rd-party idp user info. Optional. Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ |
+| candidates | [AICompletionResponse.Candidate](#bytebase-v1-AICompletionResponse-Candidate) | repeated | candidates is used for results with multiple choices and candidates. Used for OpenAI and Gemini. |
-<a name="bytebase-v1-GetIdentityProviderRequest"></a>
+<a name="bytebase-v1-AICompletionResponse-Candidate"></a>
-### GetIdentityProviderRequest
+### AICompletionResponse.Candidate
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |
+| content | [AICompletionResponse.Candidate.Content](#bytebase-v1-AICompletionResponse-Candidate-Content) | | |
-<a name="bytebase-v1-IdentityProvider"></a>
+<a name="bytebase-v1-AICompletionResponse-Candidate-Content"></a>
-### IdentityProvider
+### AICompletionResponse.Candidate.Content
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
-| title | [string](#string) | | The display title of the identity provider. |
-| domain | [string](#string) | | The domain for email matching when using this identity provider. |
-| type | [IdentityProviderType](#bytebase-v1-IdentityProviderType) | | The type of identity provider protocol. |
-| config | [IdentityProviderConfig](#bytebase-v1-IdentityProviderConfig) | | The configuration details for the identity provider. |
+| parts | [AICompletionResponse.Candidate.Content.Part](#bytebase-v1-AICompletionResponse-Candidate-Content-Part) | repeated | parts is used for a result content with multiple parts. |
-<a name="bytebase-v1-IdentityProviderConfig"></a>
+<a name="bytebase-v1-AICompletionResponse-Candidate-Content-Part"></a>
-### IdentityProviderConfig
+### AICompletionResponse.Candidate.Content.Part
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| oauth2_config | [OAuth2IdentityProviderConfig](#bytebase-v1-OAuth2IdentityProviderConfig) | | OAuth2 protocol configuration. |
-| oidc_config | [OIDCIdentityProviderConfig](#bytebase-v1-OIDCIdentityProviderConfig) | | OIDC protocol configuration. |
-| ldap_config | [LDAPIdentityProviderConfig](#bytebase-v1-LDAPIdentityProviderConfig) | | LDAP protocol configuration. |
+| text | [string](#string) | | |
-<a name="bytebase-v1-LDAPIdentityProviderConfig"></a>
+<a name="bytebase-v1-AdminExecuteRequest"></a>
+
+### AdminExecuteRequest
-### LDAPIdentityProviderConfig
-LDAPIdentityProviderConfig is the structure for LDAP identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., &#34;ldap.example.com&#34;. |
-| port | [int32](#int32) | | Port is the port number of the LDAP server, e.g., 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS. |
-| skip_tls_verify | [bool](#bool) | | SkipTLSVerify controls whether to skip TLS certificate verification. |
-| bind_dn | [string](#string) | | BindDN is the DN of the user to bind as a service account to perform search requests. |
-| bind_password | [string](#string) | | BindPassword is the password of the user to bind as a service account. |
-| base_dn | [string](#string) | | BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. |
-| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. |
-| security_protocol | [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol) | | SecurityProtocol is the security protocol to be used for establishing connections with the LDAP server. |
-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | FieldMapping is the mapping of the user attributes returned by the LDAP server. |
+| name | [string](#string) | | The name is the instance name to execute the query against. Format: instances/{instance}/databases/{databaseName} |
+| statement | [string](#string) | | The SQL statement to execute. |
+| limit | [int32](#int32) | | The maximum number of rows to return. |
+| schema | [string](#string) | optional | The default schema to execute the statement. Equals to the current schema in Oracle and search path in Postgres. |
+| container | [string](#string) | optional | Container is the container name to execute the query against, used for CosmosDB only. |
-<a name="bytebase-v1-ListIdentityProvidersRequest"></a>
+<a name="bytebase-v1-AdminExecuteResponse"></a>
-### ListIdentityProvidersRequest
+### AdminExecuteResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
-<a name="bytebase-v1-ListIdentityProvidersResponse"></a>
-### ListIdentityProvidersResponse
+
+<a name="bytebase-v1-Advice"></a>
+
+### Advice
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_providers | [IdentityProvider](#bytebase-v1-IdentityProvider) | repeated | The identity providers from the specified request. |
+| status | [Advice.Level](#bytebase-v1-Advice-Level) | | The advice level. |
+| code | [int32](#int32) | | The advice code. |
+| title | [string](#string) | | The advice title. |
+| content | [string](#string) | | The advice content. |
+| start_position | [Position](#bytebase-v1-Position) | | The start_position is inclusive and the end_position is exclusive. TODO: use range instead |
+| end_position | [Position](#bytebase-v1-Position) | | |
+| rule_type | [Advice.RuleType](#bytebase-v1-Advice-RuleType) | | The type of linting rule that generated this advice. |
-<a name="bytebase-v1-OAuth2IdentityProviderConfig"></a>
+<a name="bytebase-v1-DiffMetadataRequest"></a>
+
+### DiffMetadataRequest
-### OAuth2IdentityProviderConfig
-OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| auth_url | [string](#string) | | The authorization endpoint URL for OAuth2 flow. |
-| token_url | [string](#string) | | The token endpoint URL for exchanging authorization code. |
-| user_info_url | [string](#string) | | The user information endpoint URL. |
-| client_id | [string](#string) | | The OAuth2 client identifier. |
-| client_secret | [string](#string) | | The OAuth2 client secret for authentication. |
-| scopes | [string](#string) | repeated | The list of OAuth2 scopes to request. |
-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OAuth2 response. |
-| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |
-| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. |
+| source_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the source schema. |
+| target_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the target schema. |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine of the schema. |
-<a name="bytebase-v1-OAuth2IdentityProviderTestRequestContext"></a>
+<a name="bytebase-v1-DiffMetadataResponse"></a>
-### OAuth2IdentityProviderTestRequestContext
+### DiffMetadataResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorize code from website. |
+| diff | [string](#string) | | The diff of the metadata. |
-<a name="bytebase-v1-OIDCIdentityProviderConfig"></a>
+<a name="bytebase-v1-ExportRequest"></a>
+
+### ExportRequest
-### OIDCIdentityProviderConfig
-OIDCIdentityProviderConfig is the structure for OIDC identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issuer | [string](#string) | | The OIDC issuer URL for the identity provider. |
-| client_id | [string](#string) | | The OIDC client identifier. |
-| client_secret | [string](#string) | | The OIDC client secret for authentication. |
-| scopes | [string](#string) | repeated | The scopes that the OIDC provider supports. Should be fetched from the well-known configuration file of the OIDC provider. |
-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OIDC claims. |
-| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |
-| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. |
-| auth_endpoint | [string](#string) | | The authorization endpoint of the OIDC provider. Should be fetched from the well-known configuration file of the OIDC provider. |
+| name | [string](#string) | | The name is the resource name to execute the export against. Format: instances/{instance}/databases/{database} Format: instances/{instance} Format: projects/{project}/rollouts/{rollout} Format: projects/{project}/rollouts/{rollout}/stages/{stage} |
+| statement | [string](#string) | | The SQL statement to execute. |
+| limit | [int32](#int32) | | The maximum number of rows to return. |
+| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The export format. |
+| admin | [bool](#bool) | | The admin is used for workspace owner and DBA for exporting data from SQL Editor Admin mode. The exported data is not masked. |
+| password | [string](#string) | | The zip password provide by users. |
+| data_source_id | [string](#string) | | The id of data source. It is used for querying admin data source even if the instance has read-only data sources. Or it can be used to query a specific read-only data source. |
+| schema | [string](#string) | optional | The default schema to search objects. Equals to the current schema in Oracle and search path in Postgres. |
-<a name="bytebase-v1-OIDCIdentityProviderTestRequestContext"></a>
+<a name="bytebase-v1-ExportResponse"></a>
-### OIDCIdentityProviderTestRequestContext
+### ExportResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorize code from OIDC provider. |
+| content | [bytes](#bytes) | | The export file content. |
-<a name="bytebase-v1-TestIdentityProviderRequest"></a>
+<a name="bytebase-v1-MaskingReason"></a>
-### TestIdentityProviderRequest
+### MaskingReason
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to test connection including uncreated. |
-| oauth2_context | [OAuth2IdentityProviderTestRequestContext](#bytebase-v1-OAuth2IdentityProviderTestRequestContext) | | |
-| oidc_context | [OIDCIdentityProviderTestRequestContext](#bytebase-v1-OIDCIdentityProviderTestRequestContext) | | OIDC authentication context for test connection. |
+| semantic_type_id | [string](#string) | | The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). |
+| semantic_type_title | [string](#string) | | Human-readable semantic type title. |
+| masking_rule_id | [string](#string) | | The masking rule ID that matched (if applicable). |
+| algorithm | [string](#string) | | The masking algorithm used. |
+| context | [string](#string) | | Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). |
+| classification_level | [string](#string) | | Whether masking was due to classification level. |
+| semantic_type_icon | [string](#string) | | Icon associated with the semantic type (if any). |
-<a name="bytebase-v1-TestIdentityProviderResponse"></a>
+<a name="bytebase-v1-QueryHistory"></a>
-### TestIdentityProviderResponse
+### QueryHistory
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| claims | [TestIdentityProviderResponse.ClaimsEntry](#bytebase-v1-TestIdentityProviderResponse-ClaimsEntry) | repeated | The map of claims returned by the identity provider. |
-| user_info | [TestIdentityProviderResponse.UserInfoEntry](#bytebase-v1-TestIdentityProviderResponse-UserInfoEntry) | repeated | The matched user info from the claims. |
+| name | [string](#string) | | The name for the query history. Format: queryHistories/{uid} |
+| database | [string](#string) | | The database name to execute the query. Format: instances/{instance}/databases/{databaseName} |
+| creator | [string](#string) | | |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| statement | [string](#string) | | |
+| error | [string](#string) | optional | |
+| duration | [google.protobuf.Duration](#google-protobuf-Duration) | | |
+| type | [QueryHistory.Type](#bytebase-v1-QueryHistory-Type) | | |
-<a name="bytebase-v1-TestIdentityProviderResponse-ClaimsEntry"></a>
+<a name="bytebase-v1-QueryOption"></a>
-### TestIdentityProviderResponse.ClaimsEntry
+### QueryOption
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| redis_run_commands_on | [QueryOption.RedisRunCommandsOn](#bytebase-v1-QueryOption-RedisRunCommandsOn) | | |
+| mssql_explain_format | [QueryOption.MSSQLExplainFormat](#bytebase-v1-QueryOption-MSSQLExplainFormat) | | |
-<a name="bytebase-v1-TestIdentityProviderResponse-UserInfoEntry"></a>
+<a name="bytebase-v1-QueryRequest"></a>
-### TestIdentityProviderResponse.UserInfoEntry
+### QueryRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| name | [string](#string) | | The name is the instance name to execute the query against. Format: instances/{instance}/databases/{databaseName} |
+| statement | [string](#string) | | The SQL statement to execute. |
+| limit | [int32](#int32) | | The maximum number of rows to return. |
+| data_source_id | [string](#string) | | The id of data source. It is used for querying admin data source even if the instance has read-only data sources. Or it can be used to query a specific read-only data source. |
+| explain | [bool](#bool) | | Explain the statement. |
+| schema | [string](#string) | optional | The default schema to search objects. Equals to the current schema in Oracle and search path in Postgres. |
+| query_option | [QueryOption](#bytebase-v1-QueryOption) | | |
+| container | [string](#string) | optional | Container is the container name to execute the query against, used for CosmosDB only. |
-<a name="bytebase-v1-UpdateIdentityProviderRequest"></a>
+<a name="bytebase-v1-QueryResponse"></a>
-### UpdateIdentityProviderRequest
+### QueryResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to update.
-
-The identity provider&#39;s `name` field is used to identify the identity provider to update. Format: idps/{identity_provider} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the identity provider is not found, a new identity provider will be created. In this situation, `update_mask` is ignored. |
-
-
-
+| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
-
-<a name="bytebase-v1-IdentityProviderType"></a>
-### IdentityProviderType
+<a name="bytebase-v1-QueryResult"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| IDENTITY_PROVIDER_TYPE_UNSPECIFIED | 0 | Unspecified identity provider type. |
-| OAUTH2 | 1 | OAuth 2.0 authentication protocol. |
-| OIDC | 2 | OpenID Connect authentication protocol. |
-| LDAP | 3 | LDAP directory service authentication. |
+### QueryResult
-<a name="bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| column_names | [string](#string) | repeated | Column names of the query result. |
+| column_type_names | [string](#string) | repeated | Column types of the query result. The types come from the Golang SQL driver. |
+| rows | [QueryRow](#bytebase-v1-QueryRow) | repeated | Rows of the query result. |
+| rows_count | [int64](#int64) | | |
+| error | [string](#string) | | The error message if the query failed. |
+| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The time it takes to execute the query. |
+| statement | [string](#string) | | The query statement for the result. |
+| postgres_error | [QueryResult.PostgresError](#bytebase-v1-QueryResult-PostgresError) | | |
+| syntax_error | [QueryResult.SyntaxError](#bytebase-v1-QueryResult-SyntaxError) | | |
+| permission_denied | [QueryResult.PermissionDenied](#bytebase-v1-QueryResult-PermissionDenied) | | |
+| messages | [QueryResult.Message](#bytebase-v1-QueryResult-Message) | repeated | Informational or debug messages returned by the database engine during query execution. Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. |
+| masked | [MaskingReason](#bytebase-v1-MaskingReason) | repeated | Masking reasons for each column (empty for non-masked columns). |
-### LDAPIdentityProviderConfig.SecurityProtocol
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SECURITY_PROTOCOL_UNSPECIFIED | 0 | |
-| START_TLS | 1 | StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS. |
-| LDAPS | 2 | LDAPS is the security protocol that uses TLS from the beginning. |
-<a name="bytebase-v1-OAuth2AuthStyle"></a>
+<a name="bytebase-v1-QueryResult-Message"></a>
-### OAuth2AuthStyle
+### QueryResult.Message
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | |
-| IN_PARAMS | 1 | IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body as application/x-www-form-urlencoded parameters. |
-| IN_HEADER | 2 | IN_HEADER sends the client_id and client_password using HTTP Basic Authorization. This is an optional style described in the OAuth2 RFC 6749 section 2.3.1. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| level | [QueryResult.Message.Level](#bytebase-v1-QueryResult-Message-Level) | | |
+| content | [string](#string) | | |
-
-
-<a name="bytebase-v1-IdentityProviderService"></a>
-### IdentityProviderService
-IdentityProviderService manages external identity providers for SSO authentication.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetIdentityProvider | [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Gets an identity provider by name. Permissions required: bb.identityProviders.get |
-| ListIdentityProviders | [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest) | [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse) | Lists all configured identity providers (public endpoint for login page). Permissions required: None |
-| CreateIdentityProvider | [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Creates a new identity provider. Permissions required: bb.identityProviders.create |
-| UpdateIdentityProvider | [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Updates an identity provider. Permissions required: bb.identityProviders.update When allow_missing=true, also requires: bb.identityProviders.create |
-| DeleteIdentityProvider | [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an identity provider. Permissions required: bb.identityProviders.delete |
-| TestIdentityProvider | [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest) | [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse) | Tests the connection and configuration of an identity provider. Permissions required: bb.identityProviders.update |
+<a name="bytebase-v1-QueryResult-PermissionDenied"></a>
-
+### QueryResult.PermissionDenied
+Permission denied with resource information or disallowed command_type.
+Either resources or command_type is available.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| resources | [string](#string) | repeated | Denied to access the resources. Format: instances/{instance}/databases/{database} instances/{instance}/databases/{database}/schemas/{schema} instances/{instance}/databases/{database}/tables/{table} instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} |
+| command_type | [QueryResult.PermissionDenied.CommandType](#bytebase-v1-QueryResult-PermissionDenied-CommandType) | | Disallowed command_type. |
-<a name="v1_org_policy_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/org_policy_service.proto
-<a name="bytebase-v1-CreatePolicyRequest"></a>
-### CreatePolicyRequest
+<a name="bytebase-v1-QueryResult-PostgresError"></a>
+### QueryResult.PostgresError
+refer https://www.postgresql.org/docs/11/protocol-error-fields.html
+for field description.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| policy | [Policy](#bytebase-v1-Policy) | | The policy to create. |
-| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy to create. |
+| severity | [string](#string) | | |
+| code | [string](#string) | | |
+| message | [string](#string) | | |
+| detail | [string](#string) | | |
+| hint | [string](#string) | | |
+| position | [int32](#int32) | | |
+| internal_position | [int32](#int32) | | |
+| internal_query | [string](#string) | | |
+| where | [string](#string) | | |
+| schema_name | [string](#string) | | |
+| table_name | [string](#string) | | |
+| column_name | [string](#string) | | |
+| data_type_name | [string](#string) | | |
+| constraint_name | [string](#string) | | |
+| file | [string](#string) | | |
+| line | [int32](#int32) | | |
+| routine | [string](#string) | | |
-<a name="bytebase-v1-DataSourceQueryPolicy"></a>
+<a name="bytebase-v1-QueryResult-SyntaxError"></a>
-### DataSourceQueryPolicy
-Policy for controlling which data sources can be queried in the SQL editor.
+### QueryResult.SyntaxError
+Syntax error with position information for editor highlighting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| admin_data_source_restriction | [DataSourceQueryPolicy.Restriction](#bytebase-v1-DataSourceQueryPolicy-Restriction) | | Restriction for admin data source queries. |
-| disallow_ddl | [bool](#bool) | | Disallow running DDL statements in the SQL editor. |
-| disallow_dml | [bool](#bool) | | Disallow running DML statements in the SQL editor. |
+| start_position | [Position](#bytebase-v1-Position) | | Position information for highlighting in editor |
-<a name="bytebase-v1-DeletePolicyRequest"></a>
+<a name="bytebase-v1-QueryRow"></a>
-### DeletePolicyRequest
+### QueryRow
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
+| values | [RowValue](#bytebase-v1-RowValue) | repeated | Row values of the query result. |
-<a name="bytebase-v1-GetPolicyRequest"></a>
+<a name="bytebase-v1-RowValue"></a>
-### GetPolicyRequest
+### RowValue
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the policy to retrieve. Format: {resource type}/{resource id}/policies/{policy type} |
-
-
-
-
+| null_value | [google.protobuf.NullValue](#google-protobuf-NullValue) | | |
+| bool_value | [bool](#bool) | | |
+| bytes_value | [bytes](#bytes) | | |
+| double_value | [double](#double) | | |
+| float_value | [float](#float) | | |
+| int32_value | [int32](#int32) | | |
+| int64_value | [int64](#int64) | | |
+| string_value | [string](#string) | | |
+| uint32_value | [uint32](#uint32) | | |
+| uint64_value | [uint64](#uint64) | | |
+| value_value | [google.protobuf.Value](#google-protobuf-Value) | | value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. |
+| timestamp_value | [RowValue.Timestamp](#bytebase-v1-RowValue-Timestamp) | | timestamp_value is used for the timestamp without time zone data type, meaning it only includes the timestamp without any time zone or location info. Although it may be expressed as a UTC value, it should be seen as a timestamp missing location context. |
+| timestamp_tz_value | [RowValue.TimestampTZ](#bytebase-v1-RowValue-TimestampTZ) | | timestamp_tz_value is used for the timestamptz data type, which accurately represents the timestamp with location information. |
+
-<a name="bytebase-v1-ListPoliciesRequest"></a>
-### ListPoliciesRequest
+
+
+<a name="bytebase-v1-RowValue-Timestamp"></a>
+
+### RowValue.Timestamp
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of policies. Format: {resource type}/{resource id} |
-| policy_type | [PolicyType](#bytebase-v1-PolicyType) | optional | Filter by specific policy type. |
-| show_deleted | [bool](#bool) | | Show deleted policies if specified. |
+| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| accuracy | [int32](#int32) | | The accuracy is the number of digits after the decimal point. |
-<a name="bytebase-v1-ListPoliciesResponse"></a>
+<a name="bytebase-v1-RowValue-TimestampTZ"></a>
-### ListPoliciesResponse
+### RowValue.TimestampTZ
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policies | [Policy](#bytebase-v1-Policy) | repeated | The policies from the specified request. |
+| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| zone | [string](#string) | | Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;, &#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We retrieve the time zone information from the timestamptz field in the database. A timestamp is in UTC or epoch time, and with zone info, we can convert it to a local time string. Zone and offset are returned by time.Time.Zone() |
+| offset | [int32](#int32) | | The offset is in seconds east of UTC |
+| accuracy | [int32](#int32) | | |
-<a name="bytebase-v1-MaskingExemptionPolicy"></a>
+<a name="bytebase-v1-SearchQueryHistoriesRequest"></a>
+
+### SearchQueryHistoriesRequest
-### MaskingExemptionPolicy
-MaskingExemptionPolicy is the allowlist of users who can access sensitive data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| exemptions | [MaskingExemptionPolicy.Exemption](#bytebase-v1-MaskingExemptionPolicy-Exemption) | repeated | |
+| page_size | [int32](#int32) | | The maximum number of histories to return. The service may return fewer than this value. If unspecified, at most 10 history entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListQueryHistory` call. Provide this to retrieve the subsequent page. |
+| filter | [string](#string) | | Filter is the filter to apply on the search query history The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator. - statement: the SQL statement, support &#34;.matches()&#34; operator.
+For example: project == &#34;projects/{project}&#34; database == &#34;instances/{instance}/databases/{database}&#34; instance == &#34;instances/{instance}&#34; type == &#34;QUERY&#34; type == &#34;EXPORT&#34; statement.matches(&#34;select&#34;) type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) |
-<a name="bytebase-v1-MaskingExemptionPolicy-Exemption"></a>
-### MaskingExemptionPolicy.Exemption
+
+<a name="bytebase-v1-SearchQueryHistoriesResponse"></a>
+
+### SearchQueryHistoriesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| members | [string](#string) | repeated | Specifies the principals who are exempt from masking. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this exception policy instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec If the condition is empty, means the user can access all databases without expiration.
+| query_histories | [QueryHistory](#bytebase-v1-QueryHistory) | repeated | The list of history. |
+| next_page_token | [string](#string) | | A token to retrieve next page of history. Pass this value in the page_token field in the subsequent call to `ListQueryHistory` method to retrieve the next page of history. |
-Support variables: resource.instance_id: the instance resource id. Only support &#34;==&#34; operation. resource.database_name: the database name. Only support &#34;==&#34; operation. resource.schema_name: the schema name. Only support &#34;==&#34; operation. resource.table_name: the table name. Only support &#34;==&#34; operation. resource.column_name: the column name. Only support &#34;==&#34; operation. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)` All variables should join with &#34;&amp;&amp;&#34; condition.
-For example: resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;) resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; |
+
+<a name="bytebase-v1-Advice-Level"></a>
-<a name="bytebase-v1-MaskingRulePolicy"></a>
+### Advice.Level
+Level represents the severity level of the advice.
-### MaskingRulePolicy
-Policy for configuring data masking rules.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ADVICE_LEVEL_UNSPECIFIED | 0 | Unspecified advice level. |
+| SUCCESS | 1 | Success status indicating the check passed without issues. |
+| WARNING | 2 | Warning status indicating potential issues that should be reviewed. |
+| ERROR | 3 | Error status indicating critical issues that must be addressed. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |
+<a name="bytebase-v1-Advice-RuleType"></a>
+### Advice.RuleType
+RuleType indicates the source of the linting rule.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| RULE_TYPE_UNSPECIFIED | 0 | Unspecified rule type. |
+| PARSER_BASED | 1 | Parser-based rule enforced by the built-in SQL parser. These are non-configurable, mandatory checks for schema health. |
+| AI_POWERED | 2 | AI-powered rule defined by user in natural language. These are custom, flexible checks powered by AI models. |
-<a name="bytebase-v1-MaskingRulePolicy-MaskingRule"></a>
+<a name="bytebase-v1-QueryHistory-Type"></a>
-### MaskingRulePolicy.MaskingRule
-A rule that defines when and how to mask data.
+### QueryHistory.Type
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | A unique identifier for the rule in UUID format. |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition for the masking rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified query history type. |
+| QUERY | 1 | Query execution for data retrieval. |
+| EXPORT | 2 | Data export operation to file. |
-Support variables: resource.environment_id: the environment resource id. resource.project_id: the project resource id. resource.instance_id: the instance resource id. resource.database_name: the database name. resource.table_name: the table name. resource.column_name: the column name. resource.classification_level: the classification level.
-Each variable support following operations: ==: the value equals the target. !=: the value not equals the target. in: the value matches one of the targets. !(in): the value not matches any of the targets.
-For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34; resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;] resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;]) resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) |
-| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). |
+<a name="bytebase-v1-QueryOption-MSSQLExplainFormat"></a>
+### QueryOption.MSSQLExplainFormat
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| MSSQL_EXPLAIN_FORMAT_UNSPECIFIED | 0 | defaults to SHOWPLAN_ALL |
+| MSSQL_EXPLAIN_FORMAT_ALL | 1 | SHOWPLAN_ALL |
+| MSSQL_EXPLAIN_FORMAT_XML | 2 | SHOWPLAN_XML |
-<a name="bytebase-v1-Policy"></a>
+<a name="bytebase-v1-QueryOption-RedisRunCommandsOn"></a>
-### Policy
+### QueryOption.RedisRunCommandsOn
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| REDIS_RUN_COMMANDS_ON_UNSPECIFIED | 0 | UNSPECIFIED defaults to SINGLE_NODE. |
+| SINGLE_NODE | 1 | Execute Redis commands on a single node in the cluster. |
+| ALL_NODES | 2 | Execute Redis commands on all nodes in the cluster for cluster-wide operations. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| inherit_from_parent | [bool](#bool) | | Whether this policy inherits from its parent resource. |
-| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy. |
-| rollout_policy | [RolloutPolicy](#bytebase-v1-RolloutPolicy) | | |
-| masking_rule_policy | [MaskingRulePolicy](#bytebase-v1-MaskingRulePolicy) | | |
-| masking_exemption_policy | [MaskingExemptionPolicy](#bytebase-v1-MaskingExemptionPolicy) | | |
-| tag_policy | [TagPolicy](#bytebase-v1-TagPolicy) | | |
-| data_source_query_policy | [DataSourceQueryPolicy](#bytebase-v1-DataSourceQueryPolicy) | | |
-| query_data_policy | [QueryDataPolicy](#bytebase-v1-QueryDataPolicy) | | |
-| enforce | [bool](#bool) | | Whether the policy is enforced. |
-| resource_type | [PolicyResourceType](#bytebase-v1-PolicyResourceType) | | The resource type for the policy. |
+<a name="bytebase-v1-QueryResult-Message-Level"></a>
+### QueryResult.Message.Level
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| LEVEL_UNSPECIFIED | 0 | Unspecified message level. |
+| INFO | 1 | Informational message. |
+| WARNING | 2 | Warning message indicating potential issues. |
+| DEBUG | 3 | Debug message for development and troubleshooting. |
+| LOG | 4 | General log message. |
+| NOTICE | 5 | Notice message for important information. |
+| EXCEPTION | 6 | Exception message indicating error conditions. |
-<a name="bytebase-v1-QueryDataPolicy"></a>
-### QueryDataPolicy
-QueryDataPolicy is the policy configuration for querying data.
+<a name="bytebase-v1-QueryResult-PermissionDenied-CommandType"></a>
+
+### QueryResult.PermissionDenied.CommandType
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The query timeout duration. |
-| disable_export | [bool](#bool) | | Disable data export in the SQL editor. |
-| maximum_result_size | [int64](#int64) | | The maximum result size limit in bytes. The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. |
-| maximum_result_rows | [int32](#int32) | | The maximum number of rows to return. The default value is -1, means no limit. |
-| disable_copy_data | [bool](#bool) | | Disable copying query results. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| COMMAND_TYPE_UNSPECIFIED | 0 | |
+| DDL | 1 | |
+| DML | 2 | |
+| NON_READ_ONLY | 3 | |
+
+
-<a name="bytebase-v1-RolloutPolicy"></a>
+<a name="bytebase-v1-SQLService"></a>
-### RolloutPolicy
-Rollout policy configuration.
+### SQLService
+SQLService executes SQL queries and manages query operations.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| Query | [QueryRequest](#bytebase-v1-QueryRequest) | [QueryResponse](#bytebase-v1-QueryResponse) | Executes a read-only SQL query against a database. Permissions required: bb.databases.get |
+| AdminExecute | [AdminExecuteRequest](#bytebase-v1-AdminExecuteRequest) stream | [AdminExecuteResponse](#bytebase-v1-AdminExecuteResponse) stream | Executes SQL with admin privileges via streaming connection. Permissions required: bb.sql.admin |
+| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller&#39;s own query histories) |
+| Export | [ExportRequest](#bytebase-v1-ExportRequest) | [ExportResponse](#bytebase-v1-ExportResponse) | Exports query results to a file format. Permissions required: bb.databases.get |
+| DiffMetadata | [DiffMetadataRequest](#bytebase-v1-DiffMetadataRequest) | [DiffMetadataResponse](#bytebase-v1-DiffMetadataResponse) | Computes schema differences between two database metadata. Permissions required: None |
+| AICompletion | [AICompletionRequest](#bytebase-v1-AICompletionRequest) | [AICompletionResponse](#bytebase-v1-AICompletionResponse) | Provides AI-powered SQL completion and generation. Permissions required: None (authenticated users only, requires AI to be enabled) |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| automatic | [bool](#bool) | | Whether rollout is automatic without manual approval. |
-| roles | [string](#string) | repeated | The roles that can approve rollout execution. |
+
+<a name="v1_plan_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/plan_service.proto
-<a name="bytebase-v1-TagPolicy"></a>
-### TagPolicy
-Policy for tagging resources with metadata.
+<a name="bytebase-v1-CancelPlanCheckRunRequest"></a>
+### CancelPlanCheckRunRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| tags | [TagPolicy.TagsEntry](#bytebase-v1-TagPolicy-TagsEntry) | repeated | tags is the key - value map for resources. for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the plan check run to cancel. Format: projects/{project}/plans/{plan}/planCheckRun |
-<a name="bytebase-v1-TagPolicy-TagsEntry"></a>
-### TagPolicy.TagsEntry
+<a name="bytebase-v1-CancelPlanCheckRunResponse"></a>
+### CancelPlanCheckRunResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
-<a name="bytebase-v1-UpdatePolicyRequest"></a>
+<a name="bytebase-v1-CreatePlanRequest"></a>
-### UpdatePolicyRequest
+### CreatePlanRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policy | [Policy](#bytebase-v1-Policy) | | The policy to update.
+| parent | [string](#string) | | The parent project where this plan will be created. Format: projects/{project} |
+| plan | [Plan](#bytebase-v1-Plan) | | The plan to create. |
-The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the policy is not found, a new policy will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-GetPlanCheckRunRequest"></a>
+### GetPlanCheckRunRequest
-<a name="bytebase-v1-DataSourceQueryPolicy-Restriction"></a>
-### DataSourceQueryPolicy.Restriction
-Restriction level for admin data source access.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| RESTRICTION_UNSPECIFIED | 0 | Unspecified restriction. |
-| FALLBACK | 1 | Allow querying admin data sources when there is no read-only data source. |
-| DISALLOW | 2 | Disallow querying admin data sources. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the plan check run to retrieve. Format: projects/{project}/plans/{plan}/planCheckRun |
-<a name="bytebase-v1-PolicyResourceType"></a>
-### PolicyResourceType
-The resource type that a policy can be attached to.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| RESOURCE_TYPE_UNSPECIFIED | 0 | Unspecified resource type. |
-| WORKSPACE | 1 | Workspace-level policy. |
-| ENVIRONMENT | 2 | Environment-level policy. |
-| PROJECT | 3 | Project-level policy. |
+<a name="bytebase-v1-GetPlanRequest"></a>
+### GetPlanRequest
-<a name="bytebase-v1-PolicyType"></a>
-### PolicyType
-The type of organizational policy.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |
-| MASKING_RULE | 1 | Data masking rule policy. |
-| MASKING_EXEMPTION | 2 | Data masking exemption policy. |
-| ROLLOUT_POLICY | 3 | Rollout deployment policy. |
-| TAG | 4 | Resource tag policy. |
-| DATA_SOURCE_QUERY | 5 | Data source query restrictions policy. |
-| DATA_QUERY | 6 | Query data access policy. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the plan to retrieve. Format: projects/{project}/plans/{plan} |
-
-
-<a name="bytebase-v1-OrgPolicyService"></a>
-### OrgPolicyService
-OrgPolicyService manages organizational policies at various resource levels.
-
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetPolicy | [GetPolicyRequest](#bytebase-v1-GetPolicyRequest) | [Policy](#bytebase-v1-Policy) | Retrieves a policy by name. Permissions required: bb.policies.get |
-| ListPolicies | [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest) | [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse) | Lists policies at a specified resource level. Permissions required: bb.policies.list |
-| CreatePolicy | [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Creates a new organizational policy. Permissions required: bb.policies.create |
-| UpdatePolicy | [UpdatePolicyRequest](#bytebase-v1-UpdatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Updates an existing organizational policy. Permissions required: bb.policies.update |
-| DeletePolicy | [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an organizational policy. Permissions required: bb.policies.delete |
-
-
-
-
-
-<a name="v1_sql_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-
-## v1/sql_service.proto
+<a name="bytebase-v1-ListPlansRequest"></a>
+### ListPlansRequest
-<a name="bytebase-v1-AICompletionRequest"></a>
-### AICompletionRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use &#34;projects/-&#34; to list all plans from all projects. |
+| page_size | [int32](#int32) | | The maximum number of plans to return. The service may return fewer than this value. If unspecified, at most 10 plans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListPlans` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListPlans` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter plans returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filters: - creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match. - spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;. - state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| messages | [AICompletionRequest.Message](#bytebase-v1-AICompletionRequest-Message) | repeated | |
+For example: creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; has_rollout == false &amp;&amp; has_issue == true title == &#34;My Plan&#34; title.matches(&#34;database migration&#34;) spec_type == &#34;change_database_config&#34; state == &#34;ACTIVE&#34; |
-<a name="bytebase-v1-AICompletionRequest-Message"></a>
+<a name="bytebase-v1-ListPlansResponse"></a>
-### AICompletionRequest.Message
+### ListPlansResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [string](#string) | | |
-| content | [string](#string) | | |
+| plans | [Plan](#bytebase-v1-Plan) | repeated | The plans from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-AICompletionResponse"></a>
+<a name="bytebase-v1-Plan"></a>
-### AICompletionResponse
+### Plan
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| candidates | [AICompletionResponse.Candidate](#bytebase-v1-AICompletionResponse-Candidate) | repeated | candidates is used for results with multiple choices and candidates. Used for OpenAI and Gemini. |
+| name | [string](#string) | | The name of the plan. `plan` is a system generated ID. Format: projects/{project}/plans/{plan} |
+| state | [State](#bytebase-v1-State) | | The state of the plan. |
+| issue | [string](#string) | | The issue associated with the plan. Can be empty. Format: projects/{project}/issues/{issue} |
+| title | [string](#string) | | The title of the plan. |
+| description | [string](#string) | | The description of the plan. |
+| specs | [Plan.Spec](#bytebase-v1-Plan-Spec) | repeated | The deployment specs for the plan. |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| plan_check_run_status_count | [Plan.PlanCheckRunStatusCountEntry](#bytebase-v1-Plan-PlanCheckRunStatusCountEntry) | repeated | The status count of the latest plan check runs. Keys are: - SUCCESS - WARNING - ERROR - RUNNING |
+| has_rollout | [bool](#bool) | | Whether the plan has started the rollout. |
-<a name="bytebase-v1-AICompletionResponse-Candidate"></a>
+<a name="bytebase-v1-Plan-ChangeDatabaseConfig"></a>
-### AICompletionResponse.Candidate
+### Plan.ChangeDatabaseConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [AICompletionResponse.Candidate.Content](#bytebase-v1-AICompletionResponse-Candidate-Content) | | |
+| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. |
+| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
+| release | [string](#string) | | The resource name of the release. Format: projects/{project}/releases/{release} |
+| ghost_flags | [Plan.ChangeDatabaseConfig.GhostFlagsEntry](#bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry) | repeated | |
+| enable_prior_backup | [bool](#bool) | | If set, a backup of the modified data will be created automatically before any changes are applied. |
+| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
-<a name="bytebase-v1-AICompletionResponse-Candidate-Content"></a>
+<a name="bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry"></a>
-### AICompletionResponse.Candidate.Content
+### Plan.ChangeDatabaseConfig.GhostFlagsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parts | [AICompletionResponse.Candidate.Content.Part](#bytebase-v1-AICompletionResponse-Candidate-Content-Part) | repeated | parts is used for a result content with multiple parts. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-AICompletionResponse-Candidate-Content-Part"></a>
+<a name="bytebase-v1-Plan-CreateDatabaseConfig"></a>
-### AICompletionResponse.Candidate.Content.Part
+### Plan.CreateDatabaseConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| text | [string](#string) | | |
+| target | [string](#string) | | The resource name of the instance on which the database is created. Format: instances/{instance} |
+| database | [string](#string) | | The name of the database to create. |
+| table | [string](#string) | | table is the name of the table, if it is not empty, Bytebase should create a table after creating the database. For example, in MongoDB, it only creates the database when we first store data in that database. |
+| character_set | [string](#string) | | character_set is the character set of the database. |
+| collation | [string](#string) | | collation is the collation of the database. |
+| cluster | [string](#string) | | cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. |
+| owner | [string](#string) | | owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. |
+| environment | [string](#string) | | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-<a name="bytebase-v1-AdminExecuteRequest"></a>
+<a name="bytebase-v1-Plan-ExportDataConfig"></a>
-### AdminExecuteRequest
+### Plan.ExportDataConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the instance name to execute the query against. Format: instances/{instance}/databases/{databaseName} |
-| statement | [string](#string) | | The SQL statement to execute. |
-| limit | [int32](#int32) | | The maximum number of rows to return. |
-| schema | [string](#string) | optional | The default schema to execute the statement. Equals to the current schema in Oracle and search path in Postgres. |
-| container | [string](#string) | optional | Container is the container name to execute the query against, used for CosmosDB only. |
+| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. |
+| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
+| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The format of the exported file. |
+| password | [string](#string) | optional | The zip password provide by users. Leave it empty if no needs to encrypt the zip file. |
-<a name="bytebase-v1-AdminExecuteResponse"></a>
+<a name="bytebase-v1-Plan-PlanCheckRunStatusCountEntry"></a>
-### AdminExecuteResponse
+### Plan.PlanCheckRunStatusCountEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
+| key | [string](#string) | | |
+| value | [int32](#int32) | | |
-<a name="bytebase-v1-Advice"></a>
+<a name="bytebase-v1-Plan-Spec"></a>
-### Advice
+### Plan.Spec
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [Advice.Level](#bytebase-v1-Advice-Level) | | The advice level. |
-| code | [int32](#int32) | | The advice code. |
-| title | [string](#string) | | The advice title. |
-| content | [string](#string) | | The advice content. |
-| start_position | [Position](#bytebase-v1-Position) | | The start_position is inclusive and the end_position is exclusive. TODO: use range instead |
-| end_position | [Position](#bytebase-v1-Position) | | |
-| rule_type | [Advice.RuleType](#bytebase-v1-Advice-RuleType) | | The type of linting rule that generated this advice. |
+| id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. |
+| create_database_config | [Plan.CreateDatabaseConfig](#bytebase-v1-Plan-CreateDatabaseConfig) | | |
+| change_database_config | [Plan.ChangeDatabaseConfig](#bytebase-v1-Plan-ChangeDatabaseConfig) | | |
+| export_data_config | [Plan.ExportDataConfig](#bytebase-v1-Plan-ExportDataConfig) | | |
-<a name="bytebase-v1-DiffMetadataRequest"></a>
+<a name="bytebase-v1-PlanCheckRun"></a>
-### DiffMetadataRequest
+### PlanCheckRun
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| source_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the source schema. |
-| target_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the target schema. |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine of the schema. |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/planCheckRun |
+| status | [PlanCheckRun.Status](#bytebase-v1-PlanCheckRun-Status) | | |
+| results | [PlanCheckRun.Result](#bytebase-v1-PlanCheckRun-Result) | repeated | |
+| error | [string](#string) | | error is set if the Status is FAILED. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-<a name="bytebase-v1-DiffMetadataResponse"></a>
+<a name="bytebase-v1-PlanCheckRun-Result"></a>
-### DiffMetadataResponse
+### PlanCheckRun.Result
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| diff | [string](#string) | | The diff of the metadata. |
+| status | [Advice.Level](#bytebase-v1-Advice-Level) | | |
+| title | [string](#string) | | |
+| content | [string](#string) | | |
+| code | [int32](#int32) | | |
+| target | [string](#string) | | Target identification for consolidated results. Format: instances/{instance}/databases/{database} |
+| type | [PlanCheckRun.Result.Type](#bytebase-v1-PlanCheckRun-Result-Type) | | |
+| sql_summary_report | [PlanCheckRun.Result.SqlSummaryReport](#bytebase-v1-PlanCheckRun-Result-SqlSummaryReport) | | |
+| sql_review_report | [PlanCheckRun.Result.SqlReviewReport](#bytebase-v1-PlanCheckRun-Result-SqlReviewReport) | | |
-<a name="bytebase-v1-ExportRequest"></a>
+<a name="bytebase-v1-PlanCheckRun-Result-SqlReviewReport"></a>
-### ExportRequest
+### PlanCheckRun.Result.SqlReviewReport
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the resource name to execute the export against. Format: instances/{instance}/databases/{database} Format: instances/{instance} Format: projects/{project}/rollouts/{rollout} Format: projects/{project}/rollouts/{rollout}/stages/{stage} |
-| statement | [string](#string) | | The SQL statement to execute. |
-| limit | [int32](#int32) | | The maximum number of rows to return. |
-| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The export format. |
-| admin | [bool](#bool) | | The admin is used for workspace owner and DBA for exporting data from SQL Editor Admin mode. The exported data is not masked. |
-| password | [string](#string) | | The zip password provide by users. |
-| data_source_id | [string](#string) | | The id of data source. It is used for querying admin data source even if the instance has read-only data sources. Or it can be used to query a specific read-only data source. |
-| schema | [string](#string) | optional | The default schema to search objects. Equals to the current schema in Oracle and search path in Postgres. |
+| start_position | [Position](#bytebase-v1-Position) | | Position of the SQL statement. |
+| end_position | [Position](#bytebase-v1-Position) | | |
-<a name="bytebase-v1-ExportResponse"></a>
+<a name="bytebase-v1-PlanCheckRun-Result-SqlSummaryReport"></a>
-### ExportResponse
+### PlanCheckRun.Result.SqlSummaryReport
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [bytes](#bytes) | | The export file content. |
+| statement_types | [string](#string) | repeated | statement_types are the types of statements that are found in the sql. |
+| affected_rows | [int64](#int64) | | |
-<a name="bytebase-v1-MaskingReason"></a>
+<a name="bytebase-v1-RunPlanChecksRequest"></a>
-### MaskingReason
+### RunPlanChecksRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| semantic_type_id | [string](#string) | | The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). |
-| semantic_type_title | [string](#string) | | Human-readable semantic type title. |
-| masking_rule_id | [string](#string) | | The masking rule ID that matched (if applicable). |
-| algorithm | [string](#string) | | The masking algorithm used. |
-| context | [string](#string) | | Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). |
-| classification_level | [string](#string) | | Whether masking was due to classification level. |
-| semantic_type_icon | [string](#string) | | Icon associated with the semantic type (if any). |
-
-
+| name | [string](#string) | | The plan to run plan checks. Format: projects/{project}/plans/{plan} |
+| spec_id | [string](#string) | optional | The UUID of the specific spec to run plan checks for. This should match the spec.id field in Plan.Spec. If not set, all specs in the plan will be used. |
-<a name="bytebase-v1-QueryHistory"></a>
-### QueryHistory
+<a name="bytebase-v1-RunPlanChecksResponse"></a>
+### RunPlanChecksResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name for the query history. Format: queryHistories/{uid} |
-| database | [string](#string) | | The database name to execute the query. Format: instances/{instance}/databases/{databaseName} |
-| creator | [string](#string) | | |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| statement | [string](#string) | | |
-| error | [string](#string) | optional | |
-| duration | [google.protobuf.Duration](#google-protobuf-Duration) | | |
-| type | [QueryHistory.Type](#bytebase-v1-QueryHistory-Type) | | |
-<a name="bytebase-v1-QueryOption"></a>
+<a name="bytebase-v1-UpdatePlanRequest"></a>
-### QueryOption
+### UpdatePlanRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| redis_run_commands_on | [QueryOption.RedisRunCommandsOn](#bytebase-v1-QueryOption-RedisRunCommandsOn) | | |
-| mssql_explain_format | [QueryOption.MSSQLExplainFormat](#bytebase-v1-QueryOption-MSSQLExplainFormat) | | |
-
-
-
-
+| plan | [Plan](#bytebase-v1-Plan) | | The plan to update.
+The plan&#39;s `name` field is used to identify the plan to update. Format: projects/{project}/plans/{plan} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the plan is not found, a new plan will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-QueryRequest"></a>
-### QueryRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the instance name to execute the query against. Format: instances/{instance}/databases/{databaseName} |
-| statement | [string](#string) | | The SQL statement to execute. |
-| limit | [int32](#int32) | | The maximum number of rows to return. |
-| data_source_id | [string](#string) | | The id of data source. It is used for querying admin data source even if the instance has read-only data sources. Or it can be used to query a specific read-only data source. |
-| explain | [bool](#bool) | | Explain the statement. |
-| schema | [string](#string) | optional | The default schema to search objects. Equals to the current schema in Oracle and search path in Postgres. |
-| query_option | [QueryOption](#bytebase-v1-QueryOption) | | |
-| container | [string](#string) | optional | Container is the container name to execute the query against, used for CosmosDB only. |
+
+<a name="bytebase-v1-PlanCheckRun-Result-Type"></a>
+### PlanCheckRun.Result.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| STATEMENT_ADVISE | 1 | |
+| STATEMENT_SUMMARY_REPORT | 2 | |
+| GHOST_SYNC | 3 | |
-<a name="bytebase-v1-QueryResponse"></a>
-### QueryResponse
+<a name="bytebase-v1-PlanCheckRun-Status"></a>
+### PlanCheckRun.Status
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | |
+| RUNNING | 1 | |
+| DONE | 2 | |
+| FAILED | 3 | |
+| CANCELED | 4 | |
+
+
-<a name="bytebase-v1-QueryResult"></a>
+<a name="bytebase-v1-PlanService"></a>
-### QueryResult
+### PlanService
+PlanService manages deployment plans for database changes.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetPlan | [GetPlanRequest](#bytebase-v1-GetPlanRequest) | [Plan](#bytebase-v1-Plan) | Retrieves a deployment plan by name. Permissions required: bb.plans.get |
+| ListPlans | [ListPlansRequest](#bytebase-v1-ListPlansRequest) | [ListPlansResponse](#bytebase-v1-ListPlansResponse) | Lists deployment plans in a project. Permissions required: bb.plans.list |
+| CreatePlan | [CreatePlanRequest](#bytebase-v1-CreatePlanRequest) | [Plan](#bytebase-v1-Plan) | Creates a new deployment plan. Permissions required: bb.plans.create |
+| UpdatePlan | [UpdatePlanRequest](#bytebase-v1-UpdatePlanRequest) | [Plan](#bytebase-v1-Plan) | UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update (or creator) |
+| GetPlanCheckRun | [GetPlanCheckRunRequest](#bytebase-v1-GetPlanCheckRunRequest) | [PlanCheckRun](#bytebase-v1-PlanCheckRun) | Gets the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.get |
+| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |
+| CancelPlanCheckRun | [CancelPlanCheckRunRequest](#bytebase-v1-CancelPlanCheckRunRequest) | [CancelPlanCheckRunResponse](#bytebase-v1-CancelPlanCheckRunResponse) | Cancels the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.run |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| column_names | [string](#string) | repeated | Column names of the query result. |
-| column_type_names | [string](#string) | repeated | Column types of the query result. The types come from the Golang SQL driver. |
-| rows | [QueryRow](#bytebase-v1-QueryRow) | repeated | Rows of the query result. |
-| rows_count | [int64](#int64) | | |
-| error | [string](#string) | | The error message if the query failed. |
-| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The time it takes to execute the query. |
-| statement | [string](#string) | | The query statement for the result. |
-| postgres_error | [QueryResult.PostgresError](#bytebase-v1-QueryResult-PostgresError) | | |
-| syntax_error | [QueryResult.SyntaxError](#bytebase-v1-QueryResult-SyntaxError) | | |
-| permission_denied | [QueryResult.PermissionDenied](#bytebase-v1-QueryResult-PermissionDenied) | | |
-| messages | [QueryResult.Message](#bytebase-v1-QueryResult-Message) | repeated | Informational or debug messages returned by the database engine during query execution. Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. |
-| masked | [MaskingReason](#bytebase-v1-MaskingReason) | repeated | Masking reasons for each column (empty for non-masked columns). |
+<a name="v1_project_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/project_service.proto
-<a name="bytebase-v1-QueryResult-Message"></a>
+<a name="bytebase-v1-Activity"></a>
-### QueryResult.Message
+### Activity
+Activity types for webhook notifications.
+
+
+
+
+
+
+<a name="bytebase-v1-AddWebhookRequest"></a>
+
+### AddWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [QueryResult.Message.Level](#bytebase-v1-QueryResult-Message-Level) | | |
-| content | [string](#string) | | |
+| project | [string](#string) | | The name of the project to add the webhook to. Format: projects/{project} |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to add. |
-<a name="bytebase-v1-QueryResult-PermissionDenied"></a>
+<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>
+
+### BatchDeleteProjectsRequest
-### QueryResult.PermissionDenied
-Permission denied with resource information or disallowed command_type.
-Either resources or command_type is available.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| resources | [string](#string) | repeated | Denied to access the resources. Format: instances/{instance}/databases/{database} instances/{instance}/databases/{database}/schemas/{schema} instances/{instance}/databases/{database}/tables/{table} instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} |
-| command_type | [QueryResult.PermissionDenied.CommandType](#bytebase-v1-QueryResult-PermissionDenied-CommandType) | | Disallowed command_type. |
+| names | [string](#string) | repeated | The names of the projects to delete. Format: projects/{project} |
+| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
-<a name="bytebase-v1-QueryResult-PostgresError"></a>
+<a name="bytebase-v1-BatchGetProjectsRequest"></a>
+
+### BatchGetProjectsRequest
-### QueryResult.PostgresError
-refer https://www.postgresql.org/docs/11/protocol-error-fields.html
-for field description.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| severity | [string](#string) | | |
-| code | [string](#string) | | |
-| message | [string](#string) | | |
-| detail | [string](#string) | | |
-| hint | [string](#string) | | |
-| position | [int32](#int32) | | |
-| internal_position | [int32](#int32) | | |
-| internal_query | [string](#string) | | |
-| where | [string](#string) | | |
-| schema_name | [string](#string) | | |
-| table_name | [string](#string) | | |
-| column_name | [string](#string) | | |
-| data_type_name | [string](#string) | | |
-| constraint_name | [string](#string) | | |
-| file | [string](#string) | | |
-| line | [int32](#int32) | | |
-| routine | [string](#string) | | |
+| names | [string](#string) | repeated | The names of projects to retrieve. Format: projects/{project} |
-<a name="bytebase-v1-QueryResult-SyntaxError"></a>
+<a name="bytebase-v1-BatchGetProjectsResponse"></a>
+
+### BatchGetProjectsResponse
-### QueryResult.SyntaxError
-Syntax error with position information for editor highlighting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_position | [Position](#bytebase-v1-Position) | | Position information for highlighting in editor |
+| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
-<a name="bytebase-v1-QueryRow"></a>
+<a name="bytebase-v1-CreateProjectRequest"></a>
-### QueryRow
+### CreateProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| values | [RowValue](#bytebase-v1-RowValue) | repeated | Row values of the query result. |
+| project | [Project](#bytebase-v1-Project) | | The project to create. |
+| project_id | [string](#string) | | The ID to use for the project, which will become the final component of the project&#39;s resource name.
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-<a name="bytebase-v1-RowValue"></a>
-### RowValue
+<a name="bytebase-v1-DeleteProjectRequest"></a>
+
+### DeleteProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| null_value | [google.protobuf.NullValue](#google-protobuf-NullValue) | | |
-| bool_value | [bool](#bool) | | |
-| bytes_value | [bytes](#bytes) | | |
-| double_value | [double](#double) | | |
-| float_value | [float](#float) | | |
-| int32_value | [int32](#int32) | | |
-| int64_value | [int64](#int64) | | |
-| string_value | [string](#string) | | |
-| uint32_value | [uint32](#uint32) | | |
-| uint64_value | [uint64](#uint64) | | |
-| value_value | [google.protobuf.Value](#google-protobuf-Value) | | value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. |
-| timestamp_value | [RowValue.Timestamp](#bytebase-v1-RowValue-Timestamp) | | timestamp_value is used for the timestamp without time zone data type, meaning it only includes the timestamp without any time zone or location info. Although it may be expressed as a UTC value, it should be seen as a timestamp missing location context. |
-| timestamp_tz_value | [RowValue.TimestampTZ](#bytebase-v1-RowValue-TimestampTZ) | | timestamp_tz_value is used for the timestamptz data type, which accurately represents the timestamp with location information. |
+| name | [string](#string) | | The name of the project to delete. Format: projects/{project} |
+| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
+| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted project and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted projects. The project must already be soft-deleted for this to work. |
-<a name="bytebase-v1-RowValue-Timestamp"></a>
+<a name="bytebase-v1-GetProjectRequest"></a>
-### RowValue.Timestamp
+### GetProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| accuracy | [int32](#int32) | | The accuracy is the number of digits after the decimal point. |
-
+| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |
-<a name="bytebase-v1-RowValue-TimestampTZ"></a>
-### RowValue.TimestampTZ
+<a name="bytebase-v1-Label"></a>
+### Label
+A label for categorizing and organizing issues.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| zone | [string](#string) | | Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;, &#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We retrieve the time zone information from the timestamptz field in the database. A timestamp is in UTC or epoch time, and with zone info, we can convert it to a local time string. Zone and offset are returned by time.Time.Zone() |
-| offset | [int32](#int32) | | The offset is in seconds east of UTC |
-| accuracy | [int32](#int32) | | |
+| value | [string](#string) | | The label value/name. |
+| color | [string](#string) | | The color code for the label (e.g., hex color). |
+| group | [string](#string) | | The group this label belongs to. |
-<a name="bytebase-v1-SearchQueryHistoriesRequest"></a>
+<a name="bytebase-v1-ListProjectsRequest"></a>
-### SearchQueryHistoriesRequest
+### ListProjectsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of histories to return. The service may return fewer than this value. If unspecified, at most 10 history entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListQueryHistory` call. Provide this to retrieve the subsequent page. |
-| filter | [string](#string) | | Filter is the filter to apply on the search query history The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator. - statement: the SQL statement, support &#34;.matches()&#34; operator.
+| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListProjects` call. Provide this to retrieve the subsequent page.
-For example: project == &#34;projects/{project}&#34; database == &#34;instances/{instance}/databases/{database}&#34; instance == &#34;instances/{instance}&#34; type == &#34;QUERY&#34; type == &#34;EXPORT&#34; statement.matches(&#34;select&#34;) type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) |
+When paginating, all other parameters provided to `ListProjects` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
+| filter | [string](#string) | | Filter the project. Check filter for SearchProjectsRequest for details. Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). |
+| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
-<a name="bytebase-v1-SearchQueryHistoriesResponse"></a>
+<a name="bytebase-v1-ListProjectsResponse"></a>
-### SearchQueryHistoriesResponse
+### ListProjectsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| query_histories | [QueryHistory](#bytebase-v1-QueryHistory) | repeated | The list of history. |
-| next_page_token | [string](#string) | | A token to retrieve next page of history. Pass this value in the page_token field in the subsequent call to `ListQueryHistory` method to retrieve the next page of history. |
+| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
+<a name="bytebase-v1-Project"></a>
-<a name="bytebase-v1-Advice-Level"></a>
+### Project
-### Advice.Level
-Level represents the severity level of the advice.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| ADVICE_LEVEL_UNSPECIFIED | 0 | Unspecified advice level. |
-| SUCCESS | 1 | Success status indicating the check passed without issues. |
-| WARNING | 2 | Warning status indicating potential issues that should be reviewed. |
-| ERROR | 3 | Error status indicating critical issues that must be addressed. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the project. Format: projects/{project} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the project. |
+| title | [string](#string) | | The title or name of a project. It&#39;s not unique within the workspace. |
+| webhooks | [Webhook](#bytebase-v1-Webhook) | repeated | The list of webhooks configured for the project. |
+| data_classification_config_id | [string](#string) | | The data classification configuration ID for the project. |
+| issue_labels | [Label](#bytebase-v1-Label) | repeated | Labels available for tagging issues in this project. |
+| force_issue_labels | [bool](#bool) | | Force issue labels to be used when creating an issue. |
+| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |
+| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |
+| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |
+| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. |
+| allow_self_approval | [bool](#bool) | | Whether to allow issue creators to self-approve their own issues. |
+| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy) | | Execution retry policy for task runs. |
+| ci_sampling_size | [int32](#int32) | | The maximum number of database rows to sample during CI data validation. Without specification, sampling is disabled, resulting in full validation. |
+| parallel_tasks_per_rollout | [int32](#int32) | | The maximum number of parallel tasks allowed during rollout execution. |
+| labels | [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the project. For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } |
+| enforce_sql_review | [bool](#bool) | | Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors. |
+| require_issue_approval | [bool](#bool) | | Whether to require issue approval before rollout. |
+| require_plan_check_no_error | [bool](#bool) | | Whether to require plan check to have no error before rollout. |
-<a name="bytebase-v1-Advice-RuleType"></a>
-### Advice.RuleType
-RuleType indicates the source of the linting rule.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| RULE_TYPE_UNSPECIFIED | 0 | Unspecified rule type. |
-| PARSER_BASED | 1 | Parser-based rule enforced by the built-in SQL parser. These are non-configurable, mandatory checks for schema health. |
-| AI_POWERED | 2 | AI-powered rule defined by user in natural language. These are custom, flexible checks powered by AI models. |
+<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>
-<a name="bytebase-v1-QueryHistory-Type"></a>
+### Project.ExecutionRetryPolicy
+Execution retry policy configuration.
-### QueryHistory.Type
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified query history type. |
-| QUERY | 1 | Query execution for data retrieval. |
-| EXPORT | 2 | Data export operation to file. |
-<a name="bytebase-v1-QueryOption-MSSQLExplainFormat"></a>
-### QueryOption.MSSQLExplainFormat
+<a name="bytebase-v1-Project-LabelsEntry"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| MSSQL_EXPLAIN_FORMAT_UNSPECIFIED | 0 | defaults to SHOWPLAN_ALL |
-| MSSQL_EXPLAIN_FORMAT_ALL | 1 | SHOWPLAN_ALL |
-| MSSQL_EXPLAIN_FORMAT_XML | 2 | SHOWPLAN_XML |
+### Project.LabelsEntry
-<a name="bytebase-v1-QueryOption-RedisRunCommandsOn"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-### QueryOption.RedisRunCommandsOn
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| REDIS_RUN_COMMANDS_ON_UNSPECIFIED | 0 | UNSPECIFIED defaults to SINGLE_NODE. |
-| SINGLE_NODE | 1 | Execute Redis commands on a single node in the cluster. |
-| ALL_NODES | 2 | Execute Redis commands on all nodes in the cluster for cluster-wide operations. |
-<a name="bytebase-v1-QueryResult-Message-Level"></a>
+<a name="bytebase-v1-RemoveWebhookRequest"></a>
-### QueryResult.Message.Level
+### RemoveWebhookRequest
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| LEVEL_UNSPECIFIED | 0 | Unspecified message level. |
-| INFO | 1 | Informational message. |
-| WARNING | 2 | Warning message indicating potential issues. |
-| DEBUG | 3 | Debug message for development and troubleshooting. |
-| LOG | 4 | General log message. |
-| NOTICE | 5 | Notice message for important information. |
-| EXCEPTION | 6 | Exception message indicating error conditions. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |
-<a name="bytebase-v1-QueryResult-PermissionDenied-CommandType"></a>
-### QueryResult.PermissionDenied.CommandType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| COMMAND_TYPE_UNSPECIFIED | 0 | |
-| DDL | 1 | |
-| DML | 2 | |
-| NON_READ_ONLY | 3 | |
+<a name="bytebase-v1-SearchProjectsRequest"></a>
-
-
-
+### SearchProjectsRequest
-<a name="bytebase-v1-SQLService"></a>
-### SQLService
-SQLService executes SQL queries and manages query operations.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
+| filter | [string](#string) | | Filter the project. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| Query | [QueryRequest](#bytebase-v1-QueryRequest) | [QueryResponse](#bytebase-v1-QueryResponse) | Executes a read-only SQL query against a database. Permissions required: bb.databases.get |
-| AdminExecute | [AdminExecuteRequest](#bytebase-v1-AdminExecuteRequest) stream | [AdminExecuteResponse](#bytebase-v1-AdminExecuteResponse) stream | Executes SQL with admin privileges via streaming connection. Permissions required: bb.sql.admin |
-| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller&#39;s own query histories) |
-| Export | [ExportRequest](#bytebase-v1-ExportRequest) | [ExportResponse](#bytebase-v1-ExportResponse) | Exports query results to a file format. Permissions required: bb.databases.get |
-| DiffMetadata | [DiffMetadataRequest](#bytebase-v1-DiffMetadataRequest) | [DiffMetadataResponse](#bytebase-v1-DiffMetadataResponse) | Computes schema differences between two database metadata. Permissions required: None |
-| AICompletion | [AICompletionRequest](#bytebase-v1-AICompletionRequest) | [AICompletionResponse](#bytebase-v1-AICompletionResponse) | Provides AI-powered SQL completion and generation. Permissions required: None (authenticated users only, requires AI to be enabled) |
+Supported filters: - name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator. - exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator. - state: check the State enum for the values, support &#34;==&#34; operator. - labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
-
+For example: name == &#34;project name&#34; name.matches(&#34;project name&#34;) resource_id == &#34;project id&#34; resource_id.matches(&#34;project id&#34;) exclude_default == true state == &#34;DELETED&#34; labels.environment == &#34;production&#34; labels.tier == &#34;critical&#34; labels.environment in [&#34;staging&#34;, &#34;prod&#34;] You can combine filter conditions like: name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;) name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34; labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; |
+| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchProjects` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `SearchProjects` must match the call that provided the page token. |
+| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
-<a name="v1_plan_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/plan_service.proto
-<a name="bytebase-v1-CancelPlanCheckRunRequest"></a>
+<a name="bytebase-v1-SearchProjectsResponse"></a>
-### CancelPlanCheckRunRequest
+### SearchProjectsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan check run to cancel. Format: projects/{project}/plans/{plan}/planCheckRun |
+| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-CancelPlanCheckRunResponse"></a>
+<a name="bytebase-v1-TestWebhookRequest"></a>
+
+### TestWebhookRequest
-### CancelPlanCheckRunResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| project | [string](#string) | | The name of the project which owns the webhook to test. Format: projects/{project} |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to test. Identified by its url. |
+
-<a name="bytebase-v1-CreatePlanRequest"></a>
+<a name="bytebase-v1-TestWebhookResponse"></a>
-### CreatePlanRequest
+### TestWebhookResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent project where this plan will be created. Format: projects/{project} |
-| plan | [Plan](#bytebase-v1-Plan) | | The plan to create. |
+| error | [string](#string) | | The result of the test, empty if the test is successful. |
-<a name="bytebase-v1-GetPlanCheckRunRequest"></a>
+<a name="bytebase-v1-UndeleteProjectRequest"></a>
-### GetPlanCheckRunRequest
+### UndeleteProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan check run to retrieve. Format: projects/{project}/plans/{plan}/planCheckRun |
+| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |
-<a name="bytebase-v1-GetPlanRequest"></a>
+<a name="bytebase-v1-UpdateProjectRequest"></a>
-### GetPlanRequest
+### UpdateProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan to retrieve. Format: projects/{project}/plans/{plan} |
+| project | [Project](#bytebase-v1-Project) | | The project to update.
+
+The project&#39;s `name` field is used to identify the project to update. Format: projects/{project} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the project is not found, a new project will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-ListPlansRequest"></a>
+<a name="bytebase-v1-UpdateWebhookRequest"></a>
-### ListPlansRequest
+### UpdateWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use &#34;projects/-&#34; to list all plans from all projects. |
-| page_size | [int32](#int32) | | The maximum number of plans to return. The service may return fewer than this value. If unspecified, at most 10 plans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListPlans` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListPlans` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter plans returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match. - spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;. - state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
-
-For example: creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; has_rollout == false &amp;&amp; has_issue == true title == &#34;My Plan&#34; title.matches(&#34;database migration&#34;) spec_type == &#34;change_database_config&#34; state == &#34;ACTIVE&#34; |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to modify. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the webhook is not found, a new webhook will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-ListPlansResponse"></a>
+<a name="bytebase-v1-Webhook"></a>
-### ListPlansResponse
+### Webhook
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| plans | [Plan](#bytebase-v1-Plan) | repeated | The plans from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
-
+| name | [string](#string) | | name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook} |
+| type | [WebhookType](#bytebase-v1-WebhookType) | | Webhook integration type. type is the type of the webhook. |
+| title | [string](#string) | | title is the title of the webhook. |
+| url | [string](#string) | | url is the url of the webhook, should be unique within the project. |
+| direct_message | [bool](#bool) | | if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work. |
+| notification_types | [Activity.Type](#bytebase-v1-Activity-Type) | repeated | notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following: - ISSUE_CREATED - ISSUE_APPROVAL_REQUESTED - ISSUE_SENT_BACK - PIPELINE_FAILED - PIPELINE_COMPLETED |
-<a name="bytebase-v1-Plan"></a>
-### Plan
+
+<a name="bytebase-v1-Activity-Type"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan. `plan` is a system generated ID. Format: projects/{project}/plans/{plan} |
-| state | [State](#bytebase-v1-State) | | The state of the plan. |
-| issue | [string](#string) | | The issue associated with the plan. Can be empty. Format: projects/{project}/issues/{issue} |
-| title | [string](#string) | | The title of the plan. |
-| description | [string](#string) | | The description of the plan. |
-| specs | [Plan.Spec](#bytebase-v1-Plan-Spec) | repeated | The deployment specs for the plan. |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| plan_check_run_status_count | [Plan.PlanCheckRunStatusCountEntry](#bytebase-v1-Plan-PlanCheckRunStatusCountEntry) | repeated | The status count of the latest plan check runs. Keys are: - SUCCESS - WARNING - ERROR - RUNNING |
-| has_rollout | [bool](#bool) | | Whether the plan has started the rollout. |
+### Activity.Type
+Activity type enumeration.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| ISSUE_CREATED | 10 | ISSUE_CREATED represents a new issue creation event. |
+| ISSUE_APPROVAL_REQUESTED | 11 | ISSUE_APPROVAL_REQUESTED represents an approval request event. |
+| ISSUE_SENT_BACK | 12 | ISSUE_SENT_BACK represents an issue being sent back by an approver. |
+| PIPELINE_FAILED | 13 | PIPELINE_FAILED represents a pipeline failure event. |
+| PIPELINE_COMPLETED | 14 | PIPELINE_COMPLETED represents a pipeline completion event. |
+
+
-<a name="bytebase-v1-Plan-ChangeDatabaseConfig"></a>
+<a name="bytebase-v1-ProjectService"></a>
-### Plan.ChangeDatabaseConfig
+### ProjectService
+ProjectService manages projects that group databases and changes.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method. Permissions required: bb.projects.get |
+| BatchGetProjects | [BatchGetProjectsRequest](#bytebase-v1-BatchGetProjectsRequest) | [BatchGetProjectsResponse](#bytebase-v1-BatchGetProjectsResponse) | BatchGetProjects retrieves multiple projects by their names. Permissions required: bb.projects.get |
+| ListProjects | [ListProjectsRequest](#bytebase-v1-ListProjectsRequest) | [ListProjectsResponse](#bytebase-v1-ListProjectsResponse) | Lists all projects in the workspace with optional filtering. Permissions required: bb.projects.list |
+| SearchProjects | [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest) | [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse) | Searches for projects with advanced filtering capabilities. Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects) |
+| CreateProject | [CreateProjectRequest](#bytebase-v1-CreateProjectRequest) | [Project](#bytebase-v1-Project) | Creates a new project in the workspace. Permissions required: bb.projects.create |
+| UpdateProject | [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest) | [Project](#bytebase-v1-Project) | Updates an existing project&#39;s properties. Permissions required: bb.projects.update |
+| DeleteProject | [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes (soft-delete or purge) a project. Permissions required: bb.projects.delete |
+| UndeleteProject | [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest) | [Project](#bytebase-v1-Project) | Restores a soft-deleted project. Permissions required: bb.projects.undelete |
+| BatchDeleteProjects | [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes multiple projects in a single operation. Permissions required: bb.projects.delete |
+| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Retrieves the IAM policy for a project. Permissions required: bb.projects.getIamPolicy |
+| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |
+| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |
+| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |
+| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |
+| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. |
-| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
-| release | [string](#string) | | The resource name of the release. Format: projects/{project}/releases/{release} |
-| ghost_flags | [Plan.ChangeDatabaseConfig.GhostFlagsEntry](#bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry) | repeated | |
-| enable_prior_backup | [bool](#bool) | | If set, a backup of the modified data will be created automatically before any changes are applied. |
-| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
+<a name="v1_release_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/release_service.proto
-<a name="bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry"></a>
+<a name="bytebase-v1-CheckReleaseRequest"></a>
-### Plan.ChangeDatabaseConfig.GhostFlagsEntry
+### CheckReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| parent | [string](#string) | | Format: projects/{project} |
+| release | [Release](#bytebase-v1-Release) | | The release to check. |
+| targets | [string](#string) | repeated | The targets to dry-run the release. Can be database or databaseGroup. Format: projects/{project}/databaseGroups/{databaseGroup} instances/{instance}/databases/{database} |
+| custom_rules | [string](#string) | | Custom linting rules in natural language for AI-powered validation. Each rule should be a clear statement describing the desired schema constraint. Example: &#34;All tables must have a primary key&#34; Example: &#34;VARCHAR columns should specify a maximum length&#34; |
-<a name="bytebase-v1-Plan-CreateDatabaseConfig"></a>
+<a name="bytebase-v1-CheckReleaseResponse"></a>
-### Plan.CreateDatabaseConfig
+### CheckReleaseResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| target | [string](#string) | | The resource name of the instance on which the database is created. Format: instances/{instance} |
-| database | [string](#string) | | The name of the database to create. |
-| table | [string](#string) | | table is the name of the table, if it is not empty, Bytebase should create a table after creating the database. For example, in MongoDB, it only creates the database when we first store data in that database. |
-| character_set | [string](#string) | | character_set is the character set of the database. |
-| collation | [string](#string) | | collation is the collation of the database. |
-| cluster | [string](#string) | | cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. |
-| owner | [string](#string) | | owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. |
-| environment | [string](#string) | | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-
+| results | [CheckReleaseResponse.CheckResult](#bytebase-v1-CheckReleaseResponse-CheckResult) | repeated | The check results for each file and target combination. |
+| affected_rows | [int64](#int64) | | The total affected rows across all checks. |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The aggregated risk level of the check. |
-<a name="bytebase-v1-Plan-ExportDataConfig"></a>
-### Plan.ExportDataConfig
+<a name="bytebase-v1-CheckReleaseResponse-CheckResult"></a>
+### CheckReleaseResponse.CheckResult
+Check result for a single release file on a target database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. |
-| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
-| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The format of the exported file. |
-| password | [string](#string) | optional | The zip password provide by users. Leave it empty if no needs to encrypt the zip file. |
+| file | [string](#string) | | The file path that is being checked. |
+| target | [string](#string) | | The target that the check is performed on. Should be a database. Format: instances/{instance}/databases/{database} |
+| advices | [Advice](#bytebase-v1-Advice) | repeated | The list of advice for the file and the target. |
+| affected_rows | [int64](#int64) | | The count of affected rows of the statement on the target. |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the statement on the target. |
-<a name="bytebase-v1-Plan-PlanCheckRunStatusCountEntry"></a>
+<a name="bytebase-v1-CreateReleaseRequest"></a>
-### Plan.PlanCheckRunStatusCountEntry
+### CreateReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [int32](#int32) | | |
+| parent | [string](#string) | | Format: projects/{project} |
+| release | [Release](#bytebase-v1-Release) | | The release to create. |
-<a name="bytebase-v1-Plan-Spec"></a>
+<a name="bytebase-v1-DeleteReleaseRequest"></a>
-### Plan.Spec
+### DeleteReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. |
-| create_database_config | [Plan.CreateDatabaseConfig](#bytebase-v1-Plan-CreateDatabaseConfig) | | |
-| change_database_config | [Plan.ChangeDatabaseConfig](#bytebase-v1-Plan-ChangeDatabaseConfig) | | |
-| export_data_config | [Plan.ExportDataConfig](#bytebase-v1-Plan-ExportDataConfig) | | |
+| name | [string](#string) | | The name of the release to delete. Format: projects/{project}/releases/{release} |
-<a name="bytebase-v1-PlanCheckRun"></a>
+<a name="bytebase-v1-GetReleaseRequest"></a>
-### PlanCheckRun
+### GetReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/planCheckRun |
-| status | [PlanCheckRun.Status](#bytebase-v1-PlanCheckRun-Status) | | |
-| results | [PlanCheckRun.Result](#bytebase-v1-PlanCheckRun-Result) | repeated | |
-| error | [string](#string) | | error is set if the Status is FAILED. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| name | [string](#string) | | Format: projects/{project}/releases/{release} |
-<a name="bytebase-v1-PlanCheckRun-Result"></a>
+<a name="bytebase-v1-ListReleasesRequest"></a>
-### PlanCheckRun.Result
+### ListReleasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [Advice.Level](#bytebase-v1-Advice-Level) | | |
-| title | [string](#string) | | |
-| content | [string](#string) | | |
-| code | [int32](#int32) | | |
-| target | [string](#string) | | Target identification for consolidated results. Format: instances/{instance}/databases/{database} |
-| type | [PlanCheckRun.Result.Type](#bytebase-v1-PlanCheckRun-Result-Type) | | |
-| sql_summary_report | [PlanCheckRun.Result.SqlSummaryReport](#bytebase-v1-PlanCheckRun-Result-SqlSummaryReport) | | |
-| sql_review_report | [PlanCheckRun.Result.SqlReviewReport](#bytebase-v1-PlanCheckRun-Result-SqlReviewReport) | | |
+| parent | [string](#string) | | Format: projects/{project} |
+| page_size | [int32](#int32) | | The maximum number of releases to return. The service may return fewer than this value. If unspecified, at most 10 releases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted releases if specified. |
-<a name="bytebase-v1-PlanCheckRun-Result-SqlReviewReport"></a>
-### PlanCheckRun.Result.SqlReviewReport
+<a name="bytebase-v1-ListReleasesResponse"></a>
+
+### ListReleasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_position | [Position](#bytebase-v1-Position) | | Position of the SQL statement. |
-| end_position | [Position](#bytebase-v1-Position) | | |
+| releases | [Release](#bytebase-v1-Release) | repeated | The releases from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-PlanCheckRun-Result-SqlSummaryReport"></a>
+<a name="bytebase-v1-Release"></a>
-### PlanCheckRun.Result.SqlSummaryReport
+### Release
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| statement_types | [string](#string) | repeated | statement_types are the types of statements that are found in the sql. |
-| affected_rows | [int64](#int64) | | |
-
+| name | [string](#string) | | Format: projects/{project}/releases/{release} |
+| title | [string](#string) | | The title of the release. |
+| files | [Release.File](#bytebase-v1-Release-File) | repeated | The SQL files included in the release. |
+| vcs_source | [Release.VCSSource](#bytebase-v1-Release-VCSSource) | | The version control source of the release. |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the release. |
+| digest | [string](#string) | | The digest of the release. The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease. Whether to provide digest and how to generate it is up to the user. If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned. |
+| type | [Release.Type](#bytebase-v1-Release-Type) | | The type of schema change for all files in this release. |
-<a name="bytebase-v1-RunPlanChecksRequest"></a>
-### RunPlanChecksRequest
+<a name="bytebase-v1-Release-File"></a>
+### Release.File
+A SQL file in a release.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The plan to run plan checks. Format: projects/{project}/plans/{plan} |
-| spec_id | [string](#string) | optional | The UUID of the specific spec to run plan checks for. This should match the spec.id field in Plan.Spec. If not set, all specs in the plan will be used. |
+| path | [string](#string) | | The path of the file. e.g., `2.2/V0001_create_table.sql`. |
+| version | [string](#string) | | The version identifier for the file. |
+| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
+| sheet | [string](#string) | | For inputs, we must either use `sheet` or `statement`. For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
+The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
+| statement | [bytes](#bytes) | | The raw SQL statement content. |
+| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet content or the statement. |
-<a name="bytebase-v1-RunPlanChecksResponse"></a>
-### RunPlanChecksResponse
+<a name="bytebase-v1-Release-VCSSource"></a>
+
+### Release.VCSSource
+Version control system source information.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| vcs_type | [VCSType](#bytebase-v1-VCSType) | | The type of VCS. |
+| url | [string](#string) | | The url link to the e.g., GitHub commit or pull request. |
-<a name="bytebase-v1-UpdatePlanRequest"></a>
-### UpdatePlanRequest
+<a name="bytebase-v1-UndeleteReleaseRequest"></a>
+
+### UndeleteReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| plan | [Plan](#bytebase-v1-Plan) | | The plan to update.
+| name | [string](#string) | | The name of the deleted release. Format: projects/{project}/releases/{release} |
-The plan&#39;s `name` field is used to identify the plan to update. Format: projects/{project}/plans/{plan} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the plan is not found, a new plan will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-UpdateReleaseRequest"></a>
+### UpdateReleaseRequest
-<a name="bytebase-v1-PlanCheckRun-Result-Type"></a>
-### PlanCheckRun.Result.Type
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| release | [Release](#bytebase-v1-Release) | | The release to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. |
+| allow_missing | [bool](#bool) | | If set to true, and the release is not found, a new release will be created. In this situation, `update_mask` is ignored. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| STATEMENT_ADVISE | 1 | |
-| STATEMENT_SUMMARY_REPORT | 2 | |
-| GHOST_SYNC | 3 | |
-<a name="bytebase-v1-PlanCheckRun-Status"></a>
+
-### PlanCheckRun.Status
+<a name="bytebase-v1-Release-Type"></a>
+
+### Release.Type
+The type of schema change.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | |
-| RUNNING | 1 | |
-| DONE | 2 | |
-| FAILED | 3 | |
-| CANCELED | 4 | |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| VERSIONED | 1 | Versioned schema migration. |
+| DECLARATIVE | 2 | Declarative schema definition. |
@@ -7817,709 +7761,701 @@ The plan&#39;s `name` field is used to identify the plan to update. Format: proj
-<a name="bytebase-v1-PlanService"></a>
+<a name="bytebase-v1-ReleaseService"></a>
-### PlanService
-PlanService manages deployment plans for database changes.
+### ReleaseService
+ReleaseService manages releases for coordinating deployments.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetPlan | [GetPlanRequest](#bytebase-v1-GetPlanRequest) | [Plan](#bytebase-v1-Plan) | Retrieves a deployment plan by name. Permissions required: bb.plans.get |
-| ListPlans | [ListPlansRequest](#bytebase-v1-ListPlansRequest) | [ListPlansResponse](#bytebase-v1-ListPlansResponse) | Lists deployment plans in a project. Permissions required: bb.plans.list |
-| CreatePlan | [CreatePlanRequest](#bytebase-v1-CreatePlanRequest) | [Plan](#bytebase-v1-Plan) | Creates a new deployment plan. Permissions required: bb.plans.create |
-| UpdatePlan | [UpdatePlanRequest](#bytebase-v1-UpdatePlanRequest) | [Plan](#bytebase-v1-Plan) | UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update (or creator) |
-| GetPlanCheckRun | [GetPlanCheckRunRequest](#bytebase-v1-GetPlanCheckRunRequest) | [PlanCheckRun](#bytebase-v1-PlanCheckRun) | Gets the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.get |
-| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |
-| CancelPlanCheckRun | [CancelPlanCheckRunRequest](#bytebase-v1-CancelPlanCheckRunRequest) | [CancelPlanCheckRunResponse](#bytebase-v1-CancelPlanCheckRunResponse) | Cancels the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.run |
+| GetRelease | [GetReleaseRequest](#bytebase-v1-GetReleaseRequest) | [Release](#bytebase-v1-Release) | Retrieves a release by name. Permissions required: bb.releases.get |
+| ListReleases | [ListReleasesRequest](#bytebase-v1-ListReleasesRequest) | [ListReleasesResponse](#bytebase-v1-ListReleasesResponse) | Lists releases in a project. Permissions required: bb.releases.list |
+| CreateRelease | [CreateReleaseRequest](#bytebase-v1-CreateReleaseRequest) | [Release](#bytebase-v1-Release) | Creates a new release with SQL files. Permissions required: bb.releases.create |
+| UpdateRelease | [UpdateReleaseRequest](#bytebase-v1-UpdateReleaseRequest) | [Release](#bytebase-v1-Release) | Updates an existing release. Permissions required: bb.releases.update When allow_missing=true, also requires: bb.releases.create |
+| DeleteRelease | [DeleteReleaseRequest](#bytebase-v1-DeleteReleaseRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a release. Permissions required: bb.releases.delete |
+| UndeleteRelease | [UndeleteReleaseRequest](#bytebase-v1-UndeleteReleaseRequest) | [Release](#bytebase-v1-Release) | Restores a deleted release. Permissions required: bb.releases.undelete |
+| CheckRelease | [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest) | [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse) | Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check |
-<a name="v1_project_service-proto"></a>
+<a name="v1_review_config_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/project_service.proto
+## v1/review_config_service.proto
-<a name="bytebase-v1-Activity"></a>
+<a name="bytebase-v1-CreateReviewConfigRequest"></a>
-### Activity
-Activity types for webhook notifications.
+### CreateReviewConfigRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to create. |
-<a name="bytebase-v1-AddWebhookRequest"></a>
-### AddWebhookRequest
+
+
+<a name="bytebase-v1-DeleteReviewConfigRequest"></a>
+
+### DeleteReviewConfigRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| project | [string](#string) | | The name of the project to add the webhook to. Format: projects/{project} |
-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to add. |
+| name | [string](#string) | | The name of the SQL review config to delete. Format: reviewConfigs/{reviewConfig} |
-<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>
+<a name="bytebase-v1-GetReviewConfigRequest"></a>
-### BatchDeleteProjectsRequest
+### GetReviewConfigRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The names of the projects to delete. Format: projects/{project} |
-| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
-
-
+| name | [string](#string) | | The name of the SQL review config to retrieve. Format: reviewConfigs/{reviewConfig} |
-<a name="bytebase-v1-BatchGetProjectsRequest"></a>
-### BatchGetProjectsRequest
+<a name="bytebase-v1-ListReviewConfigsRequest"></a>
+### ListReviewConfigsRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The names of projects to retrieve. Format: projects/{project} |
-<a name="bytebase-v1-BatchGetProjectsResponse"></a>
+<a name="bytebase-v1-ListReviewConfigsResponse"></a>
-### BatchGetProjectsResponse
+### ListReviewConfigsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
+| review_configs | [ReviewConfig](#bytebase-v1-ReviewConfig) | repeated | The SQL review configs from the specified request. |
-<a name="bytebase-v1-CreateProjectRequest"></a>
+<a name="bytebase-v1-ReviewConfig"></a>
-### CreateProjectRequest
+### ReviewConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| project | [Project](#bytebase-v1-Project) | | The project to create. |
-| project_id | [string](#string) | | The ID to use for the project, which will become the final component of the project&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-
+| name | [string](#string) | | The name of the SQL review config. Format: reviewConfigs/{reviewConfig} |
+| title | [string](#string) | | The title of the review configuration. |
+| enabled | [bool](#bool) | | Whether the review configuration is enabled. |
+| rules | [SQLReviewRule](#bytebase-v1-SQLReviewRule) | repeated | The SQL review rules to enforce. |
+| resources | [string](#string) | repeated | Resources using the config. Format: {resource}/{resource id}, e.g., environments/test. |
-<a name="bytebase-v1-DeleteProjectRequest"></a>
-### DeleteProjectRequest
+<a name="bytebase-v1-SQLReviewRule"></a>
+### SQLReviewRule
+SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project to delete. Format: projects/{project} |
-| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
-| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted project and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted projects. The project must already be soft-deleted for this to work. |
+| type | [SQLReviewRule.Type](#bytebase-v1-SQLReviewRule-Type) | | The type of SQL review rule. |
+| level | [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level) | | The severity level of the rule. |
+| naming_payload | [SQLReviewRule.NamingRulePayload](#bytebase-v1-SQLReviewRule-NamingRulePayload) | | |
+| number_payload | [SQLReviewRule.NumberRulePayload](#bytebase-v1-SQLReviewRule-NumberRulePayload) | | |
+| string_array_payload | [SQLReviewRule.StringArrayRulePayload](#bytebase-v1-SQLReviewRule-StringArrayRulePayload) | | |
+| comment_convention_payload | [SQLReviewRule.CommentConventionRulePayload](#bytebase-v1-SQLReviewRule-CommentConventionRulePayload) | | |
+| string_payload | [SQLReviewRule.StringRulePayload](#bytebase-v1-SQLReviewRule-StringRulePayload) | | |
+| naming_case_payload | [SQLReviewRule.NamingCaseRulePayload](#bytebase-v1-SQLReviewRule-NamingCaseRulePayload) | | |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |
-<a name="bytebase-v1-GetProjectRequest"></a>
+<a name="bytebase-v1-SQLReviewRule-CommentConventionRulePayload"></a>
-### GetProjectRequest
+### SQLReviewRule.CommentConventionRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |
+| required | [bool](#bool) | | |
+| max_length | [int32](#int32) | | |
-<a name="bytebase-v1-Label"></a>
+<a name="bytebase-v1-SQLReviewRule-NamingCaseRulePayload"></a>
+
+### SQLReviewRule.NamingCaseRulePayload
-### Label
-A label for categorizing and organizing issues.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| value | [string](#string) | | The label value/name. |
-| color | [string](#string) | | The color code for the label (e.g., hex color). |
-| group | [string](#string) | | The group this label belongs to. |
-
+| upper | [bool](#bool) | | |
-<a name="bytebase-v1-ListProjectsRequest"></a>
-### ListProjectsRequest
+<a name="bytebase-v1-SQLReviewRule-NamingRulePayload"></a>
+### SQLReviewRule.NamingRulePayload
+Payload message types for SQL review rules
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListProjects` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListProjects` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
-| filter | [string](#string) | | Filter the project. Check filter for SearchProjectsRequest for details. Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). |
-| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
+| max_length | [int32](#int32) | | |
+| format | [string](#string) | | |
-<a name="bytebase-v1-ListProjectsResponse"></a>
+<a name="bytebase-v1-SQLReviewRule-NumberRulePayload"></a>
-### ListProjectsResponse
+### SQLReviewRule.NumberRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| number | [int32](#int32) | | |
-<a name="bytebase-v1-Project"></a>
+<a name="bytebase-v1-SQLReviewRule-StringArrayRulePayload"></a>
-### Project
+### SQLReviewRule.StringArrayRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project. Format: projects/{project} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the project. |
-| title | [string](#string) | | The title or name of a project. It&#39;s not unique within the workspace. |
-| webhooks | [Webhook](#bytebase-v1-Webhook) | repeated | The list of webhooks configured for the project. |
-| data_classification_config_id | [string](#string) | | The data classification configuration ID for the project. |
-| issue_labels | [Label](#bytebase-v1-Label) | repeated | Labels available for tagging issues in this project. |
-| force_issue_labels | [bool](#bool) | | Force issue labels to be used when creating an issue. |
-| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |
-| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |
-| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |
-| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. |
-| allow_self_approval | [bool](#bool) | | Whether to allow issue creators to self-approve their own issues. |
-| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy) | | Execution retry policy for task runs. |
-| ci_sampling_size | [int32](#int32) | | The maximum number of database rows to sample during CI data validation. Without specification, sampling is disabled, resulting in full validation. |
-| parallel_tasks_per_rollout | [int32](#int32) | | The maximum number of parallel tasks allowed during rollout execution. |
-| labels | [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the project. For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } |
-| enforce_sql_review | [bool](#bool) | | Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors. |
-| require_issue_approval | [bool](#bool) | | Whether to require issue approval before rollout. |
-| require_plan_check_no_error | [bool](#bool) | | Whether to require plan check to have no error before rollout. |
+| list | [string](#string) | repeated | |
-<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>
+<a name="bytebase-v1-SQLReviewRule-StringRulePayload"></a>
+
+### SQLReviewRule.StringRulePayload
-### Project.ExecutionRetryPolicy
-Execution retry policy configuration.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |
+| value | [string](#string) | | |
-<a name="bytebase-v1-Project-LabelsEntry"></a>
+<a name="bytebase-v1-UpdateReviewConfigRequest"></a>
-### Project.LabelsEntry
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
-
-
-
-
-
-
-<a name="bytebase-v1-RemoveWebhookRequest"></a>
-
-### RemoveWebhookRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |
-
-
-
-
-
-
-<a name="bytebase-v1-SearchProjectsRequest"></a>
-
-### SearchProjectsRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
-| filter | [string](#string) | | Filter the project. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator. - exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator. - state: check the State enum for the values, support &#34;==&#34; operator. - labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example: name == &#34;project name&#34; name.matches(&#34;project name&#34;) resource_id == &#34;project id&#34; resource_id.matches(&#34;project id&#34;) exclude_default == true state == &#34;DELETED&#34; labels.environment == &#34;production&#34; labels.tier == &#34;critical&#34; labels.environment in [&#34;staging&#34;, &#34;prod&#34;] You can combine filter conditions like: name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;) name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34; labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; |
-| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchProjects` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchProjects` must match the call that provided the page token. |
-| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
-
-
-
-
-
-
-<a name="bytebase-v1-SearchProjectsResponse"></a>
-
-### SearchProjectsResponse
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
-
-
-
-
-
-<a name="bytebase-v1-TestWebhookRequest"></a>
-
-### TestWebhookRequest
+### UpdateReviewConfigRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| project | [string](#string) | | The name of the project which owns the webhook to test. Format: projects/{project} |
-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to test. Identified by its url. |
-
-
-
-
-
-
-<a name="bytebase-v1-TestWebhookResponse"></a>
+| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to update.
-### TestWebhookResponse
+The name field is used to identify the SQL review config to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the config is not found, a new config will be created. In this situation, `update_mask` is ignored. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| error | [string](#string) | | The result of the test, empty if the test is successful. |
+
+<a name="bytebase-v1-SQLReviewRule-Level"></a>
+### SQLReviewRule.Level
+The severity level for SQL review rules.
-<a name="bytebase-v1-UndeleteProjectRequest"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| LEVEL_UNSPECIFIED | 0 | Unspecified level. |
+| ERROR | 1 | Rule violation is an error. |
+| WARNING | 2 | Rule violation is a warning. |
-### UndeleteProjectRequest
+<a name="bytebase-v1-SQLReviewRule-Type"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |
+### SQLReviewRule.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| ENGINE_MYSQL_USE_INNODB | 1 | |
+| NAMING_FULLY_QUALIFIED | 2 | |
+| NAMING_TABLE | 3 | |
+| NAMING_COLUMN | 4 | |
+| NAMING_INDEX_PK | 5 | |
+| NAMING_INDEX_UK | 6 | |
+| NAMING_INDEX_FK | 7 | |
+| NAMING_INDEX_IDX | 8 | |
+| NAMING_COLUMN_AUTO_INCREMENT | 9 | |
+| NAMING_TABLE_NO_KEYWORD | 10 | |
+| NAMING_IDENTIFIER_NO_KEYWORD | 11 | |
+| NAMING_IDENTIFIER_CASE | 12 | |
+| STATEMENT_SELECT_NO_SELECT_ALL | 13 | |
+| STATEMENT_WHERE_REQUIRE_SELECT | 14 | |
+| STATEMENT_WHERE_REQUIRE_UPDATE_DELETE | 15 | |
+| STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE | 16 | |
+| STATEMENT_DISALLOW_ON_DEL_CASCADE | 17 | |
+| STATEMENT_DISALLOW_RM_TBL_CASCADE | 18 | |
+| STATEMENT_DISALLOW_COMMIT | 19 | |
+| STATEMENT_DISALLOW_LIMIT | 20 | |
+| STATEMENT_DISALLOW_ORDER_BY | 21 | |
+| STATEMENT_MERGE_ALTER_TABLE | 22 | |
+| STATEMENT_INSERT_ROW_LIMIT | 23 | |
+| STATEMENT_INSERT_MUST_SPECIFY_COLUMN | 24 | |
+| STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND | 25 | |
+| STATEMENT_AFFECTED_ROW_LIMIT | 26 | |
+| STATEMENT_DML_DRY_RUN | 27 | |
+| STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT | 28 | |
+| STATEMENT_ADD_CHECK_NOT_VALID | 29 | |
+| STATEMENT_ADD_FOREIGN_KEY_NOT_VALID | 30 | |
+| STATEMENT_DISALLOW_ADD_NOT_NULL | 31 | |
+| STATEMENT_SELECT_FULL_TABLE_SCAN | 32 | |
+| STATEMENT_CREATE_SPECIFY_SCHEMA | 33 | |
+| STATEMENT_CHECK_SET_ROLE_VARIABLE | 34 | |
+| STATEMENT_DISALLOW_USING_FILESORT | 35 | |
+| STATEMENT_DISALLOW_USING_TEMPORARY | 36 | |
+| STATEMENT_WHERE_NO_EQUAL_NULL | 37 | |
+| STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS | 38 | |
+| STATEMENT_QUERY_MINIMUM_PLAN_LEVEL | 39 | |
+| STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT | 40 | |
+| STATEMENT_MAXIMUM_LIMIT_VALUE | 41 | |
+| STATEMENT_MAXIMUM_JOIN_TABLE_COUNT | 42 | |
+| STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION | 43 | |
+| STATEMENT_JOIN_STRICT_COLUMN_ATTRS | 44 | |
+| STATEMENT_NON_TRANSACTIONAL | 45 | |
+| STATEMENT_ADD_COLUMN_WITHOUT_POSITION | 46 | |
+| STATEMENT_DISALLOW_OFFLINE_DDL | 47 | |
+| STATEMENT_DISALLOW_CROSS_DB_QUERIES | 48 | |
+| STATEMENT_MAX_EXECUTION_TIME | 49 | |
+| STATEMENT_REQUIRE_ALGORITHM_OPTION | 50 | |
+| STATEMENT_REQUIRE_LOCK_OPTION | 51 | |
+| STATEMENT_OBJECT_OWNER_CHECK | 52 | |
+| TABLE_REQUIRE_PK | 53 | |
+| TABLE_NO_FOREIGN_KEY | 54 | |
+| TABLE_DROP_NAMING_CONVENTION | 55 | |
+| TABLE_COMMENT | 56 | |
+| TABLE_DISALLOW_PARTITION | 57 | |
+| TABLE_DISALLOW_TRIGGER | 58 | |
+| TABLE_NO_DUPLICATE_INDEX | 59 | |
+| TABLE_TEXT_FIELDS_TOTAL_LENGTH | 60 | |
+| TABLE_DISALLOW_SET_CHARSET | 61 | |
+| TABLE_DISALLOW_DDL | 62 | |
+| TABLE_DISALLOW_DML | 63 | |
+| TABLE_LIMIT_SIZE | 64 | |
+| TABLE_REQUIRE_CHARSET | 65 | |
+| TABLE_REQUIRE_COLLATION | 66 | |
+| COLUMN_REQUIRED | 67 | |
+| COLUMN_NO_NULL | 68 | |
+| COLUMN_DISALLOW_CHANGE_TYPE | 69 | |
+| COLUMN_SET_DEFAULT_FOR_NOT_NULL | 70 | |
+| COLUMN_DISALLOW_CHANGE | 71 | |
+| COLUMN_DISALLOW_CHANGING_ORDER | 72 | |
+| COLUMN_DISALLOW_DROP | 73 | |
+| COLUMN_DISALLOW_DROP_IN_INDEX | 74 | |
+| COLUMN_COMMENT | 75 | |
+| COLUMN_AUTO_INCREMENT_MUST_INTEGER | 76 | |
+| COLUMN_TYPE_DISALLOW_LIST | 77 | |
+| COLUMN_DISALLOW_SET_CHARSET | 78 | |
+| COLUMN_MAXIMUM_CHARACTER_LENGTH | 79 | |
+| COLUMN_MAXIMUM_VARCHAR_LENGTH | 80 | |
+| COLUMN_AUTO_INCREMENT_INITIAL_VALUE | 81 | |
+| COLUMN_AUTO_INCREMENT_MUST_UNSIGNED | 82 | |
+| COLUMN_CURRENT_TIME_COUNT_LIMIT | 83 | |
+| COLUMN_REQUIRE_DEFAULT | 84 | |
+| COLUMN_DEFAULT_DISALLOW_VOLATILE | 85 | |
+| COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT | 86 | |
+| COLUMN_REQUIRE_CHARSET | 87 | |
+| COLUMN_REQUIRE_COLLATION | 88 | |
+| SCHEMA_BACKWARD_COMPATIBILITY | 89 | |
+| DATABASE_DROP_EMPTY_DATABASE | 90 | |
+| INDEX_NO_DUPLICATE_COLUMN | 91 | |
+| INDEX_KEY_NUMBER_LIMIT | 92 | |
+| INDEX_PK_TYPE_LIMIT | 93 | |
+| INDEX_TYPE_NO_BLOB | 94 | |
+| INDEX_TOTAL_NUMBER_LIMIT | 95 | |
+| INDEX_PRIMARY_KEY_TYPE_ALLOWLIST | 96 | |
+| INDEX_CREATE_CONCURRENTLY | 97 | |
+| INDEX_TYPE_ALLOW_LIST | 98 | |
+| INDEX_NOT_REDUNDANT | 99 | |
+| SYSTEM_CHARSET_ALLOWLIST | 100 | |
+| SYSTEM_COLLATION_ALLOWLIST | 101 | |
+| SYSTEM_COMMENT_LENGTH | 102 | |
+| SYSTEM_PROCEDURE_DISALLOW_CREATE | 103 | |
+| SYSTEM_EVENT_DISALLOW_CREATE | 104 | |
+| SYSTEM_VIEW_DISALLOW_CREATE | 105 | |
+| SYSTEM_FUNCTION_DISALLOW_CREATE | 106 | |
+| SYSTEM_FUNCTION_DISALLOWED_LIST | 107 | |
+| ADVICE_ONLINE_MIGRATION | 108 | |
+| BUILTIN_PRIOR_BACKUP_CHECK | 109 | |
+
+
-<a name="bytebase-v1-UpdateProjectRequest"></a>
-### UpdateProjectRequest
+<a name="bytebase-v1-ReviewConfigService"></a>
+### ReviewConfigService
+ReviewConfigService manages approval flow configurations.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| CreateReviewConfig | [CreateReviewConfigRequest](#bytebase-v1-CreateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Creates a new SQL review configuration. Permissions required: bb.reviewConfigs.create |
+| ListReviewConfigs | [ListReviewConfigsRequest](#bytebase-v1-ListReviewConfigsRequest) | [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse) | Lists all SQL review configurations. Permissions required: bb.reviewConfigs.list |
+| GetReviewConfig | [GetReviewConfigRequest](#bytebase-v1-GetReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Retrieves a SQL review configuration by name. Permissions required: bb.reviewConfigs.get |
+| UpdateReviewConfig | [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Updates a SQL review configuration. Permissions required: bb.reviewConfigs.update When allow_missing=true, also requires: bb.reviewConfigs.create |
+| DeleteReviewConfig | [DeleteReviewConfigRequest](#bytebase-v1-DeleteReviewConfigRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a SQL review configuration. Permissions required: bb.reviewConfigs.delete |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| project | [Project](#bytebase-v1-Project) | | The project to update.
+
-The project&#39;s `name` field is used to identify the project to update. Format: projects/{project} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the project is not found, a new project will be created. In this situation, `update_mask` is ignored. |
+<a name="v1_revision_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/revision_service.proto
-<a name="bytebase-v1-UpdateWebhookRequest"></a>
+<a name="bytebase-v1-BatchCreateRevisionsRequest"></a>
-### UpdateWebhookRequest
+### BatchCreateRevisionsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to modify. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the webhook is not found, a new webhook will be created. In this situation, `update_mask` is ignored. |
+| parent | [string](#string) | | The parent resource shared by all revisions being created. Format: instances/{instance}/databases/{database} |
+| requests | [CreateRevisionRequest](#bytebase-v1-CreateRevisionRequest) | repeated | The request message specifying the revisions to create. A maximum of 100 revisions can be created in a batch. |
-<a name="bytebase-v1-Webhook"></a>
+<a name="bytebase-v1-BatchCreateRevisionsResponse"></a>
-### Webhook
+### BatchCreateRevisionsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook} |
-| type | [WebhookType](#bytebase-v1-WebhookType) | | Webhook integration type. type is the type of the webhook. |
-| title | [string](#string) | | title is the title of the webhook. |
-| url | [string](#string) | | url is the url of the webhook, should be unique within the project. |
-| direct_message | [bool](#bool) | | if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work. |
-| notification_types | [Activity.Type](#bytebase-v1-Activity-Type) | repeated | notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following: - ISSUE_CREATED - ISSUE_APPROVAL_REQUESTED - ISSUE_SENT_BACK - PIPELINE_FAILED - PIPELINE_COMPLETED |
-
-
-
-
-
-
-
-
-<a name="bytebase-v1-Activity-Type"></a>
-
-### Activity.Type
-Activity type enumeration.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| ISSUE_CREATED | 10 | ISSUE_CREATED represents a new issue creation event. |
-| ISSUE_APPROVAL_REQUESTED | 11 | ISSUE_APPROVAL_REQUESTED represents an approval request event. |
-| ISSUE_SENT_BACK | 12 | ISSUE_SENT_BACK represents an issue being sent back by an approver. |
-| PIPELINE_FAILED | 13 | PIPELINE_FAILED represents a pipeline failure event. |
-| PIPELINE_COMPLETED | 14 | PIPELINE_COMPLETED represents a pipeline completion event. |
+| revisions | [Revision](#bytebase-v1-Revision) | repeated | The created revisions. |
-
-
-
-<a name="bytebase-v1-ProjectService"></a>
-### ProjectService
-ProjectService manages projects that group databases and changes.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method. Permissions required: bb.projects.get |
-| BatchGetProjects | [BatchGetProjectsRequest](#bytebase-v1-BatchGetProjectsRequest) | [BatchGetProjectsResponse](#bytebase-v1-BatchGetProjectsResponse) | BatchGetProjects retrieves multiple projects by their names. Permissions required: bb.projects.get |
-| ListProjects | [ListProjectsRequest](#bytebase-v1-ListProjectsRequest) | [ListProjectsResponse](#bytebase-v1-ListProjectsResponse) | Lists all projects in the workspace with optional filtering. Permissions required: bb.projects.list |
-| SearchProjects | [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest) | [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse) | Searches for projects with advanced filtering capabilities. Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects) |
-| CreateProject | [CreateProjectRequest](#bytebase-v1-CreateProjectRequest) | [Project](#bytebase-v1-Project) | Creates a new project in the workspace. Permissions required: bb.projects.create |
-| UpdateProject | [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest) | [Project](#bytebase-v1-Project) | Updates an existing project&#39;s properties. Permissions required: bb.projects.update |
-| DeleteProject | [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes (soft-delete or purge) a project. Permissions required: bb.projects.delete |
-| UndeleteProject | [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest) | [Project](#bytebase-v1-Project) | Restores a soft-deleted project. Permissions required: bb.projects.undelete |
-| BatchDeleteProjects | [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes multiple projects in a single operation. Permissions required: bb.projects.delete |
-| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Retrieves the IAM policy for a project. Permissions required: bb.projects.getIamPolicy |
-| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |
-| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |
-| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |
-| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |
-| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |
+<a name="bytebase-v1-CreateRevisionRequest"></a>
-
+### CreateRevisionRequest
-<a name="v1_release_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | Format: instances/{instance}/databases/{database} |
+| revision | [Revision](#bytebase-v1-Revision) | | The revision to create. |
-## v1/release_service.proto
-<a name="bytebase-v1-CheckReleaseRequest"></a>
-### CheckReleaseRequest
+
+<a name="bytebase-v1-DeleteRevisionRequest"></a>
+
+### DeleteRevisionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
-| release | [Release](#bytebase-v1-Release) | | The release to check. |
-| targets | [string](#string) | repeated | The targets to dry-run the release. Can be database or databaseGroup. Format: projects/{project}/databaseGroups/{databaseGroup} instances/{instance}/databases/{database} |
-| custom_rules | [string](#string) | | Custom linting rules in natural language for AI-powered validation. Each rule should be a clear statement describing the desired schema constraint. Example: &#34;All tables must have a primary key&#34; Example: &#34;VARCHAR columns should specify a maximum length&#34; |
+| name | [string](#string) | | The name of the revision to delete. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-<a name="bytebase-v1-CheckReleaseResponse"></a>
+<a name="bytebase-v1-GetRevisionRequest"></a>
-### CheckReleaseResponse
+### GetRevisionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| results | [CheckReleaseResponse.CheckResult](#bytebase-v1-CheckReleaseResponse-CheckResult) | repeated | The check results for each file and target combination. |
-| affected_rows | [int64](#int64) | | The total affected rows across all checks. |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The aggregated risk level of the check. |
+| name | [string](#string) | | The name of the revision. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-<a name="bytebase-v1-CheckReleaseResponse-CheckResult"></a>
+<a name="bytebase-v1-ListRevisionsRequest"></a>
+
+### ListRevisionsRequest
-### CheckReleaseResponse.CheckResult
-Check result for a single release file on a target database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| file | [string](#string) | | The file path that is being checked. |
-| target | [string](#string) | | The target that the check is performed on. Should be a database. Format: instances/{instance}/databases/{database} |
-| advices | [Advice](#bytebase-v1-Advice) | repeated | The list of advice for the file and the target. |
-| affected_rows | [int64](#int64) | | The count of affected rows of the statement on the target. |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the statement on the target. |
+| parent | [string](#string) | | The parent of the revisions. Format: instances/{instance}/databases/{database} |
+| page_size | [int32](#int32) | | The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 10 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListRevisions` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListRevisions` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Whether to include deleted revisions in the results. |
-<a name="bytebase-v1-CreateReleaseRequest"></a>
+<a name="bytebase-v1-ListRevisionsResponse"></a>
-### CreateReleaseRequest
+### ListRevisionsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
-| release | [Release](#bytebase-v1-Release) | | The release to create. |
+| revisions | [Revision](#bytebase-v1-Revision) | repeated | The revisions from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-DeleteReleaseRequest"></a>
+<a name="bytebase-v1-Revision"></a>
-### DeleteReleaseRequest
+### Revision
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the release to delete. Format: projects/{project}/releases/{release} |
+| name | [string](#string) | | Format: instances/{instance}/databases/{database}/revisions/{revision} |
+| release | [string](#string) | | Format: projects/{project}/releases/{release} Can be empty. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| deleter | [string](#string) | | Format: users/[email protected] Can be empty. |
+| delete_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Can be empty. |
+| file | [string](#string) | | Format: projects/{project}/releases/{release}/files/{id} Can be empty. |
+| version | [string](#string) | | The schema version string for this revision. |
+| sheet | [string](#string) | | The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
+| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet. |
+| task_run | [string](#string) | | The task run associated with the revision. Can be empty. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| type | [Revision.Type](#bytebase-v1-Revision-Type) | | The type of the revision. |
+
-<a name="bytebase-v1-GetReleaseRequest"></a>
-### GetReleaseRequest
+<a name="bytebase-v1-Revision-Type"></a>
+### Revision.Type
+The type of schema revision.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| VERSIONED | 1 | Versioned schema migration. |
+| DECLARATIVE | 2 | Declarative schema definition. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/releases/{release} |
+
+
+<a name="bytebase-v1-RevisionService"></a>
+### RevisionService
+RevisionService manages schema revision history.
-<a name="bytebase-v1-ListReleasesRequest"></a>
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| ListRevisions | [ListRevisionsRequest](#bytebase-v1-ListRevisionsRequest) | [ListRevisionsResponse](#bytebase-v1-ListRevisionsResponse) | Lists schema revisions for a database. Permissions required: bb.revisions.list |
+| GetRevision | [GetRevisionRequest](#bytebase-v1-GetRevisionRequest) | [Revision](#bytebase-v1-Revision) | Retrieves a schema revision by name. Permissions required: bb.revisions.get |
+| BatchCreateRevisions | [BatchCreateRevisionsRequest](#bytebase-v1-BatchCreateRevisionsRequest) | [BatchCreateRevisionsResponse](#bytebase-v1-BatchCreateRevisionsResponse) | Creates multiple schema revisions in a single operation. Permissions required: bb.revisions.create |
+| DeleteRevision | [DeleteRevisionRequest](#bytebase-v1-DeleteRevisionRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a schema revision. Permissions required: bb.revisions.delete |
-### ListReleasesRequest
+
+
+
+
+<a name="v1_role_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/role_service.proto
+
+
+
+<a name="bytebase-v1-CreateRoleRequest"></a>
+
+### CreateRoleRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
-| page_size | [int32](#int32) | | The maximum number of releases to return. The service may return fewer than this value. If unspecified, at most 10 releases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page.
+| role | [Role](#bytebase-v1-Role) | | The role to create. |
+| role_id | [string](#string) | | The ID to use for the role, which will become the final component of the role&#39;s resource name.
-When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted releases if specified. |
+This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/. |
-<a name="bytebase-v1-ListReleasesResponse"></a>
+<a name="bytebase-v1-DeleteRoleRequest"></a>
-### ListReleasesResponse
+### DeleteRoleRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| releases | [Release](#bytebase-v1-Release) | repeated | The releases from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| name | [string](#string) | | The name of the role to delete. Format: roles/{role} |
-<a name="bytebase-v1-Release"></a>
+<a name="bytebase-v1-GetRoleRequest"></a>
-### Release
+### GetRoleRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/releases/{release} |
-| title | [string](#string) | | The title of the release. |
-| files | [Release.File](#bytebase-v1-Release-File) | repeated | The SQL files included in the release. |
-| vcs_source | [Release.VCSSource](#bytebase-v1-Release-VCSSource) | | The version control source of the release. |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the release. |
-| digest | [string](#string) | | The digest of the release. The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease. Whether to provide digest and how to generate it is up to the user. If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned. |
-| type | [Release.Type](#bytebase-v1-Release-Type) | | The type of schema change for all files in this release. |
-
+| name | [string](#string) | | The name of the role to retrieve. Format: roles/{role} |
-<a name="bytebase-v1-Release-File"></a>
-### Release.File
-A SQL file in a release.
+<a name="bytebase-v1-ListRolesRequest"></a>
+### ListRolesRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| path | [string](#string) | | The path of the file. e.g., `2.2/V0001_create_table.sql`. |
-| version | [string](#string) | | The version identifier for the file. |
-| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
-| sheet | [string](#string) | | For inputs, we must either use `sheet` or `statement`. For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
-The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
-| statement | [bytes](#bytes) | | The raw SQL statement content. |
-| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet content or the statement. |
+<a name="bytebase-v1-ListRolesResponse"></a>
-<a name="bytebase-v1-Release-VCSSource"></a>
+### ListRolesResponse
-### Release.VCSSource
-Version control system source information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| vcs_type | [VCSType](#bytebase-v1-VCSType) | | The type of VCS. |
-| url | [string](#string) | | The url link to the e.g., GitHub commit or pull request. |
-
+| roles | [Role](#bytebase-v1-Role) | repeated | The roles from the specified request. |
-<a name="bytebase-v1-UndeleteReleaseRequest"></a>
-### UndeleteReleaseRequest
+<a name="bytebase-v1-Role"></a>
+### Role
+Role defines a set of permissions that can be assigned to users.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted release. Format: projects/{project}/releases/{release} |
+| name | [string](#string) | | Resource name. Format: roles/{role} |
+| title | [string](#string) | | Human-readable title. |
+| description | [string](#string) | | Optional description of the role. |
+| permissions | [string](#string) | repeated | List of permission identifiers granted by this role. |
+| type | [Role.Type](#bytebase-v1-Role-Type) | | Role type indicating if it&#39;s built-in or custom. |
-<a name="bytebase-v1-UpdateReleaseRequest"></a>
+<a name="bytebase-v1-UpdateRoleRequest"></a>
-### UpdateReleaseRequest
+### UpdateRoleRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| release | [Release](#bytebase-v1-Release) | | The release to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. |
-| allow_missing | [bool](#bool) | | If set to true, and the release is not found, a new release will be created. In this situation, `update_mask` is ignored. |
+| role | [Role](#bytebase-v1-Role) | | The role to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the role is not found, a new role will be created. In this situation, `update_mask` is ignored. |
@@ -8528,16 +8464,16 @@ Version control system source information.
-<a name="bytebase-v1-Release-Type"></a>
+<a name="bytebase-v1-Role-Type"></a>
+
+### Role.Type
-### Release.Type
-The type of schema change.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| VERSIONED | 1 | Versioned schema migration. |
-| DECLARATIVE | 2 | Declarative schema definition. |
+| TYPE_UNSPECIFIED | 0 | |
+| BUILT_IN | 1 | System-defined role that cannot be modified. |
+| CUSTOM | 2 | User-defined role that can be modified. |
@@ -8545,1470 +8481,1522 @@ The type of schema change.
-<a name="bytebase-v1-ReleaseService"></a>
+<a name="bytebase-v1-RoleService"></a>
-### ReleaseService
-ReleaseService manages releases for coordinating deployments.
+### RoleService
+RoleService manages workspace roles and permissions.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetRelease | [GetReleaseRequest](#bytebase-v1-GetReleaseRequest) | [Release](#bytebase-v1-Release) | Retrieves a release by name. Permissions required: bb.releases.get |
-| ListReleases | [ListReleasesRequest](#bytebase-v1-ListReleasesRequest) | [ListReleasesResponse](#bytebase-v1-ListReleasesResponse) | Lists releases in a project. Permissions required: bb.releases.list |
-| CreateRelease | [CreateReleaseRequest](#bytebase-v1-CreateReleaseRequest) | [Release](#bytebase-v1-Release) | Creates a new release with SQL files. Permissions required: bb.releases.create |
-| UpdateRelease | [UpdateReleaseRequest](#bytebase-v1-UpdateReleaseRequest) | [Release](#bytebase-v1-Release) | Updates an existing release. Permissions required: bb.releases.update When allow_missing=true, also requires: bb.releases.create |
-| DeleteRelease | [DeleteReleaseRequest](#bytebase-v1-DeleteReleaseRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a release. Permissions required: bb.releases.delete |
-| UndeleteRelease | [UndeleteReleaseRequest](#bytebase-v1-UndeleteReleaseRequest) | [Release](#bytebase-v1-Release) | Restores a deleted release. Permissions required: bb.releases.undelete |
-| CheckRelease | [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest) | [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse) | Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check |
+| ListRoles | [ListRolesRequest](#bytebase-v1-ListRolesRequest) | [ListRolesResponse](#bytebase-v1-ListRolesResponse) | Lists roles in the workspace. Permissions required: bb.roles.list |
+| GetRole | [GetRoleRequest](#bytebase-v1-GetRoleRequest) | [Role](#bytebase-v1-Role) | Retrieves a role by name. Permissions required: bb.roles.get |
+| CreateRole | [CreateRoleRequest](#bytebase-v1-CreateRoleRequest) | [Role](#bytebase-v1-Role) | Creates a new custom role. Permissions required: bb.roles.create |
+| UpdateRole | [UpdateRoleRequest](#bytebase-v1-UpdateRoleRequest) | [Role](#bytebase-v1-Role) | Updates a role&#39;s properties. Permissions required: bb.roles.update When allow_missing=true, also requires: bb.roles.create |
+| DeleteRole | [DeleteRoleRequest](#bytebase-v1-DeleteRoleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a custom role. Permissions required: bb.roles.delete |
-<a name="v1_review_config_service-proto"></a>
+<a name="v1_rollout_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/review_config_service.proto
+## v1/rollout_service.proto
+
+
+
+<a name="bytebase-v1-BatchCancelTaskRunsRequest"></a>
+
+### BatchCancelTaskRunsRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The task name for the taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. |
+| task_runs | [string](#string) | repeated | The taskRuns to cancel. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+
+
+
+
+
+
+<a name="bytebase-v1-BatchCancelTaskRunsResponse"></a>
+
+### BatchCancelTaskRunsResponse
+
+
+
+
+
+
+
+<a name="bytebase-v1-BatchRunTasksRequest"></a>
+
+### BatchRunTasksRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
+| tasks | [string](#string) | repeated | The tasks to run. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
+| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. |
+
-<a name="bytebase-v1-CreateReviewConfigRequest"></a>
-### CreateReviewConfigRequest
+<a name="bytebase-v1-BatchRunTasksResponse"></a>
+### BatchRunTasksResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to create. |
-<a name="bytebase-v1-DeleteReviewConfigRequest"></a>
+<a name="bytebase-v1-BatchSkipTasksRequest"></a>
-### DeleteReviewConfigRequest
+### BatchSkipTasksRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the SQL review config to delete. Format: reviewConfigs/{reviewConfig} |
+| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
+| tasks | [string](#string) | repeated | The tasks to skip. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
+| reason | [string](#string) | | The reason for skipping the tasks. |
-<a name="bytebase-v1-GetReviewConfigRequest"></a>
+<a name="bytebase-v1-BatchSkipTasksResponse"></a>
-### GetReviewConfigRequest
+### BatchSkipTasksResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the SQL review config to retrieve. Format: reviewConfigs/{reviewConfig} |
+<a name="bytebase-v1-CreateRolloutRequest"></a>
+### CreateRolloutRequest
-<a name="bytebase-v1-ListReviewConfigsRequest"></a>
-### ListReviewConfigsRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent plan for which this rollout will be created. Format: projects/{project}/plans/{plan} |
+| target | [string](#string) | optional | Create the rollout only for the specified target. Format: environments/{environment} If unspecified, all stages are created. If set to &#34;&#34;, no stages are created. |
-<a name="bytebase-v1-ListReviewConfigsResponse"></a>
+<a name="bytebase-v1-GetRolloutRequest"></a>
-### ListReviewConfigsResponse
+### GetRolloutRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| review_configs | [ReviewConfig](#bytebase-v1-ReviewConfig) | repeated | The SQL review configs from the specified request. |
+| name | [string](#string) | | The name of the rollout to retrieve. This is the rollout resource name, which is the plan name plus /rollout suffix. Format: projects/{project}/plans/{plan}/rollout |
-<a name="bytebase-v1-ReviewConfig"></a>
+<a name="bytebase-v1-GetTaskRunLogRequest"></a>
-### ReviewConfig
+### GetTaskRunLogRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the SQL review config. Format: reviewConfigs/{reviewConfig} |
-| title | [string](#string) | | The title of the review configuration. |
-| enabled | [bool](#bool) | | Whether the review configuration is enabled. |
-| rules | [SQLReviewRule](#bytebase-v1-SQLReviewRule) | repeated | The SQL review rules to enforce. |
-| resources | [string](#string) | repeated | Resources using the config. Format: {resource}/{resource id}, e.g., environments/test. |
+| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-SQLReviewRule"></a>
+<a name="bytebase-v1-GetTaskRunRequest"></a>
+
+### GetTaskRunRequest
-### SQLReviewRule
-SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [SQLReviewRule.Type](#bytebase-v1-SQLReviewRule-Type) | | The type of SQL review rule. |
-| level | [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level) | | The severity level of the rule. |
-| naming_payload | [SQLReviewRule.NamingRulePayload](#bytebase-v1-SQLReviewRule-NamingRulePayload) | | |
-| number_payload | [SQLReviewRule.NumberRulePayload](#bytebase-v1-SQLReviewRule-NumberRulePayload) | | |
-| string_array_payload | [SQLReviewRule.StringArrayRulePayload](#bytebase-v1-SQLReviewRule-StringArrayRulePayload) | | |
-| comment_convention_payload | [SQLReviewRule.CommentConventionRulePayload](#bytebase-v1-SQLReviewRule-CommentConventionRulePayload) | | |
-| string_payload | [SQLReviewRule.StringRulePayload](#bytebase-v1-SQLReviewRule-StringRulePayload) | | |
-| naming_case_payload | [SQLReviewRule.NamingCaseRulePayload](#bytebase-v1-SQLReviewRule-NamingCaseRulePayload) | | |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-SQLReviewRule-CommentConventionRulePayload"></a>
+<a name="bytebase-v1-GetTaskRunSessionRequest"></a>
-### SQLReviewRule.CommentConventionRulePayload
+### GetTaskRunSessionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| required | [bool](#bool) | | |
-| max_length | [int32](#int32) | | |
+| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-SQLReviewRule-NamingCaseRulePayload"></a>
+<a name="bytebase-v1-ListRolloutsRequest"></a>
-### SQLReviewRule.NamingCaseRulePayload
+### ListRolloutsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| upper | [bool](#bool) | | |
+| parent | [string](#string) | | The parent, which owns this collection of rollouts. Format: projects/{project} Use &#34;projects/-&#34; to list all rollouts from all projects. |
+| page_size | [int32](#int32) | | The maximum number of rollouts to return. The service may return fewer than this value. If unspecified, at most 10 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter rollouts returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters: - update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
+For example: update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] |
-<a name="bytebase-v1-SQLReviewRule-NamingRulePayload"></a>
-### SQLReviewRule.NamingRulePayload
-Payload message types for SQL review rules
+
+<a name="bytebase-v1-ListRolloutsResponse"></a>
+
+### ListRolloutsResponse
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| max_length | [int32](#int32) | | |
-| format | [string](#string) | | |
+| rollouts | [Rollout](#bytebase-v1-Rollout) | repeated | The rollouts from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-SQLReviewRule-NumberRulePayload"></a>
+<a name="bytebase-v1-ListTaskRunsRequest"></a>
-### SQLReviewRule.NumberRulePayload
+### ListTaskRunsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| number | [int32](#int32) | | |
+| parent | [string](#string) | | The parent, which owns this collection of taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. |
-<a name="bytebase-v1-SQLReviewRule-StringArrayRulePayload"></a>
+<a name="bytebase-v1-ListTaskRunsResponse"></a>
-### SQLReviewRule.StringArrayRulePayload
+### ListTaskRunsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| list | [string](#string) | repeated | |
+| task_runs | [TaskRun](#bytebase-v1-TaskRun) | repeated | The taskRuns from the specified request. |
-<a name="bytebase-v1-SQLReviewRule-StringRulePayload"></a>
+<a name="bytebase-v1-PreviewTaskRunRollbackRequest"></a>
-### SQLReviewRule.StringRulePayload
+### PreviewTaskRunRollbackRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| value | [string](#string) | | |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-UpdateReviewConfigRequest"></a>
+<a name="bytebase-v1-PreviewTaskRunRollbackResponse"></a>
-### UpdateReviewConfigRequest
+### PreviewTaskRunRollbackResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to update.
+| statement | [string](#string) | | The rollback SQL statement that would undo the task run. |
-The name field is used to identify the SQL review config to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the config is not found, a new config will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-Rollout"></a>
+### Rollout
-<a name="bytebase-v1-SQLReviewRule-Level"></a>
-### SQLReviewRule.Level
-The severity level for SQL review rules.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| LEVEL_UNSPECIFIED | 0 | Unspecified level. |
-| ERROR | 1 | Rule violation is an error. |
-| WARNING | 2 | Rule violation is a warning. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The resource name of the rollout. Format: projects/{project}/plans/{plan}/rollout |
+| title | [string](#string) | | The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set. |
+| stages | [Stage](#bytebase-v1-Stage) | repeated | Stages and thus tasks of the rollout. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-<a name="bytebase-v1-SQLReviewRule-Type"></a>
-### SQLReviewRule.Type
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| ENGINE_MYSQL_USE_INNODB | 1 | |
-| NAMING_FULLY_QUALIFIED | 2 | |
-| NAMING_TABLE | 3 | |
-| NAMING_COLUMN | 4 | |
-| NAMING_INDEX_PK | 5 | |
-| NAMING_INDEX_UK | 6 | |
-| NAMING_INDEX_FK | 7 | |
-| NAMING_INDEX_IDX | 8 | |
-| NAMING_COLUMN_AUTO_INCREMENT | 9 | |
-| NAMING_TABLE_NO_KEYWORD | 10 | |
-| NAMING_IDENTIFIER_NO_KEYWORD | 11 | |
-| NAMING_IDENTIFIER_CASE | 12 | |
-| STATEMENT_SELECT_NO_SELECT_ALL | 13 | |
-| STATEMENT_WHERE_REQUIRE_SELECT | 14 | |
-| STATEMENT_WHERE_REQUIRE_UPDATE_DELETE | 15 | |
-| STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE | 16 | |
-| STATEMENT_DISALLOW_ON_DEL_CASCADE | 17 | |
-| STATEMENT_DISALLOW_RM_TBL_CASCADE | 18 | |
-| STATEMENT_DISALLOW_COMMIT | 19 | |
-| STATEMENT_DISALLOW_LIMIT | 20 | |
-| STATEMENT_DISALLOW_ORDER_BY | 21 | |
-| STATEMENT_MERGE_ALTER_TABLE | 22 | |
-| STATEMENT_INSERT_ROW_LIMIT | 23 | |
-| STATEMENT_INSERT_MUST_SPECIFY_COLUMN | 24 | |
-| STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND | 25 | |
-| STATEMENT_AFFECTED_ROW_LIMIT | 26 | |
-| STATEMENT_DML_DRY_RUN | 27 | |
-| STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT | 28 | |
-| STATEMENT_ADD_CHECK_NOT_VALID | 29 | |
-| STATEMENT_ADD_FOREIGN_KEY_NOT_VALID | 30 | |
-| STATEMENT_DISALLOW_ADD_NOT_NULL | 31 | |
-| STATEMENT_SELECT_FULL_TABLE_SCAN | 32 | |
-| STATEMENT_CREATE_SPECIFY_SCHEMA | 33 | |
-| STATEMENT_CHECK_SET_ROLE_VARIABLE | 34 | |
-| STATEMENT_DISALLOW_USING_FILESORT | 35 | |
-| STATEMENT_DISALLOW_USING_TEMPORARY | 36 | |
-| STATEMENT_WHERE_NO_EQUAL_NULL | 37 | |
-| STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS | 38 | |
-| STATEMENT_QUERY_MINIMUM_PLAN_LEVEL | 39 | |
-| STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT | 40 | |
-| STATEMENT_MAXIMUM_LIMIT_VALUE | 41 | |
-| STATEMENT_MAXIMUM_JOIN_TABLE_COUNT | 42 | |
-| STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION | 43 | |
-| STATEMENT_JOIN_STRICT_COLUMN_ATTRS | 44 | |
-| STATEMENT_NON_TRANSACTIONAL | 45 | |
-| STATEMENT_ADD_COLUMN_WITHOUT_POSITION | 46 | |
-| STATEMENT_DISALLOW_OFFLINE_DDL | 47 | |
-| STATEMENT_DISALLOW_CROSS_DB_QUERIES | 48 | |
-| STATEMENT_MAX_EXECUTION_TIME | 49 | |
-| STATEMENT_REQUIRE_ALGORITHM_OPTION | 50 | |
-| STATEMENT_REQUIRE_LOCK_OPTION | 51 | |
-| STATEMENT_OBJECT_OWNER_CHECK | 52 | |
-| TABLE_REQUIRE_PK | 53 | |
-| TABLE_NO_FOREIGN_KEY | 54 | |
-| TABLE_DROP_NAMING_CONVENTION | 55 | |
-| TABLE_COMMENT | 56 | |
-| TABLE_DISALLOW_PARTITION | 57 | |
-| TABLE_DISALLOW_TRIGGER | 58 | |
-| TABLE_NO_DUPLICATE_INDEX | 59 | |
-| TABLE_TEXT_FIELDS_TOTAL_LENGTH | 60 | |
-| TABLE_DISALLOW_SET_CHARSET | 61 | |
-| TABLE_DISALLOW_DDL | 62 | |
-| TABLE_DISALLOW_DML | 63 | |
-| TABLE_LIMIT_SIZE | 64 | |
-| TABLE_REQUIRE_CHARSET | 65 | |
-| TABLE_REQUIRE_COLLATION | 66 | |
-| COLUMN_REQUIRED | 67 | |
-| COLUMN_NO_NULL | 68 | |
-| COLUMN_DISALLOW_CHANGE_TYPE | 69 | |
-| COLUMN_SET_DEFAULT_FOR_NOT_NULL | 70 | |
-| COLUMN_DISALLOW_CHANGE | 71 | |
-| COLUMN_DISALLOW_CHANGING_ORDER | 72 | |
-| COLUMN_DISALLOW_DROP | 73 | |
-| COLUMN_DISALLOW_DROP_IN_INDEX | 74 | |
-| COLUMN_COMMENT | 75 | |
-| COLUMN_AUTO_INCREMENT_MUST_INTEGER | 76 | |
-| COLUMN_TYPE_DISALLOW_LIST | 77 | |
-| COLUMN_DISALLOW_SET_CHARSET | 78 | |
-| COLUMN_MAXIMUM_CHARACTER_LENGTH | 79 | |
-| COLUMN_MAXIMUM_VARCHAR_LENGTH | 80 | |
-| COLUMN_AUTO_INCREMENT_INITIAL_VALUE | 81 | |
-| COLUMN_AUTO_INCREMENT_MUST_UNSIGNED | 82 | |
-| COLUMN_CURRENT_TIME_COUNT_LIMIT | 83 | |
-| COLUMN_REQUIRE_DEFAULT | 84 | |
-| COLUMN_DEFAULT_DISALLOW_VOLATILE | 85 | |
-| COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT | 86 | |
-| COLUMN_REQUIRE_CHARSET | 87 | |
-| COLUMN_REQUIRE_COLLATION | 88 | |
-| SCHEMA_BACKWARD_COMPATIBILITY | 89 | |
-| DATABASE_DROP_EMPTY_DATABASE | 90 | |
-| INDEX_NO_DUPLICATE_COLUMN | 91 | |
-| INDEX_KEY_NUMBER_LIMIT | 92 | |
-| INDEX_PK_TYPE_LIMIT | 93 | |
-| INDEX_TYPE_NO_BLOB | 94 | |
-| INDEX_TOTAL_NUMBER_LIMIT | 95 | |
-| INDEX_PRIMARY_KEY_TYPE_ALLOWLIST | 96 | |
-| INDEX_CREATE_CONCURRENTLY | 97 | |
-| INDEX_TYPE_ALLOW_LIST | 98 | |
-| INDEX_NOT_REDUNDANT | 99 | |
-| SYSTEM_CHARSET_ALLOWLIST | 100 | |
-| SYSTEM_COLLATION_ALLOWLIST | 101 | |
-| SYSTEM_COMMENT_LENGTH | 102 | |
-| SYSTEM_PROCEDURE_DISALLOW_CREATE | 103 | |
-| SYSTEM_EVENT_DISALLOW_CREATE | 104 | |
-| SYSTEM_VIEW_DISALLOW_CREATE | 105 | |
-| SYSTEM_FUNCTION_DISALLOW_CREATE | 106 | |
-| SYSTEM_FUNCTION_DISALLOWED_LIST | 107 | |
-| ADVICE_ONLINE_MIGRATION | 108 | |
-| BUILTIN_PRIOR_BACKUP_CHECK | 109 | |
+<a name="bytebase-v1-Stage"></a>
+### Stage
-
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage} Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. |
+| id | [string](#string) | | id is the environment id of the stage. e.g., &#34;prod&#34;. Use &#34;-&#34; when the stage has no environment or deleted environment. |
+| environment | [string](#string) | | environment is the environment of the stage. Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. |
+| tasks | [Task](#bytebase-v1-Task) | repeated | The tasks within this stage. |
-<a name="bytebase-v1-ReviewConfigService"></a>
-### ReviewConfigService
-ReviewConfigService manages approval flow configurations.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| CreateReviewConfig | [CreateReviewConfigRequest](#bytebase-v1-CreateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Creates a new SQL review configuration. Permissions required: bb.reviewConfigs.create |
-| ListReviewConfigs | [ListReviewConfigsRequest](#bytebase-v1-ListReviewConfigsRequest) | [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse) | Lists all SQL review configurations. Permissions required: bb.reviewConfigs.list |
-| GetReviewConfig | [GetReviewConfigRequest](#bytebase-v1-GetReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Retrieves a SQL review configuration by name. Permissions required: bb.reviewConfigs.get |
-| UpdateReviewConfig | [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Updates a SQL review configuration. Permissions required: bb.reviewConfigs.update When allow_missing=true, also requires: bb.reviewConfigs.create |
-| DeleteReviewConfig | [DeleteReviewConfigRequest](#bytebase-v1-DeleteReviewConfigRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a SQL review configuration. Permissions required: bb.reviewConfigs.delete |
-
+<a name="bytebase-v1-Task"></a>
-<a name="v1_revision_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+### Task
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
+| spec_id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. |
+| status | [Task.Status](#bytebase-v1-Task-Status) | | Status is the status of the task. |
+| skipped_reason | [string](#string) | | The reason why the task was skipped. |
+| type | [Task.Type](#bytebase-v1-Task-Type) | | |
+| target | [string](#string) | | Format: instances/{instance} if the task is DatabaseCreate. Format: instances/{instance}/databases/{database} |
+| database_create | [Task.DatabaseCreate](#bytebase-v1-Task-DatabaseCreate) | | |
+| database_update | [Task.DatabaseUpdate](#bytebase-v1-Task-DatabaseUpdate) | | |
+| database_data_export | [Task.DatabaseDataExport](#bytebase-v1-Task-DatabaseDataExport) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The update_time is the update time of latest task run. If there are no task runs, it will be empty. |
+| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The run_time is the scheduled run time of latest task run. If there are no task runs or the task run is not scheduled, it will be empty. |
-## v1/revision_service.proto
-<a name="bytebase-v1-BatchCreateRevisionsRequest"></a>
-### BatchCreateRevisionsRequest
+<a name="bytebase-v1-Task-DatabaseCreate"></a>
+
+### Task.DatabaseCreate
+Payload for creating a new database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all revisions being created. Format: instances/{instance}/databases/{database} |
-| requests | [CreateRevisionRequest](#bytebase-v1-CreateRevisionRequest) | repeated | The request message specifying the revisions to create. A maximum of 100 revisions can be created in a batch. |
-
+| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
-<a name="bytebase-v1-BatchCreateRevisionsResponse"></a>
-### BatchCreateRevisionsResponse
+<a name="bytebase-v1-Task-DatabaseDataExport"></a>
+### Task.DatabaseDataExport
+Payload for exporting database data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| revisions | [Revision](#bytebase-v1-Revision) | repeated | The created revisions. |
-
+| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
-<a name="bytebase-v1-CreateRevisionRequest"></a>
-### CreateRevisionRequest
+<a name="bytebase-v1-Task-DatabaseUpdate"></a>
+### Task.DatabaseUpdate
+Payload for updating a database schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: instances/{instance}/databases/{database} |
-| revision | [Revision](#bytebase-v1-Revision) | | The revision to create. |
+| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
+| release | [string](#string) | | Format: projects/{project}/releases/{release} |
-<a name="bytebase-v1-DeleteRevisionRequest"></a>
+<a name="bytebase-v1-TaskRun"></a>
-### DeleteRevisionRequest
+### TaskRun
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the revision to delete. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| status | [TaskRun.Status](#bytebase-v1-TaskRun-Status) | | The current execution status of the task run. |
+| detail | [string](#string) | | Below are the results of a task run. Detailed information about the task run result. |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the task run started execution. |
+| export_archive_status | [TaskRun.ExportArchiveStatus](#bytebase-v1-TaskRun-ExportArchiveStatus) | | The export archive status for data export tasks. |
+| has_prior_backup | [bool](#bool) | | Indicates whether a prior backup was created for this task run. When true, rollback SQL can be generated via PreviewTaskRunRollback. Backup details are available in the task run logs. |
+| scheduler_info | [TaskRun.SchedulerInfo](#bytebase-v1-TaskRun-SchedulerInfo) | | Scheduling information about the task run. |
+| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. This can only be set when creating the task run calling BatchRunTasks. |
-<a name="bytebase-v1-GetRevisionRequest"></a>
-### GetRevisionRequest
+<a name="bytebase-v1-TaskRun-SchedulerInfo"></a>
+### TaskRun.SchedulerInfo
+Information about task run scheduling.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the revision. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-
+| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the scheduling info was reported. |
+| waiting_cause | [TaskRun.SchedulerInfo.WaitingCause](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause) | | The cause for the task run waiting. |
-<a name="bytebase-v1-ListRevisionsRequest"></a>
-### ListRevisionsRequest
+<a name="bytebase-v1-TaskRun-SchedulerInfo-WaitingCause"></a>
+### TaskRun.SchedulerInfo.WaitingCause
+Information about why a task run is waiting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent of the revisions. Format: instances/{instance}/databases/{database} |
-| page_size | [int32](#int32) | | The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 10 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListRevisions` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRevisions` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Whether to include deleted revisions in the results. |
+| parallel_tasks_limit | [bool](#bool) | | Waiting due to parallel tasks limit. |
-<a name="bytebase-v1-ListRevisionsResponse"></a>
+<a name="bytebase-v1-TaskRunLog"></a>
-### ListRevisionsResponse
+### TaskRunLog
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| revisions | [Revision](#bytebase-v1-Revision) | repeated | The revisions from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log |
+| entries | [TaskRunLogEntry](#bytebase-v1-TaskRunLogEntry) | repeated | The log entries for this task run. |
-<a name="bytebase-v1-Revision"></a>
+<a name="bytebase-v1-TaskRunLogEntry"></a>
-### Revision
+### TaskRunLogEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: instances/{instance}/databases/{database}/revisions/{revision} |
-| release | [string](#string) | | Format: projects/{project}/releases/{release} Can be empty. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| deleter | [string](#string) | | Format: users/[email protected] Can be empty. |
-| delete_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Can be empty. |
-| file | [string](#string) | | Format: projects/{project}/releases/{release}/files/{id} Can be empty. |
-| version | [string](#string) | | The schema version string for this revision. |
-| sheet | [string](#string) | | The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
-| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet. |
-| task_run | [string](#string) | | The task run associated with the revision. Can be empty. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| type | [Revision.Type](#bytebase-v1-Revision-Type) | | The type of the revision. |
+| type | [TaskRunLogEntry.Type](#bytebase-v1-TaskRunLogEntry-Type) | | The type of this log entry. |
+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the log was recorded. |
+| replica_id | [string](#string) | | The replica ID for this log entry. |
+| schema_dump | [TaskRunLogEntry.SchemaDump](#bytebase-v1-TaskRunLogEntry-SchemaDump) | | Schema dump details (if type is SCHEMA_DUMP). |
+| command_execute | [TaskRunLogEntry.CommandExecute](#bytebase-v1-TaskRunLogEntry-CommandExecute) | | Command execution details (if type is COMMAND_EXECUTE). |
+| database_sync | [TaskRunLogEntry.DatabaseSync](#bytebase-v1-TaskRunLogEntry-DatabaseSync) | | Database sync details (if type is DATABASE_SYNC). |
+| transaction_control | [TaskRunLogEntry.TransactionControl](#bytebase-v1-TaskRunLogEntry-TransactionControl) | | Transaction control details (if type is TRANSACTION_CONTROL). |
+| prior_backup | [TaskRunLogEntry.PriorBackup](#bytebase-v1-TaskRunLogEntry-PriorBackup) | | Prior backup details (if type is PRIOR_BACKUP). |
+| retry_info | [TaskRunLogEntry.RetryInfo](#bytebase-v1-TaskRunLogEntry-RetryInfo) | | Retry information details (if type is RETRY_INFO). |
+| compute_diff | [TaskRunLogEntry.ComputeDiff](#bytebase-v1-TaskRunLogEntry-ComputeDiff) | | Compute diff details (if type is COMPUTE_DIFF). |
+| release_file_execute | [TaskRunLogEntry.ReleaseFileExecute](#bytebase-v1-TaskRunLogEntry-ReleaseFileExecute) | | Release file execution details (if type is RELEASE_FILE_EXECUTE). |
-
+<a name="bytebase-v1-TaskRunLogEntry-CommandExecute"></a>
-<a name="bytebase-v1-Revision-Type"></a>
+### TaskRunLogEntry.CommandExecute
+Command execution details.
-### Revision.Type
-The type of schema revision.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| VERSIONED | 1 | Versioned schema migration. |
-| DECLARATIVE | 2 | Declarative schema definition. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the command was logged. |
+| range | [Range](#bytebase-v1-Range) | | The byte offset range of the executed command in the sheet. Uses byte offsets (not character indices) for efficient slicing of sheet content bytes. Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. |
+| statement | [string](#string) | | The executed statement. |
+| response | [TaskRunLogEntry.CommandExecute.CommandResponse](#bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse) | | The response from executing the command. |
-
-
-<a name="bytebase-v1-RevisionService"></a>
-### RevisionService
-RevisionService manages schema revision history.
+<a name="bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse"></a>
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| ListRevisions | [ListRevisionsRequest](#bytebase-v1-ListRevisionsRequest) | [ListRevisionsResponse](#bytebase-v1-ListRevisionsResponse) | Lists schema revisions for a database. Permissions required: bb.revisions.list |
-| GetRevision | [GetRevisionRequest](#bytebase-v1-GetRevisionRequest) | [Revision](#bytebase-v1-Revision) | Retrieves a schema revision by name. Permissions required: bb.revisions.get |
-| BatchCreateRevisions | [BatchCreateRevisionsRequest](#bytebase-v1-BatchCreateRevisionsRequest) | [BatchCreateRevisionsResponse](#bytebase-v1-BatchCreateRevisionsResponse) | Creates multiple schema revisions in a single operation. Permissions required: bb.revisions.create |
-| DeleteRevision | [DeleteRevisionRequest](#bytebase-v1-DeleteRevisionRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a schema revision. Permissions required: bb.revisions.delete |
+### TaskRunLogEntry.CommandExecute.CommandResponse
+Command execution response.
-
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the response was logged. |
+| error | [string](#string) | | Error message if command execution failed. |
+| affected_rows | [int64](#int64) | | Total affected rows. |
+| all_affected_rows | [int64](#int64) | repeated | `all_affected_rows` is the affected rows of each command. `all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. |
-<a name="v1_role_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/role_service.proto
+
+
+<a name="bytebase-v1-TaskRunLogEntry-ComputeDiff"></a>
+
+### TaskRunLogEntry.ComputeDiff
+Schema diff computation details.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation ended. |
+| error | [string](#string) | | Error message if computation failed. |
+
-<a name="bytebase-v1-CreateRoleRequest"></a>
-### CreateRoleRequest
+<a name="bytebase-v1-TaskRunLogEntry-DatabaseSync"></a>
+
+### TaskRunLogEntry.DatabaseSync
+Database synchronization details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [Role](#bytebase-v1-Role) | | The role to create. |
-| role_id | [string](#string) | | The ID to use for the role, which will become the final component of the role&#39;s resource name.
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync ended. |
+| error | [string](#string) | | Error message if sync failed. |
-This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/. |
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup"></a>
+
+### TaskRunLogEntry.PriorBackup
+Prior backup operation details.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup ended. |
+| prior_backup_detail | [TaskRunLogEntry.PriorBackup.PriorBackupDetail](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail) | | The backup details. |
+| error | [string](#string) | | Error message if the backup failed. |
-<a name="bytebase-v1-DeleteRoleRequest"></a>
-### DeleteRoleRequest
+
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail"></a>
+
+### TaskRunLogEntry.PriorBackup.PriorBackupDetail
+Prior backup detail for rollback purposes.
+
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role to delete. Format: roles/{role} |
+| items | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item) | repeated | The list of backed up tables. |
-<a name="bytebase-v1-GetRoleRequest"></a>
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item"></a>
+
+### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item
+A single backup table mapping.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| source_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The original table information. |
+| target_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The target backup table information. |
+| start_position | [Position](#bytebase-v1-Position) | | The start position in the SQL statement. |
+| end_position | [Position](#bytebase-v1-Position) | | The end position in the SQL statement. |
+
-### GetRoleRequest
+
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table"></a>
+
+### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table
+Table information.
+
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role to retrieve. Format: roles/{role} |
+| database | [string](#string) | | The database information. Format: instances/{instance}/databases/{database} |
+| schema | [string](#string) | | The schema name. |
+| table | [string](#string) | | The table name. |
-<a name="bytebase-v1-ListRolesRequest"></a>
+<a name="bytebase-v1-TaskRunLogEntry-ReleaseFileExecute"></a>
-### ListRolesRequest
+### TaskRunLogEntry.ReleaseFileExecute
+Release file execution details.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| version | [string](#string) | | The version of the file being executed (e.g., &#34;0001&#34;). |
+| file_path | [string](#string) | | The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). |
-<a name="bytebase-v1-ListRolesResponse"></a>
-### ListRolesResponse
+<a name="bytebase-v1-TaskRunLogEntry-RetryInfo"></a>
+### TaskRunLogEntry.RetryInfo
+Retry information for failed operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [Role](#bytebase-v1-Role) | repeated | The roles from the specified request. |
+| error | [string](#string) | | The error that triggered the retry. |
+| retry_count | [int32](#int32) | | Current retry attempt number. |
+| maximum_retries | [int32](#int32) | | Maximum number of retries allowed. |
-<a name="bytebase-v1-Role"></a>
+<a name="bytebase-v1-TaskRunLogEntry-SchemaDump"></a>
-### Role
-Role defines a set of permissions that can be assigned to users.
+### TaskRunLogEntry.SchemaDump
+Schema dump operation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Resource name. Format: roles/{role} |
-| title | [string](#string) | | Human-readable title. |
-| description | [string](#string) | | Optional description of the role. |
-| permissions | [string](#string) | repeated | List of permission identifiers granted by this role. |
-| type | [Role.Type](#bytebase-v1-Role-Type) | | Role type indicating if it&#39;s built-in or custom. |
-
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump ended. |
+| error | [string](#string) | | Error message if the schema dump failed. |
-<a name="bytebase-v1-UpdateRoleRequest"></a>
-### UpdateRoleRequest
+<a name="bytebase-v1-TaskRunLogEntry-TransactionControl"></a>
+### TaskRunLogEntry.TransactionControl
+Transaction control operation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [Role](#bytebase-v1-Role) | | The role to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the role is not found, a new role will be created. In this situation, `update_mask` is ignored. |
-
+| type | [TaskRunLogEntry.TransactionControl.Type](#bytebase-v1-TaskRunLogEntry-TransactionControl-Type) | | The type of transaction control. |
+| error | [string](#string) | | Error message if the operation failed. |
-
-<a name="bytebase-v1-Role-Type"></a>
+<a name="bytebase-v1-TaskRunSession"></a>
-### Role.Type
+### TaskRunSession
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| BUILT_IN | 1 | System-defined role that cannot be modified. |
-| CUSTOM | 2 | User-defined role that can be modified. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session |
+| postgres | [TaskRunSession.Postgres](#bytebase-v1-TaskRunSession-Postgres) | | PostgreSQL session information. |
-
-
-<a name="bytebase-v1-RoleService"></a>
-### RoleService
-RoleService manages workspace roles and permissions.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| ListRoles | [ListRolesRequest](#bytebase-v1-ListRolesRequest) | [ListRolesResponse](#bytebase-v1-ListRolesResponse) | Lists roles in the workspace. Permissions required: bb.roles.list |
-| GetRole | [GetRoleRequest](#bytebase-v1-GetRoleRequest) | [Role](#bytebase-v1-Role) | Retrieves a role by name. Permissions required: bb.roles.get |
-| CreateRole | [CreateRoleRequest](#bytebase-v1-CreateRoleRequest) | [Role](#bytebase-v1-Role) | Creates a new custom role. Permissions required: bb.roles.create |
-| UpdateRole | [UpdateRoleRequest](#bytebase-v1-UpdateRoleRequest) | [Role](#bytebase-v1-Role) | Updates a role&#39;s properties. Permissions required: bb.roles.update When allow_missing=true, also requires: bb.roles.create |
-| DeleteRole | [DeleteRoleRequest](#bytebase-v1-DeleteRoleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a custom role. Permissions required: bb.roles.delete |
+<a name="bytebase-v1-TaskRunSession-Postgres"></a>
-
+### TaskRunSession.Postgres
+PostgreSQL session information.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| session | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | | `session` is the session of the task run executing commands. |
+| blocking_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocking_sessions` block `session`. |
+| blocked_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocked_sessions` are blocked by `session`. |
-<a name="v1_rollout_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/rollout_service.proto
-<a name="bytebase-v1-BatchCancelTaskRunsRequest"></a>
-### BatchCancelTaskRunsRequest
+<a name="bytebase-v1-TaskRunSession-Postgres-Session"></a>
+### TaskRunSession.Postgres.Session
+PostgreSQL session information read from `pg_stat_activity`.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The task name for the taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. |
-| task_runs | [string](#string) | repeated | The taskRuns to cancel. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| pid | [string](#string) | | Process ID of the session. |
+| blocked_by_pids | [string](#string) | repeated | PIDs of sessions blocking this session. |
+| query | [string](#string) | | Current query being executed. |
+| state | [string](#string) | optional | Session state (active, idle, etc.). |
+| wait_event_type | [string](#string) | optional | Wait event type if session is waiting. |
+| wait_event | [string](#string) | optional | Specific wait event if session is waiting. |
+| datname | [string](#string) | optional | Database name. |
+| usename | [string](#string) | optional | User name. |
+| application_name | [string](#string) | | Application name. |
+| client_addr | [string](#string) | optional | Client IP address. |
+| client_port | [string](#string) | optional | Client port number. |
+| backend_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backend process started. |
+| xact_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current transaction started. |
+| query_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current query started. |
+
-<a name="bytebase-v1-BatchCancelTaskRunsResponse"></a>
-### BatchCancelTaskRunsResponse
+<a name="bytebase-v1-Task-Status"></a>
+
+### Task.Status
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| NOT_STARTED | 1 | Task has not started and is awaiting its turn in the deployment sequence. |
+| PENDING | 2 | Task is ready to run and waiting for approval or scheduled time. |
+| RUNNING | 3 | Task is currently executing. |
+| DONE | 4 | Task completed successfully. |
+| FAILED | 5 | Task execution failed with errors. |
+| CANCELED | 6 | Task execution was canceled by a user. |
+| SKIPPED | 7 | Task was skipped and will not be executed. |
+<a name="bytebase-v1-Task-Type"></a>
+### Task.Type
-<a name="bytebase-v1-BatchRunTasksRequest"></a>
-### BatchRunTasksRequest
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified task type. |
+| GENERAL | 1 | General task for miscellaneous operations. |
+| DATABASE_CREATE | 2 | Database creation task that creates a new database. Use payload DatabaseCreate. |
+| DATABASE_MIGRATE | 3 | Database migration task that applies versioned schema changes. Use payload DatabaseUpdate. |
+| DATABASE_EXPORT | 4 | Database export task that exports query results or table data. Use payload DatabaseDataExport. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
-| tasks | [string](#string) | repeated | The tasks to run. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
-| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. |
+<a name="bytebase-v1-TaskRun-ExportArchiveStatus"></a>
+### TaskRun.ExportArchiveStatus
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| EXPORT_ARCHIVE_STATUS_UNSPECIFIED | 0 | Unspecified export archive status. |
+| READY | 1 | Export archive is ready for download. |
+| EXPORTED | 2 | Export archive has been downloaded by the user. |
-<a name="bytebase-v1-BatchRunTasksResponse"></a>
+<a name="bytebase-v1-TaskRun-Status"></a>
-### BatchRunTasksResponse
+### TaskRun.Status
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Task run is queued and waiting to start execution. |
+| RUNNING | 2 | Task run is currently executing. |
+| DONE | 3 | Task run completed successfully. |
+| FAILED | 4 | Task run execution failed with errors. |
+| CANCELED | 5 | Task run execution was canceled by a user. |
+| AVAILABLE | 6 | Task run is ready for immediate execution. |
+<a name="bytebase-v1-TaskRunLogEntry-TransactionControl-Type"></a>
+### TaskRunLogEntry.TransactionControl.Type
+Transaction control type.
-<a name="bytebase-v1-BatchSkipTasksRequest"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| BEGIN | 1 | Begin transaction. |
+| COMMIT | 2 | Commit transaction. |
+| ROLLBACK | 3 | Rollback transaction. |
-### BatchSkipTasksRequest
+<a name="bytebase-v1-TaskRunLogEntry-Type"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
-| tasks | [string](#string) | repeated | The tasks to skip. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
-| reason | [string](#string) | | The reason for skipping the tasks. |
+### TaskRunLogEntry.Type
+The type of log entry.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| SCHEMA_DUMP | 1 | Schema dump operation. |
+| COMMAND_EXECUTE | 2 | Command execution. |
+| DATABASE_SYNC | 3 | Database synchronization. |
+| TRANSACTION_CONTROL | 5 | Transaction control (BEGIN, COMMIT, ROLLBACK). |
+| PRIOR_BACKUP | 6 | Prior backup operation. |
+| RETRY_INFO | 7 | Retry information. |
+| COMPUTE_DIFF | 8 | Schema diff computation. |
+| RELEASE_FILE_EXECUTE | 9 | Release file execution. |
+
+
-<a name="bytebase-v1-BatchSkipTasksResponse"></a>
+<a name="bytebase-v1-RolloutService"></a>
-### BatchSkipTasksResponse
+### RolloutService
+RolloutService manages the execution of deployment plans.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetRollout | [GetRolloutRequest](#bytebase-v1-GetRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Retrieves a rollout by its plan name. Permissions required: bb.rollouts.get |
+| ListRollouts | [ListRolloutsRequest](#bytebase-v1-ListRolloutsRequest) | [ListRolloutsResponse](#bytebase-v1-ListRolloutsResponse) | Lists rollouts in a project. Permissions required: bb.rollouts.list |
+| CreateRollout | [CreateRolloutRequest](#bytebase-v1-CreateRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Creates a new rollout for a plan. Permissions required: bb.rollouts.create |
+| ListTaskRuns | [ListTaskRunsRequest](#bytebase-v1-ListTaskRunsRequest) | [ListTaskRunsResponse](#bytebase-v1-ListTaskRunsResponse) | Lists task run executions for a task. Permissions required: bb.taskRuns.list |
+| GetTaskRun | [GetTaskRunRequest](#bytebase-v1-GetTaskRunRequest) | [TaskRun](#bytebase-v1-TaskRun) | Retrieves a task run by name. Permissions required: bb.taskRuns.list |
+| GetTaskRunLog | [GetTaskRunLogRequest](#bytebase-v1-GetTaskRunLogRequest) | [TaskRunLog](#bytebase-v1-TaskRunLog) | Retrieves execution logs for a task run. Permissions required: bb.taskRuns.list |
+| GetTaskRunSession | [GetTaskRunSessionRequest](#bytebase-v1-GetTaskRunSessionRequest) | [TaskRunSession](#bytebase-v1-TaskRunSession) | Retrieves database session information for a running task. Permissions required: bb.taskRuns.list |
+| BatchRunTasks | [BatchRunTasksRequest](#bytebase-v1-BatchRunTasksRequest) | [BatchRunTasksResponse](#bytebase-v1-BatchRunTasksResponse) | Executes multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
+| BatchSkipTasks | [BatchSkipTasksRequest](#bytebase-v1-BatchSkipTasksRequest) | [BatchSkipTasksResponse](#bytebase-v1-BatchSkipTasksResponse) | Skips multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
+| BatchCancelTaskRuns | [BatchCancelTaskRunsRequest](#bytebase-v1-BatchCancelTaskRunsRequest) | [BatchCancelTaskRunsResponse](#bytebase-v1-BatchCancelTaskRunsResponse) | Cancels multiple running task executions. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
+| PreviewTaskRunRollback | [PreviewTaskRunRollbackRequest](#bytebase-v1-PreviewTaskRunRollbackRequest) | [PreviewTaskRunRollbackResponse](#bytebase-v1-PreviewTaskRunRollbackResponse) | Generates rollback SQL for a completed task run. Permissions required: bb.taskRuns.list |
+
+<a name="v1_setting_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/setting_service.proto
-<a name="bytebase-v1-CreateRolloutRequest"></a>
-### CreateRolloutRequest
+<a name="bytebase-v1-AISetting"></a>
+
+### AISetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent plan for which this rollout will be created. Format: projects/{project}/plans/{plan} |
-| target | [string](#string) | optional | Create the rollout only for the specified target. Format: environments/{environment} If unspecified, all stages are created. If set to &#34;&#34;, no stages are created. |
+| enabled | [bool](#bool) | | |
+| provider | [AISetting.Provider](#bytebase-v1-AISetting-Provider) | | |
+| endpoint | [string](#string) | | |
+| api_key | [string](#string) | | |
+| model | [string](#string) | | |
+| version | [string](#string) | | |
-<a name="bytebase-v1-GetRolloutRequest"></a>
+<a name="bytebase-v1-Algorithm"></a>
-### GetRolloutRequest
+### Algorithm
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the rollout to retrieve. This is the rollout resource name, which is the plan name plus /rollout suffix. Format: projects/{project}/plans/{plan}/rollout |
+| full_mask | [Algorithm.FullMask](#bytebase-v1-Algorithm-FullMask) | | |
+| range_mask | [Algorithm.RangeMask](#bytebase-v1-Algorithm-RangeMask) | | |
+| md5_mask | [Algorithm.MD5Mask](#bytebase-v1-Algorithm-MD5Mask) | | |
+| inner_outer_mask | [Algorithm.InnerOuterMask](#bytebase-v1-Algorithm-InnerOuterMask) | | |
-<a name="bytebase-v1-GetTaskRunLogRequest"></a>
+<a name="bytebase-v1-Algorithm-FullMask"></a>
-### GetTaskRunLogRequest
+### Algorithm.FullMask
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| substitution | [string](#string) | | substitution is the string used to replace the original value, the max length of the string is 16 bytes. |
-<a name="bytebase-v1-GetTaskRunRequest"></a>
+<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>
-### GetTaskRunRequest
+### Algorithm.InnerOuterMask
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| prefix_len | [int32](#int32) | | |
+| suffix_len | [int32](#int32) | | |
+| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |
+| substitution | [string](#string) | | |
-<a name="bytebase-v1-GetTaskRunSessionRequest"></a>
+<a name="bytebase-v1-Algorithm-MD5Mask"></a>
-### GetTaskRunSessionRequest
+### Algorithm.MD5Mask
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |
-<a name="bytebase-v1-ListRolloutsRequest"></a>
+<a name="bytebase-v1-Algorithm-RangeMask"></a>
-### ListRolloutsRequest
+### Algorithm.RangeMask
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of rollouts. Format: projects/{project} Use &#34;projects/-&#34; to list all rollouts from all projects. |
-| page_size | [int32](#int32) | | The maximum number of rollouts to return. The service may return fewer than this value. If unspecified, at most 10 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter rollouts returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
-
-For example: update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] |
+| slices | [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice) | repeated | We store it as a repeated field to face the fact that the original value may have multiple parts should be masked. But frontend can be started with a single rule easily. |
-<a name="bytebase-v1-ListRolloutsResponse"></a>
+<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>
-### ListRolloutsResponse
+### Algorithm.RangeMask.Slice
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| rollouts | [Rollout](#bytebase-v1-Rollout) | repeated | The rollouts from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| start | [int32](#int32) | | start is the start character index (0-based) of the original value, should be less than end. Uses character indices (not byte offsets) for display-oriented masking. Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). |
+| end | [int32](#int32) | | end is the end character index (exclusive) of the original value. Uses character indices (not byte offsets) for display-oriented masking. |
+| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |
-<a name="bytebase-v1-ListTaskRunsRequest"></a>
+<a name="bytebase-v1-Announcement"></a>
-### ListTaskRunsRequest
+### Announcement
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. |
+| level | [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel) | | The alert level of announcement |
+| text | [string](#string) | | The text of announcement |
+| link | [string](#string) | | The optional link, user can follow the link to check extra details |
-<a name="bytebase-v1-ListTaskRunsResponse"></a>
+<a name="bytebase-v1-AppIMSetting"></a>
-### ListTaskRunsResponse
+### AppIMSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| task_runs | [TaskRun](#bytebase-v1-TaskRun) | repeated | The taskRuns from the specified request. |
+| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |
-<a name="bytebase-v1-PreviewTaskRunRollbackRequest"></a>
+<a name="bytebase-v1-AppIMSetting-DingTalk"></a>
-### PreviewTaskRunRollbackRequest
+### AppIMSetting.DingTalk
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| client_id | [string](#string) | | |
+| client_secret | [string](#string) | | |
+| robot_code | [string](#string) | | |
-<a name="bytebase-v1-PreviewTaskRunRollbackResponse"></a>
+<a name="bytebase-v1-AppIMSetting-Feishu"></a>
-### PreviewTaskRunRollbackResponse
+### AppIMSetting.Feishu
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| statement | [string](#string) | | The rollback SQL statement that would undo the task run. |
+| app_id | [string](#string) | | |
+| app_secret | [string](#string) | | |
-<a name="bytebase-v1-Rollout"></a>
+<a name="bytebase-v1-AppIMSetting-IMSetting"></a>
-### Rollout
+### AppIMSetting.IMSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the rollout. Format: projects/{project}/plans/{plan}/rollout |
-| title | [string](#string) | | The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set. |
-| stages | [Stage](#bytebase-v1-Stage) | repeated | Stages and thus tasks of the rollout. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| type | [WebhookType](#bytebase-v1-WebhookType) | | |
+| slack | [AppIMSetting.Slack](#bytebase-v1-AppIMSetting-Slack) | | |
+| feishu | [AppIMSetting.Feishu](#bytebase-v1-AppIMSetting-Feishu) | | |
+| wecom | [AppIMSetting.Wecom](#bytebase-v1-AppIMSetting-Wecom) | | |
+| lark | [AppIMSetting.Lark](#bytebase-v1-AppIMSetting-Lark) | | |
+| dingtalk | [AppIMSetting.DingTalk](#bytebase-v1-AppIMSetting-DingTalk) | | |
+| teams | [AppIMSetting.Teams](#bytebase-v1-AppIMSetting-Teams) | | |
-<a name="bytebase-v1-Stage"></a>
+<a name="bytebase-v1-AppIMSetting-Lark"></a>
-### Stage
+### AppIMSetting.Lark
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage} Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. |
-| id | [string](#string) | | id is the environment id of the stage. e.g., &#34;prod&#34;. Use &#34;-&#34; when the stage has no environment or deleted environment. |
-| environment | [string](#string) | | environment is the environment of the stage. Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. |
-| tasks | [Task](#bytebase-v1-Task) | repeated | The tasks within this stage. |
+| app_id | [string](#string) | | |
+| app_secret | [string](#string) | | |
-<a name="bytebase-v1-Task"></a>
+<a name="bytebase-v1-AppIMSetting-Slack"></a>
-### Task
+### AppIMSetting.Slack
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
-| spec_id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. |
-| status | [Task.Status](#bytebase-v1-Task-Status) | | Status is the status of the task. |
-| skipped_reason | [string](#string) | | The reason why the task was skipped. |
-| type | [Task.Type](#bytebase-v1-Task-Type) | | |
-| target | [string](#string) | | Format: instances/{instance} if the task is DatabaseCreate. Format: instances/{instance}/databases/{database} |
-| database_create | [Task.DatabaseCreate](#bytebase-v1-Task-DatabaseCreate) | | |
-| database_update | [Task.DatabaseUpdate](#bytebase-v1-Task-DatabaseUpdate) | | |
-| database_data_export | [Task.DatabaseDataExport](#bytebase-v1-Task-DatabaseDataExport) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The update_time is the update time of latest task run. If there are no task runs, it will be empty. |
-| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The run_time is the scheduled run time of latest task run. If there are no task runs or the task run is not scheduled, it will be empty. |
+| token | [string](#string) | | |
-<a name="bytebase-v1-Task-DatabaseCreate"></a>
+<a name="bytebase-v1-AppIMSetting-Teams"></a>
+
+### AppIMSetting.Teams
-### Task.DatabaseCreate
-Payload for creating a new database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
+| tenant_id | [string](#string) | | Azure AD tenant ID (Directory ID). |
+| client_id | [string](#string) | | Azure AD application (client) ID. |
+| client_secret | [string](#string) | | Azure AD client secret. |
-<a name="bytebase-v1-Task-DatabaseDataExport"></a>
+<a name="bytebase-v1-AppIMSetting-Wecom"></a>
+
+### AppIMSetting.Wecom
-### Task.DatabaseDataExport
-Payload for exporting database data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
+| corp_id | [string](#string) | | |
+| agent_id | [string](#string) | | |
+| secret | [string](#string) | | |
-<a name="bytebase-v1-Task-DatabaseUpdate"></a>
+<a name="bytebase-v1-DataClassificationSetting"></a>
+
+### DataClassificationSetting
-### Task.DatabaseUpdate
-Payload for updating a database schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
-| release | [string](#string) | | Format: projects/{project}/releases/{release} |
+| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |
-<a name="bytebase-v1-TaskRun"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>
-### TaskRun
+### DataClassificationSetting.DataClassificationConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| status | [TaskRun.Status](#bytebase-v1-TaskRun-Status) | | The current execution status of the task run. |
-| detail | [string](#string) | | Below are the results of a task run. Detailed information about the task run result. |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the task run started execution. |
-| export_archive_status | [TaskRun.ExportArchiveStatus](#bytebase-v1-TaskRun-ExportArchiveStatus) | | The export archive status for data export tasks. |
-| has_prior_backup | [bool](#bool) | | Indicates whether a prior backup was created for this task run. When true, rollback SQL can be generated via PreviewTaskRunRollback. Backup details are available in the task run logs. |
-| scheduler_info | [TaskRun.SchedulerInfo](#bytebase-v1-TaskRun-SchedulerInfo) | | Scheduling information about the task run. |
-| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. This can only be set when creating the task run calling BatchRunTasks. |
+| id | [string](#string) | | id is the uuid for classification. Each project can chose one classification config. |
+| title | [string](#string) | | |
+| levels | [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level) | repeated | levels is user defined level list for classification. The order for the level decides its priority. |
+| classification | [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry) | repeated | classification is the id - DataClassification map. The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
-<a name="bytebase-v1-TaskRun-SchedulerInfo"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>
+
+### DataClassificationSetting.DataClassificationConfig.ClassificationEntry
-### TaskRun.SchedulerInfo
-Information about task run scheduling.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the scheduling info was reported. |
-| waiting_cause | [TaskRun.SchedulerInfo.WaitingCause](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause) | | The cause for the task run waiting. |
+| key | [string](#string) | | |
+| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |
-<a name="bytebase-v1-TaskRun-SchedulerInfo-WaitingCause"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>
+
+### DataClassificationSetting.DataClassificationConfig.DataClassification
-### TaskRun.SchedulerInfo.WaitingCause
-Information about why a task run is waiting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parallel_tasks_limit | [bool](#bool) | | Waiting due to parallel tasks limit. |
+| id | [string](#string) | | id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
+| title | [string](#string) | | |
+| description | [string](#string) | | |
+| level_id | [string](#string) | optional | |
-<a name="bytebase-v1-TaskRunLog"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>
-### TaskRunLog
+### DataClassificationSetting.DataClassificationConfig.Level
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log |
-| entries | [TaskRunLogEntry](#bytebase-v1-TaskRunLogEntry) | repeated | The log entries for this task run. |
+| id | [string](#string) | | |
+| title | [string](#string) | | |
+| description | [string](#string) | | |
-<a name="bytebase-v1-TaskRunLogEntry"></a>
+<a name="bytebase-v1-EnvironmentSetting"></a>
-### TaskRunLogEntry
+### EnvironmentSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [TaskRunLogEntry.Type](#bytebase-v1-TaskRunLogEntry-Type) | | The type of this log entry. |
-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the log was recorded. |
-| replica_id | [string](#string) | | The replica ID for this log entry. |
-| schema_dump | [TaskRunLogEntry.SchemaDump](#bytebase-v1-TaskRunLogEntry-SchemaDump) | | Schema dump details (if type is SCHEMA_DUMP). |
-| command_execute | [TaskRunLogEntry.CommandExecute](#bytebase-v1-TaskRunLogEntry-CommandExecute) | | Command execution details (if type is COMMAND_EXECUTE). |
-| database_sync | [TaskRunLogEntry.DatabaseSync](#bytebase-v1-TaskRunLogEntry-DatabaseSync) | | Database sync details (if type is DATABASE_SYNC). |
-| transaction_control | [TaskRunLogEntry.TransactionControl](#bytebase-v1-TaskRunLogEntry-TransactionControl) | | Transaction control details (if type is TRANSACTION_CONTROL). |
-| prior_backup | [TaskRunLogEntry.PriorBackup](#bytebase-v1-TaskRunLogEntry-PriorBackup) | | Prior backup details (if type is PRIOR_BACKUP). |
-| retry_info | [TaskRunLogEntry.RetryInfo](#bytebase-v1-TaskRunLogEntry-RetryInfo) | | Retry information details (if type is RETRY_INFO). |
-| compute_diff | [TaskRunLogEntry.ComputeDiff](#bytebase-v1-TaskRunLogEntry-ComputeDiff) | | Compute diff details (if type is COMPUTE_DIFF). |
-| release_file_execute | [TaskRunLogEntry.ReleaseFileExecute](#bytebase-v1-TaskRunLogEntry-ReleaseFileExecute) | | Release file execution details (if type is RELEASE_FILE_EXECUTE). |
+| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |
-<a name="bytebase-v1-TaskRunLogEntry-CommandExecute"></a>
+<a name="bytebase-v1-EnvironmentSetting-Environment"></a>
+
+### EnvironmentSetting.Environment
-### TaskRunLogEntry.CommandExecute
-Command execution details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the command was logged. |
-| range | [Range](#bytebase-v1-Range) | | The byte offset range of the executed command in the sheet. Uses byte offsets (not character indices) for efficient slicing of sheet content bytes. Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. |
-| statement | [string](#string) | | The executed statement. |
-| response | [TaskRunLogEntry.CommandExecute.CommandResponse](#bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse) | | The response from executing the command. |
+| name | [string](#string) | | The resource name of the environment. Format: environments/{environment}. Output only. |
+| id | [string](#string) | | The resource id of the environment. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| title | [string](#string) | | The display name of the environment. |
+| tags | [EnvironmentSetting.Environment.TagsEntry](#bytebase-v1-EnvironmentSetting-Environment-TagsEntry) | repeated | |
+| color | [string](#string) | | |
-<a name="bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse"></a>
+<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>
+
+### EnvironmentSetting.Environment.TagsEntry
-### TaskRunLogEntry.CommandExecute.CommandResponse
-Command execution response.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the response was logged. |
-| error | [string](#string) | | Error message if command execution failed. |
-| affected_rows | [int64](#int64) | | Total affected rows. |
-| all_affected_rows | [int64](#int64) | repeated | `all_affected_rows` is the affected rows of each command. `all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-TaskRunLogEntry-ComputeDiff"></a>
+<a name="bytebase-v1-GetSettingRequest"></a>
-### TaskRunLogEntry.ComputeDiff
-Schema diff computation details.
+### GetSettingRequest
+The request message for getting a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation ended. |
-| error | [string](#string) | | Error message if computation failed. |
+| name | [string](#string) | | The resource name of the setting. |
-<a name="bytebase-v1-TaskRunLogEntry-DatabaseSync"></a>
+<a name="bytebase-v1-GetSettingResponse"></a>
-### TaskRunLogEntry.DatabaseSync
-Database synchronization details.
+### GetSettingResponse
+The response message for getting a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync ended. |
-| error | [string](#string) | | Error message if sync failed. |
+| setting | [Setting](#bytebase-v1-Setting) | | |
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup"></a>
+<a name="bytebase-v1-ListSettingsRequest"></a>
-### TaskRunLogEntry.PriorBackup
-Prior backup operation details.
+### ListSettingsRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup ended. |
-| prior_backup_detail | [TaskRunLogEntry.PriorBackup.PriorBackupDetail](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail) | | The backup details. |
-| error | [string](#string) | | Error message if the backup failed. |
+<a name="bytebase-v1-ListSettingsResponse"></a>
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail"></a>
+### ListSettingsResponse
-### TaskRunLogEntry.PriorBackup.PriorBackupDetail
-Prior backup detail for rollback purposes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| items | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item) | repeated | The list of backed up tables. |
+| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item"></a>
+<a name="bytebase-v1-SemanticTypeSetting"></a>
+
+### SemanticTypeSetting
-### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item
-A single backup table mapping.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| source_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The original table information. |
-| target_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The target backup table information. |
-| start_position | [Position](#bytebase-v1-Position) | | The start position in the SQL statement. |
-| end_position | [Position](#bytebase-v1-Position) | | The end position in the SQL statement. |
+| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table"></a>
+<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>
+
+### SemanticTypeSetting.SemanticType
-### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table
-Table information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| database | [string](#string) | | The database information. Format: instances/{instance}/databases/{database} |
-| schema | [string](#string) | | The schema name. |
-| table | [string](#string) | | The table name. |
+| id | [string](#string) | | id is the uuid for semantic type. |
+| title | [string](#string) | | the title of the semantic type, it should not be empty. |
+| description | [string](#string) | | the description of the semantic type, it can be empty. |
+| algorithm | [Algorithm](#bytebase-v1-Algorithm) | | |
+| icon | [string](#string) | | icon is the icon for semantic type, it can be emoji or base64 encoded image. |
-<a name="bytebase-v1-TaskRunLogEntry-ReleaseFileExecute"></a>
+<a name="bytebase-v1-Setting"></a>
-### TaskRunLogEntry.ReleaseFileExecute
-Release file execution details.
+### Setting
+The schema of setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| version | [string](#string) | | The version of the file being executed (e.g., &#34;0001&#34;). |
-| file_path | [string](#string) | | The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). |
+| name | [string](#string) | | The resource name of the setting. Format: settings/{setting} Example: &#34;settings/SEMANTIC_TYPES&#34; |
+| value | [SettingValue](#bytebase-v1-SettingValue) | | The configuration value of the setting. |
-<a name="bytebase-v1-TaskRunLogEntry-RetryInfo"></a>
+<a name="bytebase-v1-SettingValue"></a>
-### TaskRunLogEntry.RetryInfo
-Retry information for failed operations.
+### SettingValue
+The data in setting value.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| error | [string](#string) | | The error that triggered the retry. |
-| retry_count | [int32](#int32) | | Current retry attempt number. |
-| maximum_retries | [int32](#int32) | | Maximum number of retries allowed. |
+| app_im | [AppIMSetting](#bytebase-v1-AppIMSetting) | | |
+| workspace_profile | [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting) | | |
+| workspace_approval | [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting) | | |
+| data_classification | [DataClassificationSetting](#bytebase-v1-DataClassificationSetting) | | |
+| semantic_type | [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting) | | |
+| ai | [AISetting](#bytebase-v1-AISetting) | | |
+| environment | [EnvironmentSetting](#bytebase-v1-EnvironmentSetting) | | |
-<a name="bytebase-v1-TaskRunLogEntry-SchemaDump"></a>
+<a name="bytebase-v1-UpdateSettingRequest"></a>
-### TaskRunLogEntry.SchemaDump
-Schema dump operation details.
+### UpdateSettingRequest
+The request message for updating or creating a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump ended. |
-| error | [string](#string) | | Error message if the schema dump failed. |
+| setting | [Setting](#bytebase-v1-Setting) | | The setting to update. |
+| validate_only | [bool](#bool) | | validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true. |
+| allow_missing | [bool](#bool) | | |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | |
-<a name="bytebase-v1-TaskRunLogEntry-TransactionControl"></a>
+<a name="bytebase-v1-WorkspaceApprovalSetting"></a>
+
+### WorkspaceApprovalSetting
-### TaskRunLogEntry.TransactionControl
-Transaction control operation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [TaskRunLogEntry.TransactionControl.Type](#bytebase-v1-TaskRunLogEntry-TransactionControl-Type) | | The type of transaction control. |
-| error | [string](#string) | | Error message if the operation failed. |
+| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |
-<a name="bytebase-v1-TaskRunSession"></a>
+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>
-### TaskRunSession
+### WorkspaceApprovalSetting.Rule
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session |
-| postgres | [TaskRunSession.Postgres](#bytebase-v1-TaskRunSession-Postgres) | | PostgreSQL session information. |
+| template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with the rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+The `source` field filters which rules apply. The `condition` field then evaluates with full context.
+All supported variables: statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values. statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*) When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
+For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100 resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; |
+| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |
-<a name="bytebase-v1-TaskRunSession-Postgres"></a>
-### TaskRunSession.Postgres
-PostgreSQL session information.
+
+
+<a name="bytebase-v1-WorkspaceProfileSetting"></a>
+
+### WorkspaceProfileSetting
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| session | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | | `session` is the session of the task run executing commands. |
-| blocking_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocking_sessions` block `session`. |
-| blocked_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocked_sessions` are blocked by `session`. |
+| external_url | [string](#string) | | The external URL is used for sso authentication callback. |
+| disallow_signup | [bool](#bool) | | Disallow self-service signup, users can only be invited by the owner. |
+| require_2fa | [bool](#bool) | | Require 2FA for all users. |
+| refresh_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for refresh token. Default is 7 days. |
+| access_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for access token. Default is 1 hour. |
+| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
+| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
+| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
+| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
+| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
+| disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |
+| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
+| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. |
+| enable_audit_log_stdout | [bool](#bool) | | Whether to enable audit logging to stdout in structured JSON format. Requires TEAM or ENTERPRISE license. |
+| watermark | [bool](#bool) | | Whether to display watermark on pages. Requires ENTERPRISE license. |
+| directory_sync_token | [string](#string) | | The token for directory sync authentication. |
+| branding_logo | [string](#string) | | The branding logo as a data URI (e.g. data:image/png;base64,...). |
+| password_restriction | [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction) | | Password restriction settings. |
-<a name="bytebase-v1-TaskRunSession-Postgres-Session"></a>
+<a name="bytebase-v1-WorkspaceProfileSetting-PasswordRestriction"></a>
+
+### WorkspaceProfileSetting.PasswordRestriction
-### TaskRunSession.Postgres.Session
-PostgreSQL session information read from `pg_stat_activity`.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| pid | [string](#string) | | Process ID of the session. |
-| blocked_by_pids | [string](#string) | repeated | PIDs of sessions blocking this session. |
-| query | [string](#string) | | Current query being executed. |
-| state | [string](#string) | optional | Session state (active, idle, etc.). |
-| wait_event_type | [string](#string) | optional | Wait event type if session is waiting. |
-| wait_event | [string](#string) | optional | Specific wait event if session is waiting. |
-| datname | [string](#string) | optional | Database name. |
-| usename | [string](#string) | optional | User name. |
-| application_name | [string](#string) | | Application name. |
-| client_addr | [string](#string) | optional | Client IP address. |
-| client_port | [string](#string) | optional | Client port number. |
-| backend_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backend process started. |
-| xact_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current transaction started. |
-| query_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current query started. |
+| min_length | [int32](#int32) | | min_length is the minimum length for password, should no less than 8. |
+| require_number | [bool](#bool) | | require_number requires the password must contains at least one number. |
+| require_letter | [bool](#bool) | | require_letter requires the password must contains at least one letter, regardless of upper case or lower case |
+| require_uppercase_letter | [bool](#bool) | | require_uppercase_letter requires the password must contains at least one upper case letter. |
+| require_special_character | [bool](#bool) | | require_special_character requires the password must contains at least one special character. |
+| require_reset_password_for_first_login | [bool](#bool) | | require_reset_password_for_first_login requires users to reset their password after the 1st login. |
+| password_rotation | [google.protobuf.Duration](#google-protobuf-Duration) | | password_rotation requires users to reset their password after the duration. |
@@ -10017,99 +10005,91 @@ PostgreSQL session information read from `pg_stat_activity`.
-<a name="bytebase-v1-Task-Status"></a>
+<a name="bytebase-v1-AISetting-Provider"></a>
-### Task.Status
+### AISetting.Provider
| Name | Number | Description |
| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| NOT_STARTED | 1 | Task has not started and is awaiting its turn in the deployment sequence. |
-| PENDING | 2 | Task is ready to run and waiting for approval or scheduled time. |
-| RUNNING | 3 | Task is currently executing. |
-| DONE | 4 | Task completed successfully. |
-| FAILED | 5 | Task execution failed with errors. |
-| CANCELED | 6 | Task execution was canceled by a user. |
-| SKIPPED | 7 | Task was skipped and will not be executed. |
+| PROVIDER_UNSPECIFIED | 0 | |
+| OPEN_AI | 1 | |
+| CLAUDE | 2 | |
+| GEMINI | 3 | |
+| AZURE_OPENAI | 4 | |
-<a name="bytebase-v1-Task-Type"></a>
+<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>
-### Task.Type
+### Algorithm.InnerOuterMask.MaskType
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified task type. |
-| GENERAL | 1 | General task for miscellaneous operations. |
-| DATABASE_CREATE | 2 | Database creation task that creates a new database. Use payload DatabaseCreate. |
-| DATABASE_MIGRATE | 3 | Database migration task that applies versioned schema changes. Use payload DatabaseUpdate. |
-| DATABASE_EXPORT | 4 | Database export task that exports query results or table data. Use payload DatabaseDataExport. |
-
+| MASK_TYPE_UNSPECIFIED | 0 | |
+| INNER | 1 | |
+| OUTER | 2 | |
-<a name="bytebase-v1-TaskRun-ExportArchiveStatus"></a>
-### TaskRun.ExportArchiveStatus
+<a name="bytebase-v1-Announcement-AlertLevel"></a>
+### Announcement.AlertLevel
+We support three levels of AlertLevel: INFO, WARNING, and ERROR.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| EXPORT_ARCHIVE_STATUS_UNSPECIFIED | 0 | Unspecified export archive status. |
-| READY | 1 | Export archive is ready for download. |
-| EXPORTED | 2 | Export archive has been downloaded by the user. |
+| ALERT_LEVEL_UNSPECIFIED | 0 | |
+| INFO | 1 | |
+| WARNING | 2 | |
+| CRITICAL | 3 | |
-<a name="bytebase-v1-TaskRun-Status"></a>
+<a name="bytebase-v1-DatabaseChangeMode"></a>
-### TaskRun.Status
+### DatabaseChangeMode
| Name | Number | Description |
| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Task run is queued and waiting to start execution. |
-| RUNNING | 2 | Task run is currently executing. |
-| DONE | 3 | Task run completed successfully. |
-| FAILED | 4 | Task run execution failed with errors. |
-| CANCELED | 5 | Task run execution was canceled by a user. |
-| AVAILABLE | 6 | Task run is ready for immediate execution. |
+| DATABASE_CHANGE_MODE_UNSPECIFIED | 0 | |
+| PIPELINE | 1 | A more advanced database change process, including custom approval workflows and other advanced features. Default to this mode. |
+| EDITOR | 2 | A simple database change process in SQL editor. Users can execute SQL directly. |
-<a name="bytebase-v1-TaskRunLogEntry-TransactionControl-Type"></a>
+<a name="bytebase-v1-Setting-SettingName"></a>
+
+### Setting.SettingName
-### TaskRunLogEntry.TransactionControl.Type
-Transaction control type.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| BEGIN | 1 | Begin transaction. |
-| COMMIT | 2 | Commit transaction. |
-| ROLLBACK | 3 | Rollback transaction. |
+| SETTING_NAME_UNSPECIFIED | 0 | |
+| WORKSPACE_PROFILE | 1 | |
+| WORKSPACE_APPROVAL | 2 | |
+| APP_IM | 3 | |
+| AI | 4 | |
+| DATA_CLASSIFICATION | 5 | |
+| SEMANTIC_TYPES | 6 | |
+| ENVIRONMENT | 7 | |
-<a name="bytebase-v1-TaskRunLogEntry-Type"></a>
+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>
+
+### WorkspaceApprovalSetting.Rule.Source
-### TaskRunLogEntry.Type
-The type of log entry.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| SCHEMA_DUMP | 1 | Schema dump operation. |
-| COMMAND_EXECUTE | 2 | Command execution. |
-| DATABASE_SYNC | 3 | Database synchronization. |
-| TRANSACTION_CONTROL | 5 | Transaction control (BEGIN, COMMIT, ROLLBACK). |
-| PRIOR_BACKUP | 6 | Prior backup operation. |
-| RETRY_INFO | 7 | Retry information. |
-| COMPUTE_DIFF | 8 | Schema diff computation. |
-| RELEASE_FILE_EXECUTE | 9 | Release file execution. |
+| SOURCE_UNSPECIFIED | 0 | |
+| CHANGE_DATABASE | 1 | |
+| CREATE_DATABASE | 2 | |
+| EXPORT_DATA | 3 | |
+| REQUEST_ROLE | 4 | |
@@ -10117,24 +10097,16 @@ The type of log entry.
-<a name="bytebase-v1-RolloutService"></a>
+<a name="bytebase-v1-SettingService"></a>
-### RolloutService
-RolloutService manages the execution of deployment plans.
+### SettingService
+SettingService manages workspace-level settings and configurations.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetRollout | [GetRolloutRequest](#bytebase-v1-GetRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Retrieves a rollout by its plan name. Permissions required: bb.rollouts.get |
-| ListRollouts | [ListRolloutsRequest](#bytebase-v1-ListRolloutsRequest) | [ListRolloutsResponse](#bytebase-v1-ListRolloutsResponse) | Lists rollouts in a project. Permissions required: bb.rollouts.list |
-| CreateRollout | [CreateRolloutRequest](#bytebase-v1-CreateRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Creates a new rollout for a plan. Permissions required: bb.rollouts.create |
-| ListTaskRuns | [ListTaskRunsRequest](#bytebase-v1-ListTaskRunsRequest) | [ListTaskRunsResponse](#bytebase-v1-ListTaskRunsResponse) | Lists task run executions for a task. Permissions required: bb.taskRuns.list |
-| GetTaskRun | [GetTaskRunRequest](#bytebase-v1-GetTaskRunRequest) | [TaskRun](#bytebase-v1-TaskRun) | Retrieves a task run by name. Permissions required: bb.taskRuns.list |
-| GetTaskRunLog | [GetTaskRunLogRequest](#bytebase-v1-GetTaskRunLogRequest) | [TaskRunLog](#bytebase-v1-TaskRunLog) | Retrieves execution logs for a task run. Permissions required: bb.taskRuns.list |
-| GetTaskRunSession | [GetTaskRunSessionRequest](#bytebase-v1-GetTaskRunSessionRequest) | [TaskRunSession](#bytebase-v1-TaskRunSession) | Retrieves database session information for a running task. Permissions required: bb.taskRuns.list |
-| BatchRunTasks | [BatchRunTasksRequest](#bytebase-v1-BatchRunTasksRequest) | [BatchRunTasksResponse](#bytebase-v1-BatchRunTasksResponse) | Executes multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
-| BatchSkipTasks | [BatchSkipTasksRequest](#bytebase-v1-BatchSkipTasksRequest) | [BatchSkipTasksResponse](#bytebase-v1-BatchSkipTasksResponse) | Skips multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
-| BatchCancelTaskRuns | [BatchCancelTaskRunsRequest](#bytebase-v1-BatchCancelTaskRunsRequest) | [BatchCancelTaskRunsResponse](#bytebase-v1-BatchCancelTaskRunsResponse) | Cancels multiple running task executions. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
-| PreviewTaskRunRollback | [PreviewTaskRunRollbackRequest](#bytebase-v1-PreviewTaskRunRollbackRequest) | [PreviewTaskRunRollbackResponse](#bytebase-v1-PreviewTaskRunRollbackResponse) | Generates rollback SQL for a completed task run. Permissions required: bb.taskRuns.list |
+| ListSettings | [ListSettingsRequest](#bytebase-v1-ListSettingsRequest) | [ListSettingsResponse](#bytebase-v1-ListSettingsResponse) | Lists all workspace settings. Permissions required: bb.settings.list |
+| GetSetting | [GetSettingRequest](#bytebase-v1-GetSettingRequest) | [Setting](#bytebase-v1-Setting) | Retrieves a workspace setting by name. Permissions required: bb.settings.get |
+| UpdateSetting | [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest) | [Setting](#bytebase-v1-Setting) | Updates a workspace setting. Permissions required: bb.settings.set |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index c4719dbbe4..77e1358ff7 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -253,134 +253,121 @@
<li>
- <a href="#v1%2fissue_service.proto">v1/issue_service.proto</a>
+ <a href="#v1%2fuser_service.proto">v1/user_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a>
+ <a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a>
+ <a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a>
+ <a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a>
+ <a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a>
+ <a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a>
+ <a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a>
+ <a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GrantRequest"><span class="badge">M</span>GrantRequest</a>
+ <a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</a>
+ <a href="#bytebase.v1.UpdateEmailRequest"><span class="badge">M</span>UpdateEmailRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Approver"><span class="badge">M</span>Issue.Approver</a>
+ <a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a>
+ <a href="#bytebase.v1.User"><span class="badge">M</span>User</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a>
+ <a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a>
+ <a href="#bytebase.v1.WorkloadIdentityConfig"><span class="badge">M</span>WorkloadIdentityConfig</a>
</li>
- <li>
- <a href="#bytebase.v1.IssueComment.PlanSpecUpdate"><span class="badge">M</span>IssueComment.PlanSpecUpdate</a>
- </li>
<li>
- <a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a>
+ <a href="#bytebase.v1.UserType"><span class="badge">E</span>UserType</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a>
+ <a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType"><span class="badge">E</span>WorkloadIdentityConfig.ProviderType</a>
</li>
- <li>
- <a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</a>
- </li>
- <li>
- <a href="#bytebase.v1.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a>
- </li>
<li>
- <a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a>
+ <a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a>
</li>
- <li>
- <a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a>
- </li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2factuator_service.proto">v1/actuator_service.proto</a>
+ <ul>
<li>
- <a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a>
+ <a href="#bytebase.v1.ActuatorInfo"><span class="badge">M</span>ActuatorInfo</a>
</li>
<li>
- <a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a>
+ <a href="#bytebase.v1.ActuatorInfo.StatUser"><span class="badge">M</span>ActuatorInfo.StatUser</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a>
+ <a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a>
+ <a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a>
+ <a href="#bytebase.v1.GetResourcePackageRequest"><span class="badge">M</span>GetResourcePackageRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a>
+ <a href="#bytebase.v1.ResourcePackage"><span class="badge">M</span>ResourcePackage</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a>
+ <a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a>
+ <a href="#bytebase.v1.UpdateActuatorInfoRequest"><span class="badge">M</span>UpdateActuatorInfoRequest</a>
</li>
- <li>
- <a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a>
- </li>
<li>
- <a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a>
+ <a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a>
</li>
</ul>
@@ -388,186 +375,171 @@
<li>
- <a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a>
+ <a href="#v1%2fiam_policy.proto">v1/iam_policy.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a>
+ <a href="#bytebase.v1.Binding"><span class="badge">M</span>Binding</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a>
+ <a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a>
+ <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a>
+ <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a>
+ <a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a>
+ <a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a>
</li>
- <li>
- <a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a>
- </li>
<li>
- <a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a>
+ <a href="#bytebase.v1.BindingDelta.Action"><span class="badge">E</span>BindingDelta.Action</a>
</li>
- <li>
- <a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a>
- </li>
- <li>
- <a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a>
- </li>
- <li>
- <a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a>
- </li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a>
+ <ul>
<li>
- <a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a>
+ <a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a>
+ <a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Teams"><span class="badge">M</span>AppIMSetting.Teams</a>
+ <a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a>
+ <a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a>
+ <a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a>
+ <a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a>
+ <a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a>
</li>
- <li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a>
- </li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a>
+ <a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a>
</li>
- <li>
- <a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a>
- </li>
- <li>
- <a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a>
- </li>
<li>
- <a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a>
+ <a href="#bytebase.v1.AuditLogService"><span class="badge">S</span>AuditLogService</a>
</li>
- <li>
- <a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a>
- </li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fauth_service.proto">v1/auth_service.proto</a>
+ <ul>
<li>
- <a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a>
+ <a href="#bytebase.v1.ExchangeTokenRequest"><span class="badge">M</span>ExchangeTokenRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a>
+ <a href="#bytebase.v1.ExchangeTokenResponse"><span class="badge">M</span>ExchangeTokenResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a>
+ <a href="#bytebase.v1.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
+ <a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a>
+ <a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a>
+ <a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SettingValue"><span class="badge">M</span>SettingValue</a>
+ <a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a>
+ <a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a>
+ <a href="#bytebase.v1.RefreshRequest"><span class="badge">M</span>RefreshRequest</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a>
+ <a href="#bytebase.v1.RefreshResponse"><span class="badge">M</span>RefreshResponse</a>
</li>
- <li>
- <a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a>
- </li>
- <li>
- <a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction"><span class="badge">M</span>WorkspaceProfileSetting.PasswordRestriction</a>
- </li>
<li>
- <a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a>
+ <a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a>
</li>
- <li>
- <a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a>
- </li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fcel_service.proto">v1/cel_service.proto</a>
+ <ul>
<li>
- <a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a>
+ <a href="#bytebase.v1.BatchDeparseRequest"><span class="badge">M</span>BatchDeparseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a>
+ <a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a>
+ <a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a>
+ <a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a>
</li>
+
<li>
- <a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a>
+ <a href="#bytebase.v1.CelService"><span class="badge">S</span>CelService</a>
</li>
</ul>
@@ -575,74 +547,66 @@
<li>
- <a href="#v1%2fuser_service.proto">v1/user_service.proto</a>
+ <a href="#v1%2fdatabase_catalog_service.proto">v1/database_catalog_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a>
+ <a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a>
+ <a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a>
+ <a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a>
+ <a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a>
+ <a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a>
</li>
<li>
- <a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a>
+ <a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a>
+ <a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateEmailRequest"><span class="badge">M</span>UpdateEmailRequest</a>
+ <a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a>
+ <a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.User"><span class="badge">M</span>User</a>
+ <a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a>
+ <a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a>
</li>
<li>
- <a href="#bytebase.v1.WorkloadIdentityConfig"><span class="badge">M</span>WorkloadIdentityConfig</a>
+ <a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UserType"><span class="badge">E</span>UserType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType"><span class="badge">E</span>WorkloadIdentityConfig.ProviderType</a>
+ <a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a>
</li>
<li>
- <a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a>
+ <a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a>
</li>
</ul>
@@ -650,50 +614,50 @@
<li>
- <a href="#v1%2factuator_service.proto">v1/actuator_service.proto</a>
+ <a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.ActuatorInfo"><span class="badge">M</span>ActuatorInfo</a>
+ <a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ActuatorInfo.StatUser"><span class="badge">M</span>ActuatorInfo.StatUser</a>
+ <a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a>
+ <a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a>
</li>
<li>
- <a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a>
+ <a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetResourcePackageRequest"><span class="badge">M</span>GetResourcePackageRequest</a>
+ <a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ResourcePackage"><span class="badge">M</span>ResourcePackage</a>
+ <a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Restriction"><span class="badge">M</span>Restriction</a>
+ <a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a>
+ <a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.UpdateActuatorInfoRequest"><span class="badge">M</span>UpdateActuatorInfoRequest</a>
+ <a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a>
</li>
-
<li>
- <a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a>
+ <a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a>
</li>
</ul>
@@ -701,238 +665,189 @@
<li>
- <a href="#v1%2fiam_policy.proto">v1/iam_policy.proto</a>
+ <a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.Binding"><span class="badge">M</span>Binding</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a>
+ <a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a>
</li>
<li>
- <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>
+ <a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a>
+ <a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a>
</li>
- <li>
- <a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a>
- </li>
- <li>
- <a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a>
- </li>
<li>
- <a href="#bytebase.v1.BindingDelta.Action"><span class="badge">E</span>BindingDelta.Action</a>
+ <a href="#bytebase.v1.InstanceRoleService"><span class="badge">S</span>InstanceRoleService</a>
</li>
-
-
</ul>
</li>
<li>
- <a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a>
+ <a href="#v1%2finstance_service.proto">v1/instance_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a>
+ <a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a>
+ <a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a>
+ <a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a>
+ <a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a>
+ <a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a>
+ <a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a>
+ <a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a>
</li>
-
<li>
- <a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a>
+ <a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.AuditLogService"><span class="badge">S</span>AuditLogService</a>
+ <a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fauth_service.proto">v1/auth_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.ExchangeTokenRequest"><span class="badge">M</span>ExchangeTokenRequest</a>
+ <a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a>
</li>
<li>
- <a href="#bytebase.v1.ExchangeTokenResponse"><span class="badge">M</span>ExchangeTokenResponse</a>
+ <a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a>
</li>
<li>
- <a href="#bytebase.v1.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a>
+ <a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a>
</li>
<li>
- <a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a>
</li>
<li>
- <a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a>
</li>
<li>
- <a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a>
+ <a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a>
+ <a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a>
+ <a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a>
</li>
<li>
- <a href="#bytebase.v1.RefreshRequest"><span class="badge">M</span>RefreshRequest</a>
+ <a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.RefreshResponse"><span class="badge">M</span>RefreshResponse</a>
+ <a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a>
+ <a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fcel_service.proto">v1/cel_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.BatchDeparseRequest"><span class="badge">M</span>BatchDeparseRequest</a>
+ <a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a>
+ <a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a>
+ <a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a>
+ <a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.CelService"><span class="badge">S</span>CelService</a>
+ <a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fdatabase_catalog_service.proto">v1/database_catalog_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a>
+ <a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a>
</li>
<li>
- <a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a>
+ <a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a>
+ <a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a>
+ <a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a>
+ <a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a>
+ <a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a>
</li>
- <li>
- <a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a>
- </li>
<li>
- <a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a>
+ <a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a>
+ <a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a>
</li>
<li>
- <a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a>
</li>
<li>
- <a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a>
</li>
-
<li>
- <a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a>
+ <a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a>
+ <a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a>
</li>
</ul>
@@ -940,420 +855,179 @@
<li>
- <a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a>
+ <a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a>
+ <a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a>
+ <a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a>
+ <a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a>
+ <a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a>
</li>
-
<li>
- <a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a>
+ <a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a>
+ <a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a>
+ <a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a>
+ <a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a>
+ <a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.InstanceRoleService"><span class="badge">S</span>InstanceRoleService</a>
+ <a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2finstance_service.proto">v1/instance_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a>
+ <a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a>
+ <a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a>
+ <a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a>
+ <a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a>
+ <a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a>
</li>
<li>
- <a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a>
+ <a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a>
+ <a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a>
+ <a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a>
+ <a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a>
+ <a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a>
+ <a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a>
+ <a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a>
+ <a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a>
+ <a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a>
+ <a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a>
+ <a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a>
+ <a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a>
+ <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a>
+ <a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a>
+ <a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a>
+ <a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a>
+ <a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a>
+ <a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a>
+ <a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a>
+ <a href="#bytebase.v1.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a>
+ <a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a>
+ <a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a>
+ <a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a>
- </li>
-
-
- <li>
- <a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a>
- </li>
-
-
-
- <li>
- <a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a>
- </li>
-
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a>
- <ul>
-
- <li>
- <a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a>
+ <a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a>
</li>
<li>
@@ -1630,76 +1304,211 @@
<li>
- <a href="#v1%2forg_policy_service.proto">v1/org_policy_service.proto</a>
+ <a href="#v1%2fissue_service.proto">v1/issue_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.CreatePolicyRequest"><span class="badge">M</span>CreatePolicyRequest</a>
+ <a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceQueryPolicy"><span class="badge">M</span>DataSourceQueryPolicy</a>
+ <a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a>
</li>
<li>
- <a href="#bytebase.v1.DeletePolicyRequest"><span class="badge">M</span>DeletePolicyRequest</a>
+ <a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetPolicyRequest"><span class="badge">M</span>GetPolicyRequest</a>
+ <a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListPoliciesRequest"><span class="badge">M</span>ListPoliciesRequest</a>
+ <a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListPoliciesResponse"><span class="badge">M</span>ListPoliciesResponse</a>
+ <a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingExemptionPolicy"><span class="badge">M</span>MaskingExemptionPolicy</a>
+ <a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingExemptionPolicy.Exemption"><span class="badge">M</span>MaskingExemptionPolicy.Exemption</a>
+ <a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingRulePolicy"><span class="badge">M</span>MaskingRulePolicy</a>
+ <a href="#bytebase.v1.GrantRequest"><span class="badge">M</span>GrantRequest</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingRulePolicy.MaskingRule"><span class="badge">M</span>MaskingRulePolicy.MaskingRule</a>
+ <a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</a>
</li>
<li>
- <a href="#bytebase.v1.Policy"><span class="badge">M</span>Policy</a>
+ <a href="#bytebase.v1.Issue.Approver"><span class="badge">M</span>Issue.Approver</a>
</li>
<li>
- <a href="#bytebase.v1.QueryDataPolicy"><span class="badge">M</span>QueryDataPolicy</a>
+ <a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a>
</li>
<li>
- <a href="#bytebase.v1.RolloutPolicy"><span class="badge">M</span>RolloutPolicy</a>
+ <a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a>
</li>
<li>
- <a href="#bytebase.v1.TagPolicy"><span class="badge">M</span>TagPolicy</a>
+ <a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a>
</li>
<li>
- <a href="#bytebase.v1.TagPolicy.TagsEntry"><span class="badge">M</span>TagPolicy.TagsEntry</a>
+ <a href="#bytebase.v1.IssueComment.PlanSpecUpdate"><span class="badge">M</span>IssueComment.PlanSpecUpdate</a>
</li>
<li>
- <a href="#bytebase.v1.UpdatePolicyRequest"><span class="badge">M</span>UpdatePolicyRequest</a>
+ <a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.DataSourceQueryPolicy.Restriction"><span class="badge">E</span>DataSourceQueryPolicy.Restriction</a>
+ <a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2forg_policy_service.proto">v1/org_policy_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.CreatePolicyRequest"><span class="badge">M</span>CreatePolicyRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.DataSourceQueryPolicy"><span class="badge">M</span>DataSourceQueryPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.DeletePolicyRequest"><span class="badge">M</span>DeletePolicyRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.GetPolicyRequest"><span class="badge">M</span>GetPolicyRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListPoliciesRequest"><span class="badge">M</span>ListPoliciesRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListPoliciesResponse"><span class="badge">M</span>ListPoliciesResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingExemptionPolicy"><span class="badge">M</span>MaskingExemptionPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingExemptionPolicy.Exemption"><span class="badge">M</span>MaskingExemptionPolicy.Exemption</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingRulePolicy"><span class="badge">M</span>MaskingRulePolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingRulePolicy.MaskingRule"><span class="badge">M</span>MaskingRulePolicy.MaskingRule</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Policy"><span class="badge">M</span>Policy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.QueryDataPolicy"><span class="badge">M</span>QueryDataPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.RolloutPolicy"><span class="badge">M</span>RolloutPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TagPolicy"><span class="badge">M</span>TagPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TagPolicy.TagsEntry"><span class="badge">M</span>TagPolicy.TagsEntry</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdatePolicyRequest"><span class="badge">M</span>UpdatePolicyRequest</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.DataSourceQueryPolicy.Restriction"><span class="badge">E</span>DataSourceQueryPolicy.Restriction</a>
</li>
<li>
@@ -2557,158 +2366,345 @@
<li>
- <a href="#v1%2fsheet_service.proto">v1/sheet_service.proto</a>
+ <a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.BatchCreateSheetsRequest"><span class="badge">M</span>BatchCreateSheetsRequest</a>
+ <a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a>
</li>
<li>
- <a href="#bytebase.v1.BatchCreateSheetsResponse"><span class="badge">M</span>BatchCreateSheetsResponse</a>
+ <a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a>
</li>
<li>
- <a href="#bytebase.v1.CreateSheetRequest"><span class="badge">M</span>CreateSheetRequest</a>
+ <a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a>
</li>
<li>
- <a href="#bytebase.v1.GetSheetRequest"><span class="badge">M</span>GetSheetRequest</a>
+ <a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a>
</li>
<li>
- <a href="#bytebase.v1.Sheet"><span class="badge">M</span>Sheet</a>
+ <a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a>
</li>
+ <li>
+ <a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a>
+ </li>
-
+ <li>
+ <a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a>
+ </li>
<li>
- <a href="#bytebase.v1.SheetService"><span class="badge">S</span>SheetService</a>
+ <a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fsubscription_service.proto">v1/subscription_service.proto</a>
- <ul>
+ <li>
+ <a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a>
+ </li>
<li>
- <a href="#bytebase.v1.GetSubscriptionRequest"><span class="badge">M</span>GetSubscriptionRequest</a>
+ <a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a>
</li>
<li>
- <a href="#bytebase.v1.PlanConfig"><span class="badge">M</span>PlanConfig</a>
+ <a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a>
</li>
<li>
- <a href="#bytebase.v1.PlanLimitConfig"><span class="badge">M</span>PlanLimitConfig</a>
+ <a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a>
</li>
<li>
- <a href="#bytebase.v1.Subscription"><span class="badge">M</span>Subscription</a>
+ <a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateSubscriptionRequest"><span class="badge">M</span>UpdateSubscriptionRequest</a>
+ <a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a>
</li>
+ <li>
+ <a href="#bytebase.v1.AppIMSetting.Teams"><span class="badge">M</span>AppIMSetting.Teams</a>
+ </li>
<li>
- <a href="#bytebase.v1.PlanFeature"><span class="badge">E</span>PlanFeature</a>
+ <a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a>
</li>
<li>
- <a href="#bytebase.v1.PlanType"><span class="badge">E</span>PlanType</a>
+ <a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a>
</li>
+ <li>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a>
+ </li>
<li>
- <a href="#bytebase.v1.SubscriptionService"><span class="badge">S</span>SubscriptionService</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fworksheet_service.proto">v1/worksheet_service.proto</a>
- <ul>
+ <li>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a>
+ </li>
<li>
- <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest"><span class="badge">M</span>BatchUpdateWorksheetOrganizerRequest</a>
+ <a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse"><span class="badge">M</span>BatchUpdateWorksheetOrganizerResponse</a>
+ <a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a>
</li>
<li>
- <a href="#bytebase.v1.CreateWorksheetRequest"><span class="badge">M</span>CreateWorksheetRequest</a>
+ <a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteWorksheetRequest"><span class="badge">M</span>DeleteWorksheetRequest</a>
+ <a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a>
+ <a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a>
</li>
<li>
- <a href="#bytebase.v1.SearchWorksheetsRequest"><span class="badge">M</span>SearchWorksheetsRequest</a>
+ <a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SearchWorksheetsResponse"><span class="badge">M</span>SearchWorksheetsResponse</a>
+ <a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateWorksheetOrganizerRequest"><span class="badge">M</span>UpdateWorksheetOrganizerRequest</a>
+ <a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateWorksheetRequest"><span class="badge">M</span>UpdateWorksheetRequest</a>
+ <a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a>
</li>
<li>
- <a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a>
+ <a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a>
</li>
<li>
- <a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a>
+ <a href="#bytebase.v1.SettingValue"><span class="badge">M</span>SettingValue</a>
</li>
+ <li>
+ <a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a>
+ </li>
<li>
- <a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a>
</li>
+ <li>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a>
+ </li>
<li>
- <a href="#bytebase.v1.WorksheetService"><span class="badge">S</span>WorksheetService</a>
+ <a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction"><span class="badge">M</span>WorkspaceProfileSetting.PasswordRestriction</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fworkspace_service.proto">v1/workspace_service.proto</a>
- <ul>
+ <li>
+ <a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a>
+ </li>
<li>
- <a href="#bytebase.v1.WorkspaceService"><span class="badge">S</span>WorkspaceService</a>
+ <a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a>
</li>
- </ul>
+ <li>
+ <a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fsheet_service.proto">v1/sheet_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.BatchCreateSheetsRequest"><span class="badge">M</span>BatchCreateSheetsRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.BatchCreateSheetsResponse"><span class="badge">M</span>BatchCreateSheetsResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.CreateSheetRequest"><span class="badge">M</span>CreateSheetRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.GetSheetRequest"><span class="badge">M</span>GetSheetRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Sheet"><span class="badge">M</span>Sheet</a>
+ </li>
+
+
+
+
+ <li>
+ <a href="#bytebase.v1.SheetService"><span class="badge">S</span>SheetService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fsubscription_service.proto">v1/subscription_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.GetSubscriptionRequest"><span class="badge">M</span>GetSubscriptionRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.PlanConfig"><span class="badge">M</span>PlanConfig</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.PlanLimitConfig"><span class="badge">M</span>PlanLimitConfig</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Subscription"><span class="badge">M</span>Subscription</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateSubscriptionRequest"><span class="badge">M</span>UpdateSubscriptionRequest</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.PlanFeature"><span class="badge">E</span>PlanFeature</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.PlanType"><span class="badge">E</span>PlanType</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.SubscriptionService"><span class="badge">S</span>SubscriptionService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fworksheet_service.proto">v1/worksheet_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest"><span class="badge">M</span>BatchUpdateWorksheetOrganizerRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse"><span class="badge">M</span>BatchUpdateWorksheetOrganizerResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.CreateWorksheetRequest"><span class="badge">M</span>CreateWorksheetRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.DeleteWorksheetRequest"><span class="badge">M</span>DeleteWorksheetRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SearchWorksheetsRequest"><span class="badge">M</span>SearchWorksheetsRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SearchWorksheetsResponse"><span class="badge">M</span>SearchWorksheetsResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateWorksheetOrganizerRequest"><span class="badge">M</span>UpdateWorksheetOrganizerRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateWorksheetRequest"><span class="badge">M</span>UpdateWorksheetRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.WorksheetService"><span class="badge">S</span>WorksheetService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fworkspace_service.proto">v1/workspace_service.proto</a>
+ <ul>
+
+
+
+
+ <li>
+ <a href="#bytebase.v1.WorkspaceService"><span class="badge">S</span>WorkspaceService</a>
+ </li>
+
+ </ul>
</li>
<li><a href="#scalar-value-types">Scalar Value Types</a></li>
@@ -3299,12 +3295,12 @@ Examples:
<div class="file-heading">
- <h2 id="v1/issue_service.proto">v1/issue_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/user_service.proto">v1/user_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.ApprovalFlow">ApprovalFlow</h3>
+ <h3 id="bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</h3>
<p></p>
@@ -3315,10 +3311,11 @@ Examples:
<tbody>
<tr>
- <td>roles</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The roles required for approval in order. </p></td>
+ <td><p>The user names to retrieve.
+Format: users/{email} </p></td>
</tr>
</tbody>
@@ -3328,7 +3325,7 @@ Examples:
- <h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3>
+ <h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</h3>
<p></p>
@@ -3339,24 +3336,10 @@ Examples:
<tbody>
<tr>
- <td>flow</td>
- <td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td>
- <td></td>
- <td><p>The approval flow definition. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The title of the approval template. </p></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The description of the approval template. </p></td>
+ <td>users</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td>repeated</td>
+ <td><p>The users from the specified request. </p></td>
</tr>
</tbody>
@@ -3366,7 +3349,7 @@ Examples:
- <h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</h3>
+ <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</h3>
<p></p>
@@ -3377,18 +3360,10 @@ Examples:
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the issue to add an approver.
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p>The comment explaining the approval decision. </p></td>
+ <td><p>The user to create. </p></td>
</tr>
</tbody>
@@ -3398,7 +3373,7 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</h3>
+ <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3>
<p></p>
@@ -3409,35 +3384,11 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource shared by all issues being updated.
-Format: projects/{project}
-If the operation spans parents, a dash (-) may be accepted as a wildcard.
-We only support updating the status of databases for now. </p></td>
- </tr>
-
- <tr>
- <td>issues</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of issues to update.
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td></td>
- <td><p>The new status. </p></td>
- </tr>
-
- <tr>
- <td>reason</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The reason for the status change. </p></td>
+ <td><p>The name of the user to delete.
+Format: users/{email} </p></td>
</tr>
</tbody>
@@ -3447,14 +3398,32 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3>
+ <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3>
<p></p>
-
-
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the user to retrieve.
+Format: users/{email} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3>
+ <h3 id="bytebase.v1.ListUsersRequest">ListUsersRequest</h3>
<p></p>
@@ -3465,18 +3434,60 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of users to return. The service may return fewer than
+this value.
+If unspecified, at most 10 users will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The issue name
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>A page token, received from a previous `ListUsers` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListUsers` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>issue_comment</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment to create. </p></td>
+ <td><p>Show deleted users if specified. </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter users returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- state: check State enum for values, support &#34;==&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+
+For example:
+name == &#34;ed&#34;
+name.matches(&#34;ed&#34;)
+email == &#34;[email protected]&#34;
+email.matches(&#34;ed&#34;)
+user_type == &#34;SERVICE_ACCOUNT&#34;
+user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]
+!(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;])
+state == &#34;DELETED&#34;
+project == &#34;projects/sample-project&#34;
+You can combine filter conditions like:
+name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34;
+(name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; </p></td>
</tr>
</tbody>
@@ -3486,7 +3497,7 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3>
+ <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3>
<p></p>
@@ -3497,18 +3508,43 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>users</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td>repeated</td>
+ <td><p>The users from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of issues.
-Format: projects/{project} </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>issue</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The issue to create. </p></td>
+ <td><p>The name of the deleted user.
+Format: users/{email} </p></td>
</tr>
</tbody>
@@ -3518,7 +3554,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.GetIssueRequest">GetIssueRequest</h3>
+ <h3 id="bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</h3>
<p></p>
@@ -3532,15 +3568,16 @@ Format: projects/{project} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue to retrieve.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The name of the user whose email to update.
+Format: users/{email}
+Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. </p></td>
</tr>
<tr>
- <td>force</td>
- <td><a href="#bool">bool</a></td>
+ <td>email</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, bypass cache and fetch the latest data. </p></td>
+ <td><p>The new email address. </p></td>
</tr>
</tbody>
@@ -3550,7 +3587,7 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.GrantRequest">GrantRequest</h3>
+ <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</h3>
<p></p>
@@ -3561,33 +3598,50 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>role</td>
- <td><a href="#string">string</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p>The requested role.
-Format: roles/EXPORTER. </p></td>
+ <td><p>The user to update.
+
+The user&#39;s `name` field is used to identify the user to update.
+Format: users/{email} </p></td>
</tr>
<tr>
- <td>user</td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>otp_code</td>
<td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
+ </tr>
+
+ <tr>
+ <td>regenerate_temp_mfa_secret</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The user to be granted.
-Format: users/{email}. </p></td>
+ <td><p>The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user.
+This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. </p></td>
</tr>
<tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>regenerate_recovery_codes</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td>
+ <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>
</tr>
<tr>
- <td>expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The duration for which the grant is valid. </p></td>
+ <td><p>If set to true, and the user is not found, a new user will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -3597,7 +3651,7 @@ Format: users/{email}. </p></td>
- <h3 id="bytebase.v1.Issue">Issue</h3>
+ <h3 id="bytebase.v1.User">User</h3>
<p></p>
@@ -3611,139 +3665,108 @@ Format: users/{email}. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The name of the user.
+Format: users/{email} </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>The title of the issue. </p></td>
+ <td><p>The lifecycle state of the user account. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the issue. </p></td>
+ <td><p>The email address of the user, used for login and notifications. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The display title or full name of the user. </p></td>
</tr>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td>user_type</td>
+ <td><a href="#bytebase.v1.UserType">UserType</a></td>
<td></td>
- <td><p>The status of the issue. </p></td>
- </tr>
-
- <tr>
- <td>approvers</td>
- <td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td><p>The type of user account. </p></td>
</tr>
<tr>
- <td>approval_template</td>
- <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The approval template for the issue. </p></td>
+ <td><p>The password for authentication. Only used during user creation or password updates. </p></td>
</tr>
<tr>
- <td>creator</td>
+ <td>service_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/[email protected] </p></td>
+ <td><p>The service key for service account authentication. Only used for service accounts. </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>mfa_enabled</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td>
</tr>
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>temp_otp_secret</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td>
</tr>
<tr>
- <td>plan</td>
+ <td>temp_recovery_codes</td>
<td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td>
+ </tr>
+
+ <tr>
+ <td>temp_otp_secret_created_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The plan associated with the issue.
-Can be empty.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td>
</tr>
<tr>
- <td>grant_request</td>
- <td><a href="#bytebase.v1.GrantRequest">GrantRequest</a></td>
+ <td>phone</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Used if the issue type is GRANT_REQUEST. </p></td>
+ <td><p>Should be a valid E.164 compliant phone number.
+Could be empty. </p></td>
</tr>
<tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td>profile</td>
+ <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td>
<td></td>
- <td><p>The risk level of the issue. </p></td>
+ <td><p>User profile metadata. </p></td>
</tr>
<tr>
- <td>labels</td>
+ <td>groups</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>Labels attached to the issue for categorization and filtering. </p></td>
- </tr>
-
- <tr>
- <td>approval_status</td>
- <td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>
- <p>Approvers and their approval status for the issue.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</a></td>
- <td></td>
- <td><p>The new status. </p></td>
+ <td><p>The groups for the user.
+Format: groups/{email} </p></td>
</tr>
<tr>
- <td>principal</td>
- <td><a href="#string">string</a></td>
+ <td>workload_identity_config</td>
+ <td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td>
<td></td>
- <td><p>Format: users/[email protected] </p></td>
+ <td><p>Workload Identity configuration (only for WORKLOAD_IDENTITY type) </p></td>
</tr>
</tbody>
@@ -3753,8 +3776,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment">IssueComment</h3>
- <p>A comment on an issue.</p>
+ <h3 id="bytebase.v1.User.Profile">User.Profile</h3>
+ <p></p>
<table class="field-table">
@@ -3764,66 +3787,24 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The text content of the comment. </p></td>
- </tr>
-
- <tr>
- <td>payload</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>TODO: use struct message instead. </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
+ <td>last_login_time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The last time the user successfully logged in. </p></td>
</tr>
<tr>
- <td>update_time</td>
+ <td>last_change_password_time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The last time the user changed their password. </p></td>
</tr>
<tr>
- <td>creator</td>
+ <td>source</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/{email} </p></td>
- </tr>
-
- <tr>
- <td>approval</td>
- <td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td>
- <td></td>
- <td><p>Approval event. </p></td>
- </tr>
-
- <tr>
- <td>issue_update</td>
- <td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td>
- <td></td>
- <td><p>Issue update event. </p></td>
- </tr>
-
- <tr>
- <td>plan_spec_update</td>
- <td><a href="#bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</a></td>
- <td></td>
- <td><p>Plan spec update event. </p></td>
+ <td><p>source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td>
</tr>
</tbody>
@@ -3833,8 +3814,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>
- <p>Approval event information.</p>
+ <h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3>
+ <p>WorkloadIdentityConfig for API layer</p>
<table class="field-table">
@@ -3844,83 +3825,31 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td>
+ <td>provider_type</td>
+ <td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td>
<td></td>
- <td><p>The approval status. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>
- <p>Issue update event information.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>from_title</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>to_title</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>from_description</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td><p>Platform type (currently only GITHUB is supported) </p></td>
</tr>
<tr>
- <td>to_description</td>
+ <td>issuer_url</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>from_status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>to_status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td>
</tr>
<tr>
- <td>from_labels</td>
+ <td>allowed_audiences</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>Allowed audiences for token validation </p></td>
</tr>
<tr>
- <td>to_labels</td>
+ <td>subject_pattern</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) </p></td>
</tr>
</tbody>
@@ -3930,202 +3859,288 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</h3>
- <p>Plan spec update event information (tracks sheet changes to plan specs).</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>spec</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The spec that was updated.
-Format: projects/{project}/plans/{plan}/specs/{spec} </p></td>
- </tr>
-
- <tr>
- <td>from_sheet</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The previous sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
-
- <tr>
- <td>to_sheet</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The new sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h3 id="bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</h3>
+ <h3 id="bytebase.v1.UserType">UserType</h3>
<p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>USER_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified user type.</p></td>
+ </tr>
+
+ <tr>
+ <td>USER</td>
+ <td>1</td>
+ <td><p>Regular human user account.</p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_BOT</td>
+ <td>2</td>
+ <td><p>System-managed bot account for automated operations.</p></td>
+ </tr>
+
+ <tr>
+ <td>SERVICE_ACCOUNT</td>
+ <td>3</td>
+ <td><p>Service account for API integrations.</p></td>
+ </tr>
+
+ <tr>
+ <td>WORKLOAD_IDENTITY</td>
+ <td>4</td>
+ <td><p>External CI/CD workload identity.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3>
+ <p>ProviderType identifies the CI/CD platform.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>PROVIDER_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>GITHUB</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>GITLAB</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{projects}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of issue comments to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issue comments will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A page token, received from a previous `ListIssueComments` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListIssueComments` must match
-the call that provided the page token. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+
-
- <h3 id="bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.UserService">UserService</h3>
+ <p>UserService manages user accounts and authentication.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetUser</td>
+ <td><a href="#bytebase.v1.GetUserRequest">GetUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Get the user.
+Any authenticated user can get the user.
+Permissions required: bb.users.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchGetUsers</td>
+ <td><a href="#bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</a></td>
+ <td><p>Get the users in batch.
+Any authenticated user can batch get users.
+Permissions required: bb.users.get</p></td>
+ </tr>
+
+ <tr>
+ <td>GetCurrentUser</td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Get the current authenticated user.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>ListUsers</td>
+ <td><a href="#bytebase.v1.ListUsersRequest">ListUsersRequest</a></td>
+ <td><a href="#bytebase.v1.ListUsersResponse">ListUsersResponse</a></td>
+ <td><p>List all users.
+Any authenticated user can list users.
+Permissions required: bb.users.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateUser</td>
+ <td><a href="#bytebase.v1.CreateUserRequest">CreateUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.
+Permissions required: bb.users.create (only when Disallow Signup is enabled)</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateUser</td>
+ <td><a href="#bytebase.v1.UpdateUserRequest">UpdateUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
+Note: Email updates are not supported through this API. Use UpdateEmail instead.
+Permissions required: bb.users.update (or self)</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteUser</td>
+ <td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
+Permissions required: bb.users.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>UndeleteUser</td>
+ <td><a href="#bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Restores a deleted user.
+Permissions required: bb.users.undelete</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateEmail</td>
+ <td><a href="#bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Updates a user&#39;s email address.
+Permissions required: bb.users.updateEmail</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>issue_comments</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td>repeated</td>
- <td><p>The issue comments from the specified request. </p></td>
- </tr>
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
- </tr>
+ <tr>
+ <td>GetUser</td>
+ <td>GET</td>
+ <td>/v1/{name=users/*}</td>
+ <td></td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListIssuesRequest">ListIssuesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent, which owns this collection of issues.
-Format: projects/{project} </p></td>
- </tr>
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of issues to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issues will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
+ <tr>
+ <td>BatchGetUsers</td>
+ <td>GET</td>
+ <td>/v1/users:batchGet</td>
+ <td></td>
+ </tr>
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A page token, received from a previous `ListIssues` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListIssues` must match
-the call that provided the page token. </p></td>
- </tr>
+
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter issues returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
-- status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values.
-- create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-- type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values.
-- labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator.
-- approval_status: issue approval status, support &#34;==&#34; operator.
-- current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
-
-For example:
-creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;]
-status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34;
-labels in [&#34;label1&#34;, &#34;label2&#34;]
-create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
- </tr>
- <tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Query is the query statement. </p></td>
- </tr>
+ <tr>
+ <td>GetCurrentUser</td>
+ <td>GET</td>
+ <td>/v1/users/me</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListUsers</td>
+ <td>GET</td>
+ <td>/v1/users</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateUser</td>
+ <td>POST</td>
+ <td>/v1/users</td>
+ <td>user</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateUser</td>
+ <td>PATCH</td>
+ <td>/v1/{user.name=users/*}</td>
+ <td>user</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteUser</td>
+ <td>DELETE</td>
+ <td>/v1/{name=users/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UndeleteUser</td>
+ <td>POST</td>
+ <td>/v1/{name=users/*}:undelete</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateEmail</td>
+ <td>POST</td>
+ <td>/v1/{name=users/*}:updateEmail</td>
+ <td>*</td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3>
- <p></p>
+ <div class="file-heading">
+ <h2 id="v1/actuator_service.proto">v1/actuator_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.ActuatorInfo">ActuatorInfo</h3>
+ <p>System information and configuration for the Bytebase instance.</p><p>Actuator concept is similar to the Spring Boot Actuator.</p>
<table class="field-table">
@@ -4135,187 +4150,147 @@ create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
<tbody>
<tr>
- <td>issues</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td>repeated</td>
- <td><p>The issues from the specified request. </p></td>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The Bytebase server version. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>git_commit</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>The git commit hash of the build. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>readonly</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name of the issue to add a rejection.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>Whether the Bytebase instance is running in read-only mode. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>saas</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment explaining the rejection decision. </p></td>
+ <td><p>Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RequestIssueRequest">RequestIssueRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>demo</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether the Bytebase instance is running in demo mode. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue to request a issue.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The host address of the Bytebase instance. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment explaining the request. </p></td>
+ <td><p>The port number of the Bytebase instance. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>parent</td>
+ <td>external_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of issues.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list all issues from all projects. </p></td>
+ <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>need_admin_setup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The maximum number of issues to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issues will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>last_active_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchIssues` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchIssues` must match
-the call that provided the page token. </p></td>
+ <td><p>The last time any API call was made, refreshed on each request. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>workspace_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter issues returned in the list.
-Check the filter field in the ListIssuesRequest message. </p></td>
+ <td><p>The unique identifier for the workspace. </p></td>
</tr>
<tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
+ <td>debug</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Query is the query statement. </p></td>
+ <td><p>Whether debug mode is enabled. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>issues</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>unlicensed_features</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The issues from the specified request. </p></td>
+ <td><p>List of features that are not licensed. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>docker</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>Whether the Bytebase instance is running in Docker. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
+ <tr>
+ <td>user_stats</td>
+ <td><a href="#bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</a></td>
+ <td>repeated</td>
+ <td><p>Statistics about users in the system. </p></td>
+ </tr>
+
+ <tr>
+ <td>activated_instance_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The number of activated database instances. </p></td>
+ </tr>
+
+ <tr>
+ <td>total_instance_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The total number of database instances. </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_sample</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether sample data setup is enabled. </p></td>
+ </tr>
+
+ <tr>
+ <td>external_url_from_flag</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>
+ <p>User statistics by type and state.</p>
<table class="field-table">
@@ -4325,33 +4300,69 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>user_type</td>
+ <td><a href="#bytebase.v1.UserType">UserType</a></td>
<td></td>
- <td><p>The issue name
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The type of user. </p></td>
</tr>
<tr>
- <td>issue_comment</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>The comment to update. </p></td>
+ <td><p>The state of the user. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The count of users matching this type and state. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3>
+ <p>Request message for deleting cache.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</h3>
+ <p>Request message for getting actuator information.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</h3>
+ <p>Request message for getting branding resources.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ResourcePackage">ResourcePackage</h3>
+ <p>Custom branding resources for the Bytebase instance.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>logo</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>If set to true, and the issue comment is not found, a new issue comment will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The branding logo. </p></td>
</tr>
</tbody>
@@ -4361,8 +4372,15 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>
+ <p>Request message for setting up sample data.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</h3>
+ <p>Request message for updating actuator information.</p>
<table class="field-table">
@@ -4372,13 +4390,10 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>issue</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>actuator</td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
<td></td>
- <td><p>The issue to update.
-
-The issue&#39;s `name` field is used to identify the issue to update.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The actuator to update. </p></td>
</tr>
<tr>
@@ -4392,7 +4407,7 @@ Format: projects/{project}/issues/{issue} </p></td>
<td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the issue is not found, a new issue will be created.
+ <td><p>If set to true, and the actuator is not found, a new actuator will be created.
In this situation, `update_mask` is ignored. </p></td>
</tr>
@@ -4405,453 +4420,202 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3>
- <p>The overall approval status for the issue.</p>
+
+
+
+
+ <h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>
+ <p>ActuatorService manages system health and operational information.</p>
<table class="enum-table">
<thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>APPROVAL_STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified approval status.</p></td>
- </tr>
-
- <tr>
- <td>CHECKING</td>
- <td>1</td>
- <td><p>Approval checks are being evaluated.</p></td>
+ <td>GetActuatorInfo</td>
+ <td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td><p>Gets system information and health status of the Bytebase instance.
+Permissions required: None</p></td>
</tr>
<tr>
- <td>PENDING</td>
- <td>2</td>
- <td><p>Approval is pending.</p></td>
+ <td>UpdateActuatorInfo</td>
+ <td><a href="#bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</a></td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td><p>Updates system configuration settings for the Bytebase instance.
+Permissions required: bb.settings.set</p></td>
</tr>
<tr>
- <td>APPROVED</td>
- <td>3</td>
- <td><p>Issue has been approved.</p></td>
+ <td>SetupSample</td>
+ <td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Sets up sample data for demonstration and testing purposes.
+Permissions required: bb.projects.create</p></td>
</tr>
<tr>
- <td>REJECTED</td>
- <td>4</td>
- <td><p>Issue has been rejected.</p></td>
+ <td>DeleteCache</td>
+ <td><a href="#bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Clears the system cache to force data refresh.
+Permissions required: None</p></td>
</tr>
<tr>
- <td>SKIPPED</td>
- <td>5</td>
- <td><p>Approval was skipped.</p></td>
+ <td>GetResourcePackage</td>
+ <td><a href="#bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</a></td>
+ <td><a href="#bytebase.v1.ResourcePackage">ResourcePackage</a></td>
+ <td><p>Gets custom branding resources such as logos.
+Permissions required: None</p></td>
</tr>
</tbody>
</table>
-
- <h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3>
- <p>The approval status of an approver.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p>Awaiting approval.</p></td>
+ <td>GetActuatorInfo</td>
+ <td>GET</td>
+ <td>/v1/actuator/info</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>APPROVED</td>
- <td>2</td>
- <td><p>Approved.</p></td>
+ <td>UpdateActuatorInfo</td>
+ <td>PATCH</td>
+ <td>/v1/actuator/info</td>
+ <td>actuator</td>
</tr>
+
+
+
<tr>
- <td>REJECTED</td>
- <td>3</td>
- <td><p>Rejected.</p></td>
+ <td>SetupSample</td>
+ <td>POST</td>
+ <td>/v1/actuator:setupSample</td>
+ <td></td>
</tr>
+
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Issue.Type">Issue.Type</h3>
- <p>The type of issue.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
+
+
<tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified issue type.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_CHANGE</td>
- <td>1</td>
- <td><p>Database schema or data change.</p></td>
- </tr>
-
- <tr>
- <td>GRANT_REQUEST</td>
- <td>2</td>
- <td><p>Database access grant request.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_EXPORT</td>
- <td>3</td>
- <td><p>Database data export request.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</h3>
- <p>Approval status values.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p>Approval pending.</p></td>
- </tr>
-
- <tr>
- <td>APPROVED</td>
- <td>2</td>
- <td><p>Approved.</p></td>
- </tr>
-
- <tr>
- <td>REJECTED</td>
- <td>3</td>
- <td><p>Rejected.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.IssueStatus">IssueStatus</h3>
- <p>The status of an issue.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ISSUE_STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>OPEN</td>
- <td>1</td>
- <td><p>Issue is open and active.</p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>2</td>
- <td><p>Issue is completed.</p></td>
+ <td>DeleteCache</td>
+ <td>DELETE</td>
+ <td>/v1/actuator/cache</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>CANCELED</td>
- <td>3</td>
- <td><p>Issue is canceled.</p></td>
+ <td>GetResourcePackage</td>
+ <td>GET</td>
+ <td>/v1/actuator/resources</td>
+ <td></td>
</tr>
+
- </tbody>
- </table>
-
-
+ </tbody>
+ </table>
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/iam_policy.proto">v1/iam_policy.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
- <h3 id="bytebase.v1.IssueService">IssueService</h3>
- <p>IssueService manages issues for tracking database changes and tasks.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetIssue</td>
- <td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Retrieves an issue by name.
-Permissions required: bb.issues.get</p></td>
- </tr>
-
- <tr>
- <td>CreateIssue</td>
- <td><a href="#bytebase.v1.CreateIssueRequest">CreateIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Creates a new issue for database changes or tasks.
-Permissions required: bb.issues.create</p></td>
- </tr>
-
- <tr>
- <td>ListIssues</td>
- <td><a href="#bytebase.v1.ListIssuesRequest">ListIssuesRequest</a></td>
- <td><a href="#bytebase.v1.ListIssuesResponse">ListIssuesResponse</a></td>
- <td><p>Lists issues in a project.
-Permissions required: bb.issues.list</p></td>
- </tr>
-
- <tr>
- <td>SearchIssues</td>
- <td><a href="#bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</a></td>
- <td><a href="#bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</a></td>
- <td><p>Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query.
-Permissions required: bb.issues.get</p></td>
- </tr>
-
- <tr>
- <td>UpdateIssue</td>
- <td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Updates an issue&#39;s properties such as title, description, or labels.
-Permissions required: bb.issues.update</p></td>
- </tr>
-
- <tr>
- <td>ListIssueComments</td>
- <td><a href="#bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</a></td>
- <td><a href="#bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</a></td>
- <td><p>Lists comments on an issue.
-Permissions required: bb.issueComments.list</p></td>
- </tr>
-
- <tr>
- <td>CreateIssueComment</td>
- <td><a href="#bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</a></td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td><p>Adds a comment to an issue.
-Permissions required: bb.issueComments.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateIssueComment</td>
- <td><a href="#bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</a></td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td><p>Updates an existing issue comment.
-Permissions required: bb.issueComments.update</p></td>
- </tr>
-
- <tr>
- <td>BatchUpdateIssuesStatus</td>
- <td><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</a></td>
- <td><p>Updates the status of multiple issues in a single operation.
-Permissions required: bb.issues.update</p></td>
- </tr>
-
- <tr>
- <td>ApproveIssue</td>
- <td><a href="#bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
-Permissions required: None (determined by approval flow)</p></td>
- </tr>
-
- <tr>
- <td>RejectIssue</td>
- <td><a href="#bytebase.v1.RejectIssueRequest">RejectIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
-Permissions required: None (determined by approval flow)</p></td>
- </tr>
-
- <tr>
- <td>RequestIssue</td>
- <td><a href="#bytebase.v1.RequestIssueRequest">RequestIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
-Permissions required: None (determined by approval flow)</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.Binding">Binding</h3>
+ <p>Binding associates members with a role and optional conditions.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
-
- <tr>
- <td>GetIssue</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/issues/*}</td>
- <td></td>
- </tr>
-
+ <tr>
+ <td>role</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The role that is assigned to the members.
+Format: roles/{role} </p></td>
+ </tr>
+ <tr>
+ <td>members</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Specifies the principals requesting access for a Bytebase resource.
+For users, the member should be: user:{email}
+For groups, the member should be: group:{email} </p></td>
+ </tr>
- <tr>
- <td>CreateIssue</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues</td>
- <td>issue</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListIssues</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/issues</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>SearchIssues</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues:search</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateIssue</td>
- <td>PATCH</td>
- <td>/v1/{issue.name=projects/*/issues/*}</td>
- <td>issue</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListIssueComments</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*/issues/*}/issueComments</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateIssueComment</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/issues/*}:comment</td>
- <td>issue_comment</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateIssueComment</td>
- <td>PATCH</td>
- <td>/v1/{parent=projects/*/issues/*}:comment</td>
- <td>issue_comment</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchUpdateIssuesStatus</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ApproveIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:approve</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>RejectIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:reject</td>
- <td>*</td>
- </tr>
-
-
-
+ <tr>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td></td>
+ <td><p>The condition that is associated with this binding, only used in the project IAM policy.
+If the condition evaluates to true, then this binding applies to the current request.
+If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Support variables:
+resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
+resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
+resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
+request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
+
+For example:
+resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;]
+resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;]
+request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
+ </tr>
- <tr>
- <td>RequestIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:request</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>parsed_expr</td>
+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td></td>
+ <td><p>The parsed expression of the condition. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/setting_service.proto">v1/setting_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.AISetting">AISetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.BindingDelta">BindingDelta</h3>
+ <p>A single change to a binding.</p>
<table class="field-table">
@@ -4861,45 +4625,32 @@ Permissions required: None (determined by approval flow)</p></td>
<tbody>
<tr>
- <td>enabled</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>provider</td>
- <td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>endpoint</td>
- <td><a href="#string">string</a></td>
+ <td>action</td>
+ <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The action that was performed on a Binding. </p></td>
</tr>
<tr>
- <td>api_key</td>
+ <td>role</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Role that is assigned to `members`.
+For example, `roles/projectOwner`. </p></td>
</tr>
<tr>
- <td>model</td>
+ <td>member</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Follows the same format of Binding.members. </p></td>
</tr>
<tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The condition that is associated with this binding. </p></td>
</tr>
</tbody>
@@ -4909,8 +4660,8 @@ Permissions required: None (determined by approval flow)</p></td>
- <h3 id="bytebase.v1.Algorithm">Algorithm</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3>
+ <p>Request message for getting an IAM policy.</p>
<table class="field-table">
@@ -4920,31 +4671,46 @@ Permissions required: None (determined by approval flow)</p></td>
<tbody>
<tr>
- <td>full_mask</td>
- <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>
+ <td>resource</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the resource to get the IAM policy.
+Format: projects/{project}
+Format: workspaces/{workspace} </p></td>
</tr>
- <tr>
- <td>range_mask</td>
- <td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>
+ <p>IAM policy that binds members to roles.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>md5_mask</td>
- <td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>bindings</td>
+ <td><a href="#bytebase.v1.Binding">Binding</a></td>
+ <td>repeated</td>
+ <td><p>Collection of binding.
+A binding binds one or more project members to a single project role. </p></td>
</tr>
<tr>
- <td>inner_outer_mask</td>
- <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td>
+ <td>etag</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The current etag of the policy.
+If an etag is provided and does not match the current etag of the policy,
+the call will be blocked and an ABORTED error will be returned. </p></td>
</tr>
</tbody>
@@ -4954,8 +4720,8 @@ Permissions required: None (determined by approval flow)</p></td>
- <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>
- <p></p>
+ <h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>
+ <p>Describes changes between two IAM policies.</p>
<table class="field-table">
@@ -4965,11 +4731,10 @@ Permissions required: None (determined by approval flow)</p></td>
<tbody>
<tr>
- <td>substitution</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>substitution is the string used to replace the original value, the
-max length of the string is 16 bytes. </p></td>
+ <td>binding_deltas</td>
+ <td><a href="#bytebase.v1.BindingDelta">BindingDelta</a></td>
+ <td>repeated</td>
+ <td><p>The delta for Bindings between two policies. </p></td>
</tr>
</tbody>
@@ -4979,8 +4744,8 @@ max length of the string is 16 bytes. </p></td>
- <h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>
- <p></p>
+ <h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>
+ <p>Request message for setting an IAM policy.</p>
<table class="field-table">
@@ -4990,31 +4755,26 @@ max length of the string is 16 bytes. </p></td>
<tbody>
<tr>
- <td>prefix_len</td>
- <td><a href="#int32">int32</a></td>
+ <td>resource</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the resource to set the IAM policy.
+Format: projects/{project}
+Format: workspaces/{workspace} </p></td>
</tr>
<tr>
- <td>suffix_len</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>
+ <td>policy</td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>substitution</td>
+ <td>etag</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The current etag of the policy. </p></td>
</tr>
</tbody>
@@ -5024,8 +4784,51 @@ max length of the string is 16 bytes. </p></td>
- <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>
- <p></p>
+
+
+ <h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3>
+ <p>Type of action performed on a binding.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ACTION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified action.</p></td>
+ </tr>
+
+ <tr>
+ <td>ADD</td>
+ <td>1</td>
+ <td><p>Add a binding.</p></td>
+ </tr>
+
+ <tr>
+ <td>REMOVE</td>
+ <td>2</td>
+ <td><p>Remove a binding.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/audit_log_service.proto">v1/audit_log_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.AuditData">AuditData</h3>
+ <p>Additional audit data specific to certain operations.</p>
<table class="field-table">
@@ -5035,10 +4838,10 @@ max length of the string is 16 bytes. </p></td>
<tbody>
<tr>
- <td>salt</td>
- <td><a href="#string">string</a></td>
+ <td>policy_delta</td>
+ <td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td>
<td></td>
- <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td>
+ <td><p>Changes to IAM policies. </p></td>
</tr>
</tbody>
@@ -5048,8 +4851,8 @@ max length of the string is 16 bytes. </p></td>
- <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</h3>
- <p></p>
+ <h3 id="bytebase.v1.AuditLog">AuditLog</h3>
+ <p>Audit log entry recording system activity or API call.</p>
<table class="field-table">
@@ -5059,52 +4862,93 @@ max length of the string is 16 bytes. </p></td>
<tbody>
<tr>
- <td>slices</td>
- <td><a href="#bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</a></td>
- <td>repeated</td>
- <td><p>We store it as a repeated field to face the fact that the original value may have multiple parts should be masked.
-But frontend can be started with a single rule easily. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the log.
+Formats:
+- projects/{project}/auditLogs/{uid}
+- workspaces/{workspace}/auditLogs/{uid} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The timestamp when the audit log was created. </p></td>
+ </tr>
<tr>
- <td>start</td>
- <td><a href="#int32">int32</a></td>
+ <td>user</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>start is the start character index (0-based) of the original value, should be less than end.
-Uses character indices (not byte offsets) for display-oriented masking.
-Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). </p></td>
+ <td><p>The user who performed the action.
+Format: users/{email} </p></td>
</tr>
<tr>
- <td>end</td>
- <td><a href="#int32">int32</a></td>
+ <td>method</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>end is the end character index (exclusive) of the original value.
-Uses character indices (not byte offsets) for display-oriented masking. </p></td>
+ <td><p>The method or action being audited.
+For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></td>
</tr>
<tr>
- <td>substitution</td>
+ <td>severity</td>
+ <td><a href="#bytebase.v1.AuditLog.Severity">AuditLog.Severity</a></td>
+ <td></td>
+ <td><p>The severity level of this audit log entry. </p></td>
+ </tr>
+
+ <tr>
+ <td>resource</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>
+ <td><p>The resource associated with this audit log. </p></td>
+ </tr>
+
+ <tr>
+ <td>request</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The request payload in JSON format. </p></td>
+ </tr>
+
+ <tr>
+ <td>response</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The response payload in JSON format.
+Some fields may be omitted if they are too large or contain sensitive information. </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#google.rpc.Status">google.rpc.Status</a></td>
+ <td></td>
+ <td><p>The status of the operation. </p></td>
+ </tr>
+
+ <tr>
+ <td>latency</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration of the operation. </p></td>
+ </tr>
+
+ <tr>
+ <td>service_data</td>
+ <td><a href="#google.protobuf.Any">google.protobuf.Any</a></td>
+ <td></td>
+ <td><p>Service-specific metadata about the request, response, and activities. </p></td>
+ </tr>
+
+ <tr>
+ <td>request_metadata</td>
+ <td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td>
+ <td></td>
+ <td><p>Metadata about the request context. </p></td>
</tr>
</tbody>
@@ -5114,8 +4958,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.Announcement">Announcement</h3>
- <p></p>
+ <h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>
+ <p>Request message for exporting audit logs.</p>
<table class="field-table">
@@ -5125,24 +4969,54 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>level</td>
- <td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The alert level of announcement </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>text</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The text of announcement </p></td>
+ <td><p>The filter of the log. It should be a valid CEL expression.
+Check the filter field in the SearchAuditLogsRequest message. </p></td>
</tr>
<tr>
- <td>link</td>
+ <td>order_by</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The optional link, user can follow the link to check extra details </p></td>
+ <td><p>The order by of the log.
+Only support order by create_time. The default sorting order is ascending.
+For example:
+ - order_by = &#34;create_time asc&#34;
+ - order_by = &#34;create_time desc&#34; </p></td>
+ </tr>
+
+ <tr>
+ <td>format</td>
+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td></td>
+ <td><p>The export format. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of logs to return.
+The service may return fewer than this value.
+If unspecified, at most 10 log entries will be returned.
+The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ExportAuditLogs` call.
+Provide this to retrieve the subsequent page. </p></td>
</tr>
</tbody>
@@ -5152,8 +5026,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>
+ <p>Response message for exporting audit logs.</p>
<table class="field-table">
@@ -5163,10 +5037,19 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>settings</td>
- <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>content</td>
+ <td><a href="#bytes">bytes</a></td>
+ <td></td>
+ <td><p>The exported audit log content in the requested format. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token to retrieve next page of log entities.
+Pass this value in the page_token field in the subsequent call
+to retrieve the next page of log entities. </p></td>
</tr>
</tbody>
@@ -5176,8 +5059,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>
- <p></p>
+ <h3 id="bytebase.v1.RequestMetadata">RequestMetadata</h3>
+ <p>Metadata about the incoming request.</p>
<table class="field-table">
@@ -5187,24 +5070,18 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>client_id</td>
+ <td>caller_ip</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The IP address of the request originator. </p></td>
</tr>
<tr>
- <td>client_secret</td>
+ <td>caller_supplied_user_agent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>robot_code</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The user agent string provided by the caller.
+This is supplied by the client and is not authenticated. </p></td>
</tr>
</tbody>
@@ -5214,8 +5091,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>
- <p></p>
+ <h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>
+ <p>Request message for searching audit logs.</p>
<table class="field-table">
@@ -5225,83 +5102,59 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>app_id</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>app_secret</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+ <td><p>The filter of the log. It should be a valid CEL expression.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-
- <h3 id="bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3>
- <p></p>
+Supported filter:
+- method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator.
+- severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values.
+- user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator.
+- create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>slack</td>
- <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>feishu</td>
- <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>wecom</td>
- <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>
- <td></td>
- <td><p> </p></td>
+For example:
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34;
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34;
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34;
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; </p></td>
</tr>
<tr>
- <td>lark</td>
- <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The order by of the log.
+Only support order by create_time. The default sorting order is ascending.
+For example:
+ - order_by = &#34;create_time asc&#34;
+ - order_by = &#34;create_time desc&#34; </p></td>
</tr>
<tr>
- <td>dingtalk</td>
- <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The maximum number of logs to return.
+The service may return fewer than this value.
+If unspecified, at most 10 log entries will be returned.
+The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
</tr>
<tr>
- <td>teams</td>
- <td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A page token, received from a previous `SearchLogs` call.
+Provide this to retrieve the subsequent page. </p></td>
</tr>
</tbody>
@@ -5311,8 +5164,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3>
- <p></p>
+ <h3 id="bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</h3>
+ <p>Response message for searching audit logs.</p>
<table class="field-table">
@@ -5322,17 +5175,19 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>app_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
+ <td>audit_logs</td>
+ <td><a href="#bytebase.v1.AuditLog">AuditLog</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
<tr>
- <td>app_secret</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A token to retrieve next page of log entities.
+Pass this value in the page_token field in the subsequent call
+to retrieve the next page of log entities. </p></td>
</tr>
</tbody>
@@ -5342,69 +5197,166 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3>
- <p></p>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
+
+ <h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>
+ <p>Severity level for audit log entries.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SEVERITY_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified severity level.</p></td>
+ </tr>
+
+ <tr>
+ <td>DEBUG</td>
+ <td>1</td>
+ <td><p>Debug-level information.</p></td>
+ </tr>
+
+ <tr>
+ <td>INFO</td>
+ <td>2</td>
+ <td><p>Informational messages.</p></td>
+ </tr>
+
+ <tr>
+ <td>NOTICE</td>
+ <td>3</td>
+ <td><p>Notable events.</p></td>
+ </tr>
+
+ <tr>
+ <td>WARNING</td>
+ <td>4</td>
+ <td><p>Warning conditions.</p></td>
+ </tr>
+
+ <tr>
+ <td>ERROR</td>
+ <td>5</td>
+ <td><p>Error conditions.</p></td>
+ </tr>
+
+ <tr>
+ <td>CRITICAL</td>
+ <td>6</td>
+ <td><p>Critical conditions.</p></td>
+ </tr>
+
+ <tr>
+ <td>ALERT</td>
+ <td>7</td>
+ <td><p>Action must be taken immediately.</p></td>
+ </tr>
+
+ <tr>
+ <td>EMERGENCY</td>
+ <td>8</td>
+ <td><p>System is unusable.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
+
-
- <h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</h3>
- <p></p>
+ <h3 id="bytebase.v1.AuditLogService">AuditLogService</h3>
+ <p>AuditLogService manages audit logs for system activities and API calls.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SearchAuditLogs</td>
+ <td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td>
+ <td><a href="#bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</a></td>
+ <td><p>Searches audit logs with optional filtering and pagination.
+Permissions required: bb.auditLogs.search</p></td>
+ </tr>
+
+ <tr>
+ <td>ExportAuditLogs</td>
+ <td><a href="#bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</a></td>
+ <td><a href="#bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</a></td>
+ <td><p>Exports audit logs in a specified format for external analysis.
+Permissions required: bb.auditLogs.export</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>tenant_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Azure AD tenant ID (Directory ID). </p></td>
- </tr>
- <tr>
- <td>client_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Azure AD application (client) ID. </p></td>
- </tr>
+ <tr>
+ <td>SearchAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/auditLogs:search</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>client_secret</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Azure AD client secret. </p></td>
- </tr>
+ <tr>
+ <td>SearchAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/auditLogs:search</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ExportAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/auditLogs:export</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>ExportAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/auditLogs:export</td>
+ <td>*</td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>
+ <div class="file-heading">
+ <h2 id="v1/auth_service.proto">v1/auth_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</h3>
<p></p>
@@ -5415,24 +5367,18 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>corp_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>agent_id</td>
+ <td>token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>External OIDC token (JWT) from CI/CD platform. </p></td>
</tr>
<tr>
- <td>secret</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Workload Identity email for identifying which identity to authenticate as.
+Format: {name}@workload.bytebase.com </p></td>
</tr>
</tbody>
@@ -5442,7 +5388,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.DataClassificationSetting">DataClassificationSetting</h3>
+ <h3 id="bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</h3>
<p></p>
@@ -5453,10 +5399,10 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>configs</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>access_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Bytebase access token. </p></td>
</tr>
</tbody>
@@ -5466,8 +5412,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3>
- <p></p>
+ <h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>
+ <p>Context for identity provider authentication.</p>
<table class="field-table">
@@ -5477,33 +5423,17 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
+ <td>oauth2_context</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td>
<td></td>
- <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td>
+ <td><p>OAuth2 authentication context. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>oidc_context</td>
+ <td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>levels</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</a></td>
- <td>repeated</td>
- <td><p>levels is user defined level list for classification.
-The order for the level decides its priority. </p></td>
- </tr>
-
- <tr>
- <td>classification</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></td>
- <td>repeated</td>
- <td><p>classification is the id - DataClassification map.
-The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
+ <td><p>OpenID Connect authentication context. </p></td>
</tr>
</tbody>
@@ -5513,7 +5443,7 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3>
+ <h3 id="bytebase.v1.LoginRequest">LoginRequest</h3>
<p></p>
@@ -5524,62 +5454,61 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>key</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>User&#39;s email address. </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>User&#39;s password for authentication. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>web</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If true, sets access token and refresh token as HTTP-only cookies instead of
+returning the token in the response body. Use for browser-based clients. </p></td>
+ </tr>
<tr>
- <td>id</td>
+ <td>idp_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
+ <td><p>The name of the identity provider.
+Format: idps/{idp} </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>idp_context</td>
+ <td><a href="#bytebase.v1.IdentityProviderContext">IdentityProviderContext</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The idp_context is used to get the user information from identity provider. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>otp_code</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>optional</td>
+ <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
</tr>
<tr>
- <td>level_id</td>
+ <td>recovery_code</td>
<td><a href="#string">string</a></td>
<td>optional</td>
- <td><p> </p></td>
+ <td><p>The recovery_code is used to recovery the user&#39;s identity with MFA. </p></td>
+ </tr>
+
+ <tr>
+ <td>mfa_temp_token</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The mfa_temp_token is used to verify the user&#39;s identity by MFA. </p></td>
</tr>
</tbody>
@@ -5589,7 +5518,7 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3>
+ <h3 id="bytebase.v1.LoginResponse">LoginResponse</h3>
<p></p>
@@ -5600,24 +5529,32 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>id</td>
+ <td>token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Access token for authenticated requests.
+Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>mfa_temp_token</td>
<td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Temporary token for MFA verification. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_reset_password</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether user must reset password before continuing. </p></td>
</tr>
<tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The user from the successful login. </p></td>
</tr>
</tbody>
@@ -5627,8 +5564,15 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.LogoutRequest">LogoutRequest</h3>
+ <p>Request to logout current user session.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</h3>
+ <p>OAuth2 authentication context.</p>
<table class="field-table">
@@ -5638,10 +5582,10 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>environments</td>
- <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>code</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Authorization code from OAuth2 provider. </p></td>
</tr>
</tbody>
@@ -5651,8 +5595,8 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3>
- <p></p>
+ <h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3>
+ <p>OpenID Connect authentication context.</p>
<table class="field-table">
@@ -5662,42 +5606,10 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the environment.
-Format: environments/{environment}.
-Output only. </p></td>
- </tr>
-
- <tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource id of the environment.
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The display name of the environment. </p></td>
- </tr>
-
- <tr>
- <td>tags</td>
- <td><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>color</td>
+ <td>code</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Authorization code from OIDC provider. </p></td>
</tr>
</tbody>
@@ -5707,94 +5619,139 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.RefreshRequest">RefreshRequest</h3>
+ <p>Request to refresh the access token.</p>
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <h3 id="bytebase.v1.GetSettingRequest">GetSettingRequest</h3>
- <p>The request message for getting a setting.</p>
+ <h3 id="bytebase.v1.RefreshResponse">RefreshResponse</h3>
+ <p>Response from refreshing the access token.</p>
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the setting. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>
- <p>The response message for getting a setting.</p>
+
+
+
+
+
+
+ <h3 id="bytebase.v1.AuthService">AuthService</h3>
+ <p>AuthService handles user authentication operations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>Login</td>
+ <td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td>
+ <td><a href="#bytebase.v1.LoginResponse">LoginResponse</a></td>
+ <td><p>Authenticates a user and returns access tokens.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>Logout</td>
+ <td><a href="#bytebase.v1.LogoutRequest">LogoutRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Logs out the current user session.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>ExchangeToken</td>
+ <td><a href="#bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</a></td>
+ <td><a href="#bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</a></td>
+ <td><p>Exchanges an external OIDC token for a Bytebase access token.
+Used by CI/CD pipelines with Workload Identity Federation.
+Permissions required: None (validates via OIDC token)</p></td>
+ </tr>
+
+ <tr>
+ <td>Refresh</td>
+ <td><a href="#bytebase.v1.RefreshRequest">RefreshRequest</a></td>
+ <td><a href="#bytebase.v1.RefreshResponse">RefreshResponse</a></td>
+ <td><p>Refreshes the access token using the refresh token cookie.
+Permissions required: None (validates via refresh token cookie)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
+
+
+ <tr>
+ <td>Login</td>
+ <td>POST</td>
+ <td>/v1/auth/login</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>Logout</td>
+ <td>POST</td>
+ <td>/v1/auth/logout</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ExchangeToken</td>
+ <td>POST</td>
+ <td>/v1/auth:exchangeToken</td>
+ <td>*</td>
+ </tr>
+
+
- <tr>
- <td>setting</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>Refresh</td>
+ <td>POST</td>
+ <td>/v1/auth/refresh</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3>
- <p></p>
-
-
+ <div class="file-heading">
+ <h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
-
- <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>
+ <p>Request message for batch deparsing CEL expressions.</p>
<table class="field-table">
@@ -5804,10 +5761,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>settings</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
+ <td>expressions</td>
+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
<td>repeated</td>
- <td><p>The settings from the specified request. </p></td>
+ <td><p>The CEL expression ASTs to deparse. </p></td>
</tr>
</tbody>
@@ -5817,8 +5774,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>
+ <p>Response message for batch deparsing CEL expressions.</p>
<table class="field-table">
@@ -5828,10 +5785,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>types</td>
- <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>
+ <td>expressions</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>The deparsed CEL expressions as strings. </p></td>
</tr>
</tbody>
@@ -5841,8 +5798,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>
+ <p>Request message for batch parsing CEL expressions.</p>
<table class="field-table">
@@ -5852,38 +5809,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>id is the uuid for semantic type. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the title of the semantic type, it should not be empty. </p></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the description of the semantic type, it can be empty. </p></td>
- </tr>
-
- <tr>
- <td>algorithm</td>
- <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>icon</td>
+ <td>expressions</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>icon is the icon for semantic type, it can be emoji or base64 encoded image. </p></td>
+ <td>repeated</td>
+ <td><p>The CEL expression strings to parse. </p></td>
</tr>
</tbody>
@@ -5893,8 +5822,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.Setting">Setting</h3>
- <p>The schema of setting.</p>
+ <h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>
+ <p>Response message for batch parsing CEL expressions.</p>
<table class="field-table">
@@ -5904,19 +5833,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the setting.
-Format: settings/{setting}
-Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#bytebase.v1.SettingValue">SettingValue</a></td>
- <td></td>
- <td><p>The configuration value of the setting. </p></td>
+ <td>expressions</td>
+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>repeated</td>
+ <td><p>The parsed CEL expressions as AST. </p></td>
</tr>
</tbody>
@@ -5926,63 +5846,129 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
- <h3 id="bytebase.v1.SettingValue">SettingValue</h3>
- <p>The data in setting value.</p>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>app_im</td>
- <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
+
+
+
+
+ <h3 id="bytebase.v1.CelService">CelService</h3>
+ <p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>BatchParse</td>
+ <td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td>
+ <td><a href="#bytebase.v1.BatchParseResponse">BatchParseResponse</a></td>
+ <td><p>Parses multiple CEL expression strings into AST representations.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchDeparse</td>
+ <td><a href="#bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</a></td>
+ <td><a href="#bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</a></td>
+ <td><p>Converts multiple CEL AST representations back into expression strings.
+Permissions required: None</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
- <tr>
- <td>workspace_profile</td>
- <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
+ <tr>
+ <td>BatchParse</td>
+ <td>POST</td>
+ <td>/v1/cel/batchParse</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchDeparse</td>
+ <td>POST</td>
+ <td>/v1/cel/batchDeparse</td>
+ <td>*</td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/database_catalog_service.proto">v1/database_catalog_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.ColumnCatalog">ColumnCatalog</h3>
+ <p>Column metadata within a table.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>workspace_approval</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The column name. </p></td>
</tr>
<tr>
- <td>data_classification</td>
- <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td>
+ <td>semantic_type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The semantic type describing the data purpose. </p></td>
</tr>
<tr>
- <td>semantic_type</td>
- <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>User-defined labels for this column. </p></td>
</tr>
<tr>
- <td>ai</td>
- <td><a href="#bytebase.v1.AISetting">AISetting</a></td>
+ <td>classification</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The data classification level for this column. </p></td>
</tr>
<tr>
- <td>environment</td>
- <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>object_schema</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>optional</td>
+ <td><p>Object schema for complex column types like JSON. </p></td>
</tr>
</tbody>
@@ -5992,8 +5978,8 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
- <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>
- <p>The request message for updating or creating a setting.</p>
+ <h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -6003,30 +5989,15 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
<tbody>
<tr>
- <td>setting</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td></td>
- <td><p>The setting to update. </p></td>
- </tr>
-
- <tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>validate_only is a flag to indicate whether to validate the setting value,
-server would not persist the setting value if it is true. </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -6038,8 +6009,8 @@ server would not persist the setting value if it is true. </p></td>
- <h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3>
+ <p>Catalog metadata for a database including schemas, tables, and columns.</p>
<table class="field-table">
@@ -6049,10 +6020,18 @@ server would not persist the setting value if it is true. </p></td>
<tbody>
<tr>
- <td>rules</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database catalog.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
+ </tr>
+
+ <tr>
+ <td>schemas</td>
+ <td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>The schemas in the database. </p></td>
</tr>
</tbody>
@@ -6062,8 +6041,8 @@ server would not persist the setting value if it is true. </p></td>
- <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3>
+ <p>Request message for getting a database catalog.</p>
<table class="field-table">
@@ -6073,50 +6052,11 @@ server would not persist the setting value if it is true. </p></td>
<tbody>
<tr>
- <td>template</td>
- <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with the rule.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-The `source` field filters which rules apply. The `condition` field then evaluates with full context.
-
-All supported variables:
-statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
-statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
-resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
-resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values.
-statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
-resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
-request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-
-When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*)
-When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name
-When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name
-When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
-
-For examples:
-resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100
-resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; </p></td>
- </tr>
-
- <tr>
- <td>source</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database catalog to retrieve.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
</tr>
</tbody>
@@ -6126,8 +6066,8 @@ resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engin
- <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3>
+ <p>Schema definition for object-type columns.</p>
<table class="field-table">
@@ -6137,131 +6077,186 @@ resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engin
<tbody>
<tr>
- <td>external_url</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</a></td>
<td></td>
- <td><p>The external URL is used for sso authentication callback. </p></td>
+ <td><p>The data type of this object. </p></td>
</tr>
<tr>
- <td>disallow_signup</td>
- <td><a href="#bool">bool</a></td>
+ <td>struct_kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td>
<td></td>
- <td><p>Disallow self-service signup, users can only be invited by the owner. </p></td>
+ <td><p>Struct schema. </p></td>
</tr>
<tr>
- <td>require_2fa</td>
- <td><a href="#bool">bool</a></td>
+ <td>array_kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td>
<td></td>
- <td><p>Require 2FA for all users. </p></td>
+ <td><p>Array schema. </p></td>
</tr>
<tr>
- <td>refresh_token_duration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>semantic_type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The duration for refresh token. Default is 7 days. </p></td>
+ <td><p>The semantic type of this object. </p></td>
</tr>
- <tr>
- <td>access_token_duration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The duration for access token. Default is 1 hour. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>
+ <p>Array type with element schema.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>announcement</td>
- <td><a href="#bytebase.v1.Announcement">Announcement</a></td>
+ <td>kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>The setting of custom announcement </p></td>
+ <td><p>The schema of array elements. </p></td>
</tr>
- <tr>
- <td>maximum_role_expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The max duration for role expired. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3>
+ <p>Structure type with named properties.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>domains</td>
- <td><a href="#string">string</a></td>
+ <td>properties</td>
+ <td><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td>
<td>repeated</td>
- <td><p>The workspace domain, e.g., bytebase.com. </p></td>
+ <td><p>Properties of the struct. </p></td>
</tr>
- <tr>
- <td>enforce_identity_domain</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Only user and group from the domains can be created and login. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>database_change_mode</td>
- <td><a href="#bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The workspace database change mode. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>disallow_password_signin</td>
- <td><a href="#bool">bool</a></td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>Whether to disallow password signin. (Except workspace admins) </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>enable_metric_collection</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to enable metric collection for the workspace. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3>
+ <p>Schema metadata within a database.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>inactive_session_timeout</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
+ <td><p>The schema name. </p></td>
</tr>
<tr>
- <td>enable_audit_log_stdout</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to enable audit logging to stdout in structured JSON format.
-Requires TEAM or ENTERPRISE license. </p></td>
+ <td>tables</td>
+ <td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td>
+ <td>repeated</td>
+ <td><p>The tables in the schema. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>
+ <p>Table metadata within a schema.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>watermark</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to display watermark on pages.
-Requires ENTERPRISE license. </p></td>
+ <td><p>The table name. </p></td>
</tr>
<tr>
- <td>directory_sync_token</td>
- <td><a href="#string">string</a></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td>
<td></td>
- <td><p>The token for directory sync authentication. </p></td>
+ <td><p>Regular table columns. </p></td>
</tr>
<tr>
- <td>branding_logo</td>
- <td><a href="#string">string</a></td>
+ <td>object_schema</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>The branding logo as a data URI (e.g. data:image/png;base64,...). </p></td>
+ <td><p>Object schema for JSON/XML columns. </p></td>
</tr>
<tr>
- <td>password_restriction</td>
- <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>
+ <td>classification</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Password restriction settings. </p></td>
+ <td><p>The data classification level for this table. </p></td>
</tr>
</tbody>
@@ -6271,8 +6266,8 @@ Requires ENTERPRISE license. </p></td>
- <h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3>
- <p></p>
+ <h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>
+ <p>Column list for regular tables.</p>
<table class="field-table">
@@ -6282,52 +6277,45 @@ Requires ENTERPRISE license. </p></td>
<tbody>
<tr>
- <td>min_length</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>min_length is the minimum length for password, should no less than 8. </p></td>
- </tr>
-
- <tr>
- <td>require_number</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>require_number requires the password must contains at least one number. </p></td>
- </tr>
-
- <tr>
- <td>require_letter</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td>
+ <td>repeated</td>
+ <td><p>The columns in the table. </p></td>
</tr>
- <tr>
- <td>require_uppercase_letter</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>require_uppercase_letter requires the password must contains at least one upper case letter. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3>
+ <p>Request message for updating a database catalog.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>require_special_character</td>
- <td><a href="#bool">bool</a></td>
+ <td>catalog</td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
<td></td>
- <td><p>require_special_character requires the password must contains at least one special character. </p></td>
+ <td><p>The database catalog to update.
+
+The catalog&#39;s `name` field is used to identify the database catalog to update.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
</tr>
<tr>
- <td>require_reset_password_for_first_login</td>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td>
- </tr>
-
- <tr>
- <td>password_rotation</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>password_rotation requires users to reset their password after the duration. </p></td>
+ <td><p>If set to true, and the database catalog is not found, a new database catalog will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -6339,8 +6327,8 @@ Requires ENTERPRISE license. </p></td>
- <h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</h3>
- <p></p>
+ <h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3>
+ <p>Object schema data types.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -6348,227 +6336,39 @@ Requires ENTERPRISE license. </p></td>
<tbody>
<tr>
- <td>PROVIDER_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified type.</p></td>
</tr>
<tr>
- <td>OPEN_AI</td>
+ <td>STRING</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>String type.</p></td>
</tr>
<tr>
- <td>CLAUDE</td>
+ <td>NUMBER</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Number type.</p></td>
</tr>
<tr>
- <td>GEMINI</td>
+ <td>BOOLEAN</td>
<td>3</td>
- <td><p></p></td>
+ <td><p>Boolean type.</p></td>
</tr>
<tr>
- <td>AZURE_OPENAI</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>MASK_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>INNER</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>OUTER</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3>
- <p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ALERT_LEVEL_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>INFO</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WARNING</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CRITICAL</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATABASE_CHANGE_MODE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PIPELINE</td>
- <td>1</td>
- <td><p>A more advanced database change process, including custom approval workflows and other advanced features.
-Default to this mode.</p></td>
- </tr>
-
- <tr>
- <td>EDITOR</td>
- <td>2</td>
- <td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Setting.SettingName">Setting.SettingName</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SETTING_NAME_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE_PROFILE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE_APPROVAL</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>APP_IM</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AI</td>
+ <td>OBJECT</td>
<td>4</td>
- <td><p></p></td>
+ <td><p>Object/struct type.</p></td>
</tr>
<tr>
- <td>DATA_CLASSIFICATION</td>
+ <td>ARRAY</td>
<td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SEMANTIC_TYPES</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>ENVIRONMENT</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SOURCE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CHANGE_DATABASE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CREATE_DATABASE</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>EXPORT_DATA</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>REQUEST_ROLE</td>
- <td>4</td>
- <td><p></p></td>
+ <td><p>Array type.</p></td>
</tr>
</tbody>
@@ -6578,8 +6378,8 @@ Default to this mode.</p></td>
- <h3 id="bytebase.v1.SettingService">SettingService</h3>
- <p>SettingService manages workspace-level settings and configurations.</p>
+ <h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3>
+ <p>DatabaseCatalogService manages database schema metadata and classification.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -6587,27 +6387,19 @@ Default to this mode.</p></td>
<tbody>
<tr>
- <td>ListSettings</td>
- <td><a href="#bytebase.v1.ListSettingsRequest">ListSettingsRequest</a></td>
- <td><a href="#bytebase.v1.ListSettingsResponse">ListSettingsResponse</a></td>
- <td><p>Lists all workspace settings.
-Permissions required: bb.settings.list</p></td>
- </tr>
-
- <tr>
- <td>GetSetting</td>
- <td><a href="#bytebase.v1.GetSettingRequest">GetSettingRequest</a></td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td><p>Retrieves a workspace setting by name.
-Permissions required: bb.settings.get</p></td>
+ <td>GetDatabaseCatalog</td>
+ <td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td><p>Gets the catalog metadata for a database.
+Permissions required: bb.databaseCatalogs.get</p></td>
</tr>
<tr>
- <td>UpdateSetting</td>
- <td><a href="#bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</a></td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td><p>Updates a workspace setting.
-Permissions required: bb.settings.set</p></td>
+ <td>UpdateDatabaseCatalog</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td><p>Updates catalog metadata such as classifications and labels.
+Permissions required: bb.databaseCatalogs.update</p></td>
</tr>
</tbody>
@@ -6631,19 +6423,9 @@ Permissions required: bb.settings.set</p></td>
<tr>
- <td>ListSettings</td>
- <td>GET</td>
- <td>/v1/settings</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetSetting</td>
+ <td>GetDatabaseCatalog</td>
<td>GET</td>
- <td>/v1/{name=settings/*}</td>
+ <td>/v1/{name=instances/*/databases/*/catalog}</td>
<td></td>
</tr>
@@ -6651,10 +6433,10 @@ Permissions required: bb.settings.set</p></td>
<tr>
- <td>UpdateSetting</td>
+ <td>UpdateDatabaseCatalog</td>
<td>PATCH</td>
- <td>/v1/{setting.name=settings/*}</td>
- <td>setting</td>
+ <td>/v1/{catalog.name=instances/*/databases/*/catalog}</td>
+ <td>catalog</td>
</tr>
@@ -6665,13 +6447,13 @@ Permissions required: bb.settings.set</p></td>
<div class="file-heading">
- <h2 id="v1/user_service.proto">v1/user_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/database_group_service.proto">v1/database_group_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</h3>
+ <p>Request message for creating a database group.</p>
<table class="field-table">
@@ -6681,35 +6463,36 @@ Permissions required: bb.settings.set</p></td>
<tbody>
<tr>
- <td>names</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The user names to retrieve.
-Format: users/{email} </p></td>
+ <td></td>
+ <td><p>The parent resource where this database group will be created.
+Format: projects/{project} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</h3>
- <p></p>
+ <tr>
+ <td>database_group</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td></td>
+ <td><p>The database group to create. </p></td>
+ </tr>
+
+ <tr>
+ <td>database_group_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The ID to use for the database group, which will become the final component of
+the database group&#39;s resource name.
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
+ </tr>
<tr>
- <td>users</td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td>repeated</td>
- <td><p>The users from the specified request. </p></td>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set, validate the create request and preview the full database group response, but do not actually create it. </p></td>
</tr>
</tbody>
@@ -6719,8 +6502,8 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>
+ <p>A group of databases matched by expressions.</p>
<table class="field-table">
@@ -6730,10 +6513,44 @@ Format: users/{email} </p></td>
<tbody>
<tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The user to create. </p></td>
+ <td><p>The name of the database group.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The short name used in actual databases specified by users. </p></td>
+ </tr>
+
+ <tr>
+ <td>database_expr</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td></td>
+ <td><p>The condition that is associated with this database group.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Support variables:
+resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations.
+resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
+resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
+resource.database_labels: the database labels. Support map access operations.
+All variables should join with &#34;&amp;&amp;&#34; condition.
+
+For example:
+resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;)
+resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
+ </tr>
+
+ <tr>
+ <td>matched_databases</td>
+ <td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td>
+ <td>repeated</td>
+ <td><p>The list of databases that match the database group condition. </p></td>
</tr>
</tbody>
@@ -6743,8 +6560,8 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3>
+ <p>A database within a database group.</p>
<table class="field-table">
@@ -6757,8 +6574,8 @@ Format: users/{email} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user to delete.
-Format: users/{email} </p></td>
+ <td><p>The resource name of the database.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
</tbody>
@@ -6768,8 +6585,8 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3>
+ <p>Request message for deleting a database group.</p>
<table class="field-table">
@@ -6782,8 +6599,8 @@ Format: users/{email} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user to retrieve.
-Format: users/{email} </p></td>
+ <td><p>The name of the database group to delete.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
</tbody>
@@ -6793,8 +6610,8 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.ListUsersRequest">ListUsersRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3>
+ <p>Request message for getting a database group.</p>
<table class="field-table">
@@ -6804,60 +6621,18 @@ Format: users/{email} </p></td>
<tbody>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of users to return. The service may return fewer than
-this value.
-If unspecified, at most 10 users will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListUsers` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListUsers` must match
-the call that provided the page token. </p></td>
- </tr>
-
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted users if specified. </p></td>
+ <td><p>The name of the database group to retrieve.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
<td></td>
- <td><p>Filter is used to filter users returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- state: check State enum for values, support &#34;==&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-
-For example:
-name == &#34;ed&#34;
-name.matches(&#34;ed&#34;)
-email == &#34;[email protected]&#34;
-email.matches(&#34;ed&#34;)
-user_type == &#34;SERVICE_ACCOUNT&#34;
-user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]
-!(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;])
-state == &#34;DELETED&#34;
-project == &#34;projects/sample-project&#34;
-You can combine filter conditions like:
-name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34;
-(name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; </p></td>
+ <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
</tr>
</tbody>
@@ -6867,8 +6642,8 @@ name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#3
- <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3>
+ <p>Request message for listing database groups.</p>
<table class="field-table">
@@ -6878,43 +6653,18 @@ name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#3
<tbody>
<tr>
- <td>users</td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td>repeated</td>
- <td><p>The users from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>The parent resource whose database groups are to be listed.
+Format: projects/{project} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
<td></td>
- <td><p>The name of the deleted user.
-Format: users/{email} </p></td>
+ <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
</tr>
</tbody>
@@ -6924,8 +6674,8 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3>
+ <p>Response message for listing database groups.</p>
<table class="field-table">
@@ -6935,19 +6685,10 @@ Format: users/{email} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the user whose email to update.
-Format: users/{email}
-Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. </p></td>
- </tr>
-
- <tr>
- <td>email</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The new email address. </p></td>
+ <td>database_groups</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td>repeated</td>
+ <td><p>The database groups from the specified request. </p></td>
</tr>
</tbody>
@@ -6957,8 +6698,8 @@ Note: This is the current (old) email address. The new email is specified in the
- <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>
+ <p>Request message for updating a database group.</p>
<table class="field-table">
@@ -6968,13 +6709,13 @@ Note: This is the current (old) email address. The new email is specified in the
<tbody>
<tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
+ <td>database_group</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
<td></td>
- <td><p>The user to update.
+ <td><p>The database group to update.
-The user&#39;s `name` field is used to identify the user to update.
-Format: users/{email} </p></td>
+The database group&#39;s `name` field is used to identify the database group to update.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
@@ -6985,33 +6726,11 @@ Format: users/{email} </p></td>
</tr>
<tr>
- <td>otp_code</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
- </tr>
-
- <tr>
- <td>regenerate_temp_mfa_secret</td>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user.
-This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. </p></td>
- </tr>
-
- <tr>
- <td>regenerate_recovery_codes</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, and the user is not found, a new user will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>If set to true, and the database group is not found, a new database group will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -7021,8 +6740,173 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.User">User</h3>
- <p></p>
+
+
+ <h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3>
+ <p>View options for database group responses.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>DATABASE_GROUP_VIEW_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>The default / unset value.
+The API will default to the BASIC view.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_GROUP_VIEW_BASIC</td>
+ <td>1</td>
+ <td><p>Include basic information about the database group, but exclude the list of matched databases and unmatched databases.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_GROUP_VIEW_FULL</td>
+ <td>2</td>
+ <td><p>Include everything.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3>
+ <p>DatabaseGroupService manages database groups for organizing databases by criteria.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ListDatabaseGroups</td>
+ <td><a href="#bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</a></td>
+ <td><a href="#bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</a></td>
+ <td><p>Lists database groups in a project.
+Permissions required: bb.databaseGroups.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetDatabaseGroup</td>
+ <td><a href="#bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td><p>Gets a database group by name.
+Permissions required: bb.databaseGroups.get</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateDatabaseGroup</td>
+ <td><a href="#bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td><p>Creates a new database group.
+Permissions required: bb.databaseGroups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateDatabaseGroup</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td><p>Updates a database group.
+Permissions required: bb.databaseGroups.update
+When allow_missing=true, also requires: bb.databaseGroups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteDatabaseGroup</td>
+ <td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a database group.
+Permissions required: bb.databaseGroups.delete</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
+
+
+ <tr>
+ <td>ListDatabaseGroups</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetDatabaseGroup</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateDatabaseGroup</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td>database_group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateDatabaseGroup</td>
+ <td>PATCH</td>
+ <td>/v1/{database_group.name=projects/*/databaseGroups/*}</td>
+ <td>database_group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteDatabaseGroup</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <td></td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.InstanceRole">InstanceRole</h3>
+ <p>InstanceRole is the API message for instance role.</p>
<table class="field-table">
@@ -7035,108 +6919,235 @@ In this situation, `update_mask` is ignored. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user.
-Format: users/{email} </p></td>
+ <td><p>The name of the role.
+Format: instances/{instance}/roles/{role}
+The role name is the unique name for the role. </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>role_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The lifecycle state of the user account. </p></td>
+ <td><p>The role name. It&#39;s unique within the instance. </p></td>
</tr>
<tr>
- <td>email</td>
+ <td>password</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The email address of the user, used for login and notifications. </p></td>
+ <td>optional</td>
+ <td><p>The role password. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The display title or full name of the user. </p></td>
+ <td>connection_limit</td>
+ <td><a href="#int32">int32</a></td>
+ <td>optional</td>
+ <td><p>The connection count limit for this role. </p></td>
</tr>
<tr>
- <td>user_type</td>
- <td><a href="#bytebase.v1.UserType">UserType</a></td>
- <td></td>
- <td><p>The type of user account. </p></td>
+ <td>valid_until</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The expiration for the role&#39;s password. </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>attribute</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The password for authentication. Only used during user creation or password updates. </p></td>
+ <td>optional</td>
+ <td><p>The role attribute.
+For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html
+For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>service_key</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The service key for service account authentication. Only used for service accounts. </p></td>
+ <td><p>The parent, which owns this collection of roles.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>mfa_enabled</td>
- <td><a href="#bool">bool</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td>
+ <td><p>Not used.
+The maximum number of roles to return. The service may return fewer than
+this value.
+If unspecified, at most 10 roles will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>temp_otp_secret</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td>
- </tr>
+ <td><p>Not used.
+A page token, received from a previous `ListInstanceRoles` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListInstanceRoles` must match
+the call that provided the page token. </p></td>
+ </tr>
<tr>
- <td>temp_recovery_codes</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td>
+ <td>refresh</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Refresh will refresh and return the latest data. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>temp_otp_secret_created_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
+ <td>repeated</td>
+ <td><p>The roles from the specified request. </p></td>
</tr>
<tr>
- <td>phone</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Should be a valid E.164 compliant phone number.
-Could be empty. </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.InstanceRoleService">InstanceRoleService</h3>
+ <p>InstanceRoleService manages database roles within instances.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ListInstanceRoles</td>
+ <td><a href="#bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</a></td>
+ <td><a href="#bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</a></td>
+ <td><p>Lists all database roles in an instance.
+Permissions required: bb.instanceRoles.list</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
+
+
+ <tr>
+ <td>ListInstanceRoles</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/roles</td>
+ <td></td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>profile</td>
- <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>User profile metadata. </p></td>
+ <td><p>The name of the instance to add a data source to.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>groups</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The groups for the user.
-Format: groups/{email} </p></td>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td></td>
+ <td><p>Identified by data source ID.
+Only READ_ONLY data source can be added. </p></td>
</tr>
<tr>
- <td>workload_identity_config</td>
- <td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Workload Identity configuration (only for WORKLOAD_IDENTITY type) </p></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
</tr>
</tbody>
@@ -7146,7 +7157,7 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.User.Profile">User.Profile</h3>
+ <h3 id="bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</h3>
<p></p>
@@ -7157,24 +7168,42 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>last_login_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last time the user successfully logged in. </p></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the instances to sync.
+A maximum of 1000 instances can be synced in a batch. </p></td>
</tr>
- <tr>
- <td>last_change_password_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last time the user changed their password. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>source</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the resources to update. </p></td>
</tr>
</tbody>
@@ -7184,8 +7213,8 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3>
- <p>WorkloadIdentityConfig for API layer</p>
+ <h3 id="bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -7195,31 +7224,52 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>provider_type</td>
- <td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td>
- <td></td>
- <td><p>Platform type (currently only GITHUB is supported) </p></td>
+ <td>instances</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>issuer_url</td>
- <td><a href="#string">string</a></td>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
<td></td>
- <td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td>
+ <td><p>The instance to create. </p></td>
</tr>
<tr>
- <td>allowed_audiences</td>
+ <td>instance_id</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Allowed audiences for token validation </p></td>
+ <td></td>
+ <td><p>The ID to use for the instance, which will become the final component of
+the instance&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
<tr>
- <td>subject_pattern</td>
- <td><a href="#string">string</a></td>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) </p></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
</tr>
</tbody>
@@ -7229,450 +7279,307 @@ Format: groups/{email} </p></td>
-
-
- <h3 id="bytebase.v1.UserType">UserType</h3>
+ <h3 id="bytebase.v1.DataSource">DataSource</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>USER_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified user type.</p></td>
- </tr>
-
- <tr>
- <td>USER</td>
- <td>1</td>
- <td><p>Regular human user account.</p></td>
- </tr>
-
- <tr>
- <td>SYSTEM_BOT</td>
- <td>2</td>
- <td><p>System-managed bot account for automated operations.</p></td>
- </tr>
-
- <tr>
- <td>SERVICE_ACCOUNT</td>
- <td>3</td>
- <td><p>Service account for API integrations.</p></td>
- </tr>
-
- <tr>
- <td>WORKLOAD_IDENTITY</td>
- <td>4</td>
- <td><p>External CI/CD workload identity.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3>
- <p>ProviderType identifies the CI/CD platform.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>PROVIDER_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GITHUB</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GITLAB</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UserService">UserService</h3>
- <p>UserService manages user accounts and authentication.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetUser</td>
- <td><a href="#bytebase.v1.GetUserRequest">GetUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Get the user.
-Any authenticated user can get the user.
-Permissions required: bb.users.get</p></td>
- </tr>
-
- <tr>
- <td>BatchGetUsers</td>
- <td><a href="#bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</a></td>
- <td><p>Get the users in batch.
-Any authenticated user can batch get users.
-Permissions required: bb.users.get</p></td>
- </tr>
-
- <tr>
- <td>GetCurrentUser</td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Get the current authenticated user.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>ListUsers</td>
- <td><a href="#bytebase.v1.ListUsersRequest">ListUsersRequest</a></td>
- <td><a href="#bytebase.v1.ListUsersResponse">ListUsersResponse</a></td>
- <td><p>List all users.
-Any authenticated user can list users.
-Permissions required: bb.users.list</p></td>
- </tr>
-
- <tr>
- <td>CreateUser</td>
- <td><a href="#bytebase.v1.CreateUserRequest">CreateUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.
-Permissions required: bb.users.create (only when Disallow Signup is enabled)</p></td>
- </tr>
-
- <tr>
- <td>UpdateUser</td>
- <td><a href="#bytebase.v1.UpdateUserRequest">UpdateUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
-Note: Email updates are not supported through this API. Use UpdateEmail instead.
-Permissions required: bb.users.update (or self)</p></td>
- </tr>
-
- <tr>
- <td>DeleteUser</td>
- <td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
-Permissions required: bb.users.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteUser</td>
- <td><a href="#bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Restores a deleted user.
-Permissions required: bb.users.undelete</p></td>
- </tr>
-
- <tr>
- <td>UpdateEmail</td>
- <td><a href="#bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Updates a user&#39;s email address.
-Permissions required: bb.users.updateEmail</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The unique identifier for this data source. </p></td>
+ </tr>
- <tr>
- <td>GetUser</td>
- <td>GET</td>
- <td>/v1/{name=users/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td>
+ <td></td>
+ <td><p>The type of data source (ADMIN or READ_ONLY). </p></td>
+ </tr>
-
+ <tr>
+ <td>username</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The username for database authentication. </p></td>
+ </tr>
+ <tr>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The password for database authentication. </p></td>
+ </tr>
- <tr>
- <td>BatchGetUsers</td>
- <td>GET</td>
- <td>/v1/users:batchGet</td>
- <td></td>
- </tr>
+ <tr>
+ <td>use_ssl</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Use SSL to connect to the data source. By default, we use system default SSL configuration. </p></td>
+ </tr>
-
+ <tr>
+ <td>ssl_ca</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SSL certificate authority certificate. </p></td>
+ </tr>
+ <tr>
+ <td>ssl_cert</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SSL client certificate. </p></td>
+ </tr>
- <tr>
- <td>GetCurrentUser</td>
- <td>GET</td>
- <td>/v1/users/me</td>
- <td></td>
- </tr>
+ <tr>
+ <td>ssl_key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SSL client private key. </p></td>
+ </tr>
-
+ <tr>
+ <td>verify_tls_certificate</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>verify_tls_certificate enables TLS certificate verification for SSL connections.
+Default is false (no verification) for backward compatibility.
+Set to true for secure connections (recommended for production).
+Only set to false for development or when certificates cannot be properly
+validated (e.g., self-signed certs, VPN environments). </p></td>
+ </tr>
+ <tr>
+ <td>host</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The hostname or IP address of the database server. </p></td>
+ </tr>
- <tr>
- <td>ListUsers</td>
- <td>GET</td>
- <td>/v1/users</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateUser</td>
- <td>POST</td>
- <td>/v1/users</td>
- <td>user</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateUser</td>
- <td>PATCH</td>
- <td>/v1/{user.name=users/*}</td>
- <td>user</td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteUser</td>
- <td>DELETE</td>
- <td>/v1/{name=users/*}</td>
- <td></td>
- </tr>
-
-
-
+ <tr>
+ <td>port</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The port number of the database server. </p></td>
+ </tr>
- <tr>
- <td>UndeleteUser</td>
- <td>POST</td>
- <td>/v1/{name=users/*}:undelete</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>database</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to connect to. </p></td>
+ </tr>
-
+ <tr>
+ <td>srv</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>srv, authentication_database and replica_set are used for MongoDB.
+srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td>
+ </tr>
+ <tr>
+ <td>authentication_database</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td>
+ </tr>
- <tr>
- <td>UpdateEmail</td>
- <td>POST</td>
- <td>/v1/{name=users/*}:updateEmail</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>replica_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>replica_set is used for MongoDB replica set. </p></td>
+ </tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/actuator_service.proto">v1/actuator_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.ActuatorInfo">ActuatorInfo</h3>
- <p>System information and configuration for the Bytebase instance.</p><p>Actuator concept is similar to the Spring Boot Actuator.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>sid</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>sid and service_name are used for Oracle. </p></td>
+ </tr>
<tr>
- <td>version</td>
+ <td>service_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The Bytebase server version. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>git_commit</td>
+ <td>ssh_host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The git commit hash of the build. </p></td>
+ <td><p>Connection over SSH.
+The hostname of the SSH server agent.
+Required. </p></td>
</tr>
<tr>
- <td>readonly</td>
- <td><a href="#bool">bool</a></td>
+ <td>ssh_port</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in read-only mode. </p></td>
+ <td><p>The port of the SSH server agent. It&#39;s 22 typically.
+Required. </p></td>
</tr>
<tr>
- <td>saas</td>
- <td><a href="#bool">bool</a></td>
+ <td>ssh_user</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. </p></td>
+ <td><p>The user to login the server.
+Required. </p></td>
</tr>
<tr>
- <td>demo</td>
- <td><a href="#bool">bool</a></td>
+ <td>ssh_password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in demo mode. </p></td>
+ <td><p>The password to login the server. If it&#39;s empty string, no password is required. </p></td>
</tr>
<tr>
- <td>host</td>
+ <td>ssh_private_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The host address of the Bytebase instance. </p></td>
+ <td><p>The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). </p></td>
</tr>
<tr>
- <td>port</td>
+ <td>authentication_private_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port number of the Bytebase instance. </p></td>
+ <td><p>PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required.
+Used for authentication when connecting to the data source. </p></td>
</tr>
<tr>
- <td>external_url</td>
+ <td>authentication_private_key_passphrase</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td>
+ <td><p>Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. </p></td>
</tr>
<tr>
- <td>need_admin_setup</td>
- <td><a href="#bool">bool</a></td>
+ <td>external_secret</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td>
<td></td>
- <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>last_active_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>authentication_type</td>
+ <td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td>
<td></td>
- <td><p>The last time any API call was made, refreshed on each request. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>workspace_id</td>
- <td><a href="#string">string</a></td>
+ <td>azure_credential</td>
+ <td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td>
<td></td>
- <td><p>The unique identifier for the workspace. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>debug</td>
- <td><a href="#bool">bool</a></td>
+ <td>aws_credential</td>
+ <td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</a></td>
<td></td>
- <td><p>Whether debug mode is enabled. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>unlicensed_features</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>List of features that are not licensed. </p></td>
+ <td>gcp_credential</td>
+ <td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>docker</td>
- <td><a href="#bool">bool</a></td>
+ <td>sasl_config</td>
+ <td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in Docker. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>user_stats</td>
- <td><a href="#bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</a></td>
+ <td>additional_addresses</td>
+ <td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td>
<td>repeated</td>
- <td><p>Statistics about users in the system. </p></td>
+ <td><p>additional_addresses is used for MongoDB replica set. </p></td>
</tr>
<tr>
- <td>activated_instance_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>direct_connection</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The number of activated database instances. </p></td>
+ <td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td>
</tr>
<tr>
- <td>total_instance_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>region</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The total number of database instances. </p></td>
+ <td><p>region is the location of where the DB is, works for AWS RDS. For example, us-east-1. </p></td>
</tr>
<tr>
- <td>enable_sample</td>
- <td><a href="#bool">bool</a></td>
+ <td>warehouse_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether sample data setup is enabled. </p></td>
+ <td><p>warehouse_id is used by Databricks. </p></td>
</tr>
<tr>
- <td>external_url_from_flag</td>
- <td><a href="#bool">bool</a></td>
+ <td>master_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </p></td>
+ <td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td>
</tr>
<tr>
- <td>announcement</td>
- <td><a href="#bytebase.v1.Announcement">Announcement</a></td>
+ <td>master_username</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The setting of custom announcement </p></td>
+ <td><p>master_username and master_password are master credentials used by redis sentinel mode. </p></td>
</tr>
<tr>
- <td>enable_metric_collection</td>
- <td><a href="#bool">bool</a></td>
+ <td>master_password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to enable metric collection for the workspace. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>restriction</td>
- <td><a href="#bytebase.v1.Restriction">Restriction</a></td>
+ <td>redis_type</td>
+ <td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>cluster</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td>
+ </tr>
+
+ <tr>
+ <td>extra_connection_parameters</td>
+ <td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>
+ <td>repeated</td>
+ <td><p>Extra connection parameters for the database connection.
+For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td>
+ </tr>
+
</tbody>
</table>
@@ -7680,8 +7587,8 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>
- <p>User statistics by type and state.</p>
+ <h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3>
+ <p></p>
<table class="field-table">
@@ -7691,24 +7598,40 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>user_type</td>
- <td><a href="#bytebase.v1.UserType">UserType</a></td>
+ <td>access_key_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of user. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>secret_access_key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The state of the user. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>count</td>
- <td><a href="#int32">int32</a></td>
+ <td>session_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The count of users matching this type and state. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>role_arn</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>ARN of IAM role to assume for cross-account access.
+See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td>
+ </tr>
+
+ <tr>
+ <td>external_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Optional external ID for additional security when assuming role.
+See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html </p></td>
</tr>
</tbody>
@@ -7718,29 +7641,108 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3>
- <p>Request message for deleting cache.</p>
+ <h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3>
+ <p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>host</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>port</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</h3>
- <p>Request message for getting actuator information.</p>
+ <h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</h3>
+ <p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>tenant_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>client_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</h3>
- <p>Request message for getting branding resources.</p>
+ <h3 id="bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3>
+ <p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.ResourcePackage">ResourcePackage</h3>
- <p>Custom branding resources for the Bytebase instance.</p>
+ <h3 id="bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</h3>
+ <p></p>
<table class="field-table">
@@ -7750,10 +7752,10 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>logo</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The branding logo. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7763,7 +7765,7 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.Restriction">Restriction</h3>
+ <h3 id="bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</h3>
<p></p>
@@ -7774,73 +7776,91 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>disallow_signup</td>
- <td><a href="#bool">bool</a></td>
+ <td>secret_type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td>
<td></td>
- <td><p>Whether self-service user signup is disabled. </p></td>
+ <td><p>The type of external secret store. </p></td>
</tr>
<tr>
- <td>require_2fa</td>
- <td><a href="#bool">bool</a></td>
+ <td>url</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether two-factor authentication is required for all users. </p></td>
+ <td><p>The URL of the external secret store. </p></td>
</tr>
<tr>
- <td>disallow_password_signin</td>
- <td><a href="#bool">bool</a></td>
+ <td>auth_type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td>
<td></td>
- <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td>
+ <td><p>The authentication method for accessing the secret store. </p></td>
</tr>
<tr>
- <td>password_restriction</td>
- <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>
+ <td>app_role</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td>
<td></td>
- <td><p>Password complexity and restriction requirements. </p></td>
+ <td><p>AppRole authentication configuration. </p></td>
</tr>
<tr>
- <td>watermark</td>
- <td><a href="#bool">bool</a></td>
+ <td>token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to display watermark on pages. </p></td>
+ <td><p>Token for direct authentication. </p></td>
</tr>
<tr>
- <td>database_change_mode</td>
- <td><a href="#bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</a></td>
+ <td>engine_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The workspace database change mode. </p></td>
+ <td><p>engine name is the name for secret engine. </p></td>
</tr>
<tr>
- <td>inactive_session_timeout</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>secret_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
+ <td><p>the secret name in the engine to store the password. </p></td>
</tr>
<tr>
- <td>domains</td>
+ <td>password_key_name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The workspace domain, e.g., bytebase.com. </p></td>
+ <td></td>
+ <td><p>the key name for the password. </p></td>
</tr>
<tr>
- <td>enforce_identity_domain</td>
+ <td>skip_vault_tls_verification</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Only user and group from the domains can be created and login. </p></td>
+ <td><p>TLS configuration for connecting to Vault server.
+These fields are separate from the database TLS configuration in DataSource.
+skip_vault_tls_verification disables TLS certificate verification for Vault connections.
+Default is false (verification enabled) for security.
+Only set to true for development or when certificates cannot be properly validated. </p></td>
</tr>
<tr>
- <td>maximum_role_expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>vault_ssl_ca</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The max duration for role expired. </p></td>
+ <td><p>CA certificate for Vault server verification. </p></td>
+ </tr>
+
+ <tr>
+ <td>vault_ssl_cert</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Client certificate for mutual TLS authentication with Vault. </p></td>
+ </tr>
+
+ <tr>
+ <td>vault_ssl_key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Client private key for mutual TLS authentication with Vault. </p></td>
</tr>
</tbody>
@@ -7850,15 +7870,8 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>
- <p>Request message for setting up sample data.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</h3>
- <p>Request message for updating actuator information.</p>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3>
+ <p></p>
<table class="field-table">
@@ -7868,25 +7881,31 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>actuator</td>
- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td>role_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The actuator to update. </p></td>
+ <td><p>The role ID for Vault AppRole authentication. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>secret_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>the secret id for the role without ttl. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td>
<td></td>
- <td><p>If set to true, and the actuator is not found, a new actuator will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The type of secret for AppRole authentication. </p></td>
+ </tr>
+
+ <tr>
+ <td>mount_path</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The path where the approle auth method is mounted. </p></td>
</tr>
</tbody>
@@ -7896,142 +7915,8 @@ In this situation, `update_mask` is ignored. </p></td>
-
-
-
-
-
-
- <h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>
- <p>ActuatorService manages system health and operational information.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetActuatorInfo</td>
- <td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td>
- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
- <td><p>Gets system information and health status of the Bytebase instance.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>UpdateActuatorInfo</td>
- <td><a href="#bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</a></td>
- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
- <td><p>Updates system configuration settings for the Bytebase instance.
-Permissions required: bb.settings.set</p></td>
- </tr>
-
- <tr>
- <td>SetupSample</td>
- <td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Sets up sample data for demonstration and testing purposes.
-Permissions required: bb.projects.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteCache</td>
- <td><a href="#bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Clears the system cache to force data refresh.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>GetResourcePackage</td>
- <td><a href="#bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</a></td>
- <td><a href="#bytebase.v1.ResourcePackage">ResourcePackage</a></td>
- <td><p>Gets custom branding resources such as logos.
-Permissions required: None</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>GetActuatorInfo</td>
- <td>GET</td>
- <td>/v1/actuator/info</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateActuatorInfo</td>
- <td>PATCH</td>
- <td>/v1/actuator/info</td>
- <td>actuator</td>
- </tr>
-
-
-
-
- <tr>
- <td>SetupSample</td>
- <td>POST</td>
- <td>/v1/actuator:setupSample</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteCache</td>
- <td>DELETE</td>
- <td>/v1/actuator/cache</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetResourcePackage</td>
- <td>GET</td>
- <td>/v1/actuator/resources</td>
- <td></td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/iam_policy.proto">v1/iam_policy.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.Binding">Binding</h3>
- <p>Binding associates members with a role and optional conditions.</p>
+ <h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</h3>
+ <p></p>
<table class="field-table">
@@ -8041,48 +7926,28 @@ Permissions required: None</p></td>
<tbody>
<tr>
- <td>role</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The role that is assigned to the members.
-Format: roles/{role} </p></td>
- </tr>
-
- <tr>
- <td>members</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Specifies the principals requesting access for a Bytebase resource.
-For users, the member should be: user:{email}
-For groups, the member should be: group:{email} </p></td>
+ <td><p>The name of the instance to delete.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>force</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The condition that is associated with this binding, only used in the project IAM policy.
-If the condition evaluates to true, then this binding applies to the current request.
-If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
-
-For example:
-resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;]
-resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;]
-request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
+ <td><p>If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. </p></td>
</tr>
<tr>
- <td>parsed_expr</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>purge</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The parsed expression of the condition. </p></td>
+ <td><p>If set to true, permanently purge the soft-deleted instance and all related resources.
+This operation is irreversible. Following AIP-165, this should only be used for
+administrative cleanup of old soft-deleted instances.
+The instance must already be soft-deleted for this to work. </p></td>
</tr>
</tbody>
@@ -8092,8 +7957,8 @@ request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
- <h3 id="bytebase.v1.BindingDelta">BindingDelta</h3>
- <p>A single change to a binding.</p>
+ <h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3>
+ <p></p>
<table class="field-table">
@@ -8103,32 +7968,11 @@ request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
<tbody>
<tr>
- <td>action</td>
- <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td>
- <td></td>
- <td><p>The action that was performed on a Binding. </p></td>
- </tr>
-
- <tr>
- <td>role</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Role that is assigned to `members`.
-For example, `roles/projectOwner`. </p></td>
- </tr>
-
- <tr>
- <td>member</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Follows the same format of Binding.members. </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this binding. </p></td>
+ <td><p>The name of the instance to retrieve.
+Format: instances/{instance} </p></td>
</tr>
</tbody>
@@ -8138,8 +7982,8 @@ For example, `roles/projectOwner`. </p></td>
- <h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3>
- <p>Request message for getting an IAM policy.</p>
+ <h3 id="bytebase.v1.Instance">Instance</h3>
+ <p></p>
<table class="field-table">
@@ -8149,110 +7993,105 @@ For example, `roles/projectOwner`. </p></td>
<tbody>
<tr>
- <td>resource</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the resource to get the IAM policy.
-Format: projects/{project}
-Format: workspaces/{workspace} </p></td>
+ <td><p>The name of the instance.
+Format: instances/{instance} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>
- <p>IAM policy that binds members to roles.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>bindings</td>
- <td><a href="#bytebase.v1.Binding">Binding</a></td>
- <td>repeated</td>
- <td><p>Collection of binding.
-A binding binds one or more project members to a single project role. </p></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
+ <td></td>
+ <td><p>The lifecycle state of the instance. </p></td>
</tr>
<tr>
- <td>etag</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The current etag of the policy.
-If an etag is provided and does not match the current etag of the policy,
-the call will be blocked and an ABORTED error will be returned. </p></td>
+ <td><p>The display title of the instance. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>
- <p>Describes changes between two IAM policies.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>binding_deltas</td>
- <td><a href="#bytebase.v1.BindingDelta">BindingDelta</a></td>
- <td>repeated</td>
- <td><p>The delta for Bindings between two policies. </p></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td></td>
+ <td><p>The database engine type. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>
- <p>Request message for setting an IAM policy.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>engine_version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The version of the database engine. </p></td>
+ </tr>
<tr>
- <td>resource</td>
+ <td>external_link</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the resource to set the IAM policy.
-Format: projects/{project}
-Format: workspaces/{workspace} </p></td>
+ <td><p>External URL to the database instance console. </p></td>
</tr>
<tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
+ <td>data_sources</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>repeated</td>
+ <td><p>Data source configurations for connecting to the instance. </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>activation</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether the instance is activated for use. </p></td>
</tr>
<tr>
- <td>etag</td>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
+ <td>repeated</td>
+ <td><p>Database roles available in this instance. </p></td>
+ </tr>
+
+ <tr>
+ <td>sync_interval</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>How often the instance is synced. </p></td>
+ </tr>
+
+ <tr>
+ <td>sync_databases</td>
<td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Enable sync for following databases.
+Default empty, means sync all schemas &amp; databases. </p></td>
+ </tr>
+
+ <tr>
+ <td>last_sync_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The current etag of the policy. </p></td>
+ <td><p>The last time the instance was synced. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels are key-value pairs that can be attached to the instance.
+For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } </p></td>
</tr>
</tbody>
@@ -8262,51 +8101,8 @@ Format: workspaces/{workspace} </p></td>
-
-
- <h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3>
- <p>Type of action performed on a binding.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ACTION_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified action.</p></td>
- </tr>
-
- <tr>
- <td>ADD</td>
- <td>1</td>
- <td><p>Add a binding.</p></td>
- </tr>
-
- <tr>
- <td>REMOVE</td>
- <td>2</td>
- <td><p>Remove a binding.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/audit_log_service.proto">v1/audit_log_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.AuditData">AuditData</h3>
- <p>Additional audit data specific to certain operations.</p>
+ <h3 id="bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -8316,10 +8112,17 @@ Format: workspaces/{workspace} </p></td>
<tbody>
<tr>
- <td>policy_delta</td>
- <td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Changes to IAM policies. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -8329,8 +8132,8 @@ Format: workspaces/{workspace} </p></td>
- <h3 id="bytebase.v1.AuditLog">AuditLog</h3>
- <p>Audit log entry recording system activity or API call.</p>
+ <h3 id="bytebase.v1.InstanceResource">InstanceResource</h3>
+ <p></p>
<table class="field-table">
@@ -8340,93 +8143,54 @@ Format: workspaces/{workspace} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the log.
-Formats:
-- projects/{project}/auditLogs/{uid}
-- workspaces/{workspace}/auditLogs/{uid} </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The timestamp when the audit log was created. </p></td>
+ <td><p>The display title of the instance. </p></td>
</tr>
<tr>
- <td>user</td>
- <td><a href="#string">string</a></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
<td></td>
- <td><p>The user who performed the action.
-Format: users/{email} </p></td>
+ <td><p>The database engine type. </p></td>
</tr>
<tr>
- <td>method</td>
+ <td>engine_version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The method or action being audited.
-For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></td>
+ <td><p>The version of the database engine. </p></td>
</tr>
<tr>
- <td>severity</td>
- <td><a href="#bytebase.v1.AuditLog.Severity">AuditLog.Severity</a></td>
- <td></td>
- <td><p>The severity level of this audit log entry. </p></td>
+ <td>data_sources</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>repeated</td>
+ <td><p>Data source configurations for the instance. </p></td>
</tr>
<tr>
- <td>resource</td>
- <td><a href="#string">string</a></td>
+ <td>activation</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The resource associated with this audit log. </p></td>
+ <td><p>Whether the instance is activated. </p></td>
</tr>
<tr>
- <td>request</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The request payload in JSON format. </p></td>
+ <td><p>The name of the instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>response</td>
+ <td>environment</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The response payload in JSON format.
-Some fields may be omitted if they are too large or contain sensitive information. </p></td>
- </tr>
-
- <tr>
- <td>status</td>
- <td><a href="#google.rpc.Status">google.rpc.Status</a></td>
- <td></td>
- <td><p>The status of the operation. </p></td>
- </tr>
-
- <tr>
- <td>latency</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The duration of the operation. </p></td>
- </tr>
-
- <tr>
- <td>service_data</td>
- <td><a href="#google.protobuf.Any">google.protobuf.Any</a></td>
- <td></td>
- <td><p>Service-specific metadata about the request, response, and activities. </p></td>
- </tr>
-
- <tr>
- <td>request_metadata</td>
- <td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td>
- <td></td>
- <td><p>Metadata about the request context. </p></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
</tr>
</tbody>
@@ -8436,8 +8200,8 @@ Some fields may be omitted if they are too large or contain sensitive informatio
- <h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>
- <p>Request message for exporting audit logs.</p>
+ <h3 id="bytebase.v1.KerberosConfig">KerberosConfig</h3>
+ <p></p>
<table class="field-table">
@@ -8447,54 +8211,52 @@ Some fields may be omitted if they are too large or contain sensitive informatio
<tbody>
<tr>
- <td>parent</td>
+ <td>primary</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The primary component of the Kerberos principal. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>instance</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The filter of the log. It should be a valid CEL expression.
-Check the filter field in the SearchAuditLogsRequest message. </p></td>
+ <td><p>The instance component of the Kerberos principal. </p></td>
</tr>
<tr>
- <td>order_by</td>
+ <td>realm</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The order by of the log.
-Only support order by create_time. The default sorting order is ascending.
-For example:
- - order_by = &#34;create_time asc&#34;
- - order_by = &#34;create_time desc&#34; </p></td>
+ <td><p>The Kerberos realm. </p></td>
</tr>
<tr>
- <td>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td>keytab</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The export format. </p></td>
+ <td><p>The keytab file contents for authentication. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>kdc_host</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of logs to return.
-The service may return fewer than this value.
-If unspecified, at most 10 log entries will be returned.
-The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ <td><p>The hostname of the Key Distribution Center (KDC). </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>kdc_port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ExportAuditLogs` call.
-Provide this to retrieve the subsequent page. </p></td>
+ <td><p>The port of the Key Distribution Center (KDC). </p></td>
+ </tr>
+
+ <tr>
+ <td>kdc_transport_protocol</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The transport protocol for KDC communication (tcp or udp). </p></td>
</tr>
</tbody>
@@ -8504,8 +8266,8 @@ Provide this to retrieve the subsequent page. </p></td>
- <h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>
- <p>Response message for exporting audit logs.</p>
+ <h3 id="bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</h3>
+ <p></p>
<table class="field-table">
@@ -8515,19 +8277,18 @@ Provide this to retrieve the subsequent page. </p></td>
<tbody>
<tr>
- <td>content</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The exported audit log content in the requested format. </p></td>
+ <td><p>The name of the instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token to retrieve next page of log entities.
-Pass this value in the page_token field in the subsequent call
-to retrieve the next page of log entities. </p></td>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>optional</td>
+ <td><p>The target instance. We need to set this field if the target instance is not created yet. </p></td>
</tr>
</tbody>
@@ -8537,8 +8298,8 @@ to retrieve the next page of log entities. </p></td>
- <h3 id="bytebase.v1.RequestMetadata">RequestMetadata</h3>
- <p>Metadata about the incoming request.</p>
+ <h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3>
+ <p></p>
<table class="field-table">
@@ -8548,18 +8309,10 @@ to retrieve the next page of log entities. </p></td>
<tbody>
<tr>
- <td>caller_ip</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The IP address of the request originator. </p></td>
- </tr>
-
- <tr>
- <td>caller_supplied_user_agent</td>
+ <td>databases</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The user agent string provided by the caller.
-This is supplied by the client and is not authenticated. </p></td>
+ <td>repeated</td>
+ <td><p>All database name list in the instance. </p></td>
</tr>
</tbody>
@@ -8569,8 +8322,8 @@ This is supplied by the client and is not authenticated. </p></td>
- <h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>
- <p>Request message for searching audit logs.</p>
+ <h3 id="bytebase.v1.ListInstancesRequest">ListInstancesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -8580,59 +8333,149 @@ This is supplied by the client and is not authenticated. </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of instances to return. The service may return fewer than
+this value.
+If unspecified, at most 10 instances will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A page token, received from a previous `ListInstances` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListInstances` must match
+the call that provided the page token. </p></td>
+ </tr>
+
+ <tr>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Show deleted instances if specified. </p></td>
</tr>
<tr>
<td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The filter of the log. It should be a valid CEL expression.
+ <td><p>Filter the instance.
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-Supported filter:
-- method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator.
-- severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values.
-- user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator.
-- create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
+Supported filters:
+- name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
+- state: the instance state, check State enum for values, support &#34;==&#34; operator.
+- engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
For example:
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34;
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34;
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34;
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; </p></td>
+name == &#34;sample instance&#34;
+name.matches(&#34;sample&#34;)
+resource_id == &#34;sample-instance&#34;
+resource_id.matches(&#34;sample&#34;)
+state == &#34;DELETED&#34;
+environment == &#34;environments/test&#34;
+environment == &#34;&#34; (find instances which environment is not set)
+engine == &#34;MYSQL&#34;
+engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
+!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
+host == &#34;127.0.0.1&#34;
+host.matches(&#34;127.0&#34;)
+port == &#34;54321&#34;
+port.matches(&#34;543&#34;)
+labels.org_group == &#34;infrastructure&#34;
+labels.environment in [&#34;prod&#34;, &#34;production&#34;]
+project == &#34;projects/sample-project&#34;
+You can combine filter conditions like:
+name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34;
+host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; </p></td>
</tr>
<tr>
<td>order_by</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The order by of the log.
-Only support order by create_time. The default sorting order is ascending.
+ <td><p>The order by of instances.
+Support title, environment. The default sorting order is ascending.
For example:
- - order_by = &#34;create_time asc&#34;
- - order_by = &#34;create_time desc&#34; </p></td>
+- order_by = &#34;title&#34;
+- order_by = &#34;title desc&#34;
+- order_by = &#34;title desc, environment asc&#34; </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>instances</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>repeated</td>
+ <td><p>The instances from the specified request. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of logs to return.
-The service may return fewer than this value.
-If unspecified, at most 10 log entries will be returned.
-The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>page_token</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchLogs` call.
-Provide this to retrieve the subsequent page. </p></td>
+ <td><p>The name of the instance to remove a data source from.
+Format: instances/{instance} </p></td>
+ </tr>
+
+ <tr>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td></td>
+ <td><p>Identified by data source ID.
+Only READ_ONLY data source can be removed. </p></td>
</tr>
</tbody>
@@ -8642,8 +8485,8 @@ Provide this to retrieve the subsequent page. </p></td>
- <h3 id="bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</h3>
- <p>Response message for searching audit logs.</p>
+ <h3 id="bytebase.v1.SASLConfig">SASLConfig</h3>
+ <p></p>
<table class="field-table">
@@ -8653,19 +8496,43 @@ Provide this to retrieve the subsequent page. </p></td>
<tbody>
<tr>
- <td>audit_logs</td>
- <td><a href="#bytebase.v1.AuditLog">AuditLog</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>krb_config</td>
+ <td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td>
+ <td></td>
+ <td><p>Kerberos authentication configuration. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>next_page_token</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token to retrieve next page of log entities.
-Pass this value in the page_token field in the subsequent call
-to retrieve the next page of log entities. </p></td>
+ <td><p>The name of instance.
+Format: instances/{instance} </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_full_sync</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only
+the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td>
</tr>
</tbody>
@@ -8675,167 +8542,8 @@ to retrieve the next page of log entities. </p></td>
-
-
- <h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>
- <p>Severity level for audit log entries.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SEVERITY_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified severity level.</p></td>
- </tr>
-
- <tr>
- <td>DEBUG</td>
- <td>1</td>
- <td><p>Debug-level information.</p></td>
- </tr>
-
- <tr>
- <td>INFO</td>
- <td>2</td>
- <td><p>Informational messages.</p></td>
- </tr>
-
- <tr>
- <td>NOTICE</td>
- <td>3</td>
- <td><p>Notable events.</p></td>
- </tr>
-
- <tr>
- <td>WARNING</td>
- <td>4</td>
- <td><p>Warning conditions.</p></td>
- </tr>
-
- <tr>
- <td>ERROR</td>
- <td>5</td>
- <td><p>Error conditions.</p></td>
- </tr>
-
- <tr>
- <td>CRITICAL</td>
- <td>6</td>
- <td><p>Critical conditions.</p></td>
- </tr>
-
- <tr>
- <td>ALERT</td>
- <td>7</td>
- <td><p>Action must be taken immediately.</p></td>
- </tr>
-
- <tr>
- <td>EMERGENCY</td>
- <td>8</td>
- <td><p>System is unusable.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AuditLogService">AuditLogService</h3>
- <p>AuditLogService manages audit logs for system activities and API calls.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SearchAuditLogs</td>
- <td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td>
- <td><a href="#bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</a></td>
- <td><p>Searches audit logs with optional filtering and pagination.
-Permissions required: bb.auditLogs.search</p></td>
- </tr>
-
- <tr>
- <td>ExportAuditLogs</td>
- <td><a href="#bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</a></td>
- <td><a href="#bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</a></td>
- <td><p>Exports audit logs in a specified format for external analysis.
-Permissions required: bb.auditLogs.export</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>SearchAuditLogs</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/auditLogs:search</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>SearchAuditLogs</td>
- <td>POST</td>
- <td>/v1/auditLogs:search</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ExportAuditLogs</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/auditLogs:export</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>ExportAuditLogs</td>
- <td>POST</td>
- <td>/v1/auditLogs:export</td>
- <td>*</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/auth_service.proto">v1/auth_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3>
+ <p></p>
<table class="field-table">
@@ -8845,18 +8553,10 @@ Permissions required: bb.auditLogs.export</p></td>
<tbody>
<tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>External OIDC token (JWT) from CI/CD platform. </p></td>
- </tr>
-
- <tr>
- <td>email</td>
+ <td>databases</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Workload Identity email for identifying which identity to authenticate as.
-Format: {name}@workload.bytebase.com </p></td>
+ <td>repeated</td>
+ <td><p>All database name list in the instance. </p></td>
</tr>
</tbody>
@@ -8866,7 +8566,7 @@ Format: {name}@workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</h3>
+ <h3 id="bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</h3>
<p></p>
@@ -8877,10 +8577,11 @@ Format: {name}@workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>access_token</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Bytebase access token. </p></td>
+ <td><p>The name of the deleted instance.
+Format: instances/{instance} </p></td>
</tr>
</tbody>
@@ -8890,8 +8591,8 @@ Format: {name}@workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>
- <p>Context for identity provider authentication.</p>
+ <h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</h3>
+ <p></p>
<table class="field-table">
@@ -8901,17 +8602,40 @@ Format: {name}@workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>oauth2_context</td>
- <td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>OAuth2 authentication context. </p></td>
+ <td><p>The name of the instance to update a data source.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>oidc_context</td>
- <td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
<td></td>
- <td><p>OpenID Connect authentication context. </p></td>
+ <td><p>Identified by data source ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the data source is not found, a new data source will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -8921,7 +8645,7 @@ Format: {name}@workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.LoginRequest">LoginRequest</h3>
+ <h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</h3>
<p></p>
@@ -8932,162 +8656,28 @@ Format: {name}@workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>email</td>
- <td><a href="#string">string</a></td>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
<td></td>
- <td><p>User&#39;s email address. </p></td>
+ <td><p>The instance to update.
+
+The instance&#39;s `name` field is used to identify the instance to update.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>password</td>
- <td><a href="#string">string</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>User&#39;s password for authentication. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>web</td>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If true, sets access token and refresh token as HTTP-only cookies instead of
-returning the token in the response body. Use for browser-based clients. </p></td>
- </tr>
-
- <tr>
- <td>idp_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the identity provider.
-Format: idps/{idp} </p></td>
- </tr>
-
- <tr>
- <td>idp_context</td>
- <td><a href="#bytebase.v1.IdentityProviderContext">IdentityProviderContext</a></td>
- <td></td>
- <td><p>The idp_context is used to get the user information from identity provider. </p></td>
- </tr>
-
- <tr>
- <td>otp_code</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
- </tr>
-
- <tr>
- <td>recovery_code</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The recovery_code is used to recovery the user&#39;s identity with MFA. </p></td>
- </tr>
-
- <tr>
- <td>mfa_temp_token</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The mfa_temp_token is used to verify the user&#39;s identity by MFA. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.LoginResponse">LoginResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Access token for authenticated requests.
-Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. </p></td>
- </tr>
-
- <tr>
- <td>mfa_temp_token</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Temporary token for MFA verification. </p></td>
- </tr>
-
- <tr>
- <td>require_reset_password</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether user must reset password before continuing. </p></td>
- </tr>
-
- <tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td></td>
- <td><p>The user from the successful login. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.LogoutRequest">LogoutRequest</h3>
- <p>Request to logout current user session.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</h3>
- <p>OAuth2 authentication context.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>code</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Authorization code from OAuth2 provider. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3>
- <p>OpenID Connect authentication context.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>code</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Authorization code from OIDC provider. </p></td>
+ <td><p>If set to true, and the instance is not found, a new instance will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -9097,455 +8687,490 @@ Only returned when web=false. For web=true, the token is set as an HTTP-only coo
- <h3 id="bytebase.v1.RefreshRequest">RefreshRequest</h3>
- <p>Request to refresh the access token.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.RefreshResponse">RefreshResponse</h3>
- <p>Response from refreshing the access token.</p>
-
-
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.AuthService">AuthService</h3>
- <p>AuthService handles user authentication operations.</p>
+ <h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>Login</td>
- <td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td>
- <td><a href="#bytebase.v1.LoginResponse">LoginResponse</a></td>
- <td><p>Authenticates a user and returns access tokens.
-Permissions required: None</p></td>
+ <td>AUTHENTICATION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>Logout</td>
- <td><a href="#bytebase.v1.LogoutRequest">LogoutRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Logs out the current user session.
-Permissions required: None</p></td>
+ <td>PASSWORD</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ExchangeToken</td>
- <td><a href="#bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</a></td>
- <td><a href="#bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</a></td>
- <td><p>Exchanges an external OIDC token for a Bytebase access token.
-Used by CI/CD pipelines with Workload Identity Federation.
-Permissions required: None (validates via OIDC token)</p></td>
+ <td>GOOGLE_CLOUD_SQL_IAM</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>Refresh</td>
- <td><a href="#bytebase.v1.RefreshRequest">RefreshRequest</a></td>
- <td><a href="#bytebase.v1.RefreshResponse">RefreshResponse</a></td>
- <td><p>Refreshes the access token using the refresh token cookie.
-Permissions required: None (validates via refresh token cookie)</p></td>
+ <td>AWS_RDS_IAM</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>AZURE_IAM</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
- </thead>
- <tbody>
-
-
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.DataSource.RedisType">DataSource.RedisType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>Login</td>
- <td>POST</td>
- <td>/v1/auth/login</td>
- <td>*</td>
+ <td>REDIS_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>Logout</td>
- <td>POST</td>
- <td>/v1/auth/logout</td>
- <td>*</td>
+ <td>STANDALONE</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>ExchangeToken</td>
- <td>POST</td>
- <td>/v1/auth:exchangeToken</td>
- <td>*</td>
+ <td>SENTINEL</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>Refresh</td>
- <td>POST</td>
- <td>/v1/auth/refresh</td>
- <td>*</td>
+ <td>CLUSTER</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>
- <p>Request message for batch deparsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
- <td>repeated</td>
- <td><p>The CEL expression ASTs to deparse. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>
- <p>Response message for batch deparsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The deparsed CEL expressions as strings. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>
- <p>Request message for batch parsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The CEL expression strings to parse. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>
- <p>Response message for batch parsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
- <td>repeated</td>
- <td><p>The parsed CEL expressions as AST. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
+ </tbody>
+ </table>
-
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SECRET_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified secret type.</p></td>
+ </tr>
+
+ <tr>
+ <td>PLAIN</td>
+ <td>1</td>
+ <td><p>Plain text secret.</p></td>
+ </tr>
+
+ <tr>
+ <td>ENVIRONMENT</td>
+ <td>2</td>
+ <td><p>Secret from environment variable.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>AUTH_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified authentication type.</p></td>
+ </tr>
+
+ <tr>
+ <td>TOKEN</td>
+ <td>1</td>
+ <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td>
+ </tr>
+
+ <tr>
+ <td>VAULT_APP_ROLE</td>
+ <td>2</td>
+ <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/approle</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.CelService">CelService</h3>
- <p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>BatchParse</td>
- <td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td>
- <td><a href="#bytebase.v1.BatchParseResponse">BatchParseResponse</a></td>
- <td><p>Parses multiple CEL expression strings into AST representations.
-Permissions required: None</p></td>
+ <td>SECRET_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified secret type.</p></td>
</tr>
<tr>
- <td>BatchDeparse</td>
- <td><a href="#bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</a></td>
- <td><a href="#bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</a></td>
- <td><p>Converts multiple CEL AST representations back into expression strings.
-Permissions required: None</p></td>
+ <td>VAULT_KV_V2</td>
+ <td>1</td>
+ <td><p>ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2</p></td>
+ </tr>
+
+ <tr>
+ <td>AWS_SECRETS_MANAGER</td>
+ <td>2</td>
+ <td><p>ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</p></td>
+ </tr>
+
+ <tr>
+ <td>GCP_SECRET_MANAGER</td>
+ <td>3</td>
+ <td><p>ref: https://cloud.google.com/secret-manager/docs</p></td>
+ </tr>
+
+ <tr>
+ <td>AZURE_KEY_VAULT</td>
+ <td>4</td>
+ <td><p>ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets</p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
+
+ <h3 id="bytebase.v1.DataSourceType">DataSourceType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>DATA_SOURCE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified data source type.</p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>BatchParse</td>
- <td>POST</td>
- <td>/v1/cel/batchParse</td>
- <td>*</td>
+ <td>ADMIN</td>
+ <td>1</td>
+ <td><p>Admin data source with write permissions.</p></td>
</tr>
-
-
-
<tr>
- <td>BatchDeparse</td>
- <td>POST</td>
- <td>/v1/cel/batchDeparse</td>
- <td>*</td>
+ <td>READ_ONLY</td>
+ <td>2</td>
+ <td><p>Read-only data source for query operations.</p></td>
</tr>
-
- </tbody>
- </table>
-
-
-
+ </tbody>
+ </table>
- <div class="file-heading">
- <h2 id="v1/database_catalog_service.proto">v1/database_catalog_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
- <h3 id="bytebase.v1.ColumnCatalog">ColumnCatalog</h3>
- <p>Column metadata within a table.</p>
+
+
+ <h3 id="bytebase.v1.InstanceService">InstanceService</h3>
+ <p>InstanceService manages database instances and their connections.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetInstance</td>
+ <td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Gets a database instance by name.
+Permissions required: bb.instances.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListInstances</td>
+ <td><a href="#bytebase.v1.ListInstancesRequest">ListInstancesRequest</a></td>
+ <td><a href="#bytebase.v1.ListInstancesResponse">ListInstancesResponse</a></td>
+ <td><p>Lists all database instances.
+Permissions required: bb.instances.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateInstance</td>
+ <td><a href="#bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Creates a new database instance.
+Permissions required: bb.instances.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateInstance</td>
+ <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Updates a database instance.
+Permissions required: bb.instances.update</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteInstance</td>
+ <td><a href="#bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes or soft-deletes a database instance.
+Permissions required: bb.instances.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>UndeleteInstance</td>
+ <td><a href="#bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Restores a soft-deleted database instance.
+Permissions required: bb.instances.undelete</p></td>
+ </tr>
+
+ <tr>
+ <td>SyncInstance</td>
+ <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</a></td>
+ <td><p>Syncs database schemas and metadata from an instance.
+Permissions required: bb.instances.sync</p></td>
+ </tr>
+
+ <tr>
+ <td>ListInstanceDatabase</td>
+ <td><a href="#bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</a></td>
+ <td><a href="#bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</a></td>
+ <td><p>Lists all databases within an instance without creating them.
+Permissions required: bb.instances.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchSyncInstances</td>
+ <td><a href="#bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</a></td>
+ <td><p>Syncs multiple instances in a single request.
+Permissions required: bb.instances.sync</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchUpdateInstances</td>
+ <td><a href="#bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</a></td>
+ <td><p>Updates multiple instances in a single request.
+Permissions required: bb.instances.update</p></td>
+ </tr>
+
+ <tr>
+ <td>AddDataSource</td>
+ <td><a href="#bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Adds a read-only data source to an instance.
+Permissions required: bb.instances.update</p></td>
+ </tr>
+
+ <tr>
+ <td>RemoveDataSource</td>
+ <td><a href="#bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Removes a read-only data source from an instance.
+Permissions required: bb.instances.update</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateDataSource</td>
+ <td><a href="#bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Updates a data source configuration.
+Permissions required: bb.instances.update</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The column name. </p></td>
- </tr>
- <tr>
- <td>semantic_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The semantic type describing the data purpose. </p></td>
- </tr>
+ <tr>
+ <td>GetInstance</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>User-defined labels for this column. </p></td>
- </tr>
+
- <tr>
- <td>classification</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The data classification level for this column. </p></td>
- </tr>
- <tr>
- <td>object_schema</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
- <td>optional</td>
- <td><p>Object schema for complex column types like JSON. </p></td>
- </tr>
+ <tr>
+ <td>ListInstances</td>
+ <td>GET</td>
+ <td>/v1/instances</td>
+ <td></td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>CreateInstance</td>
+ <td>POST</td>
+ <td>/v1/instances</td>
+ <td>instance</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3>
- <p>Catalog metadata for a database including schemas, tables, and columns.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database catalog.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
- </tr>
- <tr>
- <td>schemas</td>
- <td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td>
- <td>repeated</td>
- <td><p>The schemas in the database. </p></td>
- </tr>
+ <tr>
+ <td>UpdateInstance</td>
+ <td>PATCH</td>
+ <td>/v1/{instance.name=instances/*}</td>
+ <td>instance</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3>
- <p>Request message for getting a database catalog.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database catalog to retrieve.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
- </tr>
+ <tr>
+ <td>DeleteInstance</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UndeleteInstance</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:undelete</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>SyncInstance</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:sync</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListInstanceDatabase</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:databases</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchSyncInstances</td>
+ <td>POST</td>
+ <td>/v1/instances:batchSync</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchUpdateInstances</td>
+ <td>POST</td>
+ <td>/v1/instances:batchUpdate</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>AddDataSource</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:addDataSource</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>RemoveDataSource</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:removeDataSource</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateDataSource</td>
+ <td>PATCH</td>
+ <td>/v1/{name=instances/*}:updateDataSource</td>
+ <td>data_source</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3>
- <p>Schema definition for object-type columns.</p>
+ <div class="file-heading">
+ <h2 id="v1/database_service.proto">v1/database_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -9555,31 +9180,20 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</a></td>
- <td></td>
- <td><p>The data type of this object. </p></td>
- </tr>
-
- <tr>
- <td>struct_kind</td>
- <td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td>
- <td></td>
- <td><p>Struct schema. </p></td>
- </tr>
-
- <tr>
- <td>array_kind</td>
- <td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Array schema. </p></td>
+ <td><p>The parent resource shared by all databases being retrieved.
+- projects/{project}: batch get databases in a project;
+- instances/{instances}: batch get databases in a instance;
+Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
</tr>
<tr>
- <td>semantic_type</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The semantic type of this object. </p></td>
+ <td>repeated</td>
+ <td><p>The list of database names to retrieve. </p></td>
</tr>
</tbody>
@@ -9589,8 +9203,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>
- <p>Array type with element schema.</p>
+ <h3 id="bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -9600,10 +9214,10 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>kind</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
- <td></td>
- <td><p>The schema of array elements. </p></td>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>repeated</td>
+ <td><p>The databases from the specified request. </p></td>
</tr>
</tbody>
@@ -9613,8 +9227,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3>
- <p>Structure type with named properties.</p>
+ <h3 id="bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -9624,10 +9238,19 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>properties</td>
- <td><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource shared by all databases being updated.
+Format: instances/{instance}
+If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></td>
+ </tr>
+
+ <tr>
+ <td>names</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>Properties of the struct. </p></td>
+ <td><p>The list of database names to sync. </p></td>
</tr>
</tbody>
@@ -9637,7 +9260,14 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3>
+ <h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3>
<p></p>
@@ -9648,17 +9278,21 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>key</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent resource shared by all databases being updated.
+Format: instances/{instance}
+If the operation spans parents, a dash (-) may be accepted as a wildcard.
+We only support updating the project of databases for now. </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the resources to update.
+A maximum of 1000 databases can be modified in a batch. </p></td>
</tr>
</tbody>
@@ -9668,8 +9302,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3>
- <p>Schema metadata within a database.</p>
+ <h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -9679,17 +9313,10 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema name. </p></td>
- </tr>
-
- <tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
<td>repeated</td>
- <td><p>The tables in the schema. </p></td>
+ <td><p>Databases updated. </p></td>
</tr>
</tbody>
@@ -9699,8 +9326,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>
- <p>Table metadata within a schema.</p>
+ <h3 id="bytebase.v1.BoundingBox">BoundingBox</h3>
+ <p>BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.</p>
<table class="field-table">
@@ -9710,31 +9337,31 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>xmin</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>The table name. </p></td>
+ <td><p>Minimum X coordinate </p></td>
</tr>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td>
+ <td>ymin</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>Regular table columns. </p></td>
+ <td><p>Minimum Y coordinate </p></td>
</tr>
<tr>
- <td>object_schema</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>xmax</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>Object schema for JSON/XML columns. </p></td>
+ <td><p>Maximum X coordinate </p></td>
</tr>
<tr>
- <td>classification</td>
- <td><a href="#string">string</a></td>
+ <td>ymax</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>The data classification level for this table. </p></td>
+ <td><p>Maximum Y coordinate </p></td>
</tr>
</tbody>
@@ -9744,8 +9371,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>
- <p>Column list for regular tables.</p>
+ <h3 id="bytebase.v1.Changelog">Changelog</h3>
+ <p></p>
<table class="field-table">
@@ -9755,222 +9382,60 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td>
- <td>repeated</td>
- <td><p>The columns in the table. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3>
- <p>Request message for updating a database catalog.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>catalog</td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The database catalog to update.
-
-The catalog&#39;s `name` field is used to identify the database catalog to update.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td>
<td></td>
- <td><p>If set to true, and the database catalog is not found, a new database catalog will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3>
- <p>Object schema data types.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>STRING</td>
- <td>1</td>
- <td><p>String type.</p></td>
- </tr>
-
- <tr>
- <td>NUMBER</td>
- <td>2</td>
- <td><p>Number type.</p></td>
- </tr>
-
- <tr>
- <td>BOOLEAN</td>
- <td>3</td>
- <td><p>Boolean type.</p></td>
- </tr>
-
- <tr>
- <td>OBJECT</td>
- <td>4</td>
- <td><p>Object/struct type.</p></td>
- </tr>
-
- <tr>
- <td>ARRAY</td>
- <td>5</td>
- <td><p>Array type.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3>
- <p>DatabaseCatalogService manages database schema metadata and classification.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetDatabaseCatalog</td>
- <td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
- <td><p>Gets the catalog metadata for a database.
-Permissions required: bb.databaseCatalogs.get</p></td>
- </tr>
-
- <tr>
- <td>UpdateDatabaseCatalog</td>
- <td><a href="#bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
- <td><p>Updates catalog metadata such as classifications and labels.
-Permissions required: bb.databaseCatalogs.update</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>GetDatabaseCatalog</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/catalog}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateDatabaseCatalog</td>
- <td>PATCH</td>
- <td>/v1/{catalog.name=instances/*/databases/*/catalog}</td>
- <td>catalog</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/database_group_service.proto">v1/database_group_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</h3>
- <p>Request message for creating a database group.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>parent</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource where this database group will be created.
-Format: projects/{project} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>database_group</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td>schema_size</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The database group to create. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>database_group_id</td>
+ <td>task_run</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The ID to use for the database group, which will become the final component of
-the database group&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
<tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>plan_title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set, validate the create request and preview the full database group response, but do not actually create it. </p></td>
+ <td><p>The title of the plan associated with this changelog&#39;s task run.
+This field is populated by deriving the plan from task_run for display purposes. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Changelog.Type">Changelog.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -9980,8 +9445,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>
- <p>A group of databases matched by expressions.</p>
+ <h3 id="bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</h3>
+ <p>CheckConstraintMetadata is the metadata for check constraints.</p>
<table class="field-table">
@@ -9994,41 +9459,14 @@ are /[a-z][0-9]-/. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database group.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>The name is the name of a check constraint. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>expression</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The short name used in actual databases specified by users. </p></td>
- </tr>
-
- <tr>
- <td>database_expr</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this database group.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations.
-resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
-resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
-resource.database_labels: the database labels. Support map access operations.
-All variables should join with &#34;&amp;&amp;&#34; condition.
-
-For example:
-resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;)
-resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
- </tr>
-
- <tr>
- <td>matched_databases</td>
- <td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td>
- <td>repeated</td>
- <td><p>The list of databases that match the database group condition. </p></td>
+ <td><p>The expression is the expression of a check constraint. </p></td>
</tr>
</tbody>
@@ -10038,8 +9476,8 @@ resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
- <h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3>
- <p>A database within a database group.</p>
+ <h3 id="bytebase.v1.ColumnMetadata">ColumnMetadata</h3>
+ <p>ColumnMetadata is the metadata for columns.</p>
<table class="field-table">
@@ -10052,33 +9490,141 @@ resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the database.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The name is the name of a column. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3>
- <p>Request message for deleting a database group.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>position</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The position is the position in columns. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>has_default</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>default</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database group to delete.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>The default value of column. </p></td>
+ </tr>
+
+ <tr>
+ <td>default_on_null</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Oracle specific metadata.
+The default_on_null is the default on null of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>on_update</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The on_update is the on update action of a column.
+For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with
+CURRENT_TIMESTAMP as on update value. </p></td>
+ </tr>
+
+ <tr>
+ <td>nullable</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>The nullable is the nullable of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The type is the type of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character_set is the character_set of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>generation</td>
+ <td><a href="#bytebase.v1.GenerationMetadata">GenerationMetadata</a></td>
+ <td></td>
+ <td><p>The generation is the generation of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>is_identity</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>identity_generation</td>
+ <td><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td>
+ <td></td>
+ <td><p>The identity_generation is for identity columns, PG only. </p></td>
+ </tr>
+
+ <tr>
+ <td>identity_seed</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The identity_seed is for identity columns, MSSQL only. </p></td>
+ </tr>
+
+ <tr>
+ <td>identity_increment</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The identity_increment is for identity columns, MSSQL only. </p></td>
+ </tr>
+
+ <tr>
+ <td>default_constraint_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The default_constraint_name is the name of the default constraint, MSSQL only.
+In MSSQL, default values are implemented as named constraints. When modifying or
+dropping a column&#39;s default value, you must reference the constraint by name.
+This field stores the actual constraint name from the database.
+
+Example: A column definition like:
+ CREATE TABLE employees (
+ status NVARCHAR(20) DEFAULT &#39;active&#39;
+ )
+
+Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39;
+or a user-defined name if specified:
+ ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
+
+To modify the default, you must first drop the existing constraint by name:
+ ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760
+ ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
+
+This field is populated when syncing from the database. When empty (e.g., when parsing
+from SQL files), the system cannot automatically drop the constraint. </p></td>
</tr>
</tbody>
@@ -10088,8 +9634,8 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- <h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3>
- <p>Request message for getting a database group.</p>
+ <h3 id="bytebase.v1.Database">Database</h3>
+ <p></p>
<table class="field-table">
@@ -10102,15 +9648,83 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database group to retrieve.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>The name of the database.
+Format: instances/{instance}/databases/{database}
+{database} is the database name in the instance. </p></td>
</tr>
<tr>
- <td>view</td>
- <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
+ <td><p>The existence of a database. </p></td>
+ </tr>
+
+ <tr>
+ <td>successful_sync_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The latest synchronization time. </p></td>
+ </tr>
+
+ <tr>
+ <td>project</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The project for a database.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>schema_version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The version of database schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>effective_environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The effective environment based on environment tag above and environment
+tag on the instance. Inheritance follows
+https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels will be used for deployment and policy control. </p></td>
+ </tr>
+
+ <tr>
+ <td>instance_resource</td>
+ <td><a href="#bytebase.v1.InstanceResource">InstanceResource</a></td>
+ <td></td>
+ <td><p>The instance resource. </p></td>
+ </tr>
+
+ <tr>
+ <td>backup_available</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>The database is available for DML prior backup. </p></td>
+ </tr>
+
+ <tr>
+ <td>drifted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>The schema is drifted from the source of truth. </p></td>
</tr>
</tbody>
@@ -10120,8 +9734,8 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- <h3 id="bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3>
- <p>Request message for listing database groups.</p>
+ <h3 id="bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -10131,18 +9745,17 @@ Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource whose database groups are to be listed.
-Format: projects/{project} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>view</td>
- <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -10152,8 +9765,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3>
- <p>Response message for listing database groups.</p>
+ <h3 id="bytebase.v1.DatabaseMetadata">DatabaseMetadata</h3>
+ <p>DatabaseMetadata is the metadata for databases.</p>
<table class="field-table">
@@ -10163,12 +9776,56 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>database_groups</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td>repeated</td>
- <td><p>The database groups from the specified request. </p></td>
- </tr>
-
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The database metadata name.
+
+Format: instances/{instance}/databases/{database}/metadata </p></td>
+ </tr>
+
+ <tr>
+ <td>schemas</td>
+ <td><a href="#bytebase.v1.SchemaMetadata">SchemaMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The schemas is the list of schemas in a database. </p></td>
+ </tr>
+
+ <tr>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character_set is the character set of a database. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a database. </p></td>
+ </tr>
+
+ <tr>
+ <td>extensions</td>
+ <td><a href="#bytebase.v1.ExtensionMetadata">ExtensionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The extensions is the list of extensions in a database. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the database. </p></td>
+ </tr>
+
+ <tr>
+ <td>search_path</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The search_path is the search path of a PostgreSQL database. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -10176,8 +9833,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>
- <p>Request message for updating a database group.</p>
+ <h3 id="bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</h3>
+ <p>DatabaseSDLSchema contains the schema in SDL format.</p>
<table class="field-table">
@@ -10187,28 +9844,23 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>database_group</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td></td>
- <td><p>The database group to update.
-
-The database group&#39;s `name` field is used to identify the database group to update.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>schema</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The SDL schema content.
+- For SINGLE_FILE format: contains the complete SDL schema as a text string.
+- For MULTI_FILE format: contains the ZIP archive as binary data. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>content_type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the database group is not found, a new database group will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The MIME type of the schema content.
+Indicates how the client should interpret the schema field.
+Examples:
+- &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format
+- &#34;application/zip&#34; for MULTI_FILE format </p></td>
</tr>
</tbody>
@@ -10218,173 +9870,32 @@ In this situation, `update_mask` is ignored. </p></td>
-
-
- <h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3>
- <p>View options for database group responses.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATABASE_GROUP_VIEW_UNSPECIFIED</td>
- <td>0</td>
- <td><p>The default / unset value.
-The API will default to the BASIC view.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_GROUP_VIEW_BASIC</td>
- <td>1</td>
- <td><p>Include basic information about the database group, but exclude the list of matched databases and unmatched databases.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_GROUP_VIEW_FULL</td>
- <td>2</td>
- <td><p>Include everything.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3>
- <p>DatabaseGroupService manages database groups for organizing databases by criteria.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ListDatabaseGroups</td>
- <td><a href="#bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</a></td>
- <td><a href="#bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</a></td>
- <td><p>Lists database groups in a project.
-Permissions required: bb.databaseGroups.list</p></td>
- </tr>
-
- <tr>
- <td>GetDatabaseGroup</td>
- <td><a href="#bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td><p>Gets a database group by name.
-Permissions required: bb.databaseGroups.get</p></td>
- </tr>
-
- <tr>
- <td>CreateDatabaseGroup</td>
- <td><a href="#bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td><p>Creates a new database group.
-Permissions required: bb.databaseGroups.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateDatabaseGroup</td>
- <td><a href="#bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td><p>Updates a database group.
-Permissions required: bb.databaseGroups.update
-When allow_missing=true, also requires: bb.databaseGroups.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteDatabaseGroup</td>
- <td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a database group.
-Permissions required: bb.databaseGroups.delete</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.DatabaseSchema">DatabaseSchema</h3>
+ <p>DatabaseSchema is the metadata for databases.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
-
- <tr>
- <td>ListDatabaseGroups</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/databaseGroups</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetDatabaseGroup</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/databaseGroups/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateDatabaseGroup</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/databaseGroups</td>
- <td>database_group</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateDatabaseGroup</td>
- <td>PATCH</td>
- <td>/v1/{database_group.name=projects/*/databaseGroups/*}</td>
- <td>database_group</td>
- </tr>
-
-
-
- <tr>
- <td>DeleteDatabaseGroup</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/databaseGroups/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema dump from database. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.InstanceRole">InstanceRole</h3>
- <p>InstanceRole is the API message for instance role.</p>
+ <h3 id="bytebase.v1.DependencyColumn">DependencyColumn</h3>
+ <p>DependencyColumn is the metadata for dependency columns.</p>
<table class="field-table">
@@ -10394,49 +9905,55 @@ Permissions required: bb.databaseGroups.delete</p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the role.
-Format: instances/{instance}/roles/{role}
-The role name is the unique name for the role. </p></td>
+ <td><p>The schema is the schema of a reference column. </p></td>
</tr>
<tr>
- <td>role_name</td>
+ <td>table</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The role name. It&#39;s unique within the instance. </p></td>
+ <td><p>The table is the table of a reference column. </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>column</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The role password. </p></td>
+ <td></td>
+ <td><p>The column is the name of a reference column. </p></td>
</tr>
- <tr>
- <td>connection_limit</td>
- <td><a href="#int32">int32</a></td>
- <td>optional</td>
- <td><p>The connection count limit for this role. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DependencyTable">DependencyTable</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>valid_until</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The expiration for the role&#39;s password. </p></td>
+ <td></td>
+ <td><p>The schema is the schema of a reference table. </p></td>
</tr>
<tr>
- <td>attribute</td>
+ <td>table</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The role attribute.
-For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html
-For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td>
+ <td></td>
+ <td><p>The table is the name of a reference table. </p></td>
</tr>
</tbody>
@@ -10446,7 +9963,7 @@ For MySQL, it&#39;s the global privileges as GRANT statements, which means it on
- <h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3>
+ <h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3>
<p></p>
@@ -10457,41 +9974,29 @@ For MySQL, it&#39;s the global privileges as GRANT statements, which means it on
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of roles.
-Format: instances/{instance} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Not used.
-The maximum number of roles to return. The service may return fewer than
-this value.
-If unspecified, at most 10 roles will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The name of the database or changelog.
+Format:
+database: instances/{instance}/databases/{database}
+changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Not used.
-A page token, received from a previous `ListInstanceRoles` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListInstanceRoles` must match
-the call that provided the page token. </p></td>
+ <td><p>The target schema. </p></td>
</tr>
<tr>
- <td>refresh</td>
- <td><a href="#bool">bool</a></td>
+ <td>changelog</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Refresh will refresh and return the latest data. </p></td>
+ <td><p>The resource name of the changelog
+Format:
+instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
</tbody>
@@ -10501,7 +10006,7 @@ the call that provided the page token. </p></td>
- <h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3>
+ <h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3>
<p></p>
@@ -10512,18 +10017,10 @@ the call that provided the page token. </p></td>
<tbody>
<tr>
- <td>roles</td>
- <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
- <td>repeated</td>
- <td><p>The roles from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
+ <td>diff</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -10533,70 +10030,53 @@ If this field is omitted, there are no subsequent pages. </p></td>
-
-
-
-
-
-
- <h3 id="bytebase.v1.InstanceRoleService">InstanceRoleService</h3>
- <p>InstanceRoleService manages database roles within instances.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ListInstanceRoles</td>
- <td><a href="#bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</a></td>
- <td><a href="#bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</a></td>
- <td><p>Lists all database roles in an instance.
-Permissions required: bb.instanceRoles.list</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.DimensionConstraint">DimensionConstraint</h3>
+ <p>DimensionConstraint defines constraints for a spatial dimension.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>dimension</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td>
+ </tr>
- <tr>
- <td>ListInstanceRoles</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/roles</td>
- <td></td>
- </tr>
+ <tr>
+ <td>min_value</td>
+ <td><a href="#double">double</a></td>
+ <td></td>
+ <td><p>Minimum value for this dimension </p></td>
+ </tr>
+
+ <tr>
+ <td>max_value</td>
+ <td><a href="#double">double</a></td>
+ <td></td>
+ <td><p>Maximum value for this dimension </p></td>
+ </tr>
+
+ <tr>
+ <td>tolerance</td>
+ <td><a href="#double">double</a></td>
+ <td></td>
+ <td><p>Tolerance for this dimension </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DimensionalConfig">DimensionalConfig</h3>
+ <p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>
<table class="field-table">
@@ -10606,26 +10086,31 @@ Permissions required: bb.instanceRoles.list</p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>dimensions</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The name of the instance to add a data source to.
-Format: instances/{instance} </p></td>
+ <td><p>Number of dimensions (2-4, default 2) </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>data_type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Identified by data source ID.
-Only READ_ONLY data source can be added. </p></td>
+ <td><p>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td>
</tr>
<tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>srid</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>Spatial reference system identifier (SRID) </p></td>
+ </tr>
+
+ <tr>
+ <td>constraints</td>
+ <td><a href="#bytebase.v1.DimensionConstraint">DimensionConstraint</a></td>
+ <td>repeated</td>
+ <td><p>Coordinate system constraints </p></td>
</tr>
</tbody>
@@ -10635,7 +10120,7 @@ Only READ_ONLY data source can be added. </p></td>
- <h3 id="bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</h3>
+ <h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</h3>
<p></p>
@@ -10646,11 +10131,31 @@ Only READ_ONLY data source can be added. </p></td>
<tbody>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of a type. </p></td>
+ </tr>
+
+ <tr>
+ <td>values</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The request message specifying the instances to sync.
-A maximum of 1000 instances can be synced in a batch. </p></td>
+ <td><p>The enum values of a type. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment describing the enum type. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this enum type during schema dump operations. </p></td>
</tr>
</tbody>
@@ -10660,14 +10165,7 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
- <h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3>
+ <h3 id="bytebase.v1.EventMetadata">EventMetadata</h3>
<p></p>
@@ -10678,34 +10176,52 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
<tbody>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
- <td>repeated</td>
- <td><p>The request message specifying the resources to update. </p></td>
- </tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the event. </p></td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schedule of the event. </p></td>
+ </tr>
<tr>
- <td>instances</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>time_zone</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The time zone of the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_mode</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SQL mode setting for the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>character_set_client</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character set used by the client creating the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation_connection</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation used for the connection when creating the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of an event. </p></td>
</tr>
</tbody>
@@ -10715,8 +10231,8 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
- <h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ExtensionMetadata">ExtensionMetadata</h3>
+ <p>ExtensionMetadata is the metadata for extensions.</p>
<table class="field-table">
@@ -10726,28 +10242,32 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
<tbody>
<tr>
- <td>instance</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The instance to create. </p></td>
+ <td><p>The name is the name of an extension. </p></td>
</tr>
<tr>
- <td>instance_id</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The ID to use for the instance, which will become the final component of
-the instance&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td><p>The schema is the extension that is installed to. But the extension usage
+is not limited to the schema. </p></td>
</tr>
<tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>The version is the version of an extension. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The description is the description of an extension. </p></td>
</tr>
</tbody>
@@ -10757,7 +10277,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DataSource">DataSource</h3>
+ <h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3>
<p></p>
@@ -10768,296 +10288,229 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique identifier for this data source. </p></td>
+ <td><p>The name is the name of a external table. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td>
+ <td>external_server_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of data source (ADMIN or READ_ONLY). </p></td>
+ <td><p>The external_server_name is the name of the external server. </p></td>
</tr>
<tr>
- <td>username</td>
+ <td>external_database_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The username for database authentication. </p></td>
+ <td><p>The external_database_name is the name of the external database. </p></td>
</tr>
<tr>
- <td>password</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The password for database authentication. </p></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a foreign table. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</h3>
+ <p>ForeignKeyMetadata is the metadata for foreign keys.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>use_ssl</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Use SSL to connect to the data source. By default, we use system default SSL configuration. </p></td>
+ <td><p>The name is the name of a foreign key. </p></td>
</tr>
<tr>
- <td>ssl_ca</td>
+ <td>columns</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SSL certificate authority certificate. </p></td>
+ <td>repeated</td>
+ <td><p>The columns are the ordered referencing columns of a foreign key. </p></td>
</tr>
<tr>
- <td>ssl_cert</td>
+ <td>referenced_schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SSL client certificate. </p></td>
+ <td><p>The referenced_schema is the referenced schema name of a foreign key.
+It is an empty string for databases without such concept such as MySQL. </p></td>
</tr>
<tr>
- <td>ssl_key</td>
+ <td>referenced_table</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SSL client private key. </p></td>
+ <td><p>The referenced_table is the referenced table name of a foreign key. </p></td>
</tr>
<tr>
- <td>verify_tls_certificate</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>verify_tls_certificate enables TLS certificate verification for SSL connections.
-Default is false (no verification) for backward compatibility.
-Set to true for secure connections (recommended for production).
-Only set to false for development or when certificates cannot be properly
-validated (e.g., self-signed certs, VPN environments). </p></td>
+ <td>referenced_columns</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td>
</tr>
<tr>
- <td>host</td>
+ <td>on_delete</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The hostname or IP address of the database server. </p></td>
+ <td><p>The on_delete is the on delete action of a foreign key. </p></td>
</tr>
<tr>
- <td>port</td>
+ <td>on_update</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port number of the database server. </p></td>
+ <td><p>The on_update is the on update action of a foreign key. </p></td>
</tr>
<tr>
- <td>database</td>
+ <td>match_type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to connect to. </p></td>
+ <td><p>The match_type is the match type of a foreign key.
+The match_type is the PostgreSQL specific field.
+It&#39;s empty string for other databases. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.FunctionMetadata">FunctionMetadata</h3>
+ <p>FunctionMetadata is the metadata for functions.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>srv</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>srv, authentication_database and replica_set are used for MongoDB.
-srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td>
+ <td><p>The name is the name of a function. </p></td>
</tr>
<tr>
- <td>authentication_database</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td>
+ <td><p>The definition is the definition of a function. </p></td>
</tr>
<tr>
- <td>replica_set</td>
+ <td>signature</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>replica_set is used for MongoDB replica set. </p></td>
+ <td><p>The signature is the name with the number and type of input arguments the
+function takes. </p></td>
</tr>
<tr>
- <td>sid</td>
+ <td>character_set_client</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>sid and service_name are used for Oracle. </p></td>
+ <td><p>MySQL specific metadata. </p></td>
</tr>
<tr>
- <td>service_name</td>
+ <td>collation_connection</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>ssh_host</td>
+ <td>database_collation</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Connection over SSH.
-The hostname of the SSH server agent.
-Required. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>ssh_port</td>
+ <td>sql_mode</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port of the SSH server agent. It&#39;s 22 typically.
-Required. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>ssh_user</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The user to login the server.
-Required. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>ssh_password</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The password to login the server. If it&#39;s empty string, no password is required. </p></td>
+ <td>dependency_tables</td>
+ <td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_tables is the list of dependency tables of a function.
+For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. </p></td>
</tr>
<tr>
- <td>ssh_private_key</td>
- <td><a href="#string">string</a></td>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>authentication_private_key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required.
-Used for authentication when connecting to the data source. </p></td>
- </tr>
-
- <tr>
- <td>authentication_private_key_passphrase</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. </p></td>
- </tr>
-
- <tr>
- <td>external_secret</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>authentication_type</td>
- <td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>azure_credential</td>
- <td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>aws_credential</td>
- <td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>gcp_credential</td>
- <td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>sasl_config</td>
- <td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>additional_addresses</td>
- <td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td>
- <td>repeated</td>
- <td><p>additional_addresses is used for MongoDB replica set. </p></td>
- </tr>
-
- <tr>
- <td>direct_connection</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td>
- </tr>
-
- <tr>
- <td>region</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>region is the location of where the DB is, works for AWS RDS. For example, us-east-1. </p></td>
- </tr>
-
- <tr>
- <td>warehouse_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>warehouse_id is used by Databricks. </p></td>
- </tr>
-
- <tr>
- <td>master_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td>
- </tr>
-
- <tr>
- <td>master_username</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>master_username and master_password are master credentials used by redis sentinel mode. </p></td>
- </tr>
-
- <tr>
- <td>master_password</td>
+ <td>expression</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
- <tr>
- <td>redis_type</td>
- <td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>cluster</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td>
- </tr>
-
- <tr>
- <td>extra_connection_parameters</td>
- <td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>
- <td>repeated</td>
- <td><p>Extra connection parameters for the database connection.
-For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td>
- </tr>
-
</tbody>
</table>
@@ -11065,7 +10518,7 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><
- <h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3>
+ <h3 id="bytebase.v1.GetChangelogRequest">GetChangelogRequest</h3>
<p></p>
@@ -11076,42 +10529,20 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><
<tbody>
<tr>
- <td>access_key_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>secret_access_key</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the changelog to retrieve.
+Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
<tr>
- <td>session_token</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
<td></td>
<td><p> </p></td>
</tr>
- <tr>
- <td>role_arn</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>ARN of IAM role to assume for cross-account access.
-See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td>
- </tr>
-
- <tr>
- <td>external_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Optional external ID for additional security when assuming role.
-See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html </p></td>
- </tr>
-
</tbody>
</table>
@@ -11119,7 +10550,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
- <h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3>
+ <h3 id="bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3>
<p></p>
@@ -11130,17 +10561,41 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
<tbody>
<tr>
- <td>host</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database to retrieve metadata.
+Format: instances/{instance}/databases/{database}/metadata </p></td>
</tr>
<tr>
- <td>port</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Filter is used to filter databases returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- schema: the schema name, support &#34;==&#34; operator.
+- table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+
+For example:
+schema == &#34;schema-a&#34;
+table == &#34;table-a&#34;
+table.matches(&#34;table-a&#34;)
+schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;)
+The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;.
+The column masking level will only be returned when a table filter is used. </p></td>
+ </tr>
+
+ <tr>
+ <td>limit</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Limit the response size of returned table metadata per schema.
+For example, if the database has 3 schemas, and each schema has 100 tables,
+if limit is 20, then only 20 tables will be returned for each schema, total 60 tables.
+Default 0, means no limit. </p></td>
</tr>
</tbody>
@@ -11150,7 +10605,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
- <h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</h3>
+ <h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3>
<p></p>
@@ -11161,24 +10616,11 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
<tbody>
<tr>
- <td>tenant_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>client_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>client_secret</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database to retrieve.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
</tbody>
@@ -11188,7 +10630,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
- <h3 id="bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3>
+ <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</h3>
<p></p>
@@ -11199,17 +10641,18 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
<tbody>
<tr>
- <td>key</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database to retrieve SDL schema.
+Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
+ <td>format</td>
+ <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The format of the SDL schema output. </p></td>
</tr>
</tbody>
@@ -11219,7 +10662,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
- <h3 id="bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</h3>
+ <h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</h3>
<p></p>
@@ -11230,10 +10673,11 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
<tbody>
<tr>
- <td>content</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database to retrieve schema.
+Format: instances/{instance}/databases/{database}/schema </p></td>
</tr>
</tbody>
@@ -11243,7 +10687,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
- <h3 id="bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</h3>
+ <h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3>
<p></p>
@@ -11254,91 +10698,40 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
<tbody>
<tr>
- <td>secret_type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of external secret store. </p></td>
+ <td><p>The name of the database.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>url</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</a></td>
<td></td>
- <td><p>The URL of the external secret store. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>auth_type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td>
- <td></td>
- <td><p>The authentication method for accessing the secret store. </p></td>
- </tr>
-
- <tr>
- <td>app_role</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td>
- <td></td>
- <td><p>AppRole authentication configuration. </p></td>
- </tr>
-
- <tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Token for direct authentication. </p></td>
- </tr>
-
- <tr>
- <td>engine_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>engine name is the name for secret engine. </p></td>
- </tr>
-
- <tr>
- <td>secret_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the secret name in the engine to store the password. </p></td>
- </tr>
-
- <tr>
- <td>password_key_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the key name for the password. </p></td>
- </tr>
-
- <tr>
- <td>skip_vault_tls_verification</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>TLS configuration for connecting to Vault server.
-These fields are separate from the database TLS configuration in DataSource.
-skip_vault_tls_verification disables TLS certificate verification for Vault connections.
-Default is false (verification enabled) for security.
-Only set to true for development or when certificates cannot be properly validated. </p></td>
- </tr>
-
- <tr>
- <td>vault_ssl_ca</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>CA certificate for Vault server verification. </p></td>
+ <td><p>It&#39;s empty for DATABASE. </p></td>
</tr>
<tr>
- <td>vault_ssl_cert</td>
+ <td>object</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Client certificate for mutual TLS authentication with Vault. </p></td>
+ <td><p>It&#39;s empty for DATABASE and SCHEMA. </p></td>
</tr>
<tr>
- <td>vault_ssl_key</td>
- <td><a href="#string">string</a></td>
+ <td>metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
<td></td>
- <td><p>Client private key for mutual TLS authentication with Vault. </p></td>
+ <td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.
+Also the schema and object are empty. </p></td>
</tr>
</tbody>
@@ -11348,7 +10741,7 @@ Only set to true for development or when certificates cannot be properly validat
- <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3>
+ <h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3>
<p></p>
@@ -11359,31 +10752,10 @@ Only set to true for development or when certificates cannot be properly validat
<tbody>
<tr>
- <td>role_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The role ID for Vault AppRole authentication. </p></td>
- </tr>
-
- <tr>
- <td>secret_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the secret id for the role without ttl. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td>
- <td></td>
- <td><p>The type of secret for AppRole authentication. </p></td>
- </tr>
-
- <tr>
- <td>mount_path</td>
+ <td>schema_string</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The path where the approle auth method is mounted. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -11393,8 +10765,8 @@ Only set to true for development or when certificates cannot be properly validat
- <h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.GridLevel">GridLevel</h3>
+ <p>GridLevel defines a tessellation grid level with its density.</p>
<table class="field-table">
@@ -11404,28 +10776,17 @@ Only set to true for development or when certificates cannot be properly validat
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the instance to delete.
-Format: instances/{instance} </p></td>
- </tr>
-
- <tr>
- <td>force</td>
- <td><a href="#bool">bool</a></td>
+ <td>level</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. </p></td>
+ <td><p>Grid level number (1-4 for SQL Server) </p></td>
</tr>
<tr>
- <td>purge</td>
- <td><a href="#bool">bool</a></td>
+ <td>density</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, permanently purge the soft-deleted instance and all related resources.
-This operation is irreversible. Following AIP-165, this should only be used for
-administrative cleanup of old soft-deleted instances.
-The instance must already be soft-deleted for this to work. </p></td>
+ <td><p>Grid density (LOW, MEDIUM, HIGH) </p></td>
</tr>
</tbody>
@@ -11435,8 +10796,8 @@ The instance must already be soft-deleted for this to work. </p></td>
- <h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3>
+ <p>IndexMetadata is the metadata for indexes.</p>
<table class="field-table">
@@ -11449,127 +10810,123 @@ The instance must already be soft-deleted for this to work. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance to retrieve.
-Format: instances/{instance} </p></td>
+ <td><p>The name is the name of an index. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Instance">Instance</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>expressions</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The expressions are the ordered columns or expressions of an index.
+This could refer to a column or an expression. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>key_length</td>
+ <td><a href="#int64">int64</a></td>
+ <td>repeated</td>
+ <td><p>The key_lengths are the ordered key lengths of an index.
+If the key length is not specified, it&#39;s -1. </p></td>
+ </tr>
+
+ <tr>
+ <td>descending</td>
+ <td><a href="#bool">bool</a></td>
+ <td>repeated</td>
+ <td><p>The descending is the ordered descending of an index. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance.
-Format: instances/{instance} </p></td>
+ <td><p>The type is the type of an index. </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>unique</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The lifecycle state of the instance. </p></td>
+ <td><p>The unique is whether the index is unique. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>primary</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The display title of the instance. </p></td>
+ <td><p>The primary is whether the index is a primary key index. </p></td>
</tr>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>visible</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The database engine type. </p></td>
+ <td><p>The visible is whether the index is visible. </p></td>
</tr>
<tr>
- <td>engine_version</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The version of the database engine. </p></td>
+ <td><p>The comment is the comment of an index. </p></td>
</tr>
<tr>
- <td>external_link</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>External URL to the database instance console. </p></td>
+ <td><p>The definition of an index. </p></td>
</tr>
<tr>
- <td>data_sources</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
- <td>repeated</td>
- <td><p>Data source configurations for connecting to the instance. </p></td>
+ <td>parent_index_schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema name of the parent index. </p></td>
</tr>
<tr>
- <td>environment</td>
+ <td>parent_index_name</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
+ <td></td>
+ <td><p>The index name of the parent index. </p></td>
</tr>
<tr>
- <td>activation</td>
- <td><a href="#bool">bool</a></td>
+ <td>granularity</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>Whether the instance is activated for use. </p></td>
+ <td><p>The number of granules in the block. It&#39;s a ClickHouse specific field. </p></td>
</tr>
<tr>
- <td>roles</td>
- <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
- <td>repeated</td>
- <td><p>Database roles available in this instance. </p></td>
+ <td>is_constraint</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>It&#39;s a PostgreSQL specific field.
+The unique constraint and unique index are not the same thing in PostgreSQL. </p></td>
</tr>
<tr>
- <td>sync_interval</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>spatial_config</td>
+ <td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</a></td>
<td></td>
- <td><p>How often the instance is synced. </p></td>
+ <td><p>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td>
</tr>
<tr>
- <td>sync_databases</td>
+ <td>opclass_names</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>Enable sync for following databases.
-Default empty, means sync all schemas &amp; databases. </p></td>
- </tr>
-
- <tr>
- <td>last_sync_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last time the instance was synced. </p></td>
+ <td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.html
+Name of the operator class for each column. (PostgreSQL specific). </p></td>
</tr>
<tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</a></td>
+ <td>opclass_defaults</td>
+ <td><a href="#bool">bool</a></td>
<td>repeated</td>
- <td><p>Labels are key-value pairs that can be attached to the instance.
-For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } </p></td>
+ <td><p>True if the operator class is the default. (PostgreSQL specific). </p></td>
</tr>
</tbody>
@@ -11579,7 +10936,7 @@ For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#
- <h3 id="bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</h3>
+ <h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</h3>
<p></p>
@@ -11590,19 +10947,57 @@ For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#
<tbody>
<tr>
- <td>key</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent of the changelogs.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of changelogs to return. The service may return fewer
+than this value. If unspecified, at most 10 changelogs will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
+ <td><p>A page token, received from the previous call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided must match
+the call that provided the page token. </p></td>
+ </tr>
+
+ <tr>
+ <td>view</td>
+ <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter changelogs returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values.
+type: the changelog type, support &#34;in&#34; and &#34;==&#34; operation. check Changelog.Type for available values.
+
+Example:
+status == &#34;DONE&#34;
+type in [&#34;BASELINE&#34;, &#34;MIGRATE&#34;]
+status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; </p></td>
+ </tr>
+
</tbody>
</table>
@@ -11610,7 +11005,7 @@ For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#
- <h3 id="bytebase.v1.InstanceResource">InstanceResource</h3>
+ <h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3>
<p></p>
@@ -11621,54 +11016,155 @@ For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#
<tbody>
<tr>
- <td>title</td>
+ <td>changelogs</td>
+ <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
+ <td>repeated</td>
+ <td><p>The list of changelogs. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The display title of the instance. </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>- projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission.
+- workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission.
+- instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission </p></td>
</tr>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The database engine type. </p></td>
+ <td><p>The maximum number of databases to return. The service may return fewer
+than this value.
+If unspecified, at most 10 databases will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>engine_version</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The version of the database engine. </p></td>
+ <td><p>A page token, received from a previous `ListDatabases` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListDatabases` must
+match the call that provided the page token. </p></td>
</tr>
<tr>
- <td>data_sources</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
- <td>repeated</td>
- <td><p>Data source configurations for the instance. </p></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter databases returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
+- name: the database name, support &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
+- engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator.
+- drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator.
+- table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example:
+environment == &#34;environments/{environment resource id}&#34;
+environment == &#34;&#34; (find databases which environment is not set)
+project == &#34;projects/{project resource id}&#34;
+instance == &#34;instances/{instance resource id}&#34;
+name.matches(&#34;database name&#34;)
+engine == &#34;MYSQL&#34;
+engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
+!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
+exclude_unassigned == true
+drifted == true
+table == &#34;sample&#34;
+table.matches(&#34;sam&#34;)
+labels.environment == &#34;production&#34;
+labels.region == &#34;asia&#34;
+labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+
+You can combine filter conditions like:
+environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) </p></td>
</tr>
<tr>
- <td>activation</td>
+ <td>show_deleted</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether the instance is activated. </p></td>
+ <td><p>Show deleted database if specified. </p></td>
</tr>
<tr>
- <td>name</td>
+ <td>order_by</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance.
-Format: instances/{instance} </p></td>
+ <td><p>The order by of databases.
+Support name, project, instance. The default sorting order is ascending.
+For example:
+- order_by = &#34;name&#34; - order by name ascending
+- order_by = &#34;name desc&#34;
+- order_by = &#34;name desc, project asc&#34; </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>repeated</td>
+ <td><p>The databases from the specified request. </p></td>
</tr>
<tr>
- <td>environment</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -11678,8 +11174,8 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
- <h3 id="bytebase.v1.KerberosConfig">KerberosConfig</h3>
- <p></p>
+ <h3 id="bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</h3>
+ <p>MaterializedViewMetadata is the metadata for materialized views.</p>
<table class="field-table">
@@ -11689,52 +11185,53 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
<tbody>
<tr>
- <td>primary</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The primary component of the Kerberos principal. </p></td>
+ <td><p>The name is the name of a materialized view. </p></td>
</tr>
<tr>
- <td>instance</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The instance component of the Kerberos principal. </p></td>
+ <td><p>The definition is the definition of a materialized view. </p></td>
</tr>
<tr>
- <td>realm</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The Kerberos realm. </p></td>
+ <td><p>The comment is the comment of a materialized view. </p></td>
</tr>
<tr>
- <td>keytab</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The keytab file contents for authentication. </p></td>
+ <td>dependency_columns</td>
+ <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_columns is the list of dependency columns of a materialized
+view. </p></td>
</tr>
<tr>
- <td>kdc_host</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The hostname of the Key Distribution Center (KDC). </p></td>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
</tr>
<tr>
- <td>kdc_port</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The port of the Key Distribution Center (KDC). </p></td>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The indexes is the list of indexes in a table. </p></td>
</tr>
<tr>
- <td>kdc_transport_protocol</td>
- <td><a href="#string">string</a></td>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The transport protocol for KDC communication (tcp or udp). </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -11744,8 +11241,8 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
- <h3 id="bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.PackageMetadata">PackageMetadata</h3>
+ <p>PackageMetadata is the metadata for packages.</p>
<table class="field-table">
@@ -11758,15 +11255,14 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance.
-Format: instances/{instance} </p></td>
+ <td><p>The name is the name of a package. </p></td>
</tr>
<tr>
- <td>instance</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td>optional</td>
- <td><p>The target instance. We need to set this field if the target instance is not created yet. </p></td>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a package. </p></td>
</tr>
</tbody>
@@ -11776,8 +11272,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.ProcedureMetadata">ProcedureMetadata</h3>
+ <p>ProcedureMetadata is the metadata for procedures.</p>
<table class="field-table">
@@ -11787,108 +11283,67 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>databases</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>All database name list in the instance. </p></td>
+ <td></td>
+ <td><p>The name is the name of a procedure. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListInstancesRequest">ListInstancesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a procedure. </p></td>
+ </tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>signature</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of instances to return. The service may return fewer than
-this value.
-If unspecified, at most 10 instances will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The signature is the name with the number and type of input arguments the
+procedure takes. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>character_set_client</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListInstances` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListInstances` must match
-the call that provided the page token. </p></td>
+ <td><p>MySQL specific metadata. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
+ <td>collation_connection</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Show deleted instances if specified. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>database_collation</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter the instance.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
-- state: the instance state, check State enum for values, support &#34;==&#34; operator.
-- engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example:
-name == &#34;sample instance&#34;
-name.matches(&#34;sample&#34;)
-resource_id == &#34;sample-instance&#34;
-resource_id.matches(&#34;sample&#34;)
-state == &#34;DELETED&#34;
-environment == &#34;environments/test&#34;
-environment == &#34;&#34; (find instances which environment is not set)
-engine == &#34;MYSQL&#34;
-engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
-!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
-host == &#34;127.0.0.1&#34;
-host.matches(&#34;127.0&#34;)
-port == &#34;54321&#34;
-port.matches(&#34;543&#34;)
-labels.org_group == &#34;infrastructure&#34;
-labels.environment in [&#34;prod&#34;, &#34;production&#34;]
-project == &#34;projects/sample-project&#34;
-You can combine filter conditions like:
-name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34;
-host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>order_by</td>
+ <td>sql_mode</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The order by of instances.
-Support title, environment. The default sorting order is ascending.
-For example:
-- order_by = &#34;title&#34;
-- order_by = &#34;title desc&#34;
-- order_by = &#34;title desc, environment asc&#34; </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of a procedure. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -11898,8 +11353,8 @@ For example:
- <h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.SchemaMetadata">SchemaMetadata</h3>
+ <p>SchemaMetadata is the metadata for schemas.</p><p>This is the concept of schema in Postgres, but it's a no-op for MySQL.</p>
<table class="field-table">
@@ -11909,51 +11364,118 @@ For example:
<tbody>
<tr>
- <td>instances</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the schema name.
+It is an empty string for databases without such concept such as MySQL. </p></td>
+ </tr>
+
+ <tr>
+ <td>tables</td>
+ <td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td>
<td>repeated</td>
- <td><p>The instances from the specified request. </p></td>
+ <td><p>The tables is the list of tables in a schema. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>external_tables</td>
+ <td><a href="#bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The external_tables is the list of external tables in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>views</td>
+ <td><a href="#bytebase.v1.ViewMetadata">ViewMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The views is the list of views in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>functions</td>
+ <td><a href="#bytebase.v1.FunctionMetadata">FunctionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The functions is the list of functions in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>procedures</td>
+ <td><a href="#bytebase.v1.ProcedureMetadata">ProcedureMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The procedures is the list of procedures in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>streams</td>
+ <td><a href="#bytebase.v1.StreamMetadata">StreamMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The streams is the list of streams in a schema, currently, only used for
+Snowflake. </p></td>
+ </tr>
+
+ <tr>
+ <td>tasks</td>
+ <td><a href="#bytebase.v1.TaskMetadata">TaskMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The routines is the list of routines in a schema, currently, only used for
+Snowflake. </p></td>
+ </tr>
+
+ <tr>
+ <td>materialized_views</td>
+ <td><a href="#bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The materialized_views is the list of materialized views in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>packages</td>
+ <td><a href="#bytebase.v1.PackageMetadata">PackageMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The packages is the list of packages in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>The owner of the schema. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>sequences</td>
+ <td><a href="#bytebase.v1.SequenceMetadata">SequenceMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The sequences is the list of sequences in a schema, sorted by name. </p></td>
+ </tr>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>events</td>
+ <td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The events is the list of scheduled events in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>enum_types</td>
+ <td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name of the instance to remove a data source from.
-Format: instances/{instance} </p></td>
+ <td><p>Whether to skip this schema during schema dump operations. </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Identified by data source ID.
-Only READ_ONLY data source can be removed. </p></td>
+ <td><p>The comment is the comment of a schema. </p></td>
</tr>
</tbody>
@@ -11963,7 +11485,7 @@ Only READ_ONLY data source can be removed. </p></td>
- <h3 id="bytebase.v1.SASLConfig">SASLConfig</h3>
+ <h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</h3>
<p></p>
@@ -11974,67 +11496,94 @@ Only READ_ONLY data source can be removed. </p></td>
<tbody>
<tr>
- <td>krb_config</td>
- <td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Kerberos authentication configuration. </p></td>
+ <td><p>The name of a sequence. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>data_type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The data type of a sequence. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>start</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of instance.
-Format: instances/{instance} </p></td>
+ <td><p>The start value of a sequence. </p></td>
</tr>
<tr>
- <td>enable_full_sync</td>
+ <td>min_value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The minimum value of a sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>max_value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The maximum value of a sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>increment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Increment value of a sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>cycle</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only
-the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td>
+ <td><p>Cycle is whether the sequence cycles. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>cache_size</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Cache size of a sequence. </p></td>
+ </tr>
<tr>
- <td>databases</td>
+ <td>last_value</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>All database name list in the instance. </p></td>
+ <td></td>
+ <td><p>Last value of a sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner_table</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner table of the sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner_column</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner column of the sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment describing the sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this sequence during schema dump operations. </p></td>
</tr>
</tbody>
@@ -12044,8 +11593,8 @@ the instance metadata (such as the database list) and any newly discovered datab
- <h3 id="bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</h3>
+ <p>SpatialIndexConfig defines the spatial index configuration for spatial databases.</p>
<table class="field-table">
@@ -12055,11 +11604,31 @@ the instance metadata (such as the database list) and any newly discovered datab
<tbody>
<tr>
- <td>name</td>
+ <td>method</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the deleted instance.
-Format: instances/{instance} </p></td>
+ <td><p>Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) </p></td>
+ </tr>
+
+ <tr>
+ <td>tessellation</td>
+ <td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td>
+ <td></td>
+ <td><p>Tessellation configuration for grid-based spatial indexes </p></td>
+ </tr>
+
+ <tr>
+ <td>storage</td>
+ <td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td>
+ <td></td>
+ <td><p>Storage and performance configuration </p></td>
+ </tr>
+
+ <tr>
+ <td>dimensional</td>
+ <td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td>
+ <td></td>
+ <td><p>Dimensional configuration </p></td>
</tr>
</tbody>
@@ -12069,8 +11638,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.StorageConfig">StorageConfig</h3>
+ <p>StorageConfig defines storage and performance parameters for spatial indexes.</p>
<table class="field-table">
@@ -12080,40 +11649,101 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>fillfactor</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Fill factor percentage (1-100) </p></td>
+ </tr>
+
+ <tr>
+ <td>buffering</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance to update a data source.
-Format: instances/{instance} </p></td>
+ <td><p>Buffering mode for PostgreSQL (auto, on, off) </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>tablespace</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Identified by data source ID. </p></td>
+ <td><p>Tablespace configuration for Oracle </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>work_tablespace</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>validate_only</td>
+ <td>sdo_level</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>commit_interval</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>pad_index</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>SQL Server specific parameters </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>sort_in_tempdb</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>ON, OFF </p></td>
+ </tr>
+
+ <tr>
+ <td>drop_existing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the data source is not found, a new data source will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>online</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_row_locks</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_page_locks</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>maxdop</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>data_compression</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>NONE, ROW, PAGE </p></td>
</tr>
</tbody>
@@ -12123,7 +11753,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</h3>
+ <h3 id="bytebase.v1.StreamMetadata">StreamMetadata</h3>
<p></p>
@@ -12134,544 +11764,257 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>instance</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The instance to update.
-
-The instance&#39;s `name` field is used to identify the instance to update.
-Format: instances/{instance} </p></td>
+ <td><p>The name is the name of a stream. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>table_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The table_name is the name of the table/view that the stream is created on. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the instance is not found, a new instance will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The owner of the stream. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td>
+ <td></td>
+ <td><p>The type of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>stale</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td>
+ </tr>
+
+ <tr>
+ <td>mode</td>
+ <td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td>
+ <td></td>
+ <td><p>The mode of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition of the stream. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>AUTHENTICATION_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PASSWORD</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GOOGLE_CLOUD_SQL_IAM</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AWS_RDS_IAM</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AZURE_IAM</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSource.RedisType">DataSource.RedisType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>REDIS_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STANDALONE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SENTINEL</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CLUSTER</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SECRET_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified secret type.</p></td>
- </tr>
-
- <tr>
- <td>PLAIN</td>
- <td>1</td>
- <td><p>Plain text secret.</p></td>
- </tr>
-
- <tr>
- <td>ENVIRONMENT</td>
- <td>2</td>
- <td><p>Secret from environment variable.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3>
+ <h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>AUTH_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified authentication type.</p></td>
- </tr>
-
- <tr>
- <td>TOKEN</td>
- <td>1</td>
- <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td>
- </tr>
-
- <tr>
- <td>VAULT_APP_ROLE</td>
- <td>2</td>
- <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/approle</p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to sync.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</h3>
+ <h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SECRET_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified secret type.</p></td>
- </tr>
-
- <tr>
- <td>VAULT_KV_V2</td>
- <td>1</td>
- <td><p>ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2</p></td>
- </tr>
-
- <tr>
- <td>AWS_SECRETS_MANAGER</td>
- <td>2</td>
- <td><p>ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</p></td>
- </tr>
-
- <tr>
- <td>GCP_SECRET_MANAGER</td>
- <td>3</td>
- <td><p>ref: https://cloud.google.com/secret-manager/docs</p></td>
- </tr>
-
- <tr>
- <td>AZURE_KEY_VAULT</td>
- <td>4</td>
- <td><p>ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets</p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+
+
- <h3 id="bytebase.v1.DataSourceType">DataSourceType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATA_SOURCE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified data source type.</p></td>
- </tr>
-
- <tr>
- <td>ADMIN</td>
- <td>1</td>
- <td><p>Admin data source with write permissions.</p></td>
- </tr>
-
- <tr>
- <td>READ_ONLY</td>
- <td>2</td>
- <td><p>Read-only data source for query operations.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.InstanceService">InstanceService</h3>
- <p>InstanceService manages database instances and their connections.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetInstance</td>
- <td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Gets a database instance by name.
-Permissions required: bb.instances.get</p></td>
- </tr>
-
- <tr>
- <td>ListInstances</td>
- <td><a href="#bytebase.v1.ListInstancesRequest">ListInstancesRequest</a></td>
- <td><a href="#bytebase.v1.ListInstancesResponse">ListInstancesResponse</a></td>
- <td><p>Lists all database instances.
-Permissions required: bb.instances.list</p></td>
- </tr>
-
- <tr>
- <td>CreateInstance</td>
- <td><a href="#bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Creates a new database instance.
-Permissions required: bb.instances.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateInstance</td>
- <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Updates a database instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>DeleteInstance</td>
- <td><a href="#bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes or soft-deletes a database instance.
-Permissions required: bb.instances.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteInstance</td>
- <td><a href="#bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Restores a soft-deleted database instance.
-Permissions required: bb.instances.undelete</p></td>
- </tr>
-
- <tr>
- <td>SyncInstance</td>
- <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
- <td><a href="#bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</a></td>
- <td><p>Syncs database schemas and metadata from an instance.
-Permissions required: bb.instances.sync</p></td>
- </tr>
-
- <tr>
- <td>ListInstanceDatabase</td>
- <td><a href="#bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</a></td>
- <td><a href="#bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</a></td>
- <td><p>Lists all databases within an instance without creating them.
-Permissions required: bb.instances.get</p></td>
- </tr>
-
- <tr>
- <td>BatchSyncInstances</td>
- <td><a href="#bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</a></td>
- <td><a href="#bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</a></td>
- <td><p>Syncs multiple instances in a single request.
-Permissions required: bb.instances.sync</p></td>
- </tr>
-
- <tr>
- <td>BatchUpdateInstances</td>
- <td><a href="#bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</a></td>
- <td><p>Updates multiple instances in a single request.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>AddDataSource</td>
- <td><a href="#bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Adds a read-only data source to an instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>RemoveDataSource</td>
- <td><a href="#bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Removes a read-only data source from an instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>UpdateDataSource</td>
- <td><a href="#bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Updates a data source configuration.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.TableMetadata">TableMetadata</h3>
+ <p>TableMetadata is the metadata for tables.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a table. </p></td>
+ </tr>
- <tr>
- <td>GetInstance</td>
- <td>GET</td>
- <td>/v1/{name=instances/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The indexes is the list of indexes in a table. </p></td>
+ </tr>
+ <tr>
+ <td>engine</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The engine is the engine of a table. </p></td>
+ </tr>
- <tr>
- <td>ListInstances</td>
- <td>GET</td>
- <td>/v1/instances</td>
- <td></td>
- </tr>
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>charset</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character set of table. </p></td>
+ </tr>
+ <tr>
+ <td>row_count</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The row_count is the estimated number of rows of a table. </p></td>
+ </tr>
- <tr>
- <td>CreateInstance</td>
- <td>POST</td>
- <td>/v1/instances</td>
- <td>instance</td>
- </tr>
+ <tr>
+ <td>data_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The data_size is the estimated data size of a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>index_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The index_size is the estimated index size of a table. </p></td>
+ </tr>
+ <tr>
+ <td>data_free</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The data_free is the estimated free data size of a table. </p></td>
+ </tr>
- <tr>
- <td>UpdateInstance</td>
- <td>PATCH</td>
- <td>/v1/{instance.name=instances/*}</td>
- <td>instance</td>
- </tr>
+ <tr>
+ <td>create_options</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The create_options is the create option of a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of a table. </p></td>
+ </tr>
+ <tr>
+ <td>foreign_keys</td>
+ <td><a href="#bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The foreign_keys is the list of foreign keys in a table. </p></td>
+ </tr>
- <tr>
- <td>DeleteInstance</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UndeleteInstance</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:undelete</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>SyncInstance</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:sync</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListInstanceDatabase</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:databases</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchSyncInstances</td>
- <td>POST</td>
- <td>/v1/instances:batchSync</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchUpdateInstances</td>
- <td>POST</td>
- <td>/v1/instances:batchUpdate</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>AddDataSource</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:addDataSource</td>
- <td>*</td>
- </tr>
-
-
-
+ <tr>
+ <td>partitions</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The partitions is the list of partitions in a table. </p></td>
+ </tr>
- <tr>
- <td>RemoveDataSource</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:removeDataSource</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>check_constraints</td>
+ <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The check_constraints is the list of check constraints in a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the table. </p></td>
+ </tr>
+ <tr>
+ <td>sorting_keys</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.
+Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by </p></td>
+ </tr>
- <tr>
- <td>UpdateDataSource</td>
- <td>PATCH</td>
- <td>/v1/{name=instances/*}:updateDataSource</td>
- <td>data_source</td>
- </tr>
+ <tr>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The triggers is the list of triggers associated with the table. </p></td>
+ </tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/database_service.proto">v1/database_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this table during schema dump operations. </p></td>
+ </tr>
<tr>
- <td>parent</td>
+ <td>sharding_info</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being retrieved.
-- projects/{project}: batch get databases in a project;
-- instances/{instances}: batch get databases in a instance;
-Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
+ <td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td>
</tr>
<tr>
- <td>names</td>
+ <td>primary_key_type</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of database names to retrieve. </p></td>
+ <td></td>
+ <td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes
+CLUSTERED or NONCLUSTERED. </p></td>
</tr>
</tbody>
@@ -12681,8 +12024,8 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
- <h3 id="bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</h3>
+ <p>TablePartitionMetadata is the metadata for table partitions.</p>
<table class="field-table">
@@ -12692,43 +12035,78 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
<tbody>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>The databases from the specified request. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a table partition. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td>
+ <td></td>
+ <td><p>The type of a table partition. </p></td>
+ </tr>
<tr>
- <td>parent</td>
+ <td>expression</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being updated.
-Format: instances/{instance}
-If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></td>
+ <td><p>The expression is the expression of a table partition.
+For PostgreSQL, the expression is the text of {FOR VALUES
+partition_bound_spec}, see
+https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL,
+the expression is the `expr` or `column_list` of the following syntax.
+PARTITION BY
+ { [LINEAR] HASH(expr)
+ | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list)
+ | RANGE{(expr) | COLUMNS(column_list)}
+ | LIST{(expr) | COLUMNS(column_list)} }. </p></td>
</tr>
<tr>
- <td>names</td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The value is the value of a table partition.
+For MySQL, the value is for RANGE and LIST partition types,
+- For a RANGE partition, it contains the value set in the partition&#39;s
+VALUES LESS THAN clause, which can be either an integer or MAXVALUE.
+- For a LIST partition, this column contains the values defined in the
+partition&#39;s VALUES IN clause, which is a list of comma-separated integer
+values.
+- For others, it&#39;s an empty string. </p></td>
+ </tr>
+
+ <tr>
+ <td>use_default</td>
<td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The use_default is whether the users use the default partition, it stores
+the different value for different database engines. For MySQL, it&#39;s [INT]
+type, 0 means not use default partition, otherwise, it&#39;s equals to number
+in syntax [SUB]PARTITION {number}. </p></td>
+ </tr>
+
+ <tr>
+ <td>subpartitions</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
<td>repeated</td>
- <td><p>The list of database names to sync. </p></td>
+ <td><p>The subpartitions is the list of subpartitions in a table partition. </p></td>
+ </tr>
+
+ <tr>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>check_constraints</td>
+ <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -12738,14 +12116,7 @@ If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></
- <h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3>
+ <h3 id="bytebase.v1.TaskMetadata">TaskMetadata</h3>
<p></p>
@@ -12756,45 +12127,74 @@ If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being updated.
-Format: instances/{instance}
-If the operation spans parents, a dash (-) may be accepted as a wildcard.
-We only support updating the project of databases for now. </p></td>
+ <td><p>The name is the name of a task. </p></td>
</tr>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
- <td>repeated</td>
- <td><p>The request message specifying the resources to update.
-A maximum of 1000 databases can be modified in a batch. </p></td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The id is the snowflake-generated id of a task.
+Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the task. </p></td>
+ </tr>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>warehouse</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The warehouse of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>schedule</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schedule interval of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>predecessors</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>Databases updated. </p></td>
+ <td><p>The predecessor tasks of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>state</td>
+ <td><a href="#bytebase.v1.TaskMetadata.State">TaskMetadata.State</a></td>
+ <td></td>
+ <td><p>The state of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>condition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The condition of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition of the task. </p></td>
</tr>
</tbody>
@@ -12804,8 +12204,8 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
- <h3 id="bytebase.v1.BoundingBox">BoundingBox</h3>
- <p>BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.</p>
+ <h3 id="bytebase.v1.TessellationConfig">TessellationConfig</h3>
+ <p>TessellationConfig defines tessellation parameters for spatial indexes.</p>
<table class="field-table">
@@ -12815,31 +12215,31 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
<tbody>
<tr>
- <td>xmin</td>
- <td><a href="#double">double</a></td>
+ <td>scheme</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Minimum X coordinate </p></td>
+ <td><p>Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) </p></td>
</tr>
<tr>
- <td>ymin</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Minimum Y coordinate </p></td>
+ <td>grid_levels</td>
+ <td><a href="#bytebase.v1.GridLevel">GridLevel</a></td>
+ <td>repeated</td>
+ <td><p>Grid levels and densities for multi-level tessellation </p></td>
</tr>
<tr>
- <td>xmax</td>
- <td><a href="#double">double</a></td>
+ <td>cells_per_object</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Maximum X coordinate </p></td>
+ <td><p>Number of cells per object (1-8192 for SQL Server) </p></td>
</tr>
<tr>
- <td>ymax</td>
- <td><a href="#double">double</a></td>
+ <td>bounding_box</td>
+ <td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td>
<td></td>
- <td><p>Maximum Y coordinate </p></td>
+ <td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td>
</tr>
</tbody>
@@ -12849,7 +12249,7 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
- <h3 id="bytebase.v1.Changelog">Changelog</h3>
+ <h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3>
<p></p>
@@ -12863,57 +12263,64 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
+ <td><p>The name is the name of the trigger. </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>event</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The event is the event of the trigger, such as INSERT, UPDATE, DELETE,
+TRUNCATE. </p></td>
</tr>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td>
+ <td>timing</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td>
</tr>
<tr>
- <td>schema</td>
+ <td>body</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The body is the body of the trigger. </p></td>
</tr>
<tr>
- <td>schema_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>sql_mode</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The SQL mode setting for the trigger. </p></td>
</tr>
<tr>
- <td>task_run</td>
+ <td>character_set_client</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>The character set used by the client creating the trigger. </p></td>
</tr>
<tr>
- <td>plan_title</td>
+ <td>collation_connection</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the plan associated with this changelog&#39;s task run.
-This field is populated by deriving the plan from task_run for display purposes. </p></td>
+ <td><p>The collation used for the connection when creating the trigger. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Changelog.Type">Changelog.Type</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The comment describing the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this trigger during schema dump operations. </p></td>
</tr>
</tbody>
@@ -12923,8 +12330,8 @@ This field is populated by deriving the plan from task_run for display purposes.
- <h3 id="bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</h3>
- <p>CheckConstraintMetadata is the metadata for check constraints.</p>
+ <h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3>
+ <p></p>
<table class="field-table">
@@ -12934,17 +12341,28 @@ This field is populated by deriving the plan from task_run for display purposes.
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>database</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
<td></td>
- <td><p>The name is the name of a check constraint. </p></td>
+ <td><p>The database to update.
+
+The database&#39;s `name` field is used to identify the database to update.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>expression</td>
- <td><a href="#string">string</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The expression is the expression of a check constraint. </p></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the database is not found, a new database will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -12954,8 +12372,8 @@ This field is populated by deriving the plan from task_run for display purposes.
- <h3 id="bytebase.v1.ColumnMetadata">ColumnMetadata</h3>
- <p>ColumnMetadata is the metadata for columns.</p>
+ <h3 id="bytebase.v1.ViewMetadata">ViewMetadata</h3>
+ <p>ViewMetadata is the metadata for views.</p>
<table class="field-table">
@@ -12968,141 +12386,49 @@ This field is populated by deriving the plan from task_run for display purposes.
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a column. </p></td>
- </tr>
-
- <tr>
- <td>position</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The position is the position in columns. </p></td>
- </tr>
-
- <tr>
- <td>has_default</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The name is the name of a view. </p></td>
</tr>
<tr>
- <td>default</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The default value of column. </p></td>
- </tr>
-
- <tr>
- <td>default_on_null</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Oracle specific metadata.
-The default_on_null is the default on null of a column. </p></td>
+ <td><p>The definition is the definition of a view. </p></td>
</tr>
<tr>
- <td>on_update</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The on_update is the on update action of a column.
-For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with
-CURRENT_TIMESTAMP as on update value. </p></td>
+ <td><p>The comment is the comment of a view. </p></td>
</tr>
<tr>
- <td>nullable</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The nullable is the nullable of a column. </p></td>
+ <td>dependency_columns</td>
+ <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_columns is the list of dependency columns of a view. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The type is the type of a column. </p></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
</tr>
<tr>
- <td>character_set</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The character_set is the character_set of a column. </p></td>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The triggers is the list of triggers in a view. </p></td>
</tr>
<tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The collation is the collation of a column. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of a column. </p></td>
- </tr>
-
- <tr>
- <td>generation</td>
- <td><a href="#bytebase.v1.GenerationMetadata">GenerationMetadata</a></td>
- <td></td>
- <td><p>The generation is the generation of a column. </p></td>
- </tr>
-
- <tr>
- <td>is_identity</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>identity_generation</td>
- <td><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td>
- <td></td>
- <td><p>The identity_generation is for identity columns, PG only. </p></td>
- </tr>
-
- <tr>
- <td>identity_seed</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The identity_seed is for identity columns, MSSQL only. </p></td>
- </tr>
-
- <tr>
- <td>identity_increment</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The identity_increment is for identity columns, MSSQL only. </p></td>
- </tr>
-
- <tr>
- <td>default_constraint_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The default_constraint_name is the name of the default constraint, MSSQL only.
-In MSSQL, default values are implemented as named constraints. When modifying or
-dropping a column&#39;s default value, you must reference the constraint by name.
-This field stores the actual constraint name from the database.
-
-Example: A column definition like:
- CREATE TABLE employees (
- status NVARCHAR(20) DEFAULT &#39;active&#39;
- )
-
-Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39;
-or a user-defined name if specified:
- ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
-
-To modify the default, you must first drop the existing constraint by name:
- ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760
- ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
-
-This field is populated when syncing from the database. When empty (e.g., when parsing
-from SQL files), the system cannot automatically drop the constraint. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -13112,979 +12438,737 @@ from SQL files), the system cannot automatically drop the constraint. </p></td>
- <h3 id="bytebase.v1.Database">Database</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database.
-Format: instances/{instance}/databases/{database}
-{database} is the database name in the instance. </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The existence of a database. </p></td>
- </tr>
-
- <tr>
- <td>successful_sync_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The latest synchronization time. </p></td>
- </tr>
-
- <tr>
- <td>project</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The project for a database.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>schema_version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version of database schema. </p></td>
- </tr>
-
- <tr>
- <td>environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
- </tr>
-
- <tr>
- <td>effective_environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The effective environment based on environment tag above and environment
-tag on the instance. Inheritance follows
-https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
- </tr>
-
- <tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>Labels will be used for deployment and policy control. </p></td>
- </tr>
-
- <tr>
- <td>instance_resource</td>
- <td><a href="#bytebase.v1.InstanceResource">InstanceResource</a></td>
- <td></td>
- <td><p>The instance resource. </p></td>
- </tr>
-
- <tr>
- <td>backup_available</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The database is available for DML prior backup. </p></td>
- </tr>
-
- <tr>
- <td>drifted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The schema is drifted from the source of truth. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h3 id="bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</h3>
+ <h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.DatabaseMetadata">DatabaseMetadata</h3>
- <p>DatabaseMetadata is the metadata for databases.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The database metadata name.
-
-Format: instances/{instance}/databases/{database}/metadata </p></td>
- </tr>
-
- <tr>
- <td>schemas</td>
- <td><a href="#bytebase.v1.SchemaMetadata">SchemaMetadata</a></td>
- <td>repeated</td>
- <td><p>The schemas is the list of schemas in a database. </p></td>
- </tr>
-
- <tr>
- <td>character_set</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The character_set is the character set of a database. </p></td>
- </tr>
-
- <tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The collation is the collation of a database. </p></td>
- </tr>
-
- <tr>
- <td>extensions</td>
- <td><a href="#bytebase.v1.ExtensionMetadata">ExtensionMetadata</a></td>
- <td>repeated</td>
- <td><p>The extensions is the list of extensions in a database. </p></td>
- </tr>
-
- <tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner of the database. </p></td>
- </tr>
-
- <tr>
- <td>search_path</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The search_path is the search path of a PostgreSQL database. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</h3>
- <p>DatabaseSDLSchema contains the schema in SDL format.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>schema</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The SDL schema content.
-- For SINGLE_FILE format: contains the complete SDL schema as a text string.
-- For MULTI_FILE format: contains the ZIP archive as binary data. </p></td>
- </tr>
-
- <tr>
- <td>content_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The MIME type of the schema content.
-Indicates how the client should interpret the schema field.
-Examples:
-- &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format
-- &#34;application/zip&#34; for MULTI_FILE format </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseSchema">DatabaseSchema</h3>
- <p>DatabaseSchema is the metadata for databases.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema dump from database. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DependencyColumn">DependencyColumn</h3>
- <p>DependencyColumn is the metadata for dependency columns.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema is the schema of a reference column. </p></td>
- </tr>
-
- <tr>
- <td>table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The table is the table of a reference column. </p></td>
- </tr>
-
- <tr>
- <td>column</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The column is the name of a reference column. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.Changelog.Type">Changelog.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>BASELINE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MIGRATE</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SDL</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.DependencyTable">DependencyTable</h3>
+ <h3 id="bytebase.v1.ChangelogView">ChangelogView</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema is the schema of a reference table. </p></td>
- </tr>
-
- <tr>
- <td>table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The table is the name of a reference table. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>CHANGELOG_VIEW_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>The default / unset value.
+The API will default to the BASIC view.</p></td>
+ </tr>
+
+ <tr>
+ <td>CHANGELOG_VIEW_BASIC</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>CHANGELOG_VIEW_FULL</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3>
+ <h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database or changelog.
-Format:
-database: instances/{instance}/databases/{database}
-changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The target schema. </p></td>
- </tr>
-
- <tr>
- <td>changelog</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the changelog
-Format:
-instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>IDENTITY_GENERATION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ALWAYS</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>BY_DEFAULT</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3>
+ <h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>diff</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DimensionConstraint">DimensionConstraint</h3>
- <p>DimensionConstraint defines constraints for a spatial dimension.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>dimension</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td>
- </tr>
-
- <tr>
- <td>min_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Minimum value for this dimension </p></td>
- </tr>
-
- <tr>
- <td>max_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Maximum value for this dimension </p></td>
- </tr>
-
- <tr>
- <td>tolerance</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Tolerance for this dimension </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DimensionalConfig">DimensionalConfig</h3>
- <p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>dimensions</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Number of dimensions (2-4, default 2) </p></td>
- </tr>
-
- <tr>
- <td>data_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td>
- </tr>
-
- <tr>
- <td>srid</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Spatial reference system identifier (SRID) </p></td>
- </tr>
-
- <tr>
- <td>constraints</td>
- <td><a href="#bytebase.v1.DimensionConstraint">DimensionConstraint</a></td>
- <td>repeated</td>
- <td><p>Coordinate system constraints </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>VIRTUAL</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STORED</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of a type. </p></td>
- </tr>
-
- <tr>
- <td>values</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The enum values of a type. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment describing the enum type. </p></td>
- </tr>
-
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this enum type during schema dump operations. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</h3>
+ <p>SDLFormat specifies the output format for SDL schema.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SDL_FORMAT_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified format. Defaults to SINGLE_FILE.</p></td>
+ </tr>
+
+ <tr>
+ <td>SINGLE_FILE</td>
+ <td>1</td>
+ <td><p>Single file format: returns the complete SDL schema as a single file.</p></td>
+ </tr>
+
+ <tr>
+ <td>MULTI_FILE</td>
+ <td>2</td>
+ <td><p>Multi-file format: returns the SDL schema as a ZIP archive containing
+multiple files organized by schema objects (tables, views, functions, etc.).</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.EventMetadata">EventMetadata</h3>
+ <h3 id="bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the event. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schedule of the event. </p></td>
- </tr>
-
- <tr>
- <td>time_zone</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The time zone of the event. </p></td>
- </tr>
-
- <tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SQL mode setting for the event. </p></td>
- </tr>
-
- <tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The character set used by the client creating the event. </p></td>
- </tr>
-
- <tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The collation used for the connection when creating the event. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of an event. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ExtensionMetadata">ExtensionMetadata</h3>
- <p>ExtensionMetadata is the metadata for extensions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of an extension. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema is the extension that is installed to. But the extension usage
-is not limited to the schema. </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version is the version of an extension. </p></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The description is the description of an extension. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>OBJECT_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SCHEMA</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>VIEW</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MATERIALIZED_VIEW</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FUNCTION</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>PROCEDURE</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SEQUENCE</td>
+ <td>8</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3>
+ <h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a external table. </p></td>
- </tr>
-
- <tr>
- <td>external_server_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The external_server_name is the name of the external server. </p></td>
- </tr>
-
- <tr>
- <td>external_database_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The external_database_name is the name of the external database. </p></td>
- </tr>
-
- <tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a foreign table. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>MODE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DEFAULT</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>APPEND_ONLY</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INSERT_ONLY</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</h3>
- <p>ForeignKeyMetadata is the metadata for foreign keys.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>columns</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The columns are the ordered referencing columns of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>referenced_schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The referenced_schema is the referenced schema name of a foreign key.
-It is an empty string for databases without such concept such as MySQL. </p></td>
- </tr>
-
- <tr>
- <td>referenced_table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The referenced_table is the referenced table name of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>referenced_columns</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>on_delete</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The on_delete is the on delete action of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>on_update</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The on_update is the on update action of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>match_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The match_type is the match type of a foreign key.
-The match_type is the PostgreSQL specific field.
-It&#39;s empty string for other databases. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DELTA</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.FunctionMetadata">FunctionMetadata</h3>
- <p>FunctionMetadata is the metadata for functions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a function. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition is the definition of a function. </p></td>
- </tr>
-
- <tr>
- <td>signature</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The signature is the name with the number and type of input arguments the
-function takes. </p></td>
- </tr>
-
- <tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>MySQL specific metadata. </p></td>
- </tr>
-
- <tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>database_collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>dependency_tables</td>
- <td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>
- <td>repeated</td>
- <td><p>The dependency_tables is the list of dependency tables of a function.
-For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. </p></td>
- </tr>
-
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</h3>
+ <p>Type is the type of a table partition, some database engines may not</p><p>support all types. Only avilable for the following database engines now:</p><p>MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,</p><p>LINEAR_KEY</p><p>(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:</p><p>RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,</p><p>LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>RANGE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>RANGE_COLUMNS</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LIST</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LIST_COLUMNS</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>HASH</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LINEAR_HASH</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>KEY</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LINEAR_KEY</td>
+ <td>8</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3>
+ <h3 id="bytebase.v1.TaskMetadata.State">TaskMetadata.State</h3>
<p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STARTED</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SUSPENDED</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>expression</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+
-
- <h3 id="bytebase.v1.GetChangelogRequest">GetChangelogRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseService">DatabaseService</h3>
+ <p>DatabaseService manages databases and their schemas.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetDatabase</td>
+ <td><a href="#bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</a></td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td><p>Retrieves a database by name.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchGetDatabases</td>
+ <td><a href="#bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</a></td>
+ <td><p>Retrieves multiple databases by their names.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListDatabases</td>
+ <td><a href="#bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</a></td>
+ <td><a href="#bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</a></td>
+ <td><p>Lists databases in a project, instance, or workspace.
+Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateDatabase</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td><p>Updates database properties such as labels and project assignment.
+Permissions required: bb.databases.update</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchUpdateDatabases</td>
+ <td><a href="#bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</a></td>
+ <td><p>Updates multiple databases in a single batch operation.
+Permissions required: bb.databases.update</p></td>
+ </tr>
+
+ <tr>
+ <td>SyncDatabase</td>
+ <td><a href="#bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</a></td>
+ <td><a href="#bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</a></td>
+ <td><p>Synchronizes database schema from the instance.
+Permissions required: bb.databases.sync</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchSyncDatabases</td>
+ <td><a href="#bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</a></td>
+ <td><p>Synchronizes multiple databases in a single batch operation.
+Permissions required: bb.databases.sync</p></td>
+ </tr>
+
+ <tr>
+ <td>GetDatabaseMetadata</td>
+ <td><a href="#bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
+ <td><p>Retrieves database metadata including tables, columns, and indexes.
+Permissions required: bb.databases.getSchema</p></td>
+ </tr>
+
+ <tr>
+ <td>GetDatabaseSchema</td>
+ <td><a href="#bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseSchema">DatabaseSchema</a></td>
+ <td><p>Retrieves database schema as DDL statements.
+Permissions required: bb.databases.getSchema</p></td>
+ </tr>
+
+ <tr>
+ <td>GetDatabaseSDLSchema</td>
+ <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</a></td>
+ <td><p>Retrieves database schema in SDL (Schema Definition Language) format.
+Permissions required: bb.databases.getSchema</p></td>
+ </tr>
+
+ <tr>
+ <td>DiffSchema</td>
+ <td><a href="#bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</a></td>
+ <td><a href="#bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</a></td>
+ <td><p>Compares and generates migration statements between two schemas.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListChangelogs</td>
+ <td><a href="#bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</a></td>
+ <td><a href="#bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</a></td>
+ <td><p>Lists migration history for a database.
+Permissions required: bb.changelogs.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetChangelog</td>
+ <td><a href="#bytebase.v1.GetChangelogRequest">GetChangelogRequest</a></td>
+ <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
+ <td><p>Retrieves a specific changelog entry.
+Permissions required: bb.changelogs.get</p></td>
+ </tr>
+
+ <tr>
+ <td>GetSchemaString</td>
+ <td><a href="#bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</a></td>
+ <td><a href="#bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</a></td>
+ <td><p>Generates schema DDL for a database object.
+Permissions required: bb.databases.getSchema</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the changelog to retrieve.
-Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- </tr>
-
- <tr>
- <td>view</td>
- <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>GetDatabase</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve metadata.
-Format: instances/{instance}/databases/{database}/metadata </p></td>
- </tr>
+
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter databases returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- schema: the schema name, support &#34;==&#34; operator.
-- table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-
-For example:
-schema == &#34;schema-a&#34;
-table == &#34;table-a&#34;
-table.matches(&#34;table-a&#34;)
-schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;)
-The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;.
-The column masking level will only be returned when a table filter is used. </p></td>
- </tr>
- <tr>
- <td>limit</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Limit the response size of returned table metadata per schema.
-For example, if the database has 3 schemas, and each schema has 100 tables,
-if limit is 20, then only 20 tables will be returned for each schema, total 60 tables.
-Default 0, means no limit. </p></td>
- </tr>
+ <tr>
+ <td>BatchGetDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databases:batchGet</td>
+ <td></td>
+ </tr>
- </tbody>
- </table>
-
+ <tr>
+ <td>BatchGetDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/databases:batchGet</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databases</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/databases</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=workspaces/*}/databases</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateDatabase</td>
+ <td>PATCH</td>
+ <td>/v1/{database.name=instances/*/databases/*}</td>
+ <td>database</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchUpdateDatabases</td>
+ <td>POST</td>
+ <td>/v1/{parent=instances/*}/databases:batchUpdate</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>SyncDatabase</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*}:sync</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchSyncDatabases</td>
+ <td>POST</td>
+ <td>/v1/{parent=instances/*}/databases:batchSync</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetDatabaseMetadata</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/metadata}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetDatabaseSchema</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/schema}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetDatabaseSDLSchema</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/sdlSchema}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DiffSchema</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*}:diffSchema</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>DiffSchema</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*/changelogs/*}:diffSchema</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListChangelogs</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*/databases/*}/changelogs</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetChangelog</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/changelogs/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetSchemaString</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/schemaString}</td>
+ <td></td>
+ </tr>
+
+
+ </tbody>
+ </table>
-
+
- <h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3>
- <p></p>
+ <div class="file-heading">
+ <h2 id="v1/group_service.proto">v1/group_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>
+ <p>Request message for batch getting groups.</p>
<table class="field-table">
@@ -14094,11 +13178,11 @@ Default 0, means no limit. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td>repeated</td>
+ <td><p>The group names to retrieve.
+Format: groups/{email} </p></td>
</tr>
</tbody>
@@ -14108,8 +13192,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</h3>
+ <p>Response message for batch getting groups.</p>
<table class="field-table">
@@ -14119,18 +13203,10 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve SDL schema.
-Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
- </tr>
-
- <tr>
- <td>format</td>
- <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td>
- <td></td>
- <td><p>The format of the SDL schema output. </p></td>
+ <td>groups</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>repeated</td>
+ <td><p>The groups from the specified request. </p></td>
</tr>
</tbody>
@@ -14140,8 +13216,8 @@ Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
- <h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3>
+ <p>Request message for creating a group.</p>
<table class="field-table">
@@ -14151,11 +13227,18 @@ Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>group</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td></td>
+ <td><p>The group to create. </p></td>
+ </tr>
+
+ <tr>
+ <td>group_email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to retrieve schema.
-Format: instances/{instance}/databases/{database}/schema </p></td>
+ <td><p>The email to use for the group, which will become the final component
+of the group&#39;s resource name. </p></td>
</tr>
</tbody>
@@ -14165,8 +13248,8 @@ Format: instances/{instance}/databases/{database}/schema </p></td>
- <h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>
+ <p>Request message for deleting a group.</p>
<table class="field-table">
@@ -14179,37 +13262,8 @@ Format: instances/{instance}/databases/{database}/schema </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>It&#39;s empty for DATABASE. </p></td>
- </tr>
-
- <tr>
- <td>object</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>It&#39;s empty for DATABASE and SCHEMA. </p></td>
- </tr>
-
- <tr>
- <td>metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
- <td></td>
- <td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.
-Also the schema and object are empty. </p></td>
+ <td><p>The name of the group to delete.
+Format: groups/{email} </p></td>
</tr>
</tbody>
@@ -14219,8 +13273,8 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetGroupRequest">GetGroupRequest</h3>
+ <p>Request message for getting a group.</p>
<table class="field-table">
@@ -14230,10 +13284,11 @@ Also the schema and object are empty. </p></td>
<tbody>
<tr>
- <td>schema_string</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the group to retrieve.
+Format: groups/{email} </p></td>
</tr>
</tbody>
@@ -14243,39 +13298,8 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.GridLevel">GridLevel</h3>
- <p>GridLevel defines a tessellation grid level with its density.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>level</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Grid level number (1-4 for SQL Server) </p></td>
- </tr>
-
- <tr>
- <td>density</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Grid density (LOW, MEDIUM, HIGH) </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3>
- <p>IndexMetadata is the metadata for indexes.</p>
+ <h3 id="bytebase.v1.Group">Group</h3>
+ <p>A group of users within the workspace.</p>
<table class="field-table">
@@ -14288,123 +13312,76 @@ Also the schema and object are empty. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of an index. </p></td>
- </tr>
-
- <tr>
- <td>expressions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The expressions are the ordered columns or expressions of an index.
-This could refer to a column or an expression. </p></td>
- </tr>
-
- <tr>
- <td>key_length</td>
- <td><a href="#int64">int64</a></td>
- <td>repeated</td>
- <td><p>The key_lengths are the ordered key lengths of an index.
-If the key length is not specified, it&#39;s -1. </p></td>
- </tr>
-
- <tr>
- <td>descending</td>
- <td><a href="#bool">bool</a></td>
- <td>repeated</td>
- <td><p>The descending is the ordered descending of an index. </p></td>
+ <td><p>The name of the group to retrieve.
+Format: groups/{group}, the group should be email or uuid. </p></td>
</tr>
<tr>
- <td>type</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The type is the type of an index. </p></td>
- </tr>
-
- <tr>
- <td>unique</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The unique is whether the index is unique. </p></td>
- </tr>
-
- <tr>
- <td>primary</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The primary is whether the index is a primary key index. </p></td>
- </tr>
-
- <tr>
- <td>visible</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The visible is whether the index is visible. </p></td>
+ <td><p>The display title of the group. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of an index. </p></td>
+ <td><p>The description of the group. </p></td>
</tr>
<tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition of an index. </p></td>
+ <td>members</td>
+ <td><a href="#bytebase.v1.GroupMember">GroupMember</a></td>
+ <td>repeated</td>
+ <td><p>The members of the group. </p></td>
</tr>
<tr>
- <td>parent_index_schema</td>
+ <td>source</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema name of the parent index. </p></td>
+ <td><p>The source system where the group originated (e.g., Entra ID for SCIM sync). </p></td>
</tr>
<tr>
- <td>parent_index_name</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The index name of the parent index. </p></td>
+ <td><p>The unique email for the group. </p></td>
</tr>
- <tr>
- <td>granularity</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The number of granules in the block. It&#39;s a ClickHouse specific field. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GroupMember">GroupMember</h3>
+ <p>A member of a group with a role.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>is_constraint</td>
- <td><a href="#bool">bool</a></td>
+ <td>member</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>It&#39;s a PostgreSQL specific field.
-The unique constraint and unique index are not the same thing in PostgreSQL. </p></td>
+ <td><p>Member is the principal who belong to this group.
+
+Format: users/[email protected] </p></td>
</tr>
<tr>
- <td>spatial_config</td>
- <td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</a></td>
+ <td>role</td>
+ <td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td>
<td></td>
- <td><p>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td>
- </tr>
-
- <tr>
- <td>opclass_names</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.html
-Name of the operator class for each column. (PostgreSQL specific). </p></td>
- </tr>
-
- <tr>
- <td>opclass_defaults</td>
- <td><a href="#bool">bool</a></td>
- <td>repeated</td>
- <td><p>True if the operator class is the default. (PostgreSQL specific). </p></td>
+ <td><p>The member&#39;s role in the group. </p></td>
</tr>
</tbody>
@@ -14414,8 +13391,8 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td>
- <h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListGroupsRequest">ListGroupsRequest</h3>
+ <p>Request message for listing groups.</p>
<table class="field-table">
@@ -14424,20 +13401,13 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td>
</thead>
<tbody>
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent of the changelogs.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
<tr>
<td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of changelogs to return. The service may return fewer
-than this value. If unspecified, at most 10 changelogs will be returned.
+ <td><p>The maximum number of groups to return. The service may return fewer than
+this value.
+If unspecified, at most 10 groups will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
@@ -14445,35 +13415,33 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
<td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from the previous call.
+ <td><p>A page token, received from a previous `ListGroups` call.
Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided must match
+When paginating, all other parameters provided to `ListGroups` must match
the call that provided the page token. </p></td>
</tr>
- <tr>
- <td>view</td>
- <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
<tr>
<td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter changelogs returned in the list.
+ <td><p>Filter is used to filter groups returned in the list.
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
-status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values.
-type: the changelog type, support &#34;in&#34; and &#34;==&#34; operation. check Changelog.Type for available values.
+- title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-Example:
-status == &#34;DONE&#34;
-type in [&#34;BASELINE&#34;, &#34;MIGRATE&#34;]
-status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; </p></td>
+For example:
+title == &#34;dba&#34;
+email == &#34;[email protected]&#34;
+title.matches(&#34;dba&#34;)
+email.matches(&#34;dba&#34;)
+project == &#34;projects/sample-project&#34;
+You can combine filter conditions like:
+title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) </p></td>
</tr>
</tbody>
@@ -14483,8 +13451,8 @@ status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; </p></td>
- <h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3>
+ <p>Response message for listing groups.</p>
<table class="field-table">
@@ -14494,10 +13462,10 @@ status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; </p></td>
<tbody>
<tr>
- <td>changelogs</td>
- <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
+ <td>groups</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
<td>repeated</td>
- <td><p>The list of changelogs. </p></td>
+ <td><p>The groups from the specified request. </p></td>
</tr>
<tr>
@@ -14515,8 +13483,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</h3>
+ <p>Request message for updating a group.</p>
<table class="field-table">
@@ -14526,101 +13494,220 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>group</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
<td></td>
- <td><p>- projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission.
-- workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission.
-- instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission </p></td>
+ <td><p>The group to update.
+
+The group&#39;s `name` field is used to identify the group to update.
+Format: groups/{email} </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The maximum number of databases to return. The service may return fewer
-than this value.
-If unspecified, at most 10 databases will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListDatabases` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListDatabases` must
-match the call that provided the page token. </p></td>
+ <td><p>If set to true, and the group is not found, a new group will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter databases returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ </tbody>
+ </table>
-Supported filter:
-- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
-- name: the database name, support &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
-- engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator.
-- drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator.
-- table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+
-For example:
-environment == &#34;environments/{environment resource id}&#34;
-environment == &#34;&#34; (find databases which environment is not set)
-project == &#34;projects/{project resource id}&#34;
-instance == &#34;instances/{instance resource id}&#34;
-name.matches(&#34;database name&#34;)
-engine == &#34;MYSQL&#34;
-engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
-!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
-exclude_unassigned == true
-drifted == true
-table == &#34;sample&#34;
-table.matches(&#34;sam&#34;)
-labels.environment == &#34;production&#34;
-labels.region == &#34;asia&#34;
-labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+
+
-You can combine filter conditions like:
-environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) </p></td>
- </tr>
+
+ <h3 id="bytebase.v1.GroupMember.Role">GroupMember.Role</h3>
+ <p>The role of a group member.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ROLE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified role.</p></td>
+ </tr>
+
+ <tr>
+ <td>OWNER</td>
+ <td>1</td>
+ <td><p>Group owner.</p></td>
+ </tr>
+
+ <tr>
+ <td>MEMBER</td>
+ <td>2</td>
+ <td><p>Group member.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GroupService">GroupService</h3>
+ <p>GroupService manages user groups for organizing users and permissions.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetGroup</td>
+ <td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td><p>Gets a group by name.
+Permissions required: bb.groups.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchGetGroups</td>
+ <td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</a></td>
+ <td><p>Gets multiple groups in a single request.
+Permissions required: bb.groups.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListGroups</td>
+ <td><a href="#bytebase.v1.ListGroupsRequest">ListGroupsRequest</a></td>
+ <td><a href="#bytebase.v1.ListGroupsResponse">ListGroupsResponse</a></td>
+ <td><p>Lists all groups in the workspace.
+Permissions required: bb.groups.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateGroup</td>
+ <td><a href="#bytebase.v1.CreateGroupRequest">CreateGroupRequest</a></td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td><p>Creates a new group.
+Permissions required: bb.groups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateGroup</td>
+ <td><a href="#bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</a></td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td><p>Updates a group. Group owners or users with bb.groups.update permission can update.
+Permissions required: bb.groups.update OR caller is group owner
+When allow_missing=true, also requires: bb.groups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteGroup</td>
+ <td><a href="#bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a group. Group owners or users with bb.groups.delete permission can delete.
+Permissions required: bb.groups.delete OR caller is group owner</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted database if specified. </p></td>
- </tr>
- <tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The order by of databases.
-Support name, project, instance. The default sorting order is ascending.
-For example:
-- order_by = &#34;name&#34; - order by name ascending
-- order_by = &#34;name desc&#34;
-- order_by = &#34;name desc, project asc&#34; </p></td>
- </tr>
+ <tr>
+ <td>GetGroup</td>
+ <td>GET</td>
+ <td>/v1/{name=groups/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchGetGroups</td>
+ <td>GET</td>
+ <td>/v1/groups:batchGet</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListGroups</td>
+ <td>GET</td>
+ <td>/v1/groups</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateGroup</td>
+ <td>POST</td>
+ <td>/v1/groups</td>
+ <td>group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateGroup</td>
+ <td>PATCH</td>
+ <td>/v1/{group.name=groups/*}</td>
+ <td>group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteGroup</td>
+ <td>DELETE</td>
+ <td>/v1/{name=groups/*}</td>
+ <td></td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3>
+ <div class="file-heading">
+ <h2 id="v1/idp_service.proto">v1/idp_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</h3>
<p></p>
@@ -14631,18 +13718,28 @@ For example:
<tbody>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>The databases from the specified request. </p></td>
+ <td>identity_provider</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td></td>
+ <td><p>The identity provider to create. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>identity_provider_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>The ID to use for the identity provider, which will become the final component of
+the identity provider&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
+ </tr>
+
+ <tr>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, the request will be validated without actually creating the identity provider. </p></td>
</tr>
</tbody>
@@ -14652,8 +13749,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</h3>
- <p>MaterializedViewMetadata is the metadata for materialized views.</p>
+ <h3 id="bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</h3>
+ <p></p>
<table class="field-table">
@@ -14666,50 +13763,54 @@ If this field is omitted, there are no subsequent pages. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a materialized view. </p></td>
- </tr>
+ <td><p>The name of the identity provider to delete.
+Format: idps/{identity_provider} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.FieldMapping">FieldMapping</h3>
+ <p>FieldMapping saves the field names from user info API of identity provider.</p><p>As we save all raw json string of user info response data into `principal.idp_user_info`,</p><p>we can extract the relevant data based with `FieldMapping`.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>definition</td>
+ <td>identifier</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition is the definition of a materialized view. </p></td>
+ <td><p>Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>display_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of a materialized view. </p></td>
- </tr>
-
- <tr>
- <td>dependency_columns</td>
- <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
- <td>repeated</td>
- <td><p>The dependency_columns is the list of dependency columns of a materialized
-view. </p></td>
- </tr>
-
- <tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
+ <td><p>DisplayName is the field name of display name in 3rd-party idp user info. Optional. </p></td>
</tr>
<tr>
- <td>indexes</td>
- <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
- <td>repeated</td>
- <td><p>The indexes is the list of indexes in a table. </p></td>
+ <td>phone</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Phone is the field name of primary phone in 3rd-party idp user info. Optional. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>groups</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Groups is the field name of groups in 3rd-party idp user info. Optional.
+Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ </p></td>
</tr>
</tbody>
@@ -14719,8 +13820,8 @@ view. </p></td>
- <h3 id="bytebase.v1.PackageMetadata">PackageMetadata</h3>
- <p>PackageMetadata is the metadata for packages.</p>
+ <h3 id="bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</h3>
+ <p></p>
<table class="field-table">
@@ -14733,14 +13834,8 @@ view. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a package. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition is the definition of a package. </p></td>
+ <td><p>The name of the identity provider to retrieve.
+Format: idps/{idp} </p></td>
</tr>
</tbody>
@@ -14750,8 +13845,8 @@ view. </p></td>
- <h3 id="bytebase.v1.ProcedureMetadata">ProcedureMetadata</h3>
- <p>ProcedureMetadata is the metadata for procedures.</p>
+ <h3 id="bytebase.v1.IdentityProvider">IdentityProvider</h3>
+ <p></p>
<table class="field-table">
@@ -14764,64 +13859,74 @@ view. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a procedure. </p></td>
+ <td><p>The name of the identity provider.
+Format: idps/{idp} </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition is the definition of a procedure. </p></td>
+ <td><p>The display title of the identity provider. </p></td>
</tr>
<tr>
- <td>signature</td>
+ <td>domain</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The signature is the name with the number and type of input arguments the
-procedure takes. </p></td>
+ <td><p>The domain for email matching when using this identity provider. </p></td>
</tr>
<tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.IdentityProviderType">IdentityProviderType</a></td>
<td></td>
- <td><p>MySQL specific metadata. </p></td>
+ <td><p>The type of identity provider protocol. </p></td>
</tr>
<tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
+ <td>config</td>
+ <td><a href="#bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The configuration details for the identity provider. </p></td>
</tr>
- <tr>
- <td>database_collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
+ <td>oauth2_config</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>OAuth2 protocol configuration. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>oidc_config</td>
+ <td><a href="#bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</a></td>
<td></td>
- <td><p>The comment is the comment of a procedure. </p></td>
+ <td><p>OIDC protocol configuration. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>ldap_config</td>
+ <td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>LDAP protocol configuration. </p></td>
</tr>
</tbody>
@@ -14831,8 +13936,8 @@ procedure takes. </p></td>
- <h3 id="bytebase.v1.SchemaMetadata">SchemaMetadata</h3>
- <p>SchemaMetadata is the metadata for schemas.</p><p>This is the concept of schema in Postgres, but it's a no-op for MySQL.</p>
+ <h3 id="bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</h3>
+ <p>LDAPIdentityProviderConfig is the structure for LDAP identity provider config.</p>
<table class="field-table">
@@ -14842,118 +13947,103 @@ procedure takes. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the schema name.
-It is an empty string for databases without such concept such as MySQL. </p></td>
+ <td><p>Host is the hostname or IP address of the LDAP server, e.g.,
+&#34;ldap.example.com&#34;. </p></td>
</tr>
<tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td>
- <td>repeated</td>
- <td><p>The tables is the list of tables in a schema. </p></td>
+ <td>port</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Port is the port number of the LDAP server, e.g., 389. When not set, the
+default port of the corresponding security protocol will be used, i.e. 389
+for StartTLS and 636 for LDAPS. </p></td>
</tr>
<tr>
- <td>external_tables</td>
- <td><a href="#bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</a></td>
- <td>repeated</td>
- <td><p>The external_tables is the list of external tables in a schema. </p></td>
+ <td>skip_tls_verify</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>SkipTLSVerify controls whether to skip TLS certificate verification. </p></td>
</tr>
<tr>
- <td>views</td>
- <td><a href="#bytebase.v1.ViewMetadata">ViewMetadata</a></td>
- <td>repeated</td>
- <td><p>The views is the list of views in a schema. </p></td>
+ <td>bind_dn</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>BindDN is the DN of the user to bind as a service account to perform
+search requests. </p></td>
</tr>
<tr>
- <td>functions</td>
- <td><a href="#bytebase.v1.FunctionMetadata">FunctionMetadata</a></td>
- <td>repeated</td>
- <td><p>The functions is the list of functions in a schema. </p></td>
+ <td>bind_password</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>BindPassword is the password of the user to bind as a service account. </p></td>
</tr>
<tr>
- <td>procedures</td>
- <td><a href="#bytebase.v1.ProcedureMetadata">ProcedureMetadata</a></td>
- <td>repeated</td>
- <td><p>The procedures is the list of procedures in a schema. </p></td>
+ <td>base_dn</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. </p></td>
</tr>
<tr>
- <td>streams</td>
- <td><a href="#bytebase.v1.StreamMetadata">StreamMetadata</a></td>
- <td>repeated</td>
- <td><p>The streams is the list of streams in a schema, currently, only used for
-Snowflake. </p></td>
+ <td>user_filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. </p></td>
</tr>
<tr>
- <td>tasks</td>
- <td><a href="#bytebase.v1.TaskMetadata">TaskMetadata</a></td>
- <td>repeated</td>
- <td><p>The routines is the list of routines in a schema, currently, only used for
-Snowflake. </p></td>
+ <td>security_protocol</td>
+ <td><a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</a></td>
+ <td></td>
+ <td><p>SecurityProtocol is the security protocol to be used for establishing
+connections with the LDAP server. </p></td>
</tr>
<tr>
- <td>materialized_views</td>
- <td><a href="#bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</a></td>
- <td>repeated</td>
- <td><p>The materialized_views is the list of materialized views in a schema. </p></td>
+ <td>field_mapping</td>
+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
+ <td></td>
+ <td><p>FieldMapping is the mapping of the user attributes returned by the LDAP
+server. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>packages</td>
- <td><a href="#bytebase.v1.PackageMetadata">PackageMetadata</a></td>
+ <td>identity_providers</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
<td>repeated</td>
- <td><p>The packages is the list of packages in a schema. </p></td>
- </tr>
-
- <tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner of the schema. </p></td>
- </tr>
-
- <tr>
- <td>sequences</td>
- <td><a href="#bytebase.v1.SequenceMetadata">SequenceMetadata</a></td>
- <td>repeated</td>
- <td><p>The sequences is the list of sequences in a schema, sorted by name. </p></td>
- </tr>
-
- <tr>
- <td>events</td>
- <td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td>
- <td>repeated</td>
- <td><p>The events is the list of scheduled events in a schema. </p></td>
- </tr>
-
- <tr>
- <td>enum_types</td>
- <td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td>
- <td>repeated</td>
- <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td>
- </tr>
-
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this schema during schema dump operations. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of a schema. </p></td>
+ <td><p>The identity providers from the specified request. </p></td>
</tr>
</tbody>
@@ -14963,8 +14053,8 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</h3>
- <p></p>
+ <h3 id="bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</h3>
+ <p>OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.</p>
<table class="field-table">
@@ -14974,94 +14064,66 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>data_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The data type of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>start</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The start value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>min_value</td>
+ <td>auth_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The minimum value of a sequence. </p></td>
+ <td><p>The authorization endpoint URL for OAuth2 flow. </p></td>
</tr>
<tr>
- <td>max_value</td>
+ <td>token_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum value of a sequence. </p></td>
+ <td><p>The token endpoint URL for exchanging authorization code. </p></td>
</tr>
<tr>
- <td>increment</td>
+ <td>user_info_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Increment value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>cycle</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Cycle is whether the sequence cycles. </p></td>
+ <td><p>The user information endpoint URL. </p></td>
</tr>
<tr>
- <td>cache_size</td>
+ <td>client_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Cache size of a sequence. </p></td>
+ <td><p>The OAuth2 client identifier. </p></td>
</tr>
<tr>
- <td>last_value</td>
+ <td>client_secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Last value of a sequence. </p></td>
+ <td><p>The OAuth2 client secret for authentication. </p></td>
</tr>
<tr>
- <td>owner_table</td>
+ <td>scopes</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner table of the sequence. </p></td>
+ <td>repeated</td>
+ <td><p>The list of OAuth2 scopes to request. </p></td>
</tr>
<tr>
- <td>owner_column</td>
- <td><a href="#string">string</a></td>
+ <td>field_mapping</td>
+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
<td></td>
- <td><p>The owner column of the sequence. </p></td>
+ <td><p>Mapping configuration for user attributes from OAuth2 response. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>skip_tls_verify</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment describing the sequence. </p></td>
+ <td><p>Whether to skip TLS certificate verification. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>auth_style</td>
+ <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
<td></td>
- <td><p>Whether to skip this sequence during schema dump operations. </p></td>
+ <td><p>The authentication style for client credentials. </p></td>
</tr>
</tbody>
@@ -15071,8 +14133,8 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</h3>
- <p>SpatialIndexConfig defines the spatial index configuration for spatial databases.</p>
+ <h3 id="bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</h3>
+ <p></p>
<table class="field-table">
@@ -15082,31 +14144,10 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>method</td>
+ <td>code</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) </p></td>
- </tr>
-
- <tr>
- <td>tessellation</td>
- <td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td>
- <td></td>
- <td><p>Tessellation configuration for grid-based spatial indexes </p></td>
- </tr>
-
- <tr>
- <td>storage</td>
- <td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td>
- <td></td>
- <td><p>Storage and performance configuration </p></td>
- </tr>
-
- <tr>
- <td>dimensional</td>
- <td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td>
- <td></td>
- <td><p>Dimensional configuration </p></td>
+ <td><p>Authorize code from website. </p></td>
</tr>
</tbody>
@@ -15116,8 +14157,8 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.StorageConfig">StorageConfig</h3>
- <p>StorageConfig defines storage and performance parameters for spatial indexes.</p>
+ <h3 id="bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3>
+ <p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p>
<table class="field-table">
@@ -15127,101 +14168,85 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>fillfactor</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Fill factor percentage (1-100) </p></td>
- </tr>
-
- <tr>
- <td>buffering</td>
+ <td>issuer</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Buffering mode for PostgreSQL (auto, on, off) </p></td>
+ <td><p>The OIDC issuer URL for the identity provider. </p></td>
</tr>
<tr>
- <td>tablespace</td>
+ <td>client_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Tablespace configuration for Oracle </p></td>
+ <td><p>The OIDC client identifier. </p></td>
</tr>
<tr>
- <td>work_tablespace</td>
+ <td>client_secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sdo_level</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>commit_interval</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>pad_index</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>SQL Server specific parameters </p></td>
+ <td><p>The OIDC client secret for authentication. </p></td>
</tr>
<tr>
- <td>sort_in_tempdb</td>
+ <td>scopes</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>ON, OFF </p></td>
+ <td>repeated</td>
+ <td><p>The scopes that the OIDC provider supports.
+Should be fetched from the well-known configuration file of the OIDC provider. </p></td>
</tr>
<tr>
- <td>drop_existing</td>
- <td><a href="#bool">bool</a></td>
+ <td>field_mapping</td>
+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Mapping configuration for user attributes from OIDC claims. </p></td>
</tr>
<tr>
- <td>online</td>
+ <td>skip_tls_verify</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether to skip TLS certificate verification. </p></td>
</tr>
<tr>
- <td>allow_row_locks</td>
- <td><a href="#bool">bool</a></td>
+ <td>auth_style</td>
+ <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The authentication style for client credentials. </p></td>
</tr>
<tr>
- <td>allow_page_locks</td>
- <td><a href="#bool">bool</a></td>
+ <td>auth_endpoint</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The authorization endpoint of the OIDC provider.
+Should be fetched from the well-known configuration file of the OIDC provider. </p></td>
</tr>
- <tr>
- <td>maxdop</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>data_compression</td>
+ <td>code</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>NONE, ROW, PAGE </p></td>
+ <td><p>Authorize code from OIDC provider. </p></td>
</tr>
</tbody>
@@ -15231,7 +14256,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.StreamMetadata">StreamMetadata</h3>
+ <h3 id="bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</h3>
<p></p>
@@ -15242,59 +14267,24 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>identity_provider</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
<td></td>
- <td><p>The name is the name of a stream. </p></td>
+ <td><p>The identity provider to test connection including uncreated. </p></td>
</tr>
<tr>
- <td>table_name</td>
- <td><a href="#string">string</a></td>
+ <td>oauth2_context</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</a></td>
<td></td>
- <td><p>The table_name is the name of the table/view that the stream is created on. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner of the stream. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment of the stream. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td>
- <td></td>
- <td><p>The type of the stream. </p></td>
- </tr>
-
- <tr>
- <td>stale</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td>
- </tr>
-
- <tr>
- <td>mode</td>
- <td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td>
- <td></td>
- <td><p>The mode of the stream. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
+ <td>oidc_context</td>
+ <td><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</a></td>
<td></td>
- <td><p>The definition of the stream. </p></td>
+ <td><p>OIDC authentication context for test connection. </p></td>
</tr>
</tbody>
@@ -15304,7 +14294,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3>
+ <h3 id="bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</h3>
<p></p>
@@ -15315,11 +14305,17 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to sync.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td>claims</td>
+ <td><a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</a></td>
+ <td>repeated</td>
+ <td><p>The map of claims returned by the identity provider. </p></td>
+ </tr>
+
+ <tr>
+ <td>user_info</td>
+ <td><a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</a></td>
+ <td>repeated</td>
+ <td><p>The matched user info from the claims. </p></td>
</tr>
</tbody>
@@ -15329,17 +14325,10 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3>
+ <h3 id="bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</h3>
<p></p>
-
-
-
- <h3 id="bytebase.v1.TableMetadata">TableMetadata</h3>
- <p>TableMetadata is the metadata for tables.</p>
-
-
<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
@@ -15347,152 +14336,48 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a table. </p></td>
- </tr>
-
- <tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
- </tr>
-
- <tr>
- <td>indexes</td>
- <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
- <td>repeated</td>
- <td><p>The indexes is the list of indexes in a table. </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The engine is the engine of a table. </p></td>
- </tr>
-
- <tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The collation is the collation of a table. </p></td>
- </tr>
-
- <tr>
- <td>charset</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The character set of table. </p></td>
- </tr>
-
- <tr>
- <td>row_count</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The row_count is the estimated number of rows of a table. </p></td>
- </tr>
-
- <tr>
- <td>data_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The data_size is the estimated data size of a table. </p></td>
- </tr>
-
- <tr>
- <td>index_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The index_size is the estimated index size of a table. </p></td>
- </tr>
-
- <tr>
- <td>data_free</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The data_free is the estimated free data size of a table. </p></td>
- </tr>
-
- <tr>
- <td>create_options</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The create_options is the create option of a table. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of a table. </p></td>
- </tr>
-
- <tr>
- <td>foreign_keys</td>
- <td><a href="#bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</a></td>
- <td>repeated</td>
- <td><p>The foreign_keys is the list of foreign keys in a table. </p></td>
- </tr>
-
- <tr>
- <td>partitions</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
- <td>repeated</td>
- <td><p>The partitions is the list of partitions in a table. </p></td>
- </tr>
-
- <tr>
- <td>check_constraints</td>
- <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
- <td>repeated</td>
- <td><p>The check_constraints is the list of check constraints in a table. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>owner</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The owner of the table. </p></td>
- </tr>
-
- <tr>
- <td>sorting_keys</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.
-Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by </p></td>
- </tr>
-
- <tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
- <td>repeated</td>
- <td><p>The triggers is the list of triggers associated with the table. </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this table during schema dump operations. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>sharding_info</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>primary_key_type</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes
-CLUSTERED or NONCLUSTERED. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -15502,8 +14387,8 @@ CLUSTERED or NONCLUSTERED. </p></td>
- <h3 id="bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</h3>
- <p>TablePartitionMetadata is the metadata for table partitions.</p>
+ <h3 id="bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</h3>
+ <p></p>
<table class="field-table">
@@ -15513,78 +14398,28 @@ CLUSTERED or NONCLUSTERED. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>identity_provider</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
<td></td>
- <td><p>The name is the name of a table partition. </p></td>
+ <td><p>The identity provider to update.
+
+The identity provider&#39;s `name` field is used to identify the identity provider to update.
+Format: idps/{identity_provider} </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The type of a table partition. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>expression</td>
- <td><a href="#string">string</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The expression is the expression of a table partition.
-For PostgreSQL, the expression is the text of {FOR VALUES
-partition_bound_spec}, see
-https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL,
-the expression is the `expr` or `column_list` of the following syntax.
-PARTITION BY
- { [LINEAR] HASH(expr)
- | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list)
- | RANGE{(expr) | COLUMNS(column_list)}
- | LIST{(expr) | COLUMNS(column_list)} }. </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The value is the value of a table partition.
-For MySQL, the value is for RANGE and LIST partition types,
-- For a RANGE partition, it contains the value set in the partition&#39;s
-VALUES LESS THAN clause, which can be either an integer or MAXVALUE.
-- For a LIST partition, this column contains the values defined in the
-partition&#39;s VALUES IN clause, which is a list of comma-separated integer
-values.
-- For others, it&#39;s an empty string. </p></td>
- </tr>
-
- <tr>
- <td>use_default</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The use_default is whether the users use the default partition, it stores
-the different value for different database engines. For MySQL, it&#39;s [INT]
-type, 0 means not use default partition, otherwise, it&#39;s equals to number
-in syntax [SUB]PARTITION {number}. </p></td>
- </tr>
-
- <tr>
- <td>subpartitions</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
- <td>repeated</td>
- <td><p>The subpartitions is the list of subpartitions in a table partition. </p></td>
- </tr>
-
- <tr>
- <td>indexes</td>
- <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>check_constraints</td>
- <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td><p>If set to true, and the identity provider is not found, a new identity provider will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -15594,85 +14429,269 @@ in syntax [SUB]PARTITION {number}. </p></td>
- <h3 id="bytebase.v1.TaskMetadata">TaskMetadata</h3>
+
+
+ <h3 id="bytebase.v1.IdentityProviderType">IdentityProviderType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified identity provider type.</p></td>
+ </tr>
+
+ <tr>
+ <td>OAUTH2</td>
+ <td>1</td>
+ <td><p>OAuth 2.0 authentication protocol.</p></td>
+ </tr>
+
+ <tr>
+ <td>OIDC</td>
+ <td>2</td>
+ <td><p>OpenID Connect authentication protocol.</p></td>
+ </tr>
+
+ <tr>
+ <td>LDAP</td>
+ <td>3</td>
+ <td><p>LDAP directory service authentication.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SECURITY_PROTOCOL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>START_TLS</td>
+ <td>1</td>
+ <td><p>StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS.</p></td>
+ </tr>
+
+ <tr>
+ <td>LDAPS</td>
+ <td>2</td>
+ <td><p>LDAPS is the security protocol that uses TLS from the beginning.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</h3>
<p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>IN_PARAMS</td>
+ <td>1</td>
+ <td><p>IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body
+as application/x-www-form-urlencoded parameters.</p></td>
+ </tr>
+
+ <tr>
+ <td>IN_HEADER</td>
+ <td>2</td>
+ <td><p>IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.
+This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IdentityProviderService">IdentityProviderService</h3>
+ <p>IdentityProviderService manages external identity providers for SSO authentication.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetIdentityProvider</td>
+ <td><a href="#bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</a></td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td><p>Gets an identity provider by name.
+Permissions required: bb.identityProviders.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIdentityProviders</td>
+ <td><a href="#bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</a></td>
+ <td><a href="#bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</a></td>
+ <td><p>Lists all configured identity providers (public endpoint for login page).
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIdentityProvider</td>
+ <td><a href="#bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</a></td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td><p>Creates a new identity provider.
+Permissions required: bb.identityProviders.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIdentityProvider</td>
+ <td><a href="#bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</a></td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td><p>Updates an identity provider.
+Permissions required: bb.identityProviders.update
+When allow_missing=true, also requires: bb.identityProviders.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteIdentityProvider</td>
+ <td><a href="#bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes an identity provider.
+Permissions required: bb.identityProviders.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>TestIdentityProvider</td>
+ <td><a href="#bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</a></td>
+ <td><a href="#bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</a></td>
+ <td><p>Tests the connection and configuration of an identity provider.
+Permissions required: bb.identityProviders.update</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a task. </p></td>
- </tr>
-
- <tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The id is the snowflake-generated id of a task.
-Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
- </tr>
- <tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner of the task. </p></td>
- </tr>
+ <tr>
+ <td>GetIdentityProvider</td>
+ <td>GET</td>
+ <td>/v1/{name=idps/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment of the task. </p></td>
- </tr>
+
- <tr>
- <td>warehouse</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The warehouse of the task. </p></td>
- </tr>
- <tr>
- <td>schedule</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schedule interval of the task. </p></td>
- </tr>
+ <tr>
+ <td>ListIdentityProviders</td>
+ <td>GET</td>
+ <td>/v1/idps</td>
+ <td></td>
+ </tr>
- <tr>
- <td>predecessors</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The predecessor tasks of the task. </p></td>
- </tr>
+
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.TaskMetadata.State">TaskMetadata.State</a></td>
- <td></td>
- <td><p>The state of the task. </p></td>
- </tr>
- <tr>
- <td>condition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The condition of the task. </p></td>
- </tr>
+ <tr>
+ <td>CreateIdentityProvider</td>
+ <td>POST</td>
+ <td>/v1/idps</td>
+ <td>identity_provider</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateIdentityProvider</td>
+ <td>PATCH</td>
+ <td>/v1/{identity_provider.name=idps/*}</td>
+ <td>identity_provider</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteIdentityProvider</td>
+ <td>DELETE</td>
+ <td>/v1/{name=idps/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>TestIdentityProvider</td>
+ <td>POST</td>
+ <td>/v1/idps/*:test</td>
+ <td>*</td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/issue_service.proto">v1/issue_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.ApprovalFlow">ApprovalFlow</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>definition</td>
+ <td>roles</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition of the task. </p></td>
+ <td>repeated</td>
+ <td><p>The roles required for approval in order. </p></td>
</tr>
</tbody>
@@ -15682,8 +14701,8 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
- <h3 id="bytebase.v1.TessellationConfig">TessellationConfig</h3>
- <p>TessellationConfig defines tessellation parameters for spatial indexes.</p>
+ <h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3>
+ <p></p>
<table class="field-table">
@@ -15693,31 +14712,24 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
<tbody>
<tr>
- <td>scheme</td>
- <td><a href="#string">string</a></td>
+ <td>flow</td>
+ <td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td>
<td></td>
- <td><p>Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) </p></td>
- </tr>
-
- <tr>
- <td>grid_levels</td>
- <td><a href="#bytebase.v1.GridLevel">GridLevel</a></td>
- <td>repeated</td>
- <td><p>Grid levels and densities for multi-level tessellation </p></td>
+ <td><p>The approval flow definition. </p></td>
</tr>
<tr>
- <td>cells_per_object</td>
- <td><a href="#int32">int32</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Number of cells per object (1-8192 for SQL Server) </p></td>
+ <td><p>The title of the approval template. </p></td>
</tr>
<tr>
- <td>bounding_box</td>
- <td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td>
+ <td><p>The description of the approval template. </p></td>
</tr>
</tbody>
@@ -15727,7 +14739,7 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
- <h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3>
+ <h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</h3>
<p></p>
@@ -15741,64 +14753,103 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of the trigger. </p></td>
+ <td><p>The name of the issue to add an approver.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>event</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The event is the event of the trigger, such as INSERT, UPDATE, DELETE,
-TRUNCATE. </p></td>
+ <td><p>The comment explaining the approval decision. </p></td>
</tr>
- <tr>
- <td>timing</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>body</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The body is the body of the trigger. </p></td>
+ <td><p>The parent resource shared by all issues being updated.
+Format: projects/{project}
+If the operation spans parents, a dash (-) may be accepted as a wildcard.
+We only support updating the status of databases for now. </p></td>
</tr>
<tr>
- <td>sql_mode</td>
+ <td>issues</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SQL mode setting for the trigger. </p></td>
+ <td>repeated</td>
+ <td><p>The list of issues to update.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
<td></td>
- <td><p>The character set used by the client creating the trigger. </p></td>
+ <td><p>The new status. </p></td>
</tr>
<tr>
- <td>collation_connection</td>
+ <td>reason</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The collation used for the connection when creating the trigger. </p></td>
+ <td><p>The reason for the status change. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>comment</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment describing the trigger. </p></td>
+ <td><p>The issue name
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>issue_comment</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
<td></td>
- <td><p>Whether to skip this trigger during schema dump operations. </p></td>
+ <td><p>The comment to create. </p></td>
</tr>
</tbody>
@@ -15808,7 +14859,7 @@ TRUNCATE. </p></td>
- <h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3>
+ <h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3>
<p></p>
@@ -15819,28 +14870,18 @@ TRUNCATE. </p></td>
<tbody>
<tr>
- <td>database</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td></td>
- <td><p>The database to update.
-
-The database&#39;s `name` field is used to identify the database to update.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The parent, which owns this collection of issues.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>issue</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
<td></td>
- <td><p>If set to true, and the database is not found, a new database will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The issue to create. </p></td>
</tr>
</tbody>
@@ -15850,8 +14891,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.ViewMetadata">ViewMetadata</h3>
- <p>ViewMetadata is the metadata for views.</p>
+ <h3 id="bytebase.v1.GetIssueRequest">GetIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -15864,47 +14905,185 @@ In this situation, `update_mask` is ignored. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a view. </p></td>
+ <td><p>The name of the issue to retrieve.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
+ <td>force</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The definition is the definition of a view. </p></td>
+ <td><p>If set to true, bypass cache and fetch the latest data. </p></td>
</tr>
- <tr>
- <td>comment</td>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GrantRequest">GrantRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>role</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of a view. </p></td>
+ <td><p>The requested role.
+Format: roles/EXPORTER. </p></td>
</tr>
<tr>
- <td>dependency_columns</td>
- <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
- <td>repeated</td>
- <td><p>The dependency_columns is the list of dependency columns of a view. </p></td>
+ <td>user</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The user to be granted.
+Format: users/{email}. </p></td>
</tr>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td></td>
+ <td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td>
+ </tr>
+
+ <tr>
+ <td>expiration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration for which the grant is valid. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Issue">Issue</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the issue.
+Format: projects/{project}/issues/{issue} </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The title of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The description of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td></td>
+ <td><p>The status of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>approvers</td>
+ <td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td>
<td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>approval_template</td>
+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
+ <td></td>
+ <td><p>The approval template for the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>plan</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The plan associated with the issue.
+Can be empty.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>grant_request</td>
+ <td><a href="#bytebase.v1.GrantRequest">GrantRequest</a></td>
+ <td></td>
+ <td><p>Used if the issue type is GRANT_REQUEST. </p></td>
+ </tr>
+
+ <tr>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td></td>
+ <td><p>The risk level of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The triggers is the list of triggers in a view. </p></td>
+ <td><p>Labels attached to the issue for categorization and filtering. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>approval_status</td>
+ <td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -15916,751 +15095,399 @@ In this situation, `update_mask` is ignored. </p></td>
+ <h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>
+ <p>Approvers and their approval status for the issue.</p>
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</a></td>
+ <td></td>
+ <td><p>The new status. </p></td>
+ </tr>
+
+ <tr>
+ <td>principal</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FAILED</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Changelog.Type">Changelog.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>BASELINE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>MIGRATE</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SDL</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.IssueComment">IssueComment</h3>
+ <p>A comment on an issue.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The text content of the comment. </p></td>
+ </tr>
+
+ <tr>
+ <td>payload</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>TODO: use struct message instead. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/{email} </p></td>
+ </tr>
+
+ <tr>
+ <td>approval</td>
+ <td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td>
+ <td></td>
+ <td><p>Approval event. </p></td>
+ </tr>
+
+ <tr>
+ <td>issue_update</td>
+ <td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td>
+ <td></td>
+ <td><p>Issue update event. </p></td>
+ </tr>
+
+ <tr>
+ <td>plan_spec_update</td>
+ <td><a href="#bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</a></td>
+ <td></td>
+ <td><p>Plan spec update event. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.ChangelogView">ChangelogView</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>CHANGELOG_VIEW_UNSPECIFIED</td>
- <td>0</td>
- <td><p>The default / unset value.
-The API will default to the BASIC view.</p></td>
- </tr>
-
- <tr>
- <td>CHANGELOG_VIEW_BASIC</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CHANGELOG_VIEW_FULL</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>
+ <p>Approval event information.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td>
+ <td></td>
+ <td><p>The approval status. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>IDENTITY_GENERATION_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>ALWAYS</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>BY_DEFAULT</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>
+ <p>Issue update event information.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>from_title</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_title</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_description</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_description</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_labels</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_labels</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>VIRTUAL</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STORED</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</h3>
- <p>SDLFormat specifies the output format for SDL schema.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SDL_FORMAT_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified format. Defaults to SINGLE_FILE.</p></td>
- </tr>
-
- <tr>
- <td>SINGLE_FILE</td>
- <td>1</td>
- <td><p>Single file format: returns the complete SDL schema as a single file.</p></td>
- </tr>
-
- <tr>
- <td>MULTI_FILE</td>
- <td>2</td>
- <td><p>Multi-file format: returns the SDL schema as a ZIP archive containing
-multiple files organized by schema objects (tables, views, functions, etc.).</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</h3>
+ <p>Plan spec update event information (tracks sheet changes to plan specs).</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>spec</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The spec that was updated.
+Format: projects/{project}/plans/{plan}/specs/{spec} </p></td>
+ </tr>
+
+ <tr>
+ <td>from_sheet</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The previous sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>to_sheet</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The new sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</h3>
+ <h3 id="bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>OBJECT_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DATABASE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SCHEMA</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>VIEW</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>MATERIALIZED_VIEW</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FUNCTION</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PROCEDURE</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SEQUENCE</td>
- <td>8</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{projects}/issues/{issue} </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of issue comments to return. The service may return fewer than
+this value.
+If unspecified, at most 10 issue comments will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListIssueComments` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListIssueComments` must match
+the call that provided the page token. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</h3>
+ <h3 id="bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>MODE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DEFAULT</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>APPEND_ONLY</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>INSERT_ONLY</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>issue_comments</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td>repeated</td>
+ <td><p>The issue comments from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</h3>
+ <h3 id="bytebase.v1.ListIssuesRequest">ListIssuesRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DELTA</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</h3>
- <p>Type is the type of a table partition, some database engines may not</p><p>support all types. Only avilable for the following database engines now:</p><p>MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,</p><p>LINEAR_KEY</p><p>(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:</p><p>RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,</p><p>LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>RANGE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>RANGE_COLUMNS</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>LIST</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>LIST_COLUMNS</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>HASH</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>LINEAR_HASH</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>KEY</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>LINEAR_KEY</td>
- <td>8</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.TaskMetadata.State">TaskMetadata.State</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STARTED</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SUSPENDED</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseService">DatabaseService</h3>
- <p>DatabaseService manages databases and their schemas.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetDatabase</td>
- <td><a href="#bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</a></td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td><p>Retrieves a database by name.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>BatchGetDatabases</td>
- <td><a href="#bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</a></td>
- <td><p>Retrieves multiple databases by their names.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>ListDatabases</td>
- <td><a href="#bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</a></td>
- <td><a href="#bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</a></td>
- <td><p>Lists databases in a project, instance, or workspace.
-Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)</p></td>
- </tr>
-
- <tr>
- <td>UpdateDatabase</td>
- <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td><p>Updates database properties such as labels and project assignment.
-Permissions required: bb.databases.update</p></td>
- </tr>
-
- <tr>
- <td>BatchUpdateDatabases</td>
- <td><a href="#bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</a></td>
- <td><p>Updates multiple databases in a single batch operation.
-Permissions required: bb.databases.update</p></td>
- </tr>
-
- <tr>
- <td>SyncDatabase</td>
- <td><a href="#bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</a></td>
- <td><a href="#bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</a></td>
- <td><p>Synchronizes database schema from the instance.
-Permissions required: bb.databases.sync</p></td>
- </tr>
-
- <tr>
- <td>BatchSyncDatabases</td>
- <td><a href="#bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</a></td>
- <td><a href="#bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</a></td>
- <td><p>Synchronizes multiple databases in a single batch operation.
-Permissions required: bb.databases.sync</p></td>
- </tr>
-
- <tr>
- <td>GetDatabaseMetadata</td>
- <td><a href="#bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
- <td><p>Retrieves database metadata including tables, columns, and indexes.
-Permissions required: bb.databases.getSchema</p></td>
- </tr>
-
- <tr>
- <td>GetDatabaseSchema</td>
- <td><a href="#bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseSchema">DatabaseSchema</a></td>
- <td><p>Retrieves database schema as DDL statements.
-Permissions required: bb.databases.getSchema</p></td>
- </tr>
-
- <tr>
- <td>GetDatabaseSDLSchema</td>
- <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</a></td>
- <td><p>Retrieves database schema in SDL (Schema Definition Language) format.
-Permissions required: bb.databases.getSchema</p></td>
- </tr>
-
- <tr>
- <td>DiffSchema</td>
- <td><a href="#bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</a></td>
- <td><a href="#bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</a></td>
- <td><p>Compares and generates migration statements between two schemas.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>ListChangelogs</td>
- <td><a href="#bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</a></td>
- <td><a href="#bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</a></td>
- <td><p>Lists migration history for a database.
-Permissions required: bb.changelogs.list</p></td>
- </tr>
-
- <tr>
- <td>GetChangelog</td>
- <td><a href="#bytebase.v1.GetChangelogRequest">GetChangelogRequest</a></td>
- <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
- <td><p>Retrieves a specific changelog entry.
-Permissions required: bb.changelogs.get</p></td>
- </tr>
-
- <tr>
- <td>GetSchemaString</td>
- <td><a href="#bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</a></td>
- <td><a href="#bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</a></td>
- <td><p>Generates schema DDL for a database object.
-Permissions required: bb.databases.getSchema</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent, which owns this collection of issues.
+Format: projects/{project} </p></td>
+ </tr>
- <tr>
- <td>GetDatabase</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchGetDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/databases:batchGet</td>
- <td></td>
- </tr>
-
- <tr>
- <td>BatchGetDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/databases:batchGet</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/databases</td>
- <td></td>
- </tr>
-
- <tr>
- <td>ListDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/databases</td>
- <td></td>
- </tr>
-
- <tr>
- <td>ListDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=workspaces/*}/databases</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateDatabase</td>
- <td>PATCH</td>
- <td>/v1/{database.name=instances/*/databases/*}</td>
- <td>database</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchUpdateDatabases</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*}/databases:batchUpdate</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>SyncDatabase</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:sync</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchSyncDatabases</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*}/databases:batchSync</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>GetDatabaseMetadata</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/metadata}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetDatabaseSchema</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/schema}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetDatabaseSDLSchema</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/sdlSchema}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>DiffSchema</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:diffSchema</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>DiffSchema</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*/changelogs/*}:diffSchema</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListChangelogs</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*/databases/*}/changelogs</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetChangelog</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/changelogs/*}</td>
- <td></td>
- </tr>
-
-
-
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of issues to return. The service may return fewer than
+this value.
+If unspecified, at most 10 issues will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
- <tr>
- <td>GetSchemaString</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/schemaString}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListIssues` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListIssues` must match
+the call that provided the page token. </p></td>
+ </tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/group_service.proto">v1/group_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter issues returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- <h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>
- <p>Request message for batch getting groups.</p>
+Supported filters:
+- creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
+- status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values.
+- create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+- type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values.
+- labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator.
+- approval_status: issue approval status, support &#34;==&#34; operator.
+- current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+For example:
+creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;]
+status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34;
+labels in [&#34;label1&#34;, &#34;label2&#34;]
+create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
+ </tr>
<tr>
- <td>names</td>
+ <td>query</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The group names to retrieve.
-Format: groups/{email} </p></td>
+ <td></td>
+ <td><p>Query is the query statement. </p></td>
</tr>
</tbody>
@@ -16670,8 +15497,8 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</h3>
- <p>Response message for batch getting groups.</p>
+ <h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -16681,10 +15508,18 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>groups</td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>issues</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
<td>repeated</td>
- <td><p>The groups from the specified request. </p></td>
+ <td><p>The issues from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -16694,8 +15529,8 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3>
- <p>Request message for creating a group.</p>
+ <h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -16705,18 +15540,18 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>group</td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The group to create. </p></td>
+ <td><p>The name of the issue to add a rejection.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>group_email</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The email to use for the group, which will become the final component
-of the group&#39;s resource name. </p></td>
+ <td><p>The comment explaining the rejection decision. </p></td>
</tr>
</tbody>
@@ -16726,8 +15561,8 @@ of the group&#39;s resource name. </p></td>
- <h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>
- <p>Request message for deleting a group.</p>
+ <h3 id="bytebase.v1.RequestIssueRequest">RequestIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -16740,33 +15575,15 @@ of the group&#39;s resource name. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the group to delete.
-Format: groups/{email} </p></td>
+ <td><p>The name of the issue to request a issue.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetGroupRequest">GetGroupRequest</h3>
- <p>Request message for getting a group.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the group to retrieve.
-Format: groups/{email} </p></td>
+ <td><p>The comment explaining the request. </p></td>
</tr>
</tbody>
@@ -16776,8 +15593,8 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.Group">Group</h3>
- <p>A group of users within the workspace.</p>
+ <h3 id="bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -16787,46 +15604,48 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the group to retrieve.
-Format: groups/{group}, the group should be email or uuid. </p></td>
+ <td><p>The parent, which owns this collection of issues.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list all issues from all projects. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The display title of the group. </p></td>
+ <td><p>The maximum number of issues to return. The service may return fewer than
+this value.
+If unspecified, at most 10 issues will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the group. </p></td>
- </tr>
-
- <tr>
- <td>members</td>
- <td><a href="#bytebase.v1.GroupMember">GroupMember</a></td>
- <td>repeated</td>
- <td><p>The members of the group. </p></td>
+ <td><p>A page token, received from a previous `SearchIssues` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchIssues` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>source</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The source system where the group originated (e.g., Entra ID for SCIM sync). </p></td>
+ <td><p>Filter is used to filter issues returned in the list.
+Check the filter field in the ListIssuesRequest message. </p></td>
</tr>
<tr>
- <td>email</td>
+ <td>query</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique email for the group. </p></td>
+ <td><p>Query is the query statement. </p></td>
</tr>
</tbody>
@@ -16836,8 +15655,8 @@ Format: groups/{group}, the group should be email or uuid. </p></td>
- <h3 id="bytebase.v1.GroupMember">GroupMember</h3>
- <p>A member of a group with a role.</p>
+ <h3 id="bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -16847,19 +15666,18 @@ Format: groups/{group}, the group should be email or uuid. </p></td>
<tbody>
<tr>
- <td>member</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Member is the principal who belong to this group.
-
-Format: users/[email protected] </p></td>
+ <td>issues</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>repeated</td>
+ <td><p>The issues from the specified request. </p></td>
</tr>
<tr>
- <td>role</td>
- <td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The member&#39;s role in the group. </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -16869,8 +15687,8 @@ Format: users/[email protected] </p></td>
- <h3 id="bytebase.v1.ListGroupsRequest">ListGroupsRequest</h3>
- <p>Request message for listing groups.</p>
+ <h3 id="bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</h3>
+ <p></p>
<table class="field-table">
@@ -16880,78 +15698,33 @@ Format: users/[email protected] </p></td>
<tbody>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of groups to return. The service may return fewer than
-this value.
-If unspecified, at most 10 groups will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListGroups` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListGroups` must match
-the call that provided the page token. </p></td>
+ <td><p>The issue name
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
+ <td>issue_comment</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
<td></td>
- <td><p>Filter is used to filter groups returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-
-For example:
-title == &#34;dba&#34;
-email == &#34;[email protected]&#34;
-title.matches(&#34;dba&#34;)
-email.matches(&#34;dba&#34;)
-project == &#34;projects/sample-project&#34;
-You can combine filter conditions like:
-title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) </p></td>
+ <td><p>The comment to update. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3>
- <p>Response message for listing groups.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>groups</td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td>repeated</td>
- <td><p>The groups from the specified request. </p></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>If set to true, and the issue comment is not found, a new issue comment will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -16961,8 +15734,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</h3>
- <p>Request message for updating a group.</p>
+ <h3 id="bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -16972,13 +15745,13 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>group</td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>issue</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
<td></td>
- <td><p>The group to update.
+ <td><p>The issue to update.
-The group&#39;s `name` field is used to identify the group to update.
-Format: groups/{email} </p></td>
+The issue&#39;s `name` field is used to identify the issue to update.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
@@ -16992,7 +15765,7 @@ Format: groups/{email} </p></td>
<td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the group is not found, a new group will be created.
+ <td><p>If set to true, and the issue is not found, a new issue will be created.
In this situation, `update_mask` is ignored. </p></td>
</tr>
@@ -17005,8 +15778,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.GroupMember.Role">GroupMember.Role</h3>
- <p>The role of a group member.</p>
+ <h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3>
+ <p>The overall approval status for the issue.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -17014,85 +15787,290 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>ROLE_UNSPECIFIED</td>
+ <td>APPROVAL_STATUS_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified role.</p></td>
+ <td><p>Unspecified approval status.</p></td>
</tr>
<tr>
- <td>OWNER</td>
+ <td>CHECKING</td>
<td>1</td>
- <td><p>Group owner.</p></td>
+ <td><p>Approval checks are being evaluated.</p></td>
</tr>
<tr>
- <td>MEMBER</td>
+ <td>PENDING</td>
<td>2</td>
- <td><p>Group member.</p></td>
+ <td><p>Approval is pending.</p></td>
+ </tr>
+
+ <tr>
+ <td>APPROVED</td>
+ <td>3</td>
+ <td><p>Issue has been approved.</p></td>
+ </tr>
+
+ <tr>
+ <td>REJECTED</td>
+ <td>4</td>
+ <td><p>Issue has been rejected.</p></td>
+ </tr>
+
+ <tr>
+ <td>SKIPPED</td>
+ <td>5</td>
+ <td><p>Approval was skipped.</p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h3 id="bytebase.v1.GroupService">GroupService</h3>
- <p>GroupService manages user groups for organizing users and permissions.</p>
+ <h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3>
+ <p>The approval status of an approver.</p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>GetGroup</td>
- <td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td><p>Gets a group by name.
-Permissions required: bb.groups.get</p></td>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
</tr>
<tr>
- <td>BatchGetGroups</td>
- <td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</a></td>
- <td><p>Gets multiple groups in a single request.
-Permissions required: bb.groups.get</p></td>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p>Awaiting approval.</p></td>
</tr>
<tr>
- <td>ListGroups</td>
- <td><a href="#bytebase.v1.ListGroupsRequest">ListGroupsRequest</a></td>
- <td><a href="#bytebase.v1.ListGroupsResponse">ListGroupsResponse</a></td>
- <td><p>Lists all groups in the workspace.
-Permissions required: bb.groups.list</p></td>
+ <td>APPROVED</td>
+ <td>2</td>
+ <td><p>Approved.</p></td>
</tr>
<tr>
- <td>CreateGroup</td>
- <td><a href="#bytebase.v1.CreateGroupRequest">CreateGroupRequest</a></td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td><p>Creates a new group.
-Permissions required: bb.groups.create</p></td>
+ <td>REJECTED</td>
+ <td>3</td>
+ <td><p>Rejected.</p></td>
</tr>
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Issue.Type">Issue.Type</h3>
+ <p>The type of issue.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>UpdateGroup</td>
- <td><a href="#bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</a></td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td><p>Updates a group. Group owners or users with bb.groups.update permission can update.
-Permissions required: bb.groups.update OR caller is group owner
-When allow_missing=true, also requires: bb.groups.create</p></td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified issue type.</p></td>
</tr>
<tr>
- <td>DeleteGroup</td>
- <td><a href="#bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a group. Group owners or users with bb.groups.delete permission can delete.
-Permissions required: bb.groups.delete OR caller is group owner</p></td>
+ <td>DATABASE_CHANGE</td>
+ <td>1</td>
+ <td><p>Database schema or data change.</p></td>
+ </tr>
+
+ <tr>
+ <td>GRANT_REQUEST</td>
+ <td>2</td>
+ <td><p>Database access grant request.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_EXPORT</td>
+ <td>3</td>
+ <td><p>Database data export request.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</h3>
+ <p>Approval status values.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p>Approval pending.</p></td>
+ </tr>
+
+ <tr>
+ <td>APPROVED</td>
+ <td>2</td>
+ <td><p>Approved.</p></td>
+ </tr>
+
+ <tr>
+ <td>REJECTED</td>
+ <td>3</td>
+ <td><p>Rejected.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.IssueStatus">IssueStatus</h3>
+ <p>The status of an issue.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ISSUE_STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>OPEN</td>
+ <td>1</td>
+ <td><p>Issue is open and active.</p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>2</td>
+ <td><p>Issue is completed.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>3</td>
+ <td><p>Issue is canceled.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IssueService">IssueService</h3>
+ <p>IssueService manages issues for tracking database changes and tasks.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetIssue</td>
+ <td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Retrieves an issue by name.
+Permissions required: bb.issues.get</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIssue</td>
+ <td><a href="#bytebase.v1.CreateIssueRequest">CreateIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Creates a new issue for database changes or tasks.
+Permissions required: bb.issues.create</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIssues</td>
+ <td><a href="#bytebase.v1.ListIssuesRequest">ListIssuesRequest</a></td>
+ <td><a href="#bytebase.v1.ListIssuesResponse">ListIssuesResponse</a></td>
+ <td><p>Lists issues in a project.
+Permissions required: bb.issues.list</p></td>
+ </tr>
+
+ <tr>
+ <td>SearchIssues</td>
+ <td><a href="#bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</a></td>
+ <td><a href="#bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</a></td>
+ <td><p>Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query.
+Permissions required: bb.issues.get</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIssue</td>
+ <td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Updates an issue&#39;s properties such as title, description, or labels.
+Permissions required: bb.issues.update</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIssueComments</td>
+ <td><a href="#bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</a></td>
+ <td><a href="#bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</a></td>
+ <td><p>Lists comments on an issue.
+Permissions required: bb.issueComments.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIssueComment</td>
+ <td><a href="#bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</a></td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td><p>Adds a comment to an issue.
+Permissions required: bb.issueComments.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIssueComment</td>
+ <td><a href="#bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</a></td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td><p>Updates an existing issue comment.
+Permissions required: bb.issueComments.update</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchUpdateIssuesStatus</td>
+ <td><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</a></td>
+ <td><p>Updates the status of multiple issues in a single operation.
+Permissions required: bb.issues.update</p></td>
+ </tr>
+
+ <tr>
+ <td>ApproveIssue</td>
+ <td><a href="#bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ <tr>
+ <td>RejectIssue</td>
+ <td><a href="#bytebase.v1.RejectIssueRequest">RejectIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ <tr>
+ <td>RequestIssue</td>
+ <td><a href="#bytebase.v1.RequestIssueRequest">RequestIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
</tr>
</tbody>
@@ -17116,9 +16094,9 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td>
<tr>
- <td>GetGroup</td>
+ <td>GetIssue</td>
<td>GET</td>
- <td>/v1/{name=groups/*}</td>
+ <td>/v1/{name=projects/*/issues/*}</td>
<td></td>
</tr>
@@ -17126,19 +16104,19 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td>
<tr>
- <td>BatchGetGroups</td>
- <td>GET</td>
- <td>/v1/groups:batchGet</td>
- <td></td>
+ <td>CreateIssue</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues</td>
+ <td>issue</td>
</tr>
<tr>
- <td>ListGroups</td>
+ <td>ListIssues</td>
<td>GET</td>
- <td>/v1/groups</td>
+ <td>/v1/{parent=projects/*}/issues</td>
<td></td>
</tr>
@@ -17146,33 +16124,93 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td>
<tr>
- <td>CreateGroup</td>
+ <td>SearchIssues</td>
<td>POST</td>
- <td>/v1/groups</td>
- <td>group</td>
+ <td>/v1/{parent=projects/*}/issues:search</td>
+ <td>*</td>
</tr>
<tr>
- <td>UpdateGroup</td>
+ <td>UpdateIssue</td>
<td>PATCH</td>
- <td>/v1/{group.name=groups/*}</td>
- <td>group</td>
+ <td>/v1/{issue.name=projects/*/issues/*}</td>
+ <td>issue</td>
</tr>
<tr>
- <td>DeleteGroup</td>
- <td>DELETE</td>
- <td>/v1/{name=groups/*}</td>
+ <td>ListIssueComments</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/issues/*}/issueComments</td>
<td></td>
</tr>
+
+
+ <tr>
+ <td>CreateIssueComment</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/issues/*}:comment</td>
+ <td>issue_comment</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateIssueComment</td>
+ <td>PATCH</td>
+ <td>/v1/{parent=projects/*/issues/*}:comment</td>
+ <td>issue_comment</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchUpdateIssuesStatus</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ApproveIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:approve</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>RejectIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:reject</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>RequestIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:request</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
@@ -17180,12 +16218,12 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td>
<div class="file-heading">
- <h2 id="v1/idp_service.proto">v1/idp_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/org_policy_service.proto">v1/org_policy_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</h3>
+ <h3 id="bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</h3>
<p></p>
@@ -17196,28 +16234,28 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td>
<tbody>
<tr>
- <td>identity_provider</td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The identity provider to create. </p></td>
+ <td><p>The parent resource where this instance will be created.
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
<tr>
- <td>identity_provider_id</td>
- <td><a href="#string">string</a></td>
+ <td>policy</td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
<td></td>
- <td><p>The ID to use for the identity provider, which will become the final component of
-the identity provider&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td><p>The policy to create. </p></td>
</tr>
<tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
<td></td>
- <td><p>If set to true, the request will be validated without actually creating the identity provider. </p></td>
+ <td><p>The type of policy to create. </p></td>
</tr>
</tbody>
@@ -17227,8 +16265,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DataSourceQueryPolicy">DataSourceQueryPolicy</h3>
+ <p>Policy for controlling which data sources can be queried in the SQL editor.</p>
<table class="field-table">
@@ -17238,11 +16276,24 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>admin_data_source_restriction</td>
+ <td><a href="#bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</a></td>
<td></td>
- <td><p>The name of the identity provider to delete.
-Format: idps/{identity_provider} </p></td>
+ <td><p>Restriction for admin data source queries. </p></td>
+ </tr>
+
+ <tr>
+ <td>disallow_ddl</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Disallow running DDL statements in the SQL editor. </p></td>
+ </tr>
+
+ <tr>
+ <td>disallow_dml</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Disallow running DML statements in the SQL editor. </p></td>
</tr>
</tbody>
@@ -17252,8 +16303,8 @@ Format: idps/{identity_provider} </p></td>
- <h3 id="bytebase.v1.FieldMapping">FieldMapping</h3>
- <p>FieldMapping saves the field names from user info API of identity provider.</p><p>As we save all raw json string of user info response data into `principal.idp_user_info`,</p><p>we can extract the relevant data based with `FieldMapping`.</p>
+ <h3 id="bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</h3>
+ <p></p>
<table class="field-table">
@@ -17263,32 +16314,15 @@ Format: idps/{identity_provider} </p></td>
<tbody>
<tr>
- <td>identifier</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. </p></td>
- </tr>
-
- <tr>
- <td>display_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>DisplayName is the field name of display name in 3rd-party idp user info. Optional. </p></td>
- </tr>
-
- <tr>
- <td>phone</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Phone is the field name of primary phone in 3rd-party idp user info. Optional. </p></td>
- </tr>
-
- <tr>
- <td>groups</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Groups is the field name of groups in 3rd-party idp user info. Optional.
-Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ </p></td>
+ <td><p>The policy&#39;s `name` field is used to identify the instance to update.
+Format: {resource name}/policies/{policy type}
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
</tbody>
@@ -17298,7 +16332,7 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr
- <h3 id="bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</h3>
+ <h3 id="bytebase.v1.GetPolicyRequest">GetPolicyRequest</h3>
<p></p>
@@ -17312,8 +16346,8 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the identity provider to retrieve.
-Format: idps/{idp} </p></td>
+ <td><p>The name of the policy to retrieve.
+Format: {resource type}/{resource id}/policies/{policy type} </p></td>
</tr>
</tbody>
@@ -17323,7 +16357,7 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.IdentityProvider">IdentityProvider</h3>
+ <h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3>
<p></p>
@@ -17334,39 +16368,25 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the identity provider.
-Format: idps/{idp} </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The display title of the identity provider. </p></td>
- </tr>
-
- <tr>
- <td>domain</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The domain for email matching when using this identity provider. </p></td>
+ <td><p>The parent, which owns this collection of policies.
+Format: {resource type}/{resource id} </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.IdentityProviderType">IdentityProviderType</a></td>
- <td></td>
- <td><p>The type of identity provider protocol. </p></td>
+ <td>policy_type</td>
+ <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
+ <td>optional</td>
+ <td><p>Filter by specific policy type. </p></td>
</tr>
<tr>
- <td>config</td>
- <td><a href="#bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The configuration details for the identity provider. </p></td>
+ <td><p>Show deleted policies if specified. </p></td>
</tr>
</tbody>
@@ -17376,7 +16396,7 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</h3>
+ <h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3>
<p></p>
@@ -17387,24 +16407,34 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>oauth2_config</td>
- <td><a href="#bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td>
- <td></td>
- <td><p>OAuth2 protocol configuration. </p></td>
+ <td>policies</td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
+ <td>repeated</td>
+ <td><p>The policies from the specified request. </p></td>
</tr>
- <tr>
- <td>oidc_config</td>
- <td><a href="#bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</a></td>
- <td></td>
- <td><p>OIDC protocol configuration. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</h3>
+ <p>MaskingExemptionPolicy is the allowlist of users who can access sensitive data.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>ldap_config</td>
- <td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td>
- <td></td>
- <td><p>LDAP protocol configuration. </p></td>
+ <td>exemptions</td>
+ <td><a href="#bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -17414,8 +16444,8 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</h3>
- <p>LDAPIdentityProviderConfig is the structure for LDAP identity provider config.</p>
+ <h3 id="bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</h3>
+ <p></p>
<table class="field-table">
@@ -17425,72 +16455,34 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>host</td>
+ <td>members</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Host is the hostname or IP address of the LDAP server, e.g.,
-&#34;ldap.example.com&#34;. </p></td>
- </tr>
-
- <tr>
- <td>port</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Port is the port number of the LDAP server, e.g., 389. When not set, the
-default port of the corresponding security protocol will be used, i.e. 389
-for StartTLS and 636 for LDAPS. </p></td>
- </tr>
-
- <tr>
- <td>skip_tls_verify</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>SkipTLSVerify controls whether to skip TLS certificate verification. </p></td>
- </tr>
-
- <tr>
- <td>bind_dn</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>BindDN is the DN of the user to bind as a service account to perform
-search requests. </p></td>
- </tr>
-
- <tr>
- <td>bind_password</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>BindPassword is the password of the user to bind as a service account. </p></td>
- </tr>
-
- <tr>
- <td>base_dn</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. </p></td>
- </tr>
-
- <tr>
- <td>user_filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. </p></td>
- </tr>
-
- <tr>
- <td>security_protocol</td>
- <td><a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</a></td>
- <td></td>
- <td><p>SecurityProtocol is the security protocol to be used for establishing
-connections with the LDAP server. </p></td>
+ <td>repeated</td>
+ <td><p>Specifies the principals who are exempt from masking.
+For users, the member should be: user:{email}
+For groups, the member should be: group:{email} </p></td>
</tr>
<tr>
- <td>field_mapping</td>
- <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
<td></td>
- <td><p>FieldMapping is the mapping of the user attributes returned by the LDAP
-server. </p></td>
+ <td><p>The condition that is associated with this exception policy instance.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+If the condition is empty, means the user can access all databases without expiration.
+
+Support variables:
+resource.instance_id: the instance resource id. Only support &#34;==&#34; operation.
+resource.database_name: the database name. Only support &#34;==&#34; operation.
+resource.schema_name: the schema name. Only support &#34;==&#34; operation.
+resource.table_name: the table name. Only support &#34;==&#34; operation.
+resource.column_name: the column name. Only support &#34;==&#34; operation.
+request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`
+All variables should join with &#34;&amp;&amp;&#34; condition.
+
+For example:
+resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;)
+resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; </p></td>
</tr>
</tbody>
@@ -17500,15 +16492,32 @@ server. </p></td>
- <h3 id="bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</h3>
+ <p>Policy for configuring data masking rules.</p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>rules</td>
+ <td><a href="#bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</a></td>
+ <td>repeated</td>
+ <td><p>The list of masking rules. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</h3>
+ <p>A rule that defines when and how to mask data.</p>
<table class="field-table">
@@ -17518,10 +16527,46 @@ server. </p></td>
<tbody>
<tr>
- <td>identity_providers</td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td>repeated</td>
- <td><p>The identity providers from the specified request. </p></td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A unique identifier for the rule in UUID format. </p></td>
+ </tr>
+
+ <tr>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td></td>
+ <td><p>The condition for the masking rule.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Support variables:
+resource.environment_id: the environment resource id.
+resource.project_id: the project resource id.
+resource.instance_id: the instance resource id.
+resource.database_name: the database name.
+resource.table_name: the table name.
+resource.column_name: the column name.
+resource.classification_level: the classification level.
+
+Each variable support following operations:
+==: the value equals the target.
+!=: the value not equals the target.
+in: the value matches one of the targets.
+!(in): the value not matches any of the targets.
+
+For example:
+resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34;
+resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;]
+resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;])
+resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) </p></td>
+ </tr>
+
+ <tr>
+ <td>semantic_type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). </p></td>
</tr>
</tbody>
@@ -17531,8 +16576,8 @@ server. </p></td>
- <h3 id="bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</h3>
- <p>OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.</p>
+ <h3 id="bytebase.v1.Policy">Policy</h3>
+ <p></p>
<table class="field-table">
@@ -17542,90 +16587,85 @@ server. </p></td>
<tbody>
<tr>
- <td>auth_url</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The authorization endpoint URL for OAuth2 flow. </p></td>
+ <td><p>The name of the policy.
+Format: {resource name}/policies/{policy type}
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
<tr>
- <td>token_url</td>
- <td><a href="#string">string</a></td>
+ <td>inherit_from_parent</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The token endpoint URL for exchanging authorization code. </p></td>
+ <td><p>Whether this policy inherits from its parent resource. </p></td>
</tr>
<tr>
- <td>user_info_url</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
<td></td>
- <td><p>The user information endpoint URL. </p></td>
+ <td><p>The type of policy. </p></td>
</tr>
<tr>
- <td>client_id</td>
- <td><a href="#string">string</a></td>
+ <td>rollout_policy</td>
+ <td><a href="#bytebase.v1.RolloutPolicy">RolloutPolicy</a></td>
<td></td>
- <td><p>The OAuth2 client identifier. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>client_secret</td>
- <td><a href="#string">string</a></td>
+ <td>masking_rule_policy</td>
+ <td><a href="#bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</a></td>
<td></td>
- <td><p>The OAuth2 client secret for authentication. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>scopes</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of OAuth2 scopes to request. </p></td>
+ <td>masking_exemption_policy</td>
+ <td><a href="#bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>field_mapping</td>
- <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
+ <td>tag_policy</td>
+ <td><a href="#bytebase.v1.TagPolicy">TagPolicy</a></td>
<td></td>
- <td><p>Mapping configuration for user attributes from OAuth2 response. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>skip_tls_verify</td>
- <td><a href="#bool">bool</a></td>
+ <td>data_source_query_policy</td>
+ <td><a href="#bytebase.v1.DataSourceQueryPolicy">DataSourceQueryPolicy</a></td>
<td></td>
- <td><p>Whether to skip TLS certificate verification. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>auth_style</td>
- <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
+ <td>query_data_policy</td>
+ <td><a href="#bytebase.v1.QueryDataPolicy">QueryDataPolicy</a></td>
<td></td>
- <td><p>The authentication style for client credentials. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>enforce</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether the policy is enforced. </p></td>
+ </tr>
<tr>
- <td>code</td>
- <td><a href="#string">string</a></td>
+ <td>resource_type</td>
+ <td><a href="#bytebase.v1.PolicyResourceType">PolicyResourceType</a></td>
<td></td>
- <td><p>Authorize code from website. </p></td>
+ <td><p>The resource type for the policy. </p></td>
</tr>
</tbody>
@@ -17635,8 +16675,8 @@ server. </p></td>
- <h3 id="bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3>
- <p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p>
+ <h3 id="bytebase.v1.QueryDataPolicy">QueryDataPolicy</h3>
+ <p>QueryDataPolicy is the policy configuration for querying data.</p>
<table class="field-table">
@@ -17646,85 +16686,40 @@ server. </p></td>
<tbody>
<tr>
- <td>issuer</td>
- <td><a href="#string">string</a></td>
+ <td>timeout</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
<td></td>
- <td><p>The OIDC issuer URL for the identity provider. </p></td>
+ <td><p>The query timeout duration. </p></td>
</tr>
<tr>
- <td>client_id</td>
- <td><a href="#string">string</a></td>
+ <td>disable_export</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The OIDC client identifier. </p></td>
+ <td><p>Disable data export in the SQL editor. </p></td>
</tr>
<tr>
- <td>client_secret</td>
- <td><a href="#string">string</a></td>
+ <td>maximum_result_size</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The OIDC client secret for authentication. </p></td>
- </tr>
-
- <tr>
- <td>scopes</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The scopes that the OIDC provider supports.
-Should be fetched from the well-known configuration file of the OIDC provider. </p></td>
+ <td><p>The maximum result size limit in bytes.
+The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. </p></td>
</tr>
<tr>
- <td>field_mapping</td>
- <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
+ <td>maximum_result_rows</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Mapping configuration for user attributes from OIDC claims. </p></td>
+ <td><p>The maximum number of rows to return.
+The default value is -1, means no limit. </p></td>
</tr>
<tr>
- <td>skip_tls_verify</td>
+ <td>disable_copy_data</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether to skip TLS certificate verification. </p></td>
- </tr>
-
- <tr>
- <td>auth_style</td>
- <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
- <td></td>
- <td><p>The authentication style for client credentials. </p></td>
- </tr>
-
- <tr>
- <td>auth_endpoint</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The authorization endpoint of the OIDC provider.
-Should be fetched from the well-known configuration file of the OIDC provider. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>code</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Authorize code from OIDC provider. </p></td>
+ <td><p>Disable copying query results. </p></td>
</tr>
</tbody>
@@ -17734,8 +16729,8 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
- <h3 id="bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3>
+ <p>Rollout policy configuration.</p>
<table class="field-table">
@@ -17745,55 +16740,17 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
<tbody>
<tr>
- <td>identity_provider</td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td></td>
- <td><p>The identity provider to test connection including uncreated. </p></td>
- </tr>
-
- <tr>
- <td>oauth2_context</td>
- <td><a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>oidc_context</td>
- <td><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</a></td>
+ <td>automatic</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>OIDC authentication context for test connection. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>claims</td>
- <td><a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</a></td>
- <td>repeated</td>
- <td><p>The map of claims returned by the identity provider. </p></td>
+ <td><p>Whether rollout is automatic without manual approval. </p></td>
</tr>
<tr>
- <td>user_info</td>
- <td><a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</a></td>
+ <td>roles</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The matched user info from the claims. </p></td>
+ <td><p>The roles that can approve rollout execution. </p></td>
</tr>
</tbody>
@@ -17803,8 +16760,8 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
- <h3 id="bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.TagPolicy">TagPolicy</h3>
+ <p>Policy for tagging resources with metadata.</p>
<table class="field-table">
@@ -17814,17 +16771,11 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>tags</td>
+ <td><a href="#bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td>
+ <td>repeated</td>
+ <td><p>tags is the key - value map for resources.
+for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; </p></td>
</tr>
</tbody>
@@ -17834,7 +16785,7 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
- <h3 id="bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</h3>
+ <h3 id="bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</h3>
<p></p>
@@ -17865,7 +16816,7 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
- <h3 id="bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</h3>
+ <h3 id="bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</h3>
<p></p>
@@ -17876,13 +16827,17 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
<tbody>
<tr>
- <td>identity_provider</td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td>policy</td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
<td></td>
- <td><p>The identity provider to update.
+ <td><p>The policy to update.
-The identity provider&#39;s `name` field is used to identify the identity provider to update.
-Format: idps/{identity_provider} </p></td>
+The policy&#39;s `name` field is used to identify the instance to update.
+Format: {resource name}/policies/{policy type}
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
<tr>
@@ -17896,7 +16851,7 @@ Format: idps/{identity_provider} </p></td>
<td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the identity provider is not found, a new identity provider will be created.
+ <td><p>If set to true, and the policy is not found, a new policy will be created.
In this situation, `update_mask` is ignored. </p></td>
</tr>
@@ -17909,8 +16864,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.IdentityProviderType">IdentityProviderType</h3>
- <p></p>
+ <h3 id="bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</h3>
+ <p>Restriction level for admin data source access.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -17918,34 +16873,28 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td>
+ <td>RESTRICTION_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified identity provider type.</p></td>
+ <td><p>Unspecified restriction.</p></td>
</tr>
<tr>
- <td>OAUTH2</td>
+ <td>FALLBACK</td>
<td>1</td>
- <td><p>OAuth 2.0 authentication protocol.</p></td>
+ <td><p>Allow querying admin data sources when there is no read-only data source.</p></td>
</tr>
<tr>
- <td>OIDC</td>
+ <td>DISALLOW</td>
<td>2</td>
- <td><p>OpenID Connect authentication protocol.</p></td>
- </tr>
-
- <tr>
- <td>LDAP</td>
- <td>3</td>
- <td><p>LDAP directory service authentication.</p></td>
+ <td><p>Disallow querying admin data sources.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</h3>
- <p></p>
+ <h3 id="bytebase.v1.PolicyResourceType">PolicyResourceType</h3>
+ <p>The resource type that a policy can be attached to.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -17953,28 +16902,34 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>SECURITY_PROTOCOL_UNSPECIFIED</td>
+ <td>RESOURCE_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified resource type.</p></td>
</tr>
<tr>
- <td>START_TLS</td>
+ <td>WORKSPACE</td>
<td>1</td>
- <td><p>StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS.</p></td>
+ <td><p>Workspace-level policy.</p></td>
</tr>
<tr>
- <td>LDAPS</td>
+ <td>ENVIRONMENT</td>
<td>2</td>
- <td><p>LDAPS is the security protocol that uses TLS from the beginning.</p></td>
+ <td><p>Environment-level policy.</p></td>
+ </tr>
+
+ <tr>
+ <td>PROJECT</td>
+ <td>3</td>
+ <td><p>Project-level policy.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</h3>
- <p></p>
+ <h3 id="bytebase.v1.PolicyType">PolicyType</h3>
+ <p>The type of organizational policy.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -17982,23 +16937,45 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td>
+ <td>POLICY_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified policy type.</p></td>
</tr>
<tr>
- <td>IN_PARAMS</td>
+ <td>MASKING_RULE</td>
<td>1</td>
- <td><p>IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body
-as application/x-www-form-urlencoded parameters.</p></td>
+ <td><p>Data masking rule policy.</p></td>
</tr>
<tr>
- <td>IN_HEADER</td>
+ <td>MASKING_EXEMPTION</td>
<td>2</td>
- <td><p>IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.
-This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td>
+ <td><p>Data masking exemption policy.</p></td>
+ </tr>
+
+ <tr>
+ <td>ROLLOUT_POLICY</td>
+ <td>3</td>
+ <td><p>Rollout deployment policy.</p></td>
+ </tr>
+
+ <tr>
+ <td>TAG</td>
+ <td>4</td>
+ <td><p>Resource tag policy.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATA_SOURCE_QUERY</td>
+ <td>5</td>
+ <td><p>Data source query restrictions policy.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATA_QUERY</td>
+ <td>6</td>
+ <td><p>Query data access policy.</p></td>
</tr>
</tbody>
@@ -18008,8 +16985,8 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t
- <h3 id="bytebase.v1.IdentityProviderService">IdentityProviderService</h3>
- <p>IdentityProviderService manages external identity providers for SSO authentication.</p>
+ <h3 id="bytebase.v1.OrgPolicyService">OrgPolicyService</h3>
+ <p>OrgPolicyService manages organizational policies at various resource levels.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -18017,52 +16994,43 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t
<tbody>
<tr>
- <td>GetIdentityProvider</td>
- <td><a href="#bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td><p>Gets an identity provider by name.
-Permissions required: bb.identityProviders.get</p></td>
- </tr>
-
- <tr>
- <td>ListIdentityProviders</td>
- <td><a href="#bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</a></td>
- <td><a href="#bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</a></td>
- <td><p>Lists all configured identity providers (public endpoint for login page).
-Permissions required: None</p></td>
+ <td>GetPolicy</td>
+ <td><a href="#bytebase.v1.GetPolicyRequest">GetPolicyRequest</a></td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
+ <td><p>Retrieves a policy by name.
+Permissions required: bb.policies.get</p></td>
</tr>
<tr>
- <td>CreateIdentityProvider</td>
- <td><a href="#bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td><p>Creates a new identity provider.
-Permissions required: bb.identityProviders.create</p></td>
+ <td>ListPolicies</td>
+ <td><a href="#bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</a></td>
+ <td><a href="#bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</a></td>
+ <td><p>Lists policies at a specified resource level.
+Permissions required: bb.policies.list</p></td>
</tr>
<tr>
- <td>UpdateIdentityProvider</td>
- <td><a href="#bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td><p>Updates an identity provider.
-Permissions required: bb.identityProviders.update
-When allow_missing=true, also requires: bb.identityProviders.create</p></td>
+ <td>CreatePolicy</td>
+ <td><a href="#bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</a></td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
+ <td><p>Creates a new organizational policy.
+Permissions required: bb.policies.create</p></td>
</tr>
<tr>
- <td>DeleteIdentityProvider</td>
- <td><a href="#bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes an identity provider.
-Permissions required: bb.identityProviders.delete</p></td>
+ <td>UpdatePolicy</td>
+ <td><a href="#bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</a></td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
+ <td><p>Updates an existing organizational policy.
+Permissions required: bb.policies.update</p></td>
</tr>
<tr>
- <td>TestIdentityProvider</td>
- <td><a href="#bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</a></td>
- <td><p>Tests the connection and configuration of an identity provider.
-Permissions required: bb.identityProviders.update</p></td>
+ <td>DeletePolicy</td>
+ <td><a href="#bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes an organizational policy.
+Permissions required: bb.policies.delete</p></td>
</tr>
</tbody>
@@ -18086,9 +17054,37 @@ Permissions required: bb.identityProviders.update</p></td>
<tr>
- <td>GetIdentityProvider</td>
+ <td>GetPolicy</td>
<td>GET</td>
- <td>/v1/{name=idps/*}</td>
+ <td>/v1/{name=policies/*}</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>GetPolicy</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/policies/*}</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>GetPolicy</td>
+ <td>GET</td>
+ <td>/v1/{name=environments/*/policies/*}</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>GetPolicy</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/policies/*}</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>GetPolicy</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/policies/*}</td>
<td></td>
</tr>
@@ -18096,9 +17092,37 @@ Permissions required: bb.identityProviders.update</p></td>
<tr>
- <td>ListIdentityProviders</td>
+ <td>ListPolicies</td>
<td>GET</td>
- <td>/v1/idps</td>
+ <td>/v1/policies</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListPolicies</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/policies</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListPolicies</td>
+ <td>GET</td>
+ <td>/v1/{parent=environments/*}/policies</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListPolicies</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/policies</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListPolicies</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*/databases/*}/policies</td>
<td></td>
</tr>
@@ -18106,40 +17130,114 @@ Permissions required: bb.identityProviders.update</p></td>
<tr>
- <td>CreateIdentityProvider</td>
+ <td>CreatePolicy</td>
<td>POST</td>
- <td>/v1/idps</td>
- <td>identity_provider</td>
+ <td>/v1/policies</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>CreatePolicy</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/policies</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>CreatePolicy</td>
+ <td>POST</td>
+ <td>/v1/{parent=environments/*}/policies</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>CreatePolicy</td>
+ <td>POST</td>
+ <td>/v1/{parent=instances/*}/policies</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>CreatePolicy</td>
+ <td>POST</td>
+ <td>/v1/{parent=instances/*/databases/*}/policies</td>
+ <td>policy</td>
</tr>
<tr>
- <td>UpdateIdentityProvider</td>
+ <td>UpdatePolicy</td>
<td>PATCH</td>
- <td>/v1/{identity_provider.name=idps/*}</td>
- <td>identity_provider</td>
+ <td>/v1/{policy.name=policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=projects/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=environments/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=instances/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=instances/*/databases/*/policies/*}</td>
+ <td>policy</td>
</tr>
<tr>
- <td>DeleteIdentityProvider</td>
+ <td>DeletePolicy</td>
<td>DELETE</td>
- <td>/v1/{name=idps/*}</td>
+ <td>/v1/{name=policies/*}</td>
<td></td>
</tr>
-
+ <tr>
+ <td>DeletePolicy</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/policies/*}</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>DeletePolicy</td>
+ <td>DELETE</td>
+ <td>/v1/{name=environments/*/policies/*}</td>
+ <td></td>
+ </tr>
<tr>
- <td>TestIdentityProvider</td>
- <td>POST</td>
- <td>/v1/idps/*:test</td>
- <td>*</td>
+ <td>DeletePolicy</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*/policies/*}</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>DeletePolicy</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*/databases/*/policies/*}</td>
+ <td></td>
</tr>
@@ -18150,12 +17248,12 @@ Permissions required: bb.identityProviders.update</p></td>
<div class="file-heading">
- <h2 id="v1/org_policy_service.proto">v1/org_policy_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/sql_service.proto">v1/sql_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</h3>
+ <h3 id="bytebase.v1.AICompletionRequest">AICompletionRequest</h3>
<p></p>
@@ -18166,28 +17264,10 @@ Permissions required: bb.identityProviders.update</p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource where this instance will be created.
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
- </tr>
-
- <tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td></td>
- <td><p>The policy to create. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
- <td></td>
- <td><p>The type of policy to create. </p></td>
+ <td>messages</td>
+ <td><a href="#bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -18197,8 +17277,8 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
- <h3 id="bytebase.v1.DataSourceQueryPolicy">DataSourceQueryPolicy</h3>
- <p>Policy for controlling which data sources can be queried in the SQL editor.</p>
+ <h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</h3>
+ <p></p>
<table class="field-table">
@@ -18208,24 +17288,17 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
<tbody>
<tr>
- <td>admin_data_source_restriction</td>
- <td><a href="#bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</a></td>
+ <td>role</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Restriction for admin data source queries. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>disallow_ddl</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Disallow running DDL statements in the SQL editor. </p></td>
- </tr>
-
- <tr>
- <td>disallow_dml</td>
- <td><a href="#bool">bool</a></td>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Disallow running DML statements in the SQL editor. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -18235,7 +17308,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
- <h3 id="bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</h3>
+ <h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3>
<p></p>
@@ -18246,15 +17319,11 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The policy&#39;s `name` field is used to identify the instance to update.
-Format: {resource name}/policies/{policy type}
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
+ <td>candidates</td>
+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</a></td>
+ <td>repeated</td>
+ <td><p>candidates is used for results with multiple choices and candidates. Used
+for OpenAI and Gemini. </p></td>
</tr>
</tbody>
@@ -18264,7 +17333,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
- <h3 id="bytebase.v1.GetPolicyRequest">GetPolicyRequest</h3>
+ <h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</h3>
<p></p>
@@ -18275,11 +17344,10 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>content</td>
+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</a></td>
<td></td>
- <td><p>The name of the policy to retrieve.
-Format: {resource type}/{resource id}/policies/{policy type} </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -18289,7 +17357,7 @@ Format: {resource type}/{resource id}/policies/{policy type} </p></td>
- <h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3>
+ <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3>
<p></p>
@@ -18300,25 +17368,10 @@ Format: {resource type}/{resource id}/policies/{policy type} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent, which owns this collection of policies.
-Format: {resource type}/{resource id} </p></td>
- </tr>
-
- <tr>
- <td>policy_type</td>
- <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
- <td>optional</td>
- <td><p>Filter by specific policy type. </p></td>
- </tr>
-
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted policies if specified. </p></td>
+ <td>parts</td>
+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</a></td>
+ <td>repeated</td>
+ <td><p>parts is used for a result content with multiple parts. </p></td>
</tr>
</tbody>
@@ -18328,7 +17381,7 @@ Format: {resource type}/{resource id} </p></td>
- <h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3>
+ <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</h3>
<p></p>
@@ -18339,10 +17392,10 @@ Format: {resource type}/{resource id} </p></td>
<tbody>
<tr>
- <td>policies</td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td>repeated</td>
- <td><p>The policies from the specified request. </p></td>
+ <td>text</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -18352,8 +17405,8 @@ Format: {resource type}/{resource id} </p></td>
- <h3 id="bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</h3>
- <p>MaskingExemptionPolicy is the allowlist of users who can access sensitive data.</p>
+ <h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3>
+ <p></p>
<table class="field-table">
@@ -18363,10 +17416,41 @@ Format: {resource type}/{resource id} </p></td>
<tbody>
<tr>
- <td>exemptions</td>
- <td><a href="#bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the instance name to execute the query against.
+Format: instances/{instance}/databases/{databaseName} </p></td>
+ </tr>
+
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SQL statement to execute. </p></td>
+ </tr>
+
+ <tr>
+ <td>limit</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of rows to return. </p></td>
+ </tr>
+
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The default schema to execute the statement. Equals to the current schema
+in Oracle and search path in Postgres. </p></td>
+ </tr>
+
+ <tr>
+ <td>container</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Container is the container name to execute the query against, used for
+CosmosDB only. </p></td>
</tr>
</tbody>
@@ -18376,7 +17460,7 @@ Format: {resource type}/{resource id} </p></td>
- <h3 id="bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</h3>
+ <h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3>
<p></p>
@@ -18387,34 +17471,10 @@ Format: {resource type}/{resource id} </p></td>
<tbody>
<tr>
- <td>members</td>
- <td><a href="#string">string</a></td>
+ <td>results</td>
+ <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
<td>repeated</td>
- <td><p>Specifies the principals who are exempt from masking.
-For users, the member should be: user:{email}
-For groups, the member should be: group:{email} </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this exception policy instance.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-If the condition is empty, means the user can access all databases without expiration.
-
-Support variables:
-resource.instance_id: the instance resource id. Only support &#34;==&#34; operation.
-resource.database_name: the database name. Only support &#34;==&#34; operation.
-resource.schema_name: the schema name. Only support &#34;==&#34; operation.
-resource.table_name: the table name. Only support &#34;==&#34; operation.
-resource.column_name: the column name. Only support &#34;==&#34; operation.
-request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`
-All variables should join with &#34;&amp;&amp;&#34; condition.
-
-For example:
-resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;)
-resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; </p></td>
+ <td><p>The query results. </p></td>
</tr>
</tbody>
@@ -18424,8 +17484,8 @@ resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#3
- <h3 id="bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</h3>
- <p>Policy for configuring data masking rules.</p>
+ <h3 id="bytebase.v1.Advice">Advice</h3>
+ <p></p>
<table class="field-table">
@@ -18435,10 +17495,53 @@ resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#3
<tbody>
<tr>
- <td>rules</td>
- <td><a href="#bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</a></td>
- <td>repeated</td>
- <td><p>The list of masking rules. </p></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
+ <td></td>
+ <td><p>The advice level. </p></td>
+ </tr>
+
+ <tr>
+ <td>code</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The advice code. </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The advice title. </p></td>
+ </tr>
+
+ <tr>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The advice content. </p></td>
+ </tr>
+
+ <tr>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p>The start_position is inclusive and the end_position is exclusive.
+TODO: use range instead </p></td>
+ </tr>
+
+ <tr>
+ <td>end_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>rule_type</td>
+ <td><a href="#bytebase.v1.Advice.RuleType">Advice.RuleType</a></td>
+ <td></td>
+ <td><p>The type of linting rule that generated this advice. </p></td>
</tr>
</tbody>
@@ -18448,8 +17551,8 @@ resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#3
- <h3 id="bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</h3>
- <p>A rule that defines when and how to mask data.</p>
+ <h3 id="bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</h3>
+ <p></p>
<table class="field-table">
@@ -18459,46 +17562,24 @@ resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#3
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
+ <td>source_metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
<td></td>
- <td><p>A unique identifier for the rule in UUID format. </p></td>
+ <td><p>The metadata of the source schema. </p></td>
</tr>
<tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>target_metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
<td></td>
- <td><p>The condition for the masking rule.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.environment_id: the environment resource id.
-resource.project_id: the project resource id.
-resource.instance_id: the instance resource id.
-resource.database_name: the database name.
-resource.table_name: the table name.
-resource.column_name: the column name.
-resource.classification_level: the classification level.
-
-Each variable support following operations:
-==: the value equals the target.
-!=: the value not equals the target.
-in: the value matches one of the targets.
-!(in): the value not matches any of the targets.
-
-For example:
-resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34;
-resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;]
-resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;])
-resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) </p></td>
+ <td><p>The metadata of the target schema. </p></td>
</tr>
<tr>
- <td>semantic_type</td>
- <td><a href="#string">string</a></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
<td></td>
- <td><p>The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). </p></td>
+ <td><p>The database engine of the schema. </p></td>
</tr>
</tbody>
@@ -18508,7 +17589,7 @@ resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_
- <h3 id="bytebase.v1.Policy">Policy</h3>
+ <h3 id="bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</h3>
<p></p>
@@ -18519,85 +17600,116 @@ resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_
<tbody>
<tr>
- <td>name</td>
+ <td>diff</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the policy.
-Format: {resource name}/policies/{policy type}
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
+ <td><p>The diff of the metadata. </p></td>
</tr>
- <tr>
- <td>inherit_from_parent</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether this policy inherits from its parent resource. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ExportRequest">ExportRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of policy. </p></td>
+ <td><p>The name is the resource name to execute the export against.
+Format: instances/{instance}/databases/{database}
+Format: instances/{instance}
+Format: projects/{project}/rollouts/{rollout}
+Format: projects/{project}/rollouts/{rollout}/stages/{stage} </p></td>
</tr>
<tr>
- <td>rollout_policy</td>
- <td><a href="#bytebase.v1.RolloutPolicy">RolloutPolicy</a></td>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The SQL statement to execute. </p></td>
</tr>
<tr>
- <td>masking_rule_policy</td>
- <td><a href="#bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</a></td>
+ <td>limit</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The maximum number of rows to return. </p></td>
</tr>
<tr>
- <td>masking_exemption_policy</td>
- <td><a href="#bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</a></td>
+ <td>format</td>
+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The export format. </p></td>
</tr>
<tr>
- <td>tag_policy</td>
- <td><a href="#bytebase.v1.TagPolicy">TagPolicy</a></td>
+ <td>admin</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The admin is used for workspace owner and DBA for exporting data from SQL
+Editor Admin mode. The exported data is not masked. </p></td>
</tr>
<tr>
- <td>data_source_query_policy</td>
- <td><a href="#bytebase.v1.DataSourceQueryPolicy">DataSourceQueryPolicy</a></td>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The zip password provide by users. </p></td>
</tr>
<tr>
- <td>query_data_policy</td>
- <td><a href="#bytebase.v1.QueryDataPolicy">QueryDataPolicy</a></td>
+ <td>data_source_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The id of data source.
+It is used for querying admin data source even if the instance has
+read-only data sources. Or it can be used to query a specific read-only
+data source. </p></td>
</tr>
<tr>
- <td>enforce</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the policy is enforced. </p></td>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The default schema to search objects. Equals to the current schema in
+Oracle and search path in Postgres. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ExportResponse">ExportResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>resource_type</td>
- <td><a href="#bytebase.v1.PolicyResourceType">PolicyResourceType</a></td>
+ <td>content</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The resource type for the policy. </p></td>
+ <td><p>The export file content. </p></td>
</tr>
</tbody>
@@ -18607,8 +17719,8 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
- <h3 id="bytebase.v1.QueryDataPolicy">QueryDataPolicy</h3>
- <p>QueryDataPolicy is the policy configuration for querying data.</p>
+ <h3 id="bytebase.v1.MaskingReason">MaskingReason</h3>
+ <p></p>
<table class="field-table">
@@ -18618,40 +17730,52 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
<tbody>
<tr>
- <td>timeout</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>semantic_type_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The query timeout duration. </p></td>
+ <td><p>The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). </p></td>
</tr>
<tr>
- <td>disable_export</td>
- <td><a href="#bool">bool</a></td>
+ <td>semantic_type_title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Disable data export in the SQL editor. </p></td>
+ <td><p>Human-readable semantic type title. </p></td>
</tr>
<tr>
- <td>maximum_result_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>masking_rule_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum result size limit in bytes.
-The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. </p></td>
+ <td><p>The masking rule ID that matched (if applicable). </p></td>
</tr>
<tr>
- <td>maximum_result_rows</td>
- <td><a href="#int32">int32</a></td>
+ <td>algorithm</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of rows to return.
-The default value is -1, means no limit. </p></td>
+ <td><p>The masking algorithm used. </p></td>
</tr>
<tr>
- <td>disable_copy_data</td>
- <td><a href="#bool">bool</a></td>
+ <td>context</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Disable copying query results. </p></td>
+ <td><p>Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). </p></td>
+ </tr>
+
+ <tr>
+ <td>classification_level</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Whether masking was due to classification level. </p></td>
+ </tr>
+
+ <tr>
+ <td>semantic_type_icon</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Icon associated with the semantic type (if any). </p></td>
</tr>
</tbody>
@@ -18661,8 +17785,8 @@ The default value is -1, means no limit. </p></td>
- <h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3>
- <p>Rollout policy configuration.</p>
+ <h3 id="bytebase.v1.QueryHistory">QueryHistory</h3>
+ <p></p>
<table class="field-table">
@@ -18672,42 +17796,61 @@ The default value is -1, means no limit. </p></td>
<tbody>
<tr>
- <td>automatic</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether rollout is automatic without manual approval. </p></td>
+ <td><p>The name for the query history.
+Format: queryHistories/{uid} </p></td>
</tr>
<tr>
- <td>roles</td>
+ <td>database</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The roles that can approve rollout execution. </p></td>
+ <td></td>
+ <td><p>The database name to execute the query.
+Format: instances/{instance}/databases/{databaseName} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TagPolicy">TagPolicy</h3>
- <p>Policy for tagging resources with metadata.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>tags</td>
- <td><a href="#bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td>
- <td>repeated</td>
- <td><p>tags is the key - value map for resources.
-for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; </p></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>duration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.QueryHistory.Type">QueryHistory.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -18717,7 +17860,7 @@ for example, the environment resource can have the sql review config tag, like &
- <h3 id="bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</h3>
+ <h3 id="bytebase.v1.QueryOption">QueryOption</h3>
<p></p>
@@ -18728,15 +17871,15 @@ for example, the environment resource can have the sql review config tag, like &
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
+ <td>redis_run_commands_on</td>
+ <td><a href="#bytebase.v1.QueryOption.RedisRunCommandsOn">QueryOption.RedisRunCommandsOn</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
+ <td>mssql_explain_format</td>
+ <td><a href="#bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -18748,7 +17891,7 @@ for example, the environment resource can have the sql review config tag, like &
- <h3 id="bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</h3>
+ <h3 id="bytebase.v1.QueryRequest">QueryRequest</h3>
<p></p>
@@ -18759,32 +17902,65 @@ for example, the environment resource can have the sql review config tag, like &
<tbody>
<tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The policy to update.
-
-The policy&#39;s `name` field is used to identify the instance to update.
-Format: {resource name}/policies/{policy type}
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
+ <td><p>The name is the instance name to execute the query against.
+Format: instances/{instance}/databases/{databaseName} </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The SQL statement to execute. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>limit</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of rows to return. </p></td>
+ </tr>
+
+ <tr>
+ <td>data_source_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The id of data source.
+It is used for querying admin data source even if the instance has
+read-only data sources. Or it can be used to query a specific read-only
+data source. </p></td>
+ </tr>
+
+ <tr>
+ <td>explain</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the policy is not found, a new policy will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Explain the statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The default schema to search objects. Equals to the current schema in
+Oracle and search path in Postgres. </p></td>
+ </tr>
+
+ <tr>
+ <td>query_option</td>
+ <td><a href="#bytebase.v1.QueryOption">QueryOption</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>container</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Container is the container name to execute the query against, used for
+CosmosDB only. </p></td>
</tr>
</tbody>
@@ -18794,468 +17970,327 @@ In this situation, `update_mask` is ignored. </p></td>
+ <h3 id="bytebase.v1.QueryResponse">QueryResponse</h3>
+ <p></p>
-
- <h3 id="bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</h3>
- <p>Restriction level for admin data source access.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>RESTRICTION_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified restriction.</p></td>
- </tr>
-
- <tr>
- <td>FALLBACK</td>
- <td>1</td>
- <td><p>Allow querying admin data sources when there is no read-only data source.</p></td>
- </tr>
-
- <tr>
- <td>DISALLOW</td>
- <td>2</td>
- <td><p>Disallow querying admin data sources.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.PolicyResourceType">PolicyResourceType</h3>
- <p>The resource type that a policy can be attached to.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>RESOURCE_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified resource type.</p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE</td>
- <td>1</td>
- <td><p>Workspace-level policy.</p></td>
- </tr>
-
- <tr>
- <td>ENVIRONMENT</td>
- <td>2</td>
- <td><p>Environment-level policy.</p></td>
- </tr>
-
- <tr>
- <td>PROJECT</td>
- <td>3</td>
- <td><p>Project-level policy.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.PolicyType">PolicyType</h3>
- <p>The type of organizational policy.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>POLICY_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified policy type.</p></td>
- </tr>
-
- <tr>
- <td>MASKING_RULE</td>
- <td>1</td>
- <td><p>Data masking rule policy.</p></td>
- </tr>
-
- <tr>
- <td>MASKING_EXEMPTION</td>
- <td>2</td>
- <td><p>Data masking exemption policy.</p></td>
- </tr>
-
- <tr>
- <td>ROLLOUT_POLICY</td>
- <td>3</td>
- <td><p>Rollout deployment policy.</p></td>
- </tr>
-
- <tr>
- <td>TAG</td>
- <td>4</td>
- <td><p>Resource tag policy.</p></td>
- </tr>
-
- <tr>
- <td>DATA_SOURCE_QUERY</td>
- <td>5</td>
- <td><p>Data source query restrictions policy.</p></td>
- </tr>
-
- <tr>
- <td>DATA_QUERY</td>
- <td>6</td>
- <td><p>Query data access policy.</p></td>
- </tr>
-
- </tbody>
- </table>
-
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>results</td>
+ <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
+ <td>repeated</td>
+ <td><p>The query results. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
+
+
- <h3 id="bytebase.v1.OrgPolicyService">OrgPolicyService</h3>
- <p>OrgPolicyService manages organizational policies at various resource levels.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetPolicy</td>
- <td><a href="#bytebase.v1.GetPolicyRequest">GetPolicyRequest</a></td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td><p>Retrieves a policy by name.
-Permissions required: bb.policies.get</p></td>
- </tr>
-
- <tr>
- <td>ListPolicies</td>
- <td><a href="#bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</a></td>
- <td><a href="#bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</a></td>
- <td><p>Lists policies at a specified resource level.
-Permissions required: bb.policies.list</p></td>
- </tr>
-
- <tr>
- <td>CreatePolicy</td>
- <td><a href="#bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</a></td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td><p>Creates a new organizational policy.
-Permissions required: bb.policies.create</p></td>
- </tr>
-
- <tr>
- <td>UpdatePolicy</td>
- <td><a href="#bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</a></td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td><p>Updates an existing organizational policy.
-Permissions required: bb.policies.update</p></td>
- </tr>
-
- <tr>
- <td>DeletePolicy</td>
- <td><a href="#bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes an organizational policy.
-Permissions required: bb.policies.delete</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.QueryResult">QueryResult</h3>
+ <p></p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
-
- <tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=policies/*}</td>
- <td></td>
- </tr>
- <tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>column_names</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Column names of the query result. </p></td>
+ </tr>
- <tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=environments/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>column_type_names</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Column types of the query result.
+The types come from the Golang SQL driver. </p></td>
+ </tr>
- <tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>rows</td>
+ <td><a href="#bytebase.v1.QueryRow">QueryRow</a></td>
+ <td>repeated</td>
+ <td><p>Rows of the query result. </p></td>
+ </tr>
- <tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>rows_count</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The error message if the query failed. </p></td>
+ </tr>
+ <tr>
+ <td>latency</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The time it takes to execute the query. </p></td>
+ </tr>
- <tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/policies</td>
- <td></td>
- </tr>
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The query statement for the result. </p></td>
+ </tr>
- <tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/policies</td>
- <td></td>
- </tr>
+ <tr>
+ <td>postgres_error</td>
+ <td><a href="#bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=environments/*}/policies</td>
- <td></td>
- </tr>
+ <tr>
+ <td>syntax_error</td>
+ <td><a href="#bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/policies</td>
- <td></td>
- </tr>
+ <tr>
+ <td>permission_denied</td>
+ <td><a href="#bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*/databases/*}/policies</td>
- <td></td>
- </tr>
+ <tr>
+ <td>messages</td>
+ <td><a href="#bytebase.v1.QueryResult.Message">QueryResult.Message</a></td>
+ <td>repeated</td>
+ <td><p>Informational or debug messages returned by the database engine during query execution.
+Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. </p></td>
+ </tr>
-
+ <tr>
+ <td>masked</td>
+ <td><a href="#bytebase.v1.MaskingReason">MaskingReason</a></td>
+ <td>repeated</td>
+ <td><p>Masking reasons for each column (empty for non-masked columns). </p></td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.QueryResult.Message">QueryResult.Message</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/policies</td>
- <td>policy</td>
- </tr>
+ <tr>
+ <td>level</td>
+ <td><a href="#bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/policies</td>
- <td>policy</td>
- </tr>
+ <tr>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=environments/*}/policies</td>
- <td>policy</td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</h3>
+ <p>Permission denied with resource information or disallowed command_type.</p><p>Either resources or command_type is available.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*}/policies</td>
- <td>policy</td>
- </tr>
+ <tr>
+ <td>resources</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Denied to access the resources.
+Format:
+instances/{instance}/databases/{database}
+instances/{instance}/databases/{database}/schemas/{schema}
+instances/{instance}/databases/{database}/tables/{table}
+instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></td>
+ </tr>
- <tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*/databases/*}/policies</td>
- <td>policy</td>
- </tr>
+ <tr>
+ <td>command_type</td>
+ <td><a href="#bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</a></td>
+ <td></td>
+ <td><p>Disallowed command_type. </p></td>
+ </tr>
-
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</h3>
+ <p>refer https://www.postgresql.org/docs/11/protocol-error-fields.html</p><p>for field description.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>severity</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=policies/*}</td>
- <td>policy</td>
- </tr>
-
- <tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=projects/*/policies/*}</td>
- <td>policy</td>
- </tr>
-
- <tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=environments/*/policies/*}</td>
- <td>policy</td>
- </tr>
-
- <tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=instances/*/policies/*}</td>
- <td>policy</td>
- </tr>
+ <tr>
+ <td>code</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=instances/*/databases/*/policies/*}</td>
- <td>policy</td>
- </tr>
+ <tr>
+ <td>message</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
+ <tr>
+ <td>detail</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+ <tr>
+ <td>hint</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>position</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>internal_position</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=environments/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>internal_query</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>where</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*/databases/*/policies/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>schema_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/sql_service.proto">v1/sql_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.AICompletionRequest">AICompletionRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>table_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>messages</td>
- <td><a href="#bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</a></td>
- <td>repeated</td>
+ <td>column_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>data_type_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>role</td>
+ <td>constraint_name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>content</td>
+ <td>file</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>line</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>candidates</td>
- <td><a href="#bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</a></td>
- <td>repeated</td>
- <td><p>candidates is used for results with multiple choices and candidates. Used
-for OpenAI and Gemini. </p></td>
+ <td>routine</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -19265,8 +18300,8 @@ for OpenAI and Gemini. </p></td>
- <h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</h3>
- <p></p>
+ <h3 id="bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</h3>
+ <p>Syntax error with position information for editor highlighting</p>
<table class="field-table">
@@ -19276,10 +18311,10 @@ for OpenAI and Gemini. </p></td>
<tbody>
<tr>
- <td>content</td>
- <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</a></td>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Position information for highlighting in editor </p></td>
</tr>
</tbody>
@@ -19289,7 +18324,7 @@ for OpenAI and Gemini. </p></td>
- <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3>
+ <h3 id="bytebase.v1.QueryRow">QueryRow</h3>
<p></p>
@@ -19300,10 +18335,10 @@ for OpenAI and Gemini. </p></td>
<tbody>
<tr>
- <td>parts</td>
- <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</a></td>
+ <td>values</td>
+ <td><a href="#bytebase.v1.RowValue">RowValue</a></td>
<td>repeated</td>
- <td><p>parts is used for a result content with multiple parts. </p></td>
+ <td><p>Row values of the query result. </p></td>
</tr>
</tbody>
@@ -19313,7 +18348,7 @@ for OpenAI and Gemini. </p></td>
- <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</h3>
+ <h3 id="bytebase.v1.RowValue">RowValue</h3>
<p></p>
@@ -19324,156 +18359,98 @@ for OpenAI and Gemini. </p></td>
<tbody>
<tr>
- <td>text</td>
- <td><a href="#string">string</a></td>
+ <td>null_value</td>
+ <td><a href="#google.protobuf.NullValue">google.protobuf.NullValue</a></td>
<td></td>
<td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>bool_value</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name is the instance name to execute the query against.
-Format: instances/{instance}/databases/{databaseName} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
+ <td>bytes_value</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The SQL statement to execute. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>limit</td>
- <td><a href="#int32">int32</a></td>
+ <td>double_value</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>The maximum number of rows to return. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The default schema to execute the statement. Equals to the current schema
-in Oracle and search path in Postgres. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>container</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Container is the container name to execute the query against, used for
-CosmosDB only. </p></td>
+ <td>float_value</td>
+ <td><a href="#float">float</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>results</td>
- <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
- <td>repeated</td>
- <td><p>The query results. </p></td>
+ <td>int32_value</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Advice">Advice</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
+ <td>int64_value</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The advice level. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>code</td>
- <td><a href="#int32">int32</a></td>
+ <td>string_value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The advice code. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>uint32_value</td>
+ <td><a href="#uint32">uint32</a></td>
<td></td>
- <td><p>The advice title. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>content</td>
- <td><a href="#string">string</a></td>
+ <td>uint64_value</td>
+ <td><a href="#uint64">uint64</a></td>
<td></td>
- <td><p>The advice content. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>value_value</td>
+ <td><a href="#google.protobuf.Value">google.protobuf.Value</a></td>
<td></td>
- <td><p>The start_position is inclusive and the end_position is exclusive.
-TODO: use range instead </p></td>
+ <td><p>value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. </p></td>
</tr>
<tr>
- <td>end_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>timestamp_value</td>
+ <td><a href="#bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>timestamp_value is used for the timestamp without time zone data type,
+meaning it only includes the timestamp without any time zone or location
+info. Although it may be expressed as a UTC value, it should be seen as a
+timestamp missing location context. </p></td>
</tr>
<tr>
- <td>rule_type</td>
- <td><a href="#bytebase.v1.Advice.RuleType">Advice.RuleType</a></td>
+ <td>timestamp_tz_value</td>
+ <td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</a></td>
<td></td>
- <td><p>The type of linting rule that generated this advice. </p></td>
+ <td><p>timestamp_tz_value is used for the timestamptz data type, which
+accurately represents the timestamp with location information. </p></td>
</tr>
</tbody>
@@ -19483,7 +18460,7 @@ TODO: use range instead </p></td>
- <h3 id="bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</h3>
+ <h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3>
<p></p>
@@ -19494,24 +18471,17 @@ TODO: use range instead </p></td>
<tbody>
<tr>
- <td>source_metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
- <td></td>
- <td><p>The metadata of the source schema. </p></td>
- </tr>
-
- <tr>
- <td>target_metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
+ <td>google_timestamp</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The metadata of the target schema. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>accuracy</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The database engine of the schema. </p></td>
+ <td><p>The accuracy is the number of digits after the decimal point. </p></td>
</tr>
</tbody>
@@ -19521,7 +18491,7 @@ TODO: use range instead </p></td>
- <h3 id="bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</h3>
+ <h3 id="bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</h3>
<p></p>
@@ -19532,10 +18502,36 @@ TODO: use range instead </p></td>
<tbody>
<tr>
- <td>diff</td>
+ <td>google_timestamp</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>zone</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The diff of the metadata. </p></td>
+ <td><p>Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;,
+&#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We
+retrieve the time zone information from the timestamptz field in the
+database. A timestamp is in UTC or epoch time, and with zone info, we can
+convert it to a local time string. Zone and offset are returned by
+time.Time.Zone() </p></td>
+ </tr>
+
+ <tr>
+ <td>offset</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The offset is in seconds east of UTC </p></td>
+ </tr>
+
+ <tr>
+ <td>accuracy</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -19545,7 +18541,7 @@ TODO: use range instead </p></td>
- <h3 id="bytebase.v1.ExportRequest">ExportRequest</h3>
+ <h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3>
<p></p>
@@ -19556,68 +18552,45 @@ TODO: use range instead </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the resource name to execute the export against.
-Format: instances/{instance}/databases/{database}
-Format: instances/{instance}
-Format: projects/{project}/rollouts/{rollout}
-Format: projects/{project}/rollouts/{rollout}/stages/{stage} </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SQL statement to execute. </p></td>
- </tr>
-
- <tr>
- <td>limit</td>
+ <td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of rows to return. </p></td>
- </tr>
-
- <tr>
- <td>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
- <td></td>
- <td><p>The export format. </p></td>
- </tr>
-
- <tr>
- <td>admin</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The admin is used for workspace owner and DBA for exporting data from SQL
-Editor Admin mode. The exported data is not masked. </p></td>
+ <td><p>The maximum number of histories to return.
+The service may return fewer than this value.
+If unspecified, at most 10 history entries will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The zip password provide by users. </p></td>
+ <td><p>A page token, received from a previous `ListQueryHistory` call.
+Provide this to retrieve the subsequent page. </p></td>
</tr>
<tr>
- <td>data_source_id</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The id of data source.
-It is used for querying admin data source even if the instance has
-read-only data sources. Or it can be used to query a specific read-only
-data source. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The default schema to search objects. Equals to the current schema in
-Oracle and search path in Postgres. </p></td>
+ <td><p>Filter is the filter to apply on the search query history
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator.
+- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
+- type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator.
+- statement: the SQL statement, support &#34;.matches()&#34; operator.
+
+For example:
+project == &#34;projects/{project}&#34;
+database == &#34;instances/{instance}/databases/{database}&#34;
+instance == &#34;instances/{instance}&#34;
+type == &#34;QUERY&#34;
+type == &#34;EXPORT&#34;
+statement.matches(&#34;select&#34;)
+type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
</tr>
</tbody>
@@ -19627,7 +18600,7 @@ Oracle and search path in Postgres. </p></td>
- <h3 id="bytebase.v1.ExportResponse">ExportResponse</h3>
+ <h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</h3>
<p></p>
@@ -19638,76 +18611,19 @@ Oracle and search path in Postgres. </p></td>
<tbody>
<tr>
- <td>content</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The export file content. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.MaskingReason">MaskingReason</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>semantic_type_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). </p></td>
- </tr>
-
- <tr>
- <td>semantic_type_title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Human-readable semantic type title. </p></td>
- </tr>
-
- <tr>
- <td>masking_rule_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The masking rule ID that matched (if applicable). </p></td>
- </tr>
-
- <tr>
- <td>algorithm</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The masking algorithm used. </p></td>
- </tr>
-
- <tr>
- <td>context</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). </p></td>
- </tr>
-
- <tr>
- <td>classification_level</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Whether masking was due to classification level. </p></td>
+ <td>query_histories</td>
+ <td><a href="#bytebase.v1.QueryHistory">QueryHistory</a></td>
+ <td>repeated</td>
+ <td><p>The list of history. </p></td>
</tr>
<tr>
- <td>semantic_type_icon</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Icon associated with the semantic type (if any). </p></td>
+ <td><p>A token to retrieve next page of history.
+Pass this value in the page_token field in the subsequent call to
+`ListQueryHistory` method to retrieve the next page of history. </p></td>
</tr>
</tbody>
@@ -19717,319 +18633,414 @@ Oracle and search path in Postgres. </p></td>
- <h3 id="bytebase.v1.QueryHistory">QueryHistory</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name for the query history.
-Format: queryHistories/{uid} </p></td>
- </tr>
-
- <tr>
- <td>database</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The database name to execute the query.
-Format: instances/{instance}/databases/{databaseName} </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>duration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.QueryHistory.Type">QueryHistory.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h3 id="bytebase.v1.QueryOption">QueryOption</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>redis_run_commands_on</td>
- <td><a href="#bytebase.v1.QueryOption.RedisRunCommandsOn">QueryOption.RedisRunCommandsOn</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>mssql_explain_format</td>
- <td><a href="#bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.Advice.Level">Advice.Level</h3>
+ <p>Level represents the severity level of the advice.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ADVICE_LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified advice level.</p></td>
+ </tr>
+
+ <tr>
+ <td>SUCCESS</td>
+ <td>1</td>
+ <td><p>Success status indicating the check passed without issues.</p></td>
+ </tr>
+
+ <tr>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p>Warning status indicating potential issues that should be reviewed.</p></td>
+ </tr>
+
+ <tr>
+ <td>ERROR</td>
+ <td>3</td>
+ <td><p>Error status indicating critical issues that must be addressed.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.QueryRequest">QueryRequest</h3>
+ <h3 id="bytebase.v1.Advice.RuleType">Advice.RuleType</h3>
+ <p>RuleType indicates the source of the linting rule.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>RULE_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified rule type.</p></td>
+ </tr>
+
+ <tr>
+ <td>PARSER_BASED</td>
+ <td>1</td>
+ <td><p>Parser-based rule enforced by the built-in SQL parser.
+These are non-configurable, mandatory checks for schema health.</p></td>
+ </tr>
+
+ <tr>
+ <td>AI_POWERED</td>
+ <td>2</td>
+ <td><p>AI-powered rule defined by user in natural language.
+These are custom, flexible checks powered by AI models.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.QueryHistory.Type">QueryHistory.Type</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the instance name to execute the query against.
-Format: instances/{instance}/databases/{databaseName} </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SQL statement to execute. </p></td>
- </tr>
-
- <tr>
- <td>limit</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of rows to return. </p></td>
- </tr>
-
- <tr>
- <td>data_source_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The id of data source.
-It is used for querying admin data source even if the instance has
-read-only data sources. Or it can be used to query a specific read-only
-data source. </p></td>
- </tr>
-
- <tr>
- <td>explain</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Explain the statement. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The default schema to search objects. Equals to the current schema in
-Oracle and search path in Postgres. </p></td>
- </tr>
-
- <tr>
- <td>query_option</td>
- <td><a href="#bytebase.v1.QueryOption">QueryOption</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>container</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Container is the container name to execute the query against, used for
-CosmosDB only. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified query history type.</p></td>
+ </tr>
+
+ <tr>
+ <td>QUERY</td>
+ <td>1</td>
+ <td><p>Query execution for data retrieval.</p></td>
+ </tr>
+
+ <tr>
+ <td>EXPORT</td>
+ <td>2</td>
+ <td><p>Data export operation to file.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.QueryResponse">QueryResponse</h3>
+ <h3 id="bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>results</td>
- <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
- <td>repeated</td>
- <td><p>The query results. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>MSSQL_EXPLAIN_FORMAT_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>defaults to SHOWPLAN_ALL</p></td>
+ </tr>
+
+ <tr>
+ <td>MSSQL_EXPLAIN_FORMAT_ALL</td>
+ <td>1</td>
+ <td><p>SHOWPLAN_ALL</p></td>
+ </tr>
+
+ <tr>
+ <td>MSSQL_EXPLAIN_FORMAT_XML</td>
+ <td>2</td>
+ <td><p>SHOWPLAN_XML</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.QueryResult">QueryResult</h3>
+ <h3 id="bytebase.v1.QueryOption.RedisRunCommandsOn">QueryOption.RedisRunCommandsOn</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>REDIS_RUN_COMMANDS_ON_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>UNSPECIFIED defaults to SINGLE_NODE.</p></td>
+ </tr>
+
+ <tr>
+ <td>SINGLE_NODE</td>
+ <td>1</td>
+ <td><p>Execute Redis commands on a single node in the cluster.</p></td>
+ </tr>
+
+ <tr>
+ <td>ALL_NODES</td>
+ <td>2</td>
+ <td><p>Execute Redis commands on all nodes in the cluster for cluster-wide operations.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified message level.</p></td>
+ </tr>
+
+ <tr>
+ <td>INFO</td>
+ <td>1</td>
+ <td><p>Informational message.</p></td>
+ </tr>
+
+ <tr>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p>Warning message indicating potential issues.</p></td>
+ </tr>
+
+ <tr>
+ <td>DEBUG</td>
+ <td>3</td>
+ <td><p>Debug message for development and troubleshooting.</p></td>
+ </tr>
+
+ <tr>
+ <td>LOG</td>
+ <td>4</td>
+ <td><p>General log message.</p></td>
+ </tr>
+
+ <tr>
+ <td>NOTICE</td>
+ <td>5</td>
+ <td><p>Notice message for important information.</p></td>
+ </tr>
+
+ <tr>
+ <td>EXCEPTION</td>
+ <td>6</td>
+ <td><p>Exception message indicating error conditions.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</h3>
<p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>COMMAND_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DDL</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DML</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NON_READ_ONLY</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>column_names</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Column names of the query result. </p></td>
- </tr>
+
+
+
+ <h3 id="bytebase.v1.SQLService">SQLService</h3>
+ <p>SQLService executes SQL queries and manages query operations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>Query</td>
+ <td><a href="#bytebase.v1.QueryRequest">QueryRequest</a></td>
+ <td><a href="#bytebase.v1.QueryResponse">QueryResponse</a></td>
+ <td><p>Executes a read-only SQL query against a database.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>AdminExecute</td>
+ <td><a href="#bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</a> stream</td>
+ <td><a href="#bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</a> stream</td>
+ <td><p>Executes SQL with admin privileges via streaming connection.
+Permissions required: bb.sql.admin</p></td>
+ </tr>
+
+ <tr>
+ <td>SearchQueryHistories</td>
+ <td><a href="#bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</a></td>
+ <td><a href="#bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</a></td>
+ <td><p>SearchQueryHistories searches query histories for the caller.
+Permissions required: None (only returns caller&#39;s own query histories)</p></td>
+ </tr>
+
+ <tr>
+ <td>Export</td>
+ <td><a href="#bytebase.v1.ExportRequest">ExportRequest</a></td>
+ <td><a href="#bytebase.v1.ExportResponse">ExportResponse</a></td>
+ <td><p>Exports query results to a file format.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>DiffMetadata</td>
+ <td><a href="#bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</a></td>
+ <td><a href="#bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</a></td>
+ <td><p>Computes schema differences between two database metadata.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>AICompletion</td>
+ <td><a href="#bytebase.v1.AICompletionRequest">AICompletionRequest</a></td>
+ <td><a href="#bytebase.v1.AICompletionResponse">AICompletionResponse</a></td>
+ <td><p>Provides AI-powered SQL completion and generation.
+Permissions required: None (authenticated users only, requires AI to be enabled)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
- <tr>
- <td>column_type_names</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Column types of the query result.
-The types come from the Golang SQL driver. </p></td>
- </tr>
- <tr>
- <td>rows</td>
- <td><a href="#bytebase.v1.QueryRow">QueryRow</a></td>
- <td>repeated</td>
- <td><p>Rows of the query result. </p></td>
- </tr>
+ <tr>
+ <td>Query</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*}:query</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>rows_count</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The error message if the query failed. </p></td>
- </tr>
- <tr>
- <td>latency</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The time it takes to execute the query. </p></td>
- </tr>
+ <tr>
+ <td>AdminExecute</td>
+ <td>GET</td>
+ <td>/v1:adminExecute</td>
+ <td></td>
+ </tr>
- <tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The query statement for the result. </p></td>
- </tr>
+
- <tr>
- <td>postgres_error</td>
- <td><a href="#bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>syntax_error</td>
- <td><a href="#bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>SearchQueryHistories</td>
+ <td>POST</td>
+ <td>/v1/queryHistories:search</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>permission_denied</td>
- <td><a href="#bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>messages</td>
- <td><a href="#bytebase.v1.QueryResult.Message">QueryResult.Message</a></td>
- <td>repeated</td>
- <td><p>Informational or debug messages returned by the database engine during query execution.
-Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. </p></td>
- </tr>
- <tr>
- <td>masked</td>
- <td><a href="#bytebase.v1.MaskingReason">MaskingReason</a></td>
- <td>repeated</td>
- <td><p>Masking reasons for each column (empty for non-masked columns). </p></td>
- </tr>
+ <tr>
+ <td>Export</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*}:export</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>Export</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/rollouts/*}:export</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>Export</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/rollouts/*/stages/*}:export</td>
+ <td>*</td>
+ </tr>
+
+
+
+ <tr>
+ <td>DiffMetadata</td>
+ <td>POST</td>
+ <td>/v1/schemaDesign:diffMetadata</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>AICompletion</td>
+ <td>POST</td>
+ <td>/v1/sql/aiCompletion</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.QueryResult.Message">QueryResult.Message</h3>
+ <div class="file-heading">
+ <h2 id="v1/plan_service.proto">v1/plan_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</h3>
<p></p>
@@ -20040,17 +19051,11 @@ Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39
<tbody>
<tr>
- <td>level</td>
- <td><a href="#bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>content</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the plan check run to cancel.
+Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
</tr>
</tbody>
@@ -20060,8 +19065,15 @@ Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39
- <h3 id="bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</h3>
- <p>Permission denied with resource information or disallowed command_type.</p><p>Either resources or command_type is available.</p>
+ <h3 id="bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</h3>
+ <p></p>
<table class="field-table">
@@ -20071,22 +19083,18 @@ Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39
<tbody>
<tr>
- <td>resources</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Denied to access the resources.
-Format:
-instances/{instance}/databases/{database}
-instances/{instance}/databases/{database}/schemas/{schema}
-instances/{instance}/databases/{database}/tables/{table}
-instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></td>
+ <td></td>
+ <td><p>The parent project where this plan will be created.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>command_type</td>
- <td><a href="#bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</a></td>
+ <td>plan</td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
<td></td>
- <td><p>Disallowed command_type. </p></td>
+ <td><p>The plan to create. </p></td>
</tr>
</tbody>
@@ -20096,8 +19104,8 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
- <h3 id="bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</h3>
- <p>refer https://www.postgresql.org/docs/11/protocol-error-fields.html</p><p>for field description.</p>
+ <h3 id="bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</h3>
+ <p></p>
<table class="field-table">
@@ -20107,146 +19115,243 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
<tbody>
<tr>
- <td>severity</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the plan check run to retrieve.
+Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>code</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the plan to retrieve.
+Format: projects/{project}/plans/{plan} </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>message</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent, which owns this collection of plans.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list all plans from all projects. </p></td>
</tr>
<tr>
- <td>detail</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The maximum number of plans to return. The service may return fewer than
+this value.
+If unspecified, at most 10 plans will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>hint</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A page token, received from a previous `ListPlans` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListPlans` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>position</td>
- <td><a href="#int32">int32</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Filter is used to filter plans returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
+- create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+- has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
+- has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
+- title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match.
+- spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;.
+- state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
+
+For example:
+creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
+has_rollout == false &amp;&amp; has_issue == true
+title == &#34;My Plan&#34;
+title.matches(&#34;database migration&#34;)
+spec_type == &#34;change_database_config&#34;
+state == &#34;ACTIVE&#34; </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>internal_position</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>plans</td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td>repeated</td>
+ <td><p>The plans from the specified request. </p></td>
</tr>
<tr>
- <td>internal_query</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Plan">Plan</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>where</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the plan.
+`plan` is a system generated ID.
+Format: projects/{project}/plans/{plan} </p></td>
</tr>
<tr>
- <td>schema_name</td>
- <td><a href="#string">string</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The state of the plan. </p></td>
</tr>
<tr>
- <td>table_name</td>
+ <td>issue</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The issue associated with the plan.
+Can be empty.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>column_name</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The title of the plan. </p></td>
</tr>
<tr>
- <td>data_type_name</td>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The description of the plan. </p></td>
</tr>
<tr>
- <td>constraint_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>specs</td>
+ <td><a href="#bytebase.v1.Plan.Spec">Plan.Spec</a></td>
+ <td>repeated</td>
+ <td><p>The deployment specs for the plan. </p></td>
</tr>
<tr>
- <td>file</td>
+ <td>creator</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Format: users/[email protected] </p></td>
</tr>
<tr>
- <td>line</td>
- <td><a href="#int32">int32</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>routine</td>
- <td><a href="#string">string</a></td>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</h3>
- <p>Syntax error with position information for editor highlighting</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>plan_check_run_status_count</td>
+ <td><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</a></td>
+ <td>repeated</td>
+ <td><p>The status count of the latest plan check runs.
+Keys are:
+- SUCCESS
+- WARNING
+- ERROR
+- RUNNING </p></td>
+ </tr>
<tr>
- <td>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>has_rollout</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Position information for highlighting in editor </p></td>
+ <td><p>Whether the plan has started the rollout. </p></td>
</tr>
</tbody>
@@ -20256,7 +19361,7 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
- <h3 id="bytebase.v1.QueryRow">QueryRow</h3>
+ <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3>
<p></p>
@@ -20267,122 +19372,156 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
<tbody>
<tr>
- <td>values</td>
- <td><a href="#bytebase.v1.RowValue">RowValue</a></td>
+ <td>targets</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>Row values of the query result. </p></td>
+ <td><p>The list of targets.
+Multi-database format: [instances/{instance-id}/databases/{database-name}].
+Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RowValue">RowValue</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The resource name of the sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
<tr>
- <td>null_value</td>
- <td><a href="#google.protobuf.NullValue">google.protobuf.NullValue</a></td>
+ <td>release</td>
+ <td><a href="#string">string</a></td>
<td></td>
+ <td><p>The resource name of the release.
+Format: projects/{project}/releases/{release} </p></td>
+ </tr>
+
+ <tr>
+ <td>ghost_flags</td>
+ <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
<tr>
- <td>bool_value</td>
+ <td>enable_prior_backup</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>If set, a backup of the modified data will be created automatically before any changes are applied. </p></td>
</tr>
<tr>
- <td>bytes_value</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>enable_ghost</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether to use gh-ost for online schema migration. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>double_value</td>
- <td><a href="#double">double</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>float_value</td>
- <td><a href="#float">float</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>int32_value</td>
- <td><a href="#int32">int32</a></td>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The resource name of the instance on which the database is created.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>int64_value</td>
- <td><a href="#int64">int64</a></td>
+ <td>database</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database to create. </p></td>
</tr>
<tr>
- <td>string_value</td>
+ <td>table</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>table is the name of the table, if it is not empty, Bytebase should create a table after creating the database.
+For example, in MongoDB, it only creates the database when we first store data in that database. </p></td>
</tr>
<tr>
- <td>uint32_value</td>
- <td><a href="#uint32">uint32</a></td>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>character_set is the character set of the database. </p></td>
</tr>
<tr>
- <td>uint64_value</td>
- <td><a href="#uint64">uint64</a></td>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>collation is the collation of the database. </p></td>
</tr>
<tr>
- <td>value_value</td>
- <td><a href="#google.protobuf.Value">google.protobuf.Value</a></td>
+ <td>cluster</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. </p></td>
+ <td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. </p></td>
</tr>
<tr>
- <td>timestamp_value</td>
- <td><a href="#bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</a></td>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>timestamp_value is used for the timestamp without time zone data type,
-meaning it only includes the timestamp without any time zone or location
-info. Although it may be expressed as a UTC value, it should be seen as a
-timestamp missing location context. </p></td>
+ <td><p>owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. </p></td>
</tr>
<tr>
- <td>timestamp_tz_value</td>
- <td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</a></td>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>timestamp_tz_value is used for the timestamptz data type, which
-accurately represents the timestamp with location information. </p></td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
</tr>
</tbody>
@@ -20392,7 +19531,7 @@ accurately represents the timestamp with location information. </p></td>
- <h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3>
+ <h3 id="bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</h3>
<p></p>
@@ -20403,17 +19542,35 @@ accurately represents the timestamp with location information. </p></td>
<tbody>
<tr>
- <td>google_timestamp</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>targets</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The list of targets.
+Multi-database format: [instances/{instance-id}/databases/{database-name}].
+Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td>
+ </tr>
+
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The resource name of the sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>accuracy</td>
- <td><a href="#int32">int32</a></td>
+ <td>format</td>
+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
<td></td>
- <td><p>The accuracy is the number of digits after the decimal point. </p></td>
+ <td><p>The format of the exported file. </p></td>
+ </tr>
+
+ <tr>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The zip password provide by users.
+Leave it empty if no needs to encrypt the zip file. </p></td>
</tr>
</tbody>
@@ -20423,7 +19580,7 @@ accurately represents the timestamp with location information. </p></td>
- <h3 id="bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</h3>
+ <h3 id="bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</h3>
<p></p>
@@ -20434,33 +19591,14 @@ accurately represents the timestamp with location information. </p></td>
<tbody>
<tr>
- <td>google_timestamp</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>zone</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;,
-&#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We
-retrieve the time zone information from the timestamptz field in the
-database. A timestamp is in UTC or epoch time, and with zone info, we can
-convert it to a local time string. Zone and offset are returned by
-time.Time.Zone() </p></td>
- </tr>
-
- <tr>
- <td>offset</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The offset is in seconds east of UTC </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>accuracy</td>
+ <td>value</td>
<td><a href="#int32">int32</a></td>
<td></td>
<td><p> </p></td>
@@ -20473,7 +19611,7 @@ time.Time.Zone() </p></td>
- <h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3>
+ <h3 id="bytebase.v1.Plan.Spec">Plan.Spec</h3>
<p></p>
@@ -20484,45 +19622,31 @@ time.Time.Zone() </p></td>
<tbody>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of histories to return.
-The service may return fewer than this value.
-If unspecified, at most 10 history entries will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>A UUID4 string that uniquely identifies the Spec. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>create_database_config</td>
+ <td><a href="#bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListQueryHistory` call.
-Provide this to retrieve the subsequent page. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
+ <td>change_database_config</td>
+ <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</a></td>
<td></td>
- <td><p>Filter is the filter to apply on the search query history
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator.
-- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
-- type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator.
-- statement: the SQL statement, support &#34;.matches()&#34; operator.
-
-For example:
-project == &#34;projects/{project}&#34;
-database == &#34;instances/{instance}/databases/{database}&#34;
-instance == &#34;instances/{instance}&#34;
-type == &#34;QUERY&#34;
-type == &#34;EXPORT&#34;
-statement.matches(&#34;select&#34;)
-type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>export_data_config</td>
+ <td><a href="#bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -20532,7 +19656,7 @@ type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
- <h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</h3>
+ <h3 id="bytebase.v1.PlanCheckRun">PlanCheckRun</h3>
<p></p>
@@ -20543,32 +19667,270 @@ type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
<tbody>
<tr>
- <td>query_histories</td>
- <td><a href="#bytebase.v1.QueryHistory">QueryHistory</a></td>
- <td>repeated</td>
- <td><p>The list of history. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td>
<td></td>
- <td><p>A token to retrieve next page of history.
-Pass this value in the page_token field in the subsequent call to
-`ListQueryHistory` method to retrieve the next page of history. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
+ <tr>
+ <td>results</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>error is set if the Status is FAILED. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.Advice.Level">Advice.Level</h3>
- <p>Level represents the severity level of the advice.</p>
+ <h3 id="bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>code</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Target identification for consolidated results.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_summary_report</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_review_report</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p>Position of the SQL statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>end_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>statement_types</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>statement_types are the types of statements that are found in the sql. </p></td>
+ </tr>
+
+ <tr>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The plan to run plan checks.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>spec_id</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The UUID of the specific spec to run plan checks for.
+This should match the spec.id field in Plan.Spec.
+If not set, all specs in the plan will be used. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>plan</td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td></td>
+ <td><p>The plan to update.
+
+The plan&#39;s `name` field is used to identify the plan to update.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the plan is not found, a new plan will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -20576,34 +19938,34 @@ Pass this value in the page_token field in the subsequent call to
<tbody>
<tr>
- <td>ADVICE_LEVEL_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified advice level.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>SUCCESS</td>
+ <td>STATEMENT_ADVISE</td>
<td>1</td>
- <td><p>Success status indicating the check passed without issues.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>WARNING</td>
+ <td>STATEMENT_SUMMARY_REPORT</td>
<td>2</td>
- <td><p>Warning status indicating potential issues that should be reviewed.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ERROR</td>
+ <td>GHOST_SYNC</td>
<td>3</td>
- <td><p>Error status indicating critical issues that must be addressed.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.Advice.RuleType">Advice.RuleType</h3>
- <p>RuleType indicates the source of the linting rule.</p>
+ <h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -20611,354 +19973,194 @@ Pass this value in the page_token field in the subsequent call to
<tbody>
<tr>
- <td>RULE_TYPE_UNSPECIFIED</td>
+ <td>STATUS_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified rule type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>PARSER_BASED</td>
+ <td>RUNNING</td>
<td>1</td>
- <td><p>Parser-based rule enforced by the built-in SQL parser.
-These are non-configurable, mandatory checks for schema health.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>AI_POWERED</td>
+ <td>DONE</td>
<td>2</td>
- <td><p>AI-powered rule defined by user in natural language.
-These are custom, flexible checks powered by AI models.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.QueryHistory.Type">QueryHistory.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified query history type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>QUERY</td>
- <td>1</td>
- <td><p>Query execution for data retrieval.</p></td>
+ <td>FAILED</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>EXPORT</td>
- <td>2</td>
- <td><p>Data export operation to file.</p></td>
+ <td>CANCELED</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</h3>
- <p></p>
+
+
+
+
+ <h3 id="bytebase.v1.PlanService">PlanService</h3>
+ <p>PlanService manages deployment plans for database changes.</p>
<table class="enum-table">
<thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>MSSQL_EXPLAIN_FORMAT_UNSPECIFIED</td>
- <td>0</td>
- <td><p>defaults to SHOWPLAN_ALL</p></td>
- </tr>
-
- <tr>
- <td>MSSQL_EXPLAIN_FORMAT_ALL</td>
- <td>1</td>
- <td><p>SHOWPLAN_ALL</p></td>
+ <td>GetPlan</td>
+ <td><a href="#bytebase.v1.GetPlanRequest">GetPlanRequest</a></td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td><p>Retrieves a deployment plan by name.
+Permissions required: bb.plans.get</p></td>
</tr>
<tr>
- <td>MSSQL_EXPLAIN_FORMAT_XML</td>
- <td>2</td>
- <td><p>SHOWPLAN_XML</p></td>
+ <td>ListPlans</td>
+ <td><a href="#bytebase.v1.ListPlansRequest">ListPlansRequest</a></td>
+ <td><a href="#bytebase.v1.ListPlansResponse">ListPlansResponse</a></td>
+ <td><p>Lists deployment plans in a project.
+Permissions required: bb.plans.list</p></td>
</tr>
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.QueryOption.RedisRunCommandsOn">QueryOption.RedisRunCommandsOn</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>REDIS_RUN_COMMANDS_ON_UNSPECIFIED</td>
- <td>0</td>
- <td><p>UNSPECIFIED defaults to SINGLE_NODE.</p></td>
+ <td>CreatePlan</td>
+ <td><a href="#bytebase.v1.CreatePlanRequest">CreatePlanRequest</a></td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td><p>Creates a new deployment plan.
+Permissions required: bb.plans.create</p></td>
</tr>
<tr>
- <td>SINGLE_NODE</td>
- <td>1</td>
- <td><p>Execute Redis commands on a single node in the cluster.</p></td>
+ <td>UpdatePlan</td>
+ <td><a href="#bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</a></td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td><p>UpdatePlan updates the plan.
+The plan creator and the user with bb.plans.update permission on the project can update the plan.
+Permissions required: bb.plans.update (or creator)</p></td>
</tr>
<tr>
- <td>ALL_NODES</td>
- <td>2</td>
- <td><p>Execute Redis commands on all nodes in the cluster for cluster-wide operations.</p></td>
+ <td>GetPlanCheckRun</td>
+ <td><a href="#bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</a></td>
+ <td><a href="#bytebase.v1.PlanCheckRun">PlanCheckRun</a></td>
+ <td><p>Gets the plan check run for a deployment plan.
+Permissions required: bb.planCheckRuns.get</p></td>
</tr>
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>LEVEL_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified message level.</p></td>
+ <td>RunPlanChecks</td>
+ <td><a href="#bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</a></td>
+ <td><a href="#bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</a></td>
+ <td><p>Executes validation checks on a deployment plan.
+Permissions required: bb.planCheckRuns.run</p></td>
</tr>
<tr>
- <td>INFO</td>
- <td>1</td>
- <td><p>Informational message.</p></td>
+ <td>CancelPlanCheckRun</td>
+ <td><a href="#bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</a></td>
+ <td><a href="#bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</a></td>
+ <td><p>Cancels the plan check run for a deployment plan.
+Permissions required: bb.planCheckRuns.run</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>WARNING</td>
- <td>2</td>
- <td><p>Warning message indicating potential issues.</p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>DEBUG</td>
- <td>3</td>
- <td><p>Debug message for development and troubleshooting.</p></td>
+ <td>GetPlan</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>LOG</td>
- <td>4</td>
- <td><p>General log message.</p></td>
+ <td>ListPlans</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/plans</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>NOTICE</td>
- <td>5</td>
- <td><p>Notice message for important information.</p></td>
+ <td>CreatePlan</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/plans</td>
+ <td>plan</td>
</tr>
+
+
+
<tr>
- <td>EXCEPTION</td>
- <td>6</td>
- <td><p>Exception message indicating error conditions.</p></td>
+ <td>UpdatePlan</td>
+ <td>PATCH</td>
+ <td>/v1/{plan.name=projects/*/plans/*}</td>
+ <td>plan</td>
</tr>
+
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
+
+
<tr>
- <td>COMMAND_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>GetPlanCheckRun</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*/planCheckRun}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>DDL</td>
- <td>1</td>
- <td><p></p></td>
+ <td>RunPlanChecks</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/plans/*}:runPlanChecks</td>
+ <td>*</td>
</tr>
+
+
+
<tr>
- <td>DML</td>
- <td>2</td>
- <td><p></p></td>
+ <td>CancelPlanCheckRun</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/plans/*/planCheckRun}:cancel</td>
+ <td>*</td>
</tr>
-
- <tr>
- <td>NON_READ_ONLY</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLService">SQLService</h3>
- <p>SQLService executes SQL queries and manages query operations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>Query</td>
- <td><a href="#bytebase.v1.QueryRequest">QueryRequest</a></td>
- <td><a href="#bytebase.v1.QueryResponse">QueryResponse</a></td>
- <td><p>Executes a read-only SQL query against a database.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>AdminExecute</td>
- <td><a href="#bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</a> stream</td>
- <td><a href="#bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</a> stream</td>
- <td><p>Executes SQL with admin privileges via streaming connection.
-Permissions required: bb.sql.admin</p></td>
- </tr>
-
- <tr>
- <td>SearchQueryHistories</td>
- <td><a href="#bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</a></td>
- <td><a href="#bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</a></td>
- <td><p>SearchQueryHistories searches query histories for the caller.
-Permissions required: None (only returns caller&#39;s own query histories)</p></td>
- </tr>
-
- <tr>
- <td>Export</td>
- <td><a href="#bytebase.v1.ExportRequest">ExportRequest</a></td>
- <td><a href="#bytebase.v1.ExportResponse">ExportResponse</a></td>
- <td><p>Exports query results to a file format.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>DiffMetadata</td>
- <td><a href="#bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</a></td>
- <td><a href="#bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</a></td>
- <td><p>Computes schema differences between two database metadata.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>AICompletion</td>
- <td><a href="#bytebase.v1.AICompletionRequest">AICompletionRequest</a></td>
- <td><a href="#bytebase.v1.AICompletionResponse">AICompletionResponse</a></td>
- <td><p>Provides AI-powered SQL completion and generation.
-Permissions required: None (authenticated users only, requires AI to be enabled)</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>Query</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:query</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>AdminExecute</td>
- <td>GET</td>
- <td>/v1:adminExecute</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>SearchQueryHistories</td>
- <td>POST</td>
- <td>/v1/queryHistories:search</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>Export</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:export</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>Export</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/rollouts/*}:export</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>Export</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/rollouts/*/stages/*}:export</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>DiffMetadata</td>
- <td>POST</td>
- <td>/v1/schemaDesign:diffMetadata</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>AICompletion</td>
- <td>POST</td>
- <td>/v1/sql/aiCompletion</td>
- <td>*</td>
- </tr>
-
+
</tbody>
</table>
@@ -20967,12 +20169,19 @@ Permissions required: None (authenticated users only, requires AI to be enabled)
<div class="file-heading">
- <h2 id="v1/plan_service.proto">v1/plan_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/project_service.proto">v1/project_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</h3>
+ <h3 id="bytebase.v1.Activity">Activity</h3>
+ <p>Activity types for webhook notifications.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.AddWebhookRequest">AddWebhookRequest</h3>
<p></p>
@@ -20983,11 +20192,18 @@ Permissions required: None (authenticated users only, requires AI to be enabled)
<tbody>
<tr>
- <td>name</td>
+ <td>project</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the plan check run to cancel.
-Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
+ <td><p>The name of the project to add the webhook to.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td></td>
+ <td><p>The webhook to add. </p></td>
</tr>
</tbody>
@@ -20997,14 +20213,7 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
- <h3 id="bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</h3>
+ <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>
<p></p>
@@ -21015,18 +20224,21 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent project where this plan will be created.
+ <td>repeated</td>
+ <td><p>The names of the projects to delete.
Format: projects/{project} </p></td>
</tr>
<tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td>force</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The plan to create. </p></td>
+ <td><p>If set to true, any databases from this project will be moved to default project.
+Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
+Open issues will remain open but associated with the deleted project.
+If set to false, the operation will fail if the project has databases or open issues. </p></td>
</tr>
</tbody>
@@ -21036,7 +20248,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</h3>
+ <h3 id="bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</h3>
<p></p>
@@ -21047,11 +20259,11 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the plan check run to retrieve.
-Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
+ <td>repeated</td>
+ <td><p>The names of projects to retrieve.
+Format: projects/{project} </p></td>
</tr>
</tbody>
@@ -21061,7 +20273,7 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
- <h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3>
+ <h3 id="bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</h3>
<p></p>
@@ -21072,11 +20284,10 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the plan to retrieve.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>repeated</td>
+ <td><p>The projects from the specified request. </p></td>
</tr>
</tbody>
@@ -21086,7 +20297,7 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3>
+ <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3>
<p></p>
@@ -21097,58 +20308,21 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent, which owns this collection of plans.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list all plans from all projects. </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>project</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
<td></td>
- <td><p>The maximum number of plans to return. The service may return fewer than
-this value.
-If unspecified, at most 10 plans will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The project to create. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>project_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListPlans` call.
-Provide this to retrieve the subsequent page.
+ <td><p>The ID to use for the project, which will become the final component of
+the project&#39;s resource name.
-When paginating, all other parameters provided to `ListPlans` must match
-the call that provided the page token. </p></td>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter plans returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
-- create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-- has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
-- has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
-- title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match.
-- spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;.
-- state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
-
-For example:
-creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
-has_rollout == false &amp;&amp; has_issue == true
-title == &#34;My Plan&#34;
-title.matches(&#34;database migration&#34;)
-spec_type == &#34;change_database_config&#34;
-state == &#34;ACTIVE&#34; </p></td>
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
</tbody>
@@ -21158,7 +20332,7 @@ state == &#34;ACTIVE&#34; </p></td>
- <h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3>
+ <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3>
<p></p>
@@ -21169,18 +20343,31 @@ state == &#34;ACTIVE&#34; </p></td>
<tbody>
<tr>
- <td>plans</td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
- <td>repeated</td>
- <td><p>The plans from the specified request. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the project to delete.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>force</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>If set to true, any databases from this project will be moved to default project.
+Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
+Open issues will remain open but associated with the deleted project.
+If set to false, the operation will fail if the project has databases or open issues. </p></td>
+ </tr>
+
+ <tr>
+ <td>purge</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, permanently purge the soft-deleted project and all related resources.
+This operation is irreversible. Following AIP-165, this should only be used for
+administrative cleanup of old soft-deleted projects.
+The project must already be soft-deleted for this to work. </p></td>
</tr>
</tbody>
@@ -21190,7 +20377,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Plan">Plan</h3>
+ <h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</h3>
<p></p>
@@ -21204,86 +20391,46 @@ If this field is omitted, there are no subsequent pages. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the plan.
-`plan` is a system generated ID.
-Format: projects/{project}/plans/{plan} </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The state of the plan. </p></td>
+ <td><p>The name of the project to retrieve.
+Format: projects/{project} </p></td>
</tr>
- <tr>
- <td>issue</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The issue associated with the plan.
-Can be empty.
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Label">Label</h3>
+ <p>A label for categorizing and organizing issues.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>title</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the plan. </p></td>
+ <td><p>The label value/name. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>color</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the plan. </p></td>
- </tr>
-
- <tr>
- <td>specs</td>
- <td><a href="#bytebase.v1.Plan.Spec">Plan.Spec</a></td>
- <td>repeated</td>
- <td><p>The deployment specs for the plan. </p></td>
+ <td><p>The color code for the label (e.g., hex color). </p></td>
</tr>
<tr>
- <td>creator</td>
+ <td>group</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>plan_check_run_status_count</td>
- <td><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</a></td>
- <td>repeated</td>
- <td><p>The status count of the latest plan check runs.
-Keys are:
-- SUCCESS
-- WARNING
-- ERROR
-- RUNNING </p></td>
- </tr>
-
- <tr>
- <td>has_rollout</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the plan has started the rollout. </p></td>
+ <td><p>The group this label belongs to. </p></td>
</tr>
</tbody>
@@ -21293,7 +20440,7 @@ Keys are:
- <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3>
+ <h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</h3>
<p></p>
@@ -21304,49 +20451,52 @@ Keys are:
<tbody>
<tr>
- <td>targets</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of targets.
-Multi-database format: [instances/{instance-id}/databases/{database-name}].
-Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td>
- </tr>
-
- <tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The resource name of the sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>The maximum number of projects to return. The service may return fewer than
+this value.
+If unspecified, at most 10 projects will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>release</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the release.
-Format: projects/{project}/releases/{release} </p></td>
+ <td><p>A page token, received from a previous `ListProjects` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListProjects` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>ghost_flags</td>
- <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Show deleted projects if specified. </p></td>
</tr>
<tr>
- <td>enable_prior_backup</td>
- <td><a href="#bool">bool</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set, a backup of the modified data will be created automatically before any changes are applied. </p></td>
+ <td><p>Filter the project.
+Check filter for SearchProjectsRequest for details.
+Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). </p></td>
</tr>
<tr>
- <td>enable_ghost</td>
- <td><a href="#bool">bool</a></td>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to use gh-ost for online schema migration. </p></td>
+ <td><p>The order by of projects.
+Support title. The default sorting order is ascending.
+For example:
+- order_by = &#34;title&#34;
+- order_by = &#34;title desc&#34;
+- order_by = &#34;title asc&#34; </p></td>
</tr>
</tbody>
@@ -21356,7 +20506,7 @@ Format: projects/{project}/releases/{release} </p></td>
- <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</h3>
+ <h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3>
<p></p>
@@ -21367,17 +20517,18 @@ Format: projects/{project}/releases/{release} </p></td>
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>repeated</td>
+ <td><p>The projects from the specified request. </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -21387,7 +20538,7 @@ Format: projects/{project}/releases/{release} </p></td>
- <h3 id="bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</h3>
+ <h3 id="bytebase.v1.Project">Project</h3>
<p></p>
@@ -21398,62 +20549,141 @@ Format: projects/{project}/releases/{release} </p></td>
<tbody>
<tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the instance on which the database is created.
-Format: instances/{instance} </p></td>
- </tr>
-
- <tr>
- <td>database</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to create. </p></td>
+ <td><p>The name of the project.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>table</td>
- <td><a href="#string">string</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>table is the name of the table, if it is not empty, Bytebase should create a table after creating the database.
-For example, in MongoDB, it only creates the database when we first store data in that database. </p></td>
+ <td><p>The lifecycle state of the project. </p></td>
</tr>
<tr>
- <td>character_set</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>character_set is the character set of the database. </p></td>
+ <td><p>The title or name of a project. It&#39;s not unique within the workspace. </p></td>
</tr>
<tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>collation is the collation of the database. </p></td>
+ <td>webhooks</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>repeated</td>
+ <td><p>The list of webhooks configured for the project. </p></td>
</tr>
<tr>
- <td>cluster</td>
+ <td>data_classification_config_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. </p></td>
+ <td><p>The data classification configuration ID for the project. </p></td>
</tr>
<tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
+ <td>issue_labels</td>
+ <td><a href="#bytebase.v1.Label">Label</a></td>
+ <td>repeated</td>
+ <td><p>Labels available for tagging issues in this project. </p></td>
+ </tr>
+
+ <tr>
+ <td>force_issue_labels</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. </p></td>
+ <td><p>Force issue labels to be used when creating an issue. </p></td>
</tr>
<tr>
- <td>environment</td>
- <td><a href="#string">string</a></td>
+ <td>enforce_issue_title</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
+ <td><p>Enforce issue title to be created by user instead of generated by Bytebase. </p></td>
+ </tr>
+
+ <tr>
+ <td>auto_enable_backup</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to automatically enable backup for database changes. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_backup_errors</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip backup errors and continue with data migration. </p></td>
+ </tr>
+
+ <tr>
+ <td>postgres_database_tenant_mode</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enable database tenant mode for PostgreSQL.
+If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_self_approval</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to allow issue creators to self-approve their own issues. </p></td>
+ </tr>
+
+ <tr>
+ <td>execution_retry_policy</td>
+ <td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td>
+ <td></td>
+ <td><p>Execution retry policy for task runs. </p></td>
+ </tr>
+
+ <tr>
+ <td>ci_sampling_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of database rows to sample during CI data validation.
+Without specification, sampling is disabled, resulting in full validation. </p></td>
+ </tr>
+
+ <tr>
+ <td>parallel_tasks_per_rollout</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels are key-value pairs that can be attached to the project.
+For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } </p></td>
+ </tr>
+
+ <tr>
+ <td>enforce_sql_review</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enforce SQL review checks to pass before issue creation.
+If enabled, issues cannot be created when SQL review finds errors. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_issue_approval</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to require issue approval before rollout. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_plan_check_no_error</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to require plan check to have no error before rollout. </p></td>
</tr>
</tbody>
@@ -21463,8 +20693,8 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
- <h3 id="bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</h3>
- <p></p>
+ <h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>
+ <p>Execution retry policy configuration.</p>
<table class="field-table">
@@ -21474,35 +20704,10 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
<tbody>
<tr>
- <td>targets</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of targets.
-Multi-database format: [instances/{instance-id}/databases/{database-name}].
-Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td>
- </tr>
-
- <tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
-
- <tr>
- <td>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td>maximum_retries</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The format of the exported file. </p></td>
- </tr>
-
- <tr>
- <td>password</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The zip password provide by users.
-Leave it empty if no needs to encrypt the zip file. </p></td>
+ <td><p>The maximum number of retries for lock timeout errors. </p></td>
</tr>
</tbody>
@@ -21512,7 +20717,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
- <h3 id="bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</h3>
+ <h3 id="bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</h3>
<p></p>
@@ -21531,7 +20736,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
<tr>
<td>value</td>
- <td><a href="#int32">int32</a></td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -21543,7 +20748,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
- <h3 id="bytebase.v1.Plan.Spec">Plan.Spec</h3>
+ <h3 id="bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</h3>
<p></p>
@@ -21554,31 +20759,10 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A UUID4 string that uniquely identifies the Spec. </p></td>
- </tr>
-
- <tr>
- <td>create_database_config</td>
- <td><a href="#bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>change_database_config</td>
- <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>export_data_config</td>
- <td><a href="#bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</a></td>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The webhook to remove. Identified by its url. </p></td>
</tr>
</tbody>
@@ -21588,7 +20772,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
- <h3 id="bytebase.v1.PlanCheckRun">PlanCheckRun</h3>
+ <h3 id="bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</h3>
<p></p>
@@ -21599,38 +20783,73 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
+ <td><p>Show deleted projects if specified. </p></td>
</tr>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Filter the project.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator.
+- state: check the State enum for the values, support &#34;==&#34; operator.
+- labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example:
+name == &#34;project name&#34;
+name.matches(&#34;project name&#34;)
+resource_id == &#34;project id&#34;
+resource_id.matches(&#34;project id&#34;)
+exclude_default == true
+state == &#34;DELETED&#34;
+labels.environment == &#34;production&#34;
+labels.tier == &#34;critical&#34;
+labels.environment in [&#34;staging&#34;, &#34;prod&#34;]
+You can combine filter conditions like:
+name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;)
+name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34;
+labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; </p></td>
</tr>
<tr>
- <td>results</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of projects to return. The service may return fewer than
+this value.
+If unspecified, at most 10 projects will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>error</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>error is set if the Status is FAILED. </p></td>
+ <td><p>A page token, received from a previous `SearchProjects` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchProjects` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The order by of projects.
+Support title. The default sorting order is ascending.
+For example:
+- order_by = &#34;title&#34;
+- order_by = &#34;title desc&#34;
+- order_by = &#34;title asc&#34; </p></td>
</tr>
</tbody>
@@ -21640,7 +20859,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
- <h3 id="bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</h3>
+ <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>
<p></p>
@@ -21651,60 +20870,74 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
<tbody>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>repeated</td>
+ <td><p>The projects from the specified request. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
- <tr>
- <td>content</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>code</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>target</td>
+ <td>project</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Target identification for consolidated results.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The name of the project which owns the webhook to test.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</a></td>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The webhook to test. Identified by its url. </p></td>
</tr>
- <tr>
- <td>sql_summary_report</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>sql_review_report</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</a></td>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The result of the test, empty if the test is successful. </p></td>
</tr>
</tbody>
@@ -21714,7 +20947,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3>
+ <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>
<p></p>
@@ -21725,17 +20958,11 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
- <td></td>
- <td><p>Position of the SQL statement. </p></td>
- </tr>
-
- <tr>
- <td>end_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the deleted project.
+Format: projects/{project} </p></td>
</tr>
</tbody>
@@ -21745,7 +20972,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3>
+ <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>
<p></p>
@@ -21756,17 +20983,28 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>statement_types</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>statement_types are the types of statements that are found in the sql. </p></td>
+ <td>project</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td></td>
+ <td><p>The project to update.
+
+The project&#39;s `name` field is used to identify the project to update.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the project is not found, a new project will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -21776,7 +21014,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</h3>
+ <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3>
<p></p>
@@ -21787,20 +21025,25 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
<td></td>
- <td><p>The plan to run plan checks.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td><p>The webhook to modify. </p></td>
</tr>
<tr>
- <td>spec_id</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The UUID of the specific spec to run plan checks for.
-This should match the spec.id field in Plan.Spec.
-If not set, all specs in the plan will be used. </p></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the webhook is not found, a new webhook will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -21810,14 +21053,7 @@ If not set, all specs in the plan will be used. </p></td>
- <h3 id="bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</h3>
+ <h3 id="bytebase.v1.Webhook">Webhook</h3>
<p></p>
@@ -21828,28 +21064,56 @@ If not set, all specs in the plan will be used. </p></td>
<tbody>
<tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The plan to update.
-
-The plan&#39;s `name` field is used to identify the plan to update.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td><p>name is the name of the webhook, generated by the server.
+format: projects/{project}/webhooks/{webhook} </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>Webhook integration type.
+type is the type of the webhook. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>title is the title of the webhook. </p></td>
+ </tr>
+
+ <tr>
+ <td>url</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>url is the url of the webhook, should be unique within the project. </p></td>
+ </tr>
+
+ <tr>
+ <td>direct_message</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the plan is not found, a new plan will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>if direct_message is set, the notification is sent directly
+to the persons and url will be ignored.
+IM integration setting should be set for this function to work. </p></td>
+ </tr>
+
+ <tr>
+ <td>notification_types</td>
+ <td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>
+ <td>repeated</td>
+ <td><p>notification_types is the list of activities types that the webhook is interested in.
+Bytebase will only send notifications to the webhook if the activity type is in the list.
+It should not be empty, and should be a subset of the following:
+- ISSUE_CREATED
+- ISSUE_APPROVAL_REQUESTED
+- ISSUE_SENT_BACK
+- PIPELINE_FAILED
+- PIPELINE_COMPLETED </p></td>
</tr>
</tbody>
@@ -21861,8 +21125,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</h3>
- <p></p>
+ <h3 id="bytebase.v1.Activity.Type">Activity.Type</h3>
+ <p>Activity type enumeration.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -21872,138 +21136,173 @@ In this situation, `update_mask` is ignored. </p></td>
<tr>
<td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified type.</p></td>
</tr>
<tr>
- <td>STATEMENT_ADVISE</td>
- <td>1</td>
- <td><p></p></td>
+ <td>ISSUE_CREATED</td>
+ <td>10</td>
+ <td><p>ISSUE_CREATED represents a new issue creation event.</p></td>
</tr>
<tr>
- <td>STATEMENT_SUMMARY_REPORT</td>
- <td>2</td>
- <td><p></p></td>
+ <td>ISSUE_APPROVAL_REQUESTED</td>
+ <td>11</td>
+ <td><p>ISSUE_APPROVAL_REQUESTED represents an approval request event.</p></td>
</tr>
<tr>
- <td>GHOST_SYNC</td>
- <td>3</td>
- <td><p></p></td>
+ <td>ISSUE_SENT_BACK</td>
+ <td>12</td>
+ <td><p>ISSUE_SENT_BACK represents an issue being sent back by an approver.</p></td>
+ </tr>
+
+ <tr>
+ <td>PIPELINE_FAILED</td>
+ <td>13</td>
+ <td><p>PIPELINE_FAILED represents a pipeline failure event.</p></td>
+ </tr>
+
+ <tr>
+ <td>PIPELINE_COMPLETED</td>
+ <td>14</td>
+ <td><p>PIPELINE_COMPLETED represents a pipeline completion event.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</h3>
- <p></p>
+
+
+
+
+ <h3 id="bytebase.v1.ProjectService">ProjectService</h3>
+ <p>ProjectService manages projects that group databases and changes.</p>
<table class="enum-table">
<thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>RUNNING</td>
- <td>1</td>
- <td><p></p></td>
+ <td>GetProject</td>
+ <td><a href="#bytebase.v1.GetProjectRequest">GetProjectRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>GetProject retrieves a project by name.
+Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method.
+Permissions required: bb.projects.get</p></td>
</tr>
<tr>
- <td>DONE</td>
- <td>2</td>
- <td><p></p></td>
+ <td>BatchGetProjects</td>
+ <td><a href="#bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</a></td>
+ <td><p>BatchGetProjects retrieves multiple projects by their names.
+Permissions required: bb.projects.get</p></td>
</tr>
<tr>
- <td>FAILED</td>
- <td>3</td>
- <td><p></p></td>
+ <td>ListProjects</td>
+ <td><a href="#bytebase.v1.ListProjectsRequest">ListProjectsRequest</a></td>
+ <td><a href="#bytebase.v1.ListProjectsResponse">ListProjectsResponse</a></td>
+ <td><p>Lists all projects in the workspace with optional filtering.
+Permissions required: bb.projects.list</p></td>
</tr>
<tr>
- <td>CANCELED</td>
- <td>4</td>
- <td><p></p></td>
+ <td>SearchProjects</td>
+ <td><a href="#bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</a></td>
+ <td><a href="#bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</a></td>
+ <td><p>Searches for projects with advanced filtering capabilities.
+Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)</p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PlanService">PlanService</h3>
- <p>PlanService manages deployment plans for database changes.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>CreateProject</td>
+ <td><a href="#bytebase.v1.CreateProjectRequest">CreateProjectRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Creates a new project in the workspace.
+Permissions required: bb.projects.create</p></td>
+ </tr>
<tr>
- <td>GetPlan</td>
- <td><a href="#bytebase.v1.GetPlanRequest">GetPlanRequest</a></td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
- <td><p>Retrieves a deployment plan by name.
-Permissions required: bb.plans.get</p></td>
+ <td>UpdateProject</td>
+ <td><a href="#bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Updates an existing project&#39;s properties.
+Permissions required: bb.projects.update</p></td>
</tr>
<tr>
- <td>ListPlans</td>
- <td><a href="#bytebase.v1.ListPlansRequest">ListPlansRequest</a></td>
- <td><a href="#bytebase.v1.ListPlansResponse">ListPlansResponse</a></td>
- <td><p>Lists deployment plans in a project.
-Permissions required: bb.plans.list</p></td>
+ <td>DeleteProject</td>
+ <td><a href="#bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes (soft-delete or purge) a project.
+Permissions required: bb.projects.delete</p></td>
</tr>
<tr>
- <td>CreatePlan</td>
- <td><a href="#bytebase.v1.CreatePlanRequest">CreatePlanRequest</a></td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
- <td><p>Creates a new deployment plan.
-Permissions required: bb.plans.create</p></td>
+ <td>UndeleteProject</td>
+ <td><a href="#bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Restores a soft-deleted project.
+Permissions required: bb.projects.undelete</p></td>
</tr>
<tr>
- <td>UpdatePlan</td>
- <td><a href="#bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</a></td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
- <td><p>UpdatePlan updates the plan.
-The plan creator and the user with bb.plans.update permission on the project can update the plan.
-Permissions required: bb.plans.update (or creator)</p></td>
+ <td>BatchDeleteProjects</td>
+ <td><a href="#bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes multiple projects in a single operation.
+Permissions required: bb.projects.delete</p></td>
</tr>
<tr>
- <td>GetPlanCheckRun</td>
- <td><a href="#bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</a></td>
- <td><a href="#bytebase.v1.PlanCheckRun">PlanCheckRun</a></td>
- <td><p>Gets the plan check run for a deployment plan.
-Permissions required: bb.planCheckRuns.get</p></td>
+ <td>GetIamPolicy</td>
+ <td><a href="#bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</a></td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
+ <td><p>Retrieves the IAM policy for a project.
+Permissions required: bb.projects.getIamPolicy</p></td>
</tr>
<tr>
- <td>RunPlanChecks</td>
- <td><a href="#bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</a></td>
- <td><a href="#bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</a></td>
- <td><p>Executes validation checks on a deployment plan.
-Permissions required: bb.planCheckRuns.run</p></td>
+ <td>SetIamPolicy</td>
+ <td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
+ <td><p>Sets the IAM policy for a project.
+Permissions required: bb.projects.setIamPolicy</p></td>
</tr>
<tr>
- <td>CancelPlanCheckRun</td>
- <td><a href="#bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</a></td>
- <td><a href="#bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</a></td>
- <td><p>Cancels the plan check run for a deployment plan.
-Permissions required: bb.planCheckRuns.run</p></td>
+ <td>AddWebhook</td>
+ <td><a href="#bytebase.v1.AddWebhookRequest">AddWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Adds a webhook to a project for notifications.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateWebhook</td>
+ <td><a href="#bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Updates an existing webhook configuration.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ <tr>
+ <td>RemoveWebhook</td>
+ <td><a href="#bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Removes a webhook from a project.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ <tr>
+ <td>TestWebhook</td>
+ <td><a href="#bytebase.v1.TestWebhookRequest">TestWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.TestWebhookResponse">TestWebhookResponse</a></td>
+ <td><p>Tests a webhook by sending a test notification.
+Permissions required: bb.projects.update</p></td>
</tr>
</tbody>
@@ -22027,9 +21326,9 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>GetPlan</td>
+ <td>GetProject</td>
<td>GET</td>
- <td>/v1/{name=projects/*/plans/*}</td>
+ <td>/v1/{name=projects/*}</td>
<td></td>
</tr>
@@ -22037,9 +21336,9 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>ListPlans</td>
+ <td>BatchGetProjects</td>
<td>GET</td>
- <td>/v1/{parent=projects/*}/plans</td>
+ <td>/v1/projects:batchGet</td>
<td></td>
</tr>
@@ -22047,29 +21346,79 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>CreatePlan</td>
+ <td>ListProjects</td>
+ <td>GET</td>
+ <td>/v1/projects</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>SearchProjects</td>
<td>POST</td>
- <td>/v1/{parent=projects/*}/plans</td>
- <td>plan</td>
+ <td>/v1/projects:search</td>
+ <td>*</td>
</tr>
<tr>
- <td>UpdatePlan</td>
+ <td>CreateProject</td>
+ <td>POST</td>
+ <td>/v1/projects</td>
+ <td>project</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateProject</td>
<td>PATCH</td>
- <td>/v1/{plan.name=projects/*/plans/*}</td>
- <td>plan</td>
+ <td>/v1/{project.name=projects/*}</td>
+ <td>project</td>
</tr>
<tr>
- <td>GetPlanCheckRun</td>
+ <td>DeleteProject</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UndeleteProject</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*}:undelete</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchDeleteProjects</td>
+ <td>POST</td>
+ <td>/v1/projects:batchDelete</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetIamPolicy</td>
<td>GET</td>
- <td>/v1/{name=projects/*/plans/*/planCheckRun}</td>
+ <td>/v1/{resource=projects/*}:getIamPolicy</td>
<td></td>
</tr>
@@ -22077,9 +21426,9 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>RunPlanChecks</td>
+ <td>SetIamPolicy</td>
<td>POST</td>
- <td>/v1/{name=projects/*/plans/*}:runPlanChecks</td>
+ <td>/v1/{resource=projects/*}:setIamPolicy</td>
<td>*</td>
</tr>
@@ -22087,9 +21436,39 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>CancelPlanCheckRun</td>
+ <td>AddWebhook</td>
<td>POST</td>
- <td>/v1/{name=projects/*/plans/*/planCheckRun}:cancel</td>
+ <td>/v1/{project=projects/*}:addWebhook</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateWebhook</td>
+ <td>PATCH</td>
+ <td>/v1/{webhook.name=projects/*/webhooks/*}:updateWebhook</td>
+ <td>webhook</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>RemoveWebhook</td>
+ <td>POST</td>
+ <td>/v1/{webhook.name=projects/*/webhooks/*}:removeWebhook</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>TestWebhook</td>
+ <td>POST</td>
+ <td>/v1/{project=projects/*}:testWebhook</td>
<td>*</td>
</tr>
@@ -22101,19 +21480,12 @@ Permissions required: bb.planCheckRuns.run</p></td>
<div class="file-heading">
- <h2 id="v1/project_service.proto">v1/project_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/release_service.proto">v1/release_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.Activity">Activity</h3>
- <p>Activity types for webhook notifications.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.AddWebhookRequest">AddWebhookRequest</h3>
+ <h3 id="bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</h3>
<p></p>
@@ -22124,53 +21496,38 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tbody>
<tr>
- <td>project</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to add the webhook to.
-Format: projects/{project} </p></td>
+ <td><p>Format: projects/{project} </p></td>
</tr>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>release</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td></td>
- <td><p>The webhook to add. </p></td>
+ <td><p>The release to check. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>names</td>
+ <td>targets</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The names of the projects to delete.
-Format: projects/{project} </p></td>
+ <td><p>The targets to dry-run the release.
+Can be database or databaseGroup.
+Format:
+projects/{project}/databaseGroups/{databaseGroup}
+instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>force</td>
- <td><a href="#bool">bool</a></td>
+ <td>custom_rules</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, any databases from this project will be moved to default project.
-Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
-Open issues will remain open but associated with the deleted project.
-If set to false, the operation will fail if the project has databases or open issues. </p></td>
+ <td><p>Custom linting rules in natural language for AI-powered validation.
+Each rule should be a clear statement describing the desired schema constraint.
+Example: &#34;All tables must have a primary key&#34;
+Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
</tr>
</tbody>
@@ -22180,7 +21537,7 @@ If set to false, the operation will fail if the project has databases or open is
- <h3 id="bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</h3>
+ <h3 id="bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</h3>
<p></p>
@@ -22191,35 +21548,24 @@ If set to false, the operation will fail if the project has databases or open is
<tbody>
<tr>
- <td>names</td>
- <td><a href="#string">string</a></td>
+ <td>results</td>
+ <td><a href="#bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</a></td>
<td>repeated</td>
- <td><p>The names of projects to retrieve.
-Format: projects/{project} </p></td>
+ <td><p>The check results for each file and target combination. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The total affected rows across all checks. </p></td>
+ </tr>
<tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td></td>
+ <td><p>The aggregated risk level of the check. </p></td>
</tr>
</tbody>
@@ -22229,8 +21575,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</h3>
+ <p>Check result for a single release file on a target database.</p>
<table class="field-table">
@@ -22240,21 +21586,39 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>project</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>file</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The project to create. </p></td>
+ <td><p>The file path that is being checked. </p></td>
</tr>
<tr>
- <td>project_id</td>
+ <td>target</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The ID to use for the project, which will become the final component of
-the project&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td><p>The target that the check is performed on.
+Should be a database. Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>advices</td>
+ <td><a href="#bytebase.v1.Advice">Advice</a></td>
+ <td>repeated</td>
+ <td><p>The list of advice for the file and the target. </p></td>
+ </tr>
+
+ <tr>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The count of affected rows of the statement on the target. </p></td>
+ </tr>
+
+ <tr>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td></td>
+ <td><p>The risk level of the statement on the target. </p></td>
</tr>
</tbody>
@@ -22264,7 +21628,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3>
+ <h3 id="bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</h3>
<p></p>
@@ -22275,31 +21639,17 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to delete.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>force</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, any databases from this project will be moved to default project.
-Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
-Open issues will remain open but associated with the deleted project.
-If set to false, the operation will fail if the project has databases or open issues. </p></td>
+ <td><p>Format: projects/{project} </p></td>
</tr>
<tr>
- <td>purge</td>
- <td><a href="#bool">bool</a></td>
+ <td>release</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td></td>
- <td><p>If set to true, permanently purge the soft-deleted project and all related resources.
-This operation is irreversible. Following AIP-165, this should only be used for
-administrative cleanup of old soft-deleted projects.
-The project must already be soft-deleted for this to work. </p></td>
+ <td><p>The release to create. </p></td>
</tr>
</tbody>
@@ -22309,7 +21659,7 @@ The project must already be soft-deleted for this to work. </p></td>
- <h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</h3>
+ <h3 id="bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</h3>
<p></p>
@@ -22323,8 +21673,8 @@ The project must already be soft-deleted for this to work. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to retrieve.
-Format: projects/{project} </p></td>
+ <td><p>The name of the release to delete.
+Format: projects/{project}/releases/{release} </p></td>
</tr>
</tbody>
@@ -22334,8 +21684,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.Label">Label</h3>
- <p>A label for categorizing and organizing issues.</p>
+ <h3 id="bytebase.v1.GetReleaseRequest">GetReleaseRequest</h3>
+ <p></p>
<table class="field-table">
@@ -22345,24 +21695,10 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The label value/name. </p></td>
- </tr>
-
- <tr>
- <td>color</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The color code for the label (e.g., hex color). </p></td>
- </tr>
-
- <tr>
- <td>group</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The group this label belongs to. </p></td>
+ <td><p>Format: projects/{project}/releases/{release} </p></td>
</tr>
</tbody>
@@ -22372,7 +21708,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</h3>
+ <h3 id="bytebase.v1.ListReleasesRequest">ListReleasesRequest</h3>
<p></p>
@@ -22382,13 +21718,19 @@ Format: projects/{project} </p></td>
</thead>
<tbody>
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project} </p></td>
+ </tr>
+
<tr>
<td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of projects to return. The service may return fewer than
-this value.
-If unspecified, at most 10 projects will be returned.
+ <td><p>The maximum number of releases to return. The service may return fewer than this value.
+If unspecified, at most 10 releases will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
@@ -22396,10 +21738,10 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
<td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListProjects` call.
+ <td><p>A page token, received from a previous `ListReleases` call.
Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided to `ListProjects` must match
+When paginating, all other parameters provided to `ListReleases` must match
the call that provided the page token. </p></td>
</tr>
@@ -22407,28 +21749,7 @@ the call that provided the page token. </p></td>
<td>show_deleted</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Show deleted projects if specified. </p></td>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter the project.
-Check filter for SearchProjectsRequest for details.
-Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). </p></td>
- </tr>
-
- <tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The order by of projects.
-Support title. The default sorting order is ascending.
-For example:
-- order_by = &#34;title&#34;
-- order_by = &#34;title desc&#34;
-- order_by = &#34;title asc&#34; </p></td>
+ <td><p>Show deleted releases if specified. </p></td>
</tr>
</tbody>
@@ -22438,7 +21759,7 @@ For example:
- <h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3>
+ <h3 id="bytebase.v1.ListReleasesResponse">ListReleasesResponse</h3>
<p></p>
@@ -22449,10 +21770,10 @@ For example:
<tbody>
<tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>releases</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
+ <td><p>The releases from the specified request. </p></td>
</tr>
<tr>
@@ -22470,7 +21791,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Project">Project</h3>
+ <h3 id="bytebase.v1.Release">Release</h3>
<p></p>
@@ -22484,162 +21805,129 @@ If this field is omitted, there are no subsequent pages. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The lifecycle state of the project. </p></td>
+ <td><p>Format: projects/{project}/releases/{release} </p></td>
</tr>
<tr>
<td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title or name of a project. It&#39;s not unique within the workspace. </p></td>
+ <td><p>The title of the release. </p></td>
</tr>
<tr>
- <td>webhooks</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>files</td>
+ <td><a href="#bytebase.v1.Release.File">Release.File</a></td>
<td>repeated</td>
- <td><p>The list of webhooks configured for the project. </p></td>
- </tr>
-
- <tr>
- <td>data_classification_config_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The data classification configuration ID for the project. </p></td>
- </tr>
-
- <tr>
- <td>issue_labels</td>
- <td><a href="#bytebase.v1.Label">Label</a></td>
- <td>repeated</td>
- <td><p>Labels available for tagging issues in this project. </p></td>
+ <td><p>The SQL files included in the release. </p></td>
</tr>
<tr>
- <td>force_issue_labels</td>
- <td><a href="#bool">bool</a></td>
+ <td>vcs_source</td>
+ <td><a href="#bytebase.v1.Release.VCSSource">Release.VCSSource</a></td>
<td></td>
- <td><p>Force issue labels to be used when creating an issue. </p></td>
+ <td><p>The version control source of the release. </p></td>
</tr>
<tr>
- <td>enforce_issue_title</td>
- <td><a href="#bool">bool</a></td>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Enforce issue title to be created by user instead of generated by Bytebase. </p></td>
+ <td><p>Format: users/[email protected] </p></td>
</tr>
<tr>
- <td>auto_enable_backup</td>
- <td><a href="#bool">bool</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>Whether to automatically enable backup for database changes. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>skip_backup_errors</td>
- <td><a href="#bool">bool</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>Whether to skip backup errors and continue with data migration. </p></td>
+ <td><p>The lifecycle state of the release. </p></td>
</tr>
<tr>
- <td>postgres_database_tenant_mode</td>
- <td><a href="#bool">bool</a></td>
+ <td>digest</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to enable database tenant mode for PostgreSQL.
-If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. </p></td>
+ <td><p>The digest of the release.
+The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease.
+Whether to provide digest and how to generate it is up to the user.
+If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned. </p></td>
</tr>
<tr>
- <td>allow_self_approval</td>
- <td><a href="#bool">bool</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Release.Type">Release.Type</a></td>
<td></td>
- <td><p>Whether to allow issue creators to self-approve their own issues. </p></td>
+ <td><p>The type of schema change for all files in this release. </p></td>
</tr>
- <tr>
- <td>execution_retry_policy</td>
- <td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td>
- <td></td>
- <td><p>Execution retry policy for task runs. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Release.File">Release.File</h3>
+ <p>A SQL file in a release.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>ci_sampling_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>path</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of database rows to sample during CI data validation.
-Without specification, sampling is disabled, resulting in full validation. </p></td>
+ <td><p>The path of the file. e.g., `2.2/V0001_create_table.sql`. </p></td>
</tr>
<tr>
- <td>parallel_tasks_per_rollout</td>
- <td><a href="#int32">int32</a></td>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td>
- </tr>
-
- <tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>Labels are key-value pairs that can be attached to the project.
-For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } </p></td>
+ <td><p>The version identifier for the file. </p></td>
</tr>
<tr>
- <td>enforce_sql_review</td>
+ <td>enable_ghost</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether to enforce SQL review checks to pass before issue creation.
-If enabled, issues cannot be created when SQL review finds errors. </p></td>
+ <td><p>Whether to use gh-ost for online schema migration. </p></td>
</tr>
<tr>
- <td>require_issue_approval</td>
- <td><a href="#bool">bool</a></td>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to require issue approval before rollout. </p></td>
+ <td><p>For inputs, we must either use `sheet` or `statement`.
+For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
+
+The sheet that holds the content.
+Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>require_plan_check_no_error</td>
- <td><a href="#bool">bool</a></td>
+ <td>statement</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>Whether to require plan check to have no error before rollout. </p></td>
+ <td><p>The raw SQL statement content. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>
- <p>Execution retry policy configuration.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>maximum_retries</td>
- <td><a href="#int32">int32</a></td>
+ <td>sheet_sha256</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of retries for lock timeout errors. </p></td>
+ <td><p>The SHA256 hash value of the sheet content or the statement. </p></td>
</tr>
</tbody>
@@ -22649,8 +21937,8 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
- <h3 id="bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.Release.VCSSource">Release.VCSSource</h3>
+ <p>Version control system source information.</p>
<table class="field-table">
@@ -22660,17 +21948,17 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
+ <td>vcs_type</td>
+ <td><a href="#bytebase.v1.VCSType">VCSType</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The type of VCS. </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The url link to the e.g., GitHub commit or pull request. </p></td>
</tr>
</tbody>
@@ -22680,7 +21968,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
- <h3 id="bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</h3>
+ <h3 id="bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</h3>
<p></p>
@@ -22691,10 +21979,11 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
<tbody>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The webhook to remove. Identified by its url. </p></td>
+ <td><p>The name of the deleted release.
+Format: projects/{project}/releases/{release} </p></td>
</tr>
</tbody>
@@ -22704,7 +21993,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
- <h3 id="bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</h3>
+ <h3 id="bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</h3>
<p></p>
@@ -22715,73 +22004,25 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
<tbody>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted projects if specified. </p></td>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter the project.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator.
-- state: check the State enum for the values, support &#34;==&#34; operator.
-- labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example:
-name == &#34;project name&#34;
-name.matches(&#34;project name&#34;)
-resource_id == &#34;project id&#34;
-resource_id.matches(&#34;project id&#34;)
-exclude_default == true
-state == &#34;DELETED&#34;
-labels.environment == &#34;production&#34;
-labels.tier == &#34;critical&#34;
-labels.environment in [&#34;staging&#34;, &#34;prod&#34;]
-You can combine filter conditions like:
-name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;)
-name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34;
-labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>release</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td></td>
- <td><p>The maximum number of projects to return. The service may return fewer than
-this value.
-If unspecified, at most 10 projects will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The release to update. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchProjects` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchProjects` must match
-the call that provided the page token. </p></td>
+ <td><p>The list of fields to be updated. </p></td>
</tr>
<tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The order by of projects.
-Support title. The default sorting order is ascending.
-For example:
-- order_by = &#34;title&#34;
-- order_by = &#34;title desc&#34;
-- order_by = &#34;title asc&#34; </p></td>
+ <td><p>If set to true, and the release is not found, a new release will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -22791,71 +22032,207 @@ For example:
- <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>
- <p></p>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
- </tr>
-
- </tbody>
- </table>
+
+ <h3 id="bytebase.v1.Release.Type">Release.Type</h3>
+ <p>The type of schema change.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>VERSIONED</td>
+ <td>1</td>
+ <td><p>Versioned schema migration.</p></td>
+ </tr>
+
+ <tr>
+ <td>DECLARATIVE</td>
+ <td>2</td>
+ <td><p>Declarative schema definition.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
+
-
- <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ReleaseService">ReleaseService</h3>
+ <p>ReleaseService manages releases for coordinating deployments.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetRelease</td>
+ <td><a href="#bytebase.v1.GetReleaseRequest">GetReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Retrieves a release by name.
+Permissions required: bb.releases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListReleases</td>
+ <td><a href="#bytebase.v1.ListReleasesRequest">ListReleasesRequest</a></td>
+ <td><a href="#bytebase.v1.ListReleasesResponse">ListReleasesResponse</a></td>
+ <td><p>Lists releases in a project.
+Permissions required: bb.releases.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateRelease</td>
+ <td><a href="#bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Creates a new release with SQL files.
+Permissions required: bb.releases.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateRelease</td>
+ <td><a href="#bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Updates an existing release.
+Permissions required: bb.releases.update
+When allow_missing=true, also requires: bb.releases.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteRelease</td>
+ <td><a href="#bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a release.
+Permissions required: bb.releases.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>UndeleteRelease</td>
+ <td><a href="#bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Restores a deleted release.
+Permissions required: bb.releases.undelete</p></td>
+ </tr>
+
+ <tr>
+ <td>CheckRelease</td>
+ <td><a href="#bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</a></td>
+ <td><p>Validates a release by dry-running checks on target databases.
+Permissions required: bb.releases.check</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>project</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the project which owns the webhook to test.
-Format: projects/{project} </p></td>
- </tr>
- <tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
- <td></td>
- <td><p>The webhook to test. Identified by its url. </p></td>
- </tr>
+ <tr>
+ <td>GetRelease</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/releases/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListReleases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/releases</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateRelease</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/releases</td>
+ <td>release</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateRelease</td>
+ <td>PATCH</td>
+ <td>/v1/{release.name=projects/*/releases/*}</td>
+ <td>release</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteRelease</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/releases/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UndeleteRelease</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/releases/*}:undelete</td>
+ <td></td>
+ </tr>
+
+
+
+ <tr>
+ <td>CheckRelease</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/releases:check</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>
+ <div class="file-heading">
+ <h2 id="v1/review_config_service.proto">v1/review_config_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</h3>
<p></p>
@@ -22866,10 +22243,10 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
+ <td>review_config</td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
<td></td>
- <td><p>The result of the test, empty if the test is successful. </p></td>
+ <td><p>The SQL review config to create. </p></td>
</tr>
</tbody>
@@ -22879,7 +22256,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>
+ <h3 id="bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</h3>
<p></p>
@@ -22893,8 +22270,8 @@ Format: projects/{project} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the deleted project.
-Format: projects/{project} </p></td>
+ <td><p>The name of the SQL review config to delete.
+Format: reviewConfigs/{reviewConfig} </p></td>
</tr>
</tbody>
@@ -22904,7 +22281,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>
+ <h3 id="bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</h3>
<p></p>
@@ -22915,28 +22292,11 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>project</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td></td>
- <td><p>The project to update.
-
-The project&#39;s `name` field is used to identify the project to update.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to update. </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the project is not found, a new project will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The name of the SQL review config to retrieve.
+Format: reviewConfigs/{reviewConfig} </p></td>
</tr>
</tbody>
@@ -22946,36 +22306,82 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3>
+ <h3 id="bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</h3>
<p></p>
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+
+
+
+ <h3 id="bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>review_configs</td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td>repeated</td>
+ <td><p>The SQL review configs from the specified request. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ReviewConfig">ReviewConfig</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The webhook to modify. </p></td>
+ <td><p>The name of the SQL review config.
+Format: reviewConfigs/{reviewConfig} </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The title of the review configuration. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>enabled</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the webhook is not found, a new webhook will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Whether the review configuration is enabled. </p></td>
+ </tr>
+
+ <tr>
+ <td>rules</td>
+ <td><a href="#bytebase.v1.SQLReviewRule">SQLReviewRule</a></td>
+ <td>repeated</td>
+ <td><p>The SQL review rules to enforce. </p></td>
+ </tr>
+
+ <tr>
+ <td>resources</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Resources using the config.
+Format: {resource}/{resource id}, e.g., environments/test. </p></td>
</tr>
</tbody>
@@ -22985,8 +22391,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.Webhook">Webhook</h3>
- <p></p>
+ <h3 id="bytebase.v1.SQLReviewRule">SQLReviewRule</h3>
+ <p>SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p>
<table class="field-table">
@@ -22996,56 +22402,66 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</a></td>
<td></td>
- <td><p>name is the name of the webhook, generated by the server.
-format: projects/{project}/webhooks/{webhook} </p></td>
+ <td><p>The type of SQL review rule. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>
+ <td>level</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</a></td>
<td></td>
- <td><p>Webhook integration type.
-type is the type of the webhook. </p></td>
+ <td><p>The severity level of the rule. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>naming_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td>
<td></td>
- <td><p>title is the title of the webhook. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>url</td>
- <td><a href="#string">string</a></td>
+ <td>number_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td>
<td></td>
- <td><p>url is the url of the webhook, should be unique within the project. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>direct_message</td>
- <td><a href="#bool">bool</a></td>
+ <td>string_array_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td>
<td></td>
- <td><p>if direct_message is set, the notification is sent directly
-to the persons and url will be ignored.
-IM integration setting should be set for this function to work. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>notification_types</td>
- <td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>
- <td>repeated</td>
- <td><p>notification_types is the list of activities types that the webhook is interested in.
-Bytebase will only send notifications to the webhook if the activity type is in the list.
-It should not be empty, and should be a subset of the following:
-- ISSUE_CREATED
-- ISSUE_APPROVAL_REQUESTED
-- ISSUE_SENT_BACK
-- PIPELINE_FAILED
-- PIPELINE_COMPLETED </p></td>
+ <td>comment_convention_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>string_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>naming_case_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td></td>
+ <td><p>The database engine this rule applies to. </p></td>
</tr>
</tbody>
@@ -23055,2389 +22471,2804 @@ It should not be empty, and should be a subset of the following:
+ <h3 id="bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3>
+ <p></p>
-
- <h3 id="bytebase.v1.Activity.Type">Activity.Type</h3>
- <p>Activity type enumeration.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_CREATED</td>
- <td>10</td>
- <td><p>ISSUE_CREATED represents a new issue creation event.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_APPROVAL_REQUESTED</td>
- <td>11</td>
- <td><p>ISSUE_APPROVAL_REQUESTED represents an approval request event.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_SENT_BACK</td>
- <td>12</td>
- <td><p>ISSUE_SENT_BACK represents an issue being sent back by an approver.</p></td>
- </tr>
-
- <tr>
- <td>PIPELINE_FAILED</td>
- <td>13</td>
- <td><p>PIPELINE_FAILED represents a pipeline failure event.</p></td>
- </tr>
-
- <tr>
- <td>PIPELINE_COMPLETED</td>
- <td>14</td>
- <td><p>PIPELINE_COMPLETED represents a pipeline completion event.</p></td>
- </tr>
-
- </tbody>
- </table>
-
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>required</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>upper</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.ProjectService">ProjectService</h3>
- <p>ProjectService manages projects that group databases and changes.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetProject</td>
- <td><a href="#bytebase.v1.GetProjectRequest">GetProjectRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>GetProject retrieves a project by name.
-Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method.
-Permissions required: bb.projects.get</p></td>
- </tr>
-
+ <h3 id="bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3>
+ <p>Payload message types for SQL review rules</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>format</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>number</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>list</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>review_config</td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td></td>
+ <td><p>The SQL review config to update.
+
+The name field is used to identify the SQL review config to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the config is not found, a new config will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</h3>
+ <p>The severity level for SQL review rules.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>BatchGetProjects</td>
- <td><a href="#bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</a></td>
- <td><p>BatchGetProjects retrieves multiple projects by their names.
-Permissions required: bb.projects.get</p></td>
+ <td>LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified level.</p></td>
</tr>
<tr>
- <td>ListProjects</td>
- <td><a href="#bytebase.v1.ListProjectsRequest">ListProjectsRequest</a></td>
- <td><a href="#bytebase.v1.ListProjectsResponse">ListProjectsResponse</a></td>
- <td><p>Lists all projects in the workspace with optional filtering.
-Permissions required: bb.projects.list</p></td>
+ <td>ERROR</td>
+ <td>1</td>
+ <td><p>Rule violation is an error.</p></td>
</tr>
<tr>
- <td>SearchProjects</td>
- <td><a href="#bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</a></td>
- <td><a href="#bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</a></td>
- <td><p>Searches for projects with advanced filtering capabilities.
-Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)</p></td>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p>Rule violation is a warning.</p></td>
</tr>
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>CreateProject</td>
- <td><a href="#bytebase.v1.CreateProjectRequest">CreateProjectRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Creates a new project in the workspace.
-Permissions required: bb.projects.create</p></td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>UpdateProject</td>
- <td><a href="#bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Updates an existing project&#39;s properties.
-Permissions required: bb.projects.update</p></td>
+ <td>ENGINE_MYSQL_USE_INNODB</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DeleteProject</td>
- <td><a href="#bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes (soft-delete or purge) a project.
-Permissions required: bb.projects.delete</p></td>
+ <td>NAMING_FULLY_QUALIFIED</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>UndeleteProject</td>
- <td><a href="#bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Restores a soft-deleted project.
-Permissions required: bb.projects.undelete</p></td>
+ <td>NAMING_TABLE</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>BatchDeleteProjects</td>
- <td><a href="#bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes multiple projects in a single operation.
-Permissions required: bb.projects.delete</p></td>
+ <td>NAMING_COLUMN</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>GetIamPolicy</td>
- <td><a href="#bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</a></td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
- <td><p>Retrieves the IAM policy for a project.
-Permissions required: bb.projects.getIamPolicy</p></td>
+ <td>NAMING_INDEX_PK</td>
+ <td>5</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>SetIamPolicy</td>
- <td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
- <td><p>Sets the IAM policy for a project.
-Permissions required: bb.projects.setIamPolicy</p></td>
+ <td>NAMING_INDEX_UK</td>
+ <td>6</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>AddWebhook</td>
- <td><a href="#bytebase.v1.AddWebhookRequest">AddWebhookRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Adds a webhook to a project for notifications.
-Permissions required: bb.projects.update</p></td>
+ <td>NAMING_INDEX_FK</td>
+ <td>7</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>UpdateWebhook</td>
- <td><a href="#bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Updates an existing webhook configuration.
-Permissions required: bb.projects.update</p></td>
+ <td>NAMING_INDEX_IDX</td>
+ <td>8</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>RemoveWebhook</td>
- <td><a href="#bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Removes a webhook from a project.
-Permissions required: bb.projects.update</p></td>
+ <td>NAMING_COLUMN_AUTO_INCREMENT</td>
+ <td>9</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>TestWebhook</td>
- <td><a href="#bytebase.v1.TestWebhookRequest">TestWebhookRequest</a></td>
- <td><a href="#bytebase.v1.TestWebhookResponse">TestWebhookResponse</a></td>
- <td><p>Tests a webhook by sending a test notification.
-Permissions required: bb.projects.update</p></td>
+ <td>NAMING_TABLE_NO_KEYWORD</td>
+ <td>10</td>
+ <td><p></p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>NAMING_IDENTIFIER_NO_KEYWORD</td>
+ <td>11</td>
+ <td><p></p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>GetProject</td>
- <td>GET</td>
- <td>/v1/{name=projects/*}</td>
- <td></td>
+ <td>NAMING_IDENTIFIER_CASE</td>
+ <td>12</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>BatchGetProjects</td>
- <td>GET</td>
- <td>/v1/projects:batchGet</td>
- <td></td>
+ <td>STATEMENT_SELECT_NO_SELECT_ALL</td>
+ <td>13</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>ListProjects</td>
- <td>GET</td>
- <td>/v1/projects</td>
- <td></td>
+ <td>STATEMENT_WHERE_REQUIRE_SELECT</td>
+ <td>14</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>SearchProjects</td>
- <td>POST</td>
- <td>/v1/projects:search</td>
- <td>*</td>
+ <td>STATEMENT_WHERE_REQUIRE_UPDATE_DELETE</td>
+ <td>15</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>CreateProject</td>
- <td>POST</td>
- <td>/v1/projects</td>
- <td>project</td>
+ <td>STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE</td>
+ <td>16</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>UpdateProject</td>
- <td>PATCH</td>
- <td>/v1/{project.name=projects/*}</td>
- <td>project</td>
+ <td>STATEMENT_DISALLOW_ON_DEL_CASCADE</td>
+ <td>17</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>DeleteProject</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*}</td>
- <td></td>
+ <td>STATEMENT_DISALLOW_RM_TBL_CASCADE</td>
+ <td>18</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>UndeleteProject</td>
- <td>POST</td>
- <td>/v1/{name=projects/*}:undelete</td>
- <td>*</td>
+ <td>STATEMENT_DISALLOW_COMMIT</td>
+ <td>19</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>BatchDeleteProjects</td>
- <td>POST</td>
- <td>/v1/projects:batchDelete</td>
- <td>*</td>
+ <td>STATEMENT_DISALLOW_LIMIT</td>
+ <td>20</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>GetIamPolicy</td>
- <td>GET</td>
- <td>/v1/{resource=projects/*}:getIamPolicy</td>
- <td></td>
+ <td>STATEMENT_DISALLOW_ORDER_BY</td>
+ <td>21</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>SetIamPolicy</td>
- <td>POST</td>
- <td>/v1/{resource=projects/*}:setIamPolicy</td>
- <td>*</td>
+ <td>STATEMENT_MERGE_ALTER_TABLE</td>
+ <td>22</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>AddWebhook</td>
- <td>POST</td>
- <td>/v1/{project=projects/*}:addWebhook</td>
- <td>*</td>
+ <td>STATEMENT_INSERT_ROW_LIMIT</td>
+ <td>23</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>UpdateWebhook</td>
- <td>PATCH</td>
- <td>/v1/{webhook.name=projects/*/webhooks/*}:updateWebhook</td>
- <td>webhook</td>
+ <td>STATEMENT_INSERT_MUST_SPECIFY_COLUMN</td>
+ <td>24</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>RemoveWebhook</td>
- <td>POST</td>
- <td>/v1/{webhook.name=projects/*/webhooks/*}:removeWebhook</td>
- <td>*</td>
+ <td>STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND</td>
+ <td>25</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>TestWebhook</td>
- <td>POST</td>
- <td>/v1/{project=projects/*}:testWebhook</td>
- <td>*</td>
+ <td>STATEMENT_AFFECTED_ROW_LIMIT</td>
+ <td>26</td>
+ <td><p></p></td>
</tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/release_service.proto">v1/release_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td></td>
- <td><p>The release to check. </p></td>
- </tr>
-
- <tr>
- <td>targets</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The targets to dry-run the release.
-Can be database or databaseGroup.
-Format:
-projects/{project}/databaseGroups/{databaseGroup}
-instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>custom_rules</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Custom linting rules in natural language for AI-powered validation.
-Each rule should be a clear statement describing the desired schema constraint.
-Example: &#34;All tables must have a primary key&#34;
-Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>results</td>
- <td><a href="#bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</a></td>
- <td>repeated</td>
- <td><p>The check results for each file and target combination. </p></td>
- </tr>
-
- <tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The total affected rows across all checks. </p></td>
- </tr>
-
- <tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
- <td></td>
- <td><p>The aggregated risk level of the check. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</h3>
- <p>Check result for a single release file on a target database.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>file</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The file path that is being checked. </p></td>
- </tr>
-
- <tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The target that the check is performed on.
-Should be a database. Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>advices</td>
- <td><a href="#bytebase.v1.Advice">Advice</a></td>
- <td>repeated</td>
- <td><p>The list of advice for the file and the target. </p></td>
- </tr>
-
- <tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The count of affected rows of the statement on the target. </p></td>
- </tr>
-
- <tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
- <td></td>
- <td><p>The risk level of the statement on the target. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td></td>
- <td><p>The release to create. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the release to delete.
-Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetReleaseRequest">GetReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListReleasesRequest">ListReleasesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of releases to return. The service may return fewer than this value.
-If unspecified, at most 10 releases will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A page token, received from a previous `ListReleases` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListReleases` must match
-the call that provided the page token. </p></td>
- </tr>
-
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted releases if specified. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListReleasesResponse">ListReleasesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>releases</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td>repeated</td>
- <td><p>The releases from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Release">Release</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The title of the release. </p></td>
- </tr>
-
- <tr>
- <td>files</td>
- <td><a href="#bytebase.v1.Release.File">Release.File</a></td>
- <td>repeated</td>
- <td><p>The SQL files included in the release. </p></td>
- </tr>
-
- <tr>
- <td>vcs_source</td>
- <td><a href="#bytebase.v1.Release.VCSSource">Release.VCSSource</a></td>
- <td></td>
- <td><p>The version control source of the release. </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The lifecycle state of the release. </p></td>
- </tr>
-
- <tr>
- <td>digest</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The digest of the release.
-The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease.
-Whether to provide digest and how to generate it is up to the user.
-If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Release.Type">Release.Type</a></td>
- <td></td>
- <td><p>The type of schema change for all files in this release. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Release.File">Release.File</h3>
- <p>A SQL file in a release.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>path</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The path of the file. e.g., `2.2/V0001_create_table.sql`. </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version identifier for the file. </p></td>
- </tr>
-
- <tr>
- <td>enable_ghost</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to use gh-ost for online schema migration. </p></td>
- </tr>
-
- <tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>For inputs, we must either use `sheet` or `statement`.
-For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
-
-The sheet that holds the content.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The raw SQL statement content. </p></td>
- </tr>
-
- <tr>
- <td>sheet_sha256</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SHA256 hash value of the sheet content or the statement. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Release.VCSSource">Release.VCSSource</h3>
- <p>Version control system source information.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>vcs_type</td>
- <td><a href="#bytebase.v1.VCSType">VCSType</a></td>
- <td></td>
- <td><p>The type of VCS. </p></td>
- </tr>
-
- <tr>
- <td>url</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The url link to the e.g., GitHub commit or pull request. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the deleted release.
-Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>release</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td></td>
- <td><p>The release to update. </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to be updated. </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, and the release is not found, a new release will be created.
-In this situation, `update_mask` is ignored. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.Release.Type">Release.Type</h3>
- <p>The type of schema change.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>VERSIONED</td>
- <td>1</td>
- <td><p>Versioned schema migration.</p></td>
- </tr>
-
- <tr>
- <td>DECLARATIVE</td>
- <td>2</td>
- <td><p>Declarative schema definition.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ReleaseService">ReleaseService</h3>
- <p>ReleaseService manages releases for coordinating deployments.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetRelease</td>
- <td><a href="#bytebase.v1.GetReleaseRequest">GetReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Retrieves a release by name.
-Permissions required: bb.releases.get</p></td>
- </tr>
-
- <tr>
- <td>ListReleases</td>
- <td><a href="#bytebase.v1.ListReleasesRequest">ListReleasesRequest</a></td>
- <td><a href="#bytebase.v1.ListReleasesResponse">ListReleasesResponse</a></td>
- <td><p>Lists releases in a project.
-Permissions required: bb.releases.list</p></td>
- </tr>
-
- <tr>
- <td>CreateRelease</td>
- <td><a href="#bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Creates a new release with SQL files.
-Permissions required: bb.releases.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateRelease</td>
- <td><a href="#bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Updates an existing release.
-Permissions required: bb.releases.update
-When allow_missing=true, also requires: bb.releases.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteRelease</td>
- <td><a href="#bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a release.
-Permissions required: bb.releases.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteRelease</td>
- <td><a href="#bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Restores a deleted release.
-Permissions required: bb.releases.undelete</p></td>
- </tr>
-
- <tr>
- <td>CheckRelease</td>
- <td><a href="#bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</a></td>
- <td><a href="#bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</a></td>
- <td><p>Validates a release by dry-running checks on target databases.
-Permissions required: bb.releases.check</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>GetRelease</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/releases/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListReleases</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/releases</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateRelease</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/releases</td>
- <td>release</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateRelease</td>
- <td>PATCH</td>
- <td>/v1/{release.name=projects/*/releases/*}</td>
- <td>release</td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteRelease</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/releases/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UndeleteRelease</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/releases/*}:undelete</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CheckRelease</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/releases:check</td>
- <td>*</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/review_config_service.proto">v1/review_config_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>review_config</td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td></td>
- <td><p>The SQL review config to create. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the SQL review config to delete.
-Format: reviewConfigs/{reviewConfig} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the SQL review config to retrieve.
-Format: reviewConfigs/{reviewConfig} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>review_configs</td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td>repeated</td>
- <td><p>The SQL review configs from the specified request. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ReviewConfig">ReviewConfig</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the SQL review config.
-Format: reviewConfigs/{reviewConfig} </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The title of the review configuration. </p></td>
- </tr>
-
- <tr>
- <td>enabled</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the review configuration is enabled. </p></td>
- </tr>
-
- <tr>
- <td>rules</td>
- <td><a href="#bytebase.v1.SQLReviewRule">SQLReviewRule</a></td>
- <td>repeated</td>
- <td><p>The SQL review rules to enforce. </p></td>
- </tr>
-
- <tr>
- <td>resources</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Resources using the config.
-Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule">SQLReviewRule</h3>
- <p>SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</a></td>
- <td></td>
- <td><p>The type of SQL review rule. </p></td>
- </tr>
-
- <tr>
- <td>level</td>
- <td><a href="#bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</a></td>
- <td></td>
- <td><p>The severity level of the rule. </p></td>
- </tr>
-
- <tr>
- <td>naming_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>number_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>string_array_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>comment_convention_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>string_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>naming_case_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
- <td></td>
- <td><p>The database engine this rule applies to. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>required</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>max_length</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>upper</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3>
- <p>Payload message types for SQL review rules</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>max_length</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>format</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>number</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>list</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>review_config</td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td></td>
- <td><p>The SQL review config to update.
-
-The name field is used to identify the SQL review config to update. </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to update. </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, and the config is not found, a new config will be created.
-In this situation, `update_mask` is ignored. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</h3>
- <p>The severity level for SQL review rules.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>STATEMENT_DML_DRY_RUN</td>
+ <td>27</td>
+ <td><p></p></td>
+ </tr>
<tr>
- <td>LEVEL_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified level.</p></td>
+ <td>STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT</td>
+ <td>28</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ERROR</td>
- <td>1</td>
- <td><p>Rule violation is an error.</p></td>
+ <td>STATEMENT_ADD_CHECK_NOT_VALID</td>
+ <td>29</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>WARNING</td>
- <td>2</td>
- <td><p>Rule violation is a warning.</p></td>
+ <td>STATEMENT_ADD_FOREIGN_KEY_NOT_VALID</td>
+ <td>30</td>
+ <td><p></p></td>
</tr>
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>STATEMENT_DISALLOW_ADD_NOT_NULL</td>
+ <td>31</td>
+ <td><p></p></td>
+ </tr>
<tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
+ <td>STATEMENT_SELECT_FULL_TABLE_SCAN</td>
+ <td>32</td>
<td><p></p></td>
</tr>
<tr>
- <td>ENGINE_MYSQL_USE_INNODB</td>
- <td>1</td>
+ <td>STATEMENT_CREATE_SPECIFY_SCHEMA</td>
+ <td>33</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_FULLY_QUALIFIED</td>
- <td>2</td>
+ <td>STATEMENT_CHECK_SET_ROLE_VARIABLE</td>
+ <td>34</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_TABLE</td>
- <td>3</td>
+ <td>STATEMENT_DISALLOW_USING_FILESORT</td>
+ <td>35</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_COLUMN</td>
- <td>4</td>
+ <td>STATEMENT_DISALLOW_USING_TEMPORARY</td>
+ <td>36</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_INDEX_PK</td>
- <td>5</td>
+ <td>STATEMENT_WHERE_NO_EQUAL_NULL</td>
+ <td>37</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_INDEX_UK</td>
- <td>6</td>
+ <td>STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS</td>
+ <td>38</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_INDEX_FK</td>
- <td>7</td>
+ <td>STATEMENT_QUERY_MINIMUM_PLAN_LEVEL</td>
+ <td>39</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_INDEX_IDX</td>
- <td>8</td>
+ <td>STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT</td>
+ <td>40</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_COLUMN_AUTO_INCREMENT</td>
- <td>9</td>
+ <td>STATEMENT_MAXIMUM_LIMIT_VALUE</td>
+ <td>41</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_TABLE_NO_KEYWORD</td>
- <td>10</td>
+ <td>STATEMENT_MAXIMUM_JOIN_TABLE_COUNT</td>
+ <td>42</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_IDENTIFIER_NO_KEYWORD</td>
- <td>11</td>
+ <td>STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION</td>
+ <td>43</td>
<td><p></p></td>
</tr>
<tr>
- <td>NAMING_IDENTIFIER_CASE</td>
- <td>12</td>
+ <td>STATEMENT_JOIN_STRICT_COLUMN_ATTRS</td>
+ <td>44</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_SELECT_NO_SELECT_ALL</td>
- <td>13</td>
+ <td>STATEMENT_NON_TRANSACTIONAL</td>
+ <td>45</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_WHERE_REQUIRE_SELECT</td>
- <td>14</td>
+ <td>STATEMENT_ADD_COLUMN_WITHOUT_POSITION</td>
+ <td>46</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_WHERE_REQUIRE_UPDATE_DELETE</td>
- <td>15</td>
+ <td>STATEMENT_DISALLOW_OFFLINE_DDL</td>
+ <td>47</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE</td>
- <td>16</td>
+ <td>STATEMENT_DISALLOW_CROSS_DB_QUERIES</td>
+ <td>48</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_ON_DEL_CASCADE</td>
- <td>17</td>
+ <td>STATEMENT_MAX_EXECUTION_TIME</td>
+ <td>49</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_RM_TBL_CASCADE</td>
- <td>18</td>
+ <td>STATEMENT_REQUIRE_ALGORITHM_OPTION</td>
+ <td>50</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_COMMIT</td>
- <td>19</td>
+ <td>STATEMENT_REQUIRE_LOCK_OPTION</td>
+ <td>51</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_LIMIT</td>
- <td>20</td>
+ <td>STATEMENT_OBJECT_OWNER_CHECK</td>
+ <td>52</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_ORDER_BY</td>
- <td>21</td>
+ <td>TABLE_REQUIRE_PK</td>
+ <td>53</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_MERGE_ALTER_TABLE</td>
- <td>22</td>
+ <td>TABLE_NO_FOREIGN_KEY</td>
+ <td>54</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_INSERT_ROW_LIMIT</td>
- <td>23</td>
+ <td>TABLE_DROP_NAMING_CONVENTION</td>
+ <td>55</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_INSERT_MUST_SPECIFY_COLUMN</td>
- <td>24</td>
+ <td>TABLE_COMMENT</td>
+ <td>56</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND</td>
- <td>25</td>
+ <td>TABLE_DISALLOW_PARTITION</td>
+ <td>57</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_AFFECTED_ROW_LIMIT</td>
- <td>26</td>
+ <td>TABLE_DISALLOW_TRIGGER</td>
+ <td>58</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DML_DRY_RUN</td>
- <td>27</td>
+ <td>TABLE_NO_DUPLICATE_INDEX</td>
+ <td>59</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT</td>
- <td>28</td>
+ <td>TABLE_TEXT_FIELDS_TOTAL_LENGTH</td>
+ <td>60</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_ADD_CHECK_NOT_VALID</td>
- <td>29</td>
+ <td>TABLE_DISALLOW_SET_CHARSET</td>
+ <td>61</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_ADD_FOREIGN_KEY_NOT_VALID</td>
- <td>30</td>
+ <td>TABLE_DISALLOW_DDL</td>
+ <td>62</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_ADD_NOT_NULL</td>
- <td>31</td>
+ <td>TABLE_DISALLOW_DML</td>
+ <td>63</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_SELECT_FULL_TABLE_SCAN</td>
- <td>32</td>
+ <td>TABLE_LIMIT_SIZE</td>
+ <td>64</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_REQUIRE_CHARSET</td>
+ <td>65</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_REQUIRE_COLLATION</td>
+ <td>66</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_REQUIRED</td>
+ <td>67</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_NO_NULL</td>
+ <td>68</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_CHANGE_TYPE</td>
+ <td>69</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_SET_DEFAULT_FOR_NOT_NULL</td>
+ <td>70</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_CHANGE</td>
+ <td>71</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_CHANGING_ORDER</td>
+ <td>72</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_DROP</td>
+ <td>73</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_CREATE_SPECIFY_SCHEMA</td>
- <td>33</td>
+ <td>COLUMN_DISALLOW_DROP_IN_INDEX</td>
+ <td>74</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_CHECK_SET_ROLE_VARIABLE</td>
- <td>34</td>
+ <td>COLUMN_COMMENT</td>
+ <td>75</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_USING_FILESORT</td>
- <td>35</td>
+ <td>COLUMN_AUTO_INCREMENT_MUST_INTEGER</td>
+ <td>76</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_USING_TEMPORARY</td>
- <td>36</td>
+ <td>COLUMN_TYPE_DISALLOW_LIST</td>
+ <td>77</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_WHERE_NO_EQUAL_NULL</td>
- <td>37</td>
+ <td>COLUMN_DISALLOW_SET_CHARSET</td>
+ <td>78</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS</td>
- <td>38</td>
+ <td>COLUMN_MAXIMUM_CHARACTER_LENGTH</td>
+ <td>79</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_QUERY_MINIMUM_PLAN_LEVEL</td>
- <td>39</td>
+ <td>COLUMN_MAXIMUM_VARCHAR_LENGTH</td>
+ <td>80</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT</td>
- <td>40</td>
+ <td>COLUMN_AUTO_INCREMENT_INITIAL_VALUE</td>
+ <td>81</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_MAXIMUM_LIMIT_VALUE</td>
- <td>41</td>
+ <td>COLUMN_AUTO_INCREMENT_MUST_UNSIGNED</td>
+ <td>82</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_MAXIMUM_JOIN_TABLE_COUNT</td>
- <td>42</td>
+ <td>COLUMN_CURRENT_TIME_COUNT_LIMIT</td>
+ <td>83</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION</td>
- <td>43</td>
+ <td>COLUMN_REQUIRE_DEFAULT</td>
+ <td>84</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_JOIN_STRICT_COLUMN_ATTRS</td>
- <td>44</td>
+ <td>COLUMN_DEFAULT_DISALLOW_VOLATILE</td>
+ <td>85</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_NON_TRANSACTIONAL</td>
- <td>45</td>
+ <td>COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT</td>
+ <td>86</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_ADD_COLUMN_WITHOUT_POSITION</td>
- <td>46</td>
+ <td>COLUMN_REQUIRE_CHARSET</td>
+ <td>87</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_OFFLINE_DDL</td>
- <td>47</td>
+ <td>COLUMN_REQUIRE_COLLATION</td>
+ <td>88</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_DISALLOW_CROSS_DB_QUERIES</td>
- <td>48</td>
+ <td>SCHEMA_BACKWARD_COMPATIBILITY</td>
+ <td>89</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_MAX_EXECUTION_TIME</td>
- <td>49</td>
+ <td>DATABASE_DROP_EMPTY_DATABASE</td>
+ <td>90</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_REQUIRE_ALGORITHM_OPTION</td>
- <td>50</td>
+ <td>INDEX_NO_DUPLICATE_COLUMN</td>
+ <td>91</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_REQUIRE_LOCK_OPTION</td>
- <td>51</td>
+ <td>INDEX_KEY_NUMBER_LIMIT</td>
+ <td>92</td>
<td><p></p></td>
</tr>
<tr>
- <td>STATEMENT_OBJECT_OWNER_CHECK</td>
- <td>52</td>
+ <td>INDEX_PK_TYPE_LIMIT</td>
+ <td>93</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_REQUIRE_PK</td>
- <td>53</td>
+ <td>INDEX_TYPE_NO_BLOB</td>
+ <td>94</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_NO_FOREIGN_KEY</td>
- <td>54</td>
+ <td>INDEX_TOTAL_NUMBER_LIMIT</td>
+ <td>95</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_DROP_NAMING_CONVENTION</td>
- <td>55</td>
+ <td>INDEX_PRIMARY_KEY_TYPE_ALLOWLIST</td>
+ <td>96</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_COMMENT</td>
- <td>56</td>
+ <td>INDEX_CREATE_CONCURRENTLY</td>
+ <td>97</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_DISALLOW_PARTITION</td>
- <td>57</td>
+ <td>INDEX_TYPE_ALLOW_LIST</td>
+ <td>98</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_DISALLOW_TRIGGER</td>
- <td>58</td>
+ <td>INDEX_NOT_REDUNDANT</td>
+ <td>99</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_NO_DUPLICATE_INDEX</td>
- <td>59</td>
+ <td>SYSTEM_CHARSET_ALLOWLIST</td>
+ <td>100</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_TEXT_FIELDS_TOTAL_LENGTH</td>
- <td>60</td>
+ <td>SYSTEM_COLLATION_ALLOWLIST</td>
+ <td>101</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_DISALLOW_SET_CHARSET</td>
- <td>61</td>
+ <td>SYSTEM_COMMENT_LENGTH</td>
+ <td>102</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_DISALLOW_DDL</td>
- <td>62</td>
+ <td>SYSTEM_PROCEDURE_DISALLOW_CREATE</td>
+ <td>103</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_DISALLOW_DML</td>
- <td>63</td>
+ <td>SYSTEM_EVENT_DISALLOW_CREATE</td>
+ <td>104</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_LIMIT_SIZE</td>
- <td>64</td>
+ <td>SYSTEM_VIEW_DISALLOW_CREATE</td>
+ <td>105</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_REQUIRE_CHARSET</td>
- <td>65</td>
+ <td>SYSTEM_FUNCTION_DISALLOW_CREATE</td>
+ <td>106</td>
<td><p></p></td>
</tr>
<tr>
- <td>TABLE_REQUIRE_COLLATION</td>
- <td>66</td>
+ <td>SYSTEM_FUNCTION_DISALLOWED_LIST</td>
+ <td>107</td>
<td><p></p></td>
</tr>
<tr>
- <td>COLUMN_REQUIRED</td>
- <td>67</td>
+ <td>ADVICE_ONLINE_MIGRATION</td>
+ <td>108</td>
<td><p></p></td>
</tr>
<tr>
- <td>COLUMN_NO_NULL</td>
- <td>68</td>
+ <td>BUILTIN_PRIOR_BACKUP_CHECK</td>
+ <td>109</td>
<td><p></p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ReviewConfigService">ReviewConfigService</h3>
+ <p>ReviewConfigService manages approval flow configurations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>COLUMN_DISALLOW_CHANGE_TYPE</td>
- <td>69</td>
- <td><p></p></td>
+ <td>CreateReviewConfig</td>
+ <td><a href="#bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</a></td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td><p>Creates a new SQL review configuration.
+Permissions required: bb.reviewConfigs.create</p></td>
</tr>
<tr>
- <td>COLUMN_SET_DEFAULT_FOR_NOT_NULL</td>
- <td>70</td>
- <td><p></p></td>
+ <td>ListReviewConfigs</td>
+ <td><a href="#bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</a></td>
+ <td><a href="#bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</a></td>
+ <td><p>Lists all SQL review configurations.
+Permissions required: bb.reviewConfigs.list</p></td>
</tr>
<tr>
- <td>COLUMN_DISALLOW_CHANGE</td>
- <td>71</td>
- <td><p></p></td>
+ <td>GetReviewConfig</td>
+ <td><a href="#bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</a></td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td><p>Retrieves a SQL review configuration by name.
+Permissions required: bb.reviewConfigs.get</p></td>
</tr>
<tr>
- <td>COLUMN_DISALLOW_CHANGING_ORDER</td>
- <td>72</td>
- <td><p></p></td>
+ <td>UpdateReviewConfig</td>
+ <td><a href="#bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</a></td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td><p>Updates a SQL review configuration.
+Permissions required: bb.reviewConfigs.update
+When allow_missing=true, also requires: bb.reviewConfigs.create</p></td>
</tr>
<tr>
- <td>COLUMN_DISALLOW_DROP</td>
- <td>73</td>
- <td><p></p></td>
+ <td>DeleteReviewConfig</td>
+ <td><a href="#bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a SQL review configuration.
+Permissions required: bb.reviewConfigs.delete</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>COLUMN_DISALLOW_DROP_IN_INDEX</td>
- <td>74</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>COLUMN_COMMENT</td>
- <td>75</td>
- <td><p></p></td>
+ <td>CreateReviewConfig</td>
+ <td>POST</td>
+ <td>/v1/reviewConfigs</td>
+ <td>review_config</td>
</tr>
+
+
+
<tr>
- <td>COLUMN_AUTO_INCREMENT_MUST_INTEGER</td>
- <td>76</td>
- <td><p></p></td>
+ <td>ListReviewConfigs</td>
+ <td>GET</td>
+ <td>/v1/reviewConfigs</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>COLUMN_TYPE_DISALLOW_LIST</td>
- <td>77</td>
- <td><p></p></td>
+ <td>GetReviewConfig</td>
+ <td>GET</td>
+ <td>/v1/{name=reviewConfigs/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>COLUMN_DISALLOW_SET_CHARSET</td>
- <td>78</td>
- <td><p></p></td>
+ <td>UpdateReviewConfig</td>
+ <td>PATCH</td>
+ <td>/v1/{review_config.name=reviewConfigs/*}</td>
+ <td>review_config</td>
</tr>
+
+
+
<tr>
- <td>COLUMN_MAXIMUM_CHARACTER_LENGTH</td>
- <td>79</td>
- <td><p></p></td>
+ <td>DeleteReviewConfig</td>
+ <td>DELETE</td>
+ <td>/v1/{name=reviewConfigs/*}</td>
+ <td></td>
</tr>
+
- <tr>
- <td>COLUMN_MAXIMUM_VARCHAR_LENGTH</td>
- <td>80</td>
- <td><p></p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/revision_service.proto">v1/revision_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource shared by all revisions being created.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the revisions to create.
+A maximum of 100 revisions can be created in a batch. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>revisions</td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td>repeated</td>
+ <td><p>The created revisions. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>revision</td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td></td>
+ <td><p>The revision to create. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the revision to delete.
+Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetRevisionRequest">GetRevisionRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the revision.
+Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent of the revisions.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of revisions to return. The service may return fewer
+than this value. If unspecified, at most 10 revisions will be returned. The
+maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListRevisions` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListRevisions` must
+match the call that provided the page token. </p></td>
+ </tr>
+
+ <tr>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to include deleted revisions in the results. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>revisions</td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td>repeated</td>
+ <td><p>The revisions from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Revision">Revision</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ </tr>
+
+ <tr>
+ <td>release</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/releases/{release}
+Can be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>deleter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected]
+Can be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>delete_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>Can be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>file</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/releases/{release}/files/{id}
+Can be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema version string for this revision. </p></td>
+ </tr>
+
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The sheet that holds the content.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>sheet_sha256</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SHA256 hash value of the sheet. </p></td>
+ </tr>
+
+ <tr>
+ <td>task_run</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The task run associated with the revision.
+Can be empty.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Revision.Type">Revision.Type</a></td>
+ <td></td>
+ <td><p>The type of the revision. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.Revision.Type">Revision.Type</h3>
+ <p>The type of schema revision.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>COLUMN_AUTO_INCREMENT_INITIAL_VALUE</td>
- <td>81</td>
- <td><p></p></td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
</tr>
<tr>
- <td>COLUMN_AUTO_INCREMENT_MUST_UNSIGNED</td>
- <td>82</td>
- <td><p></p></td>
+ <td>VERSIONED</td>
+ <td>1</td>
+ <td><p>Versioned schema migration.</p></td>
</tr>
<tr>
- <td>COLUMN_CURRENT_TIME_COUNT_LIMIT</td>
- <td>83</td>
- <td><p></p></td>
+ <td>DECLARATIVE</td>
+ <td>2</td>
+ <td><p>Declarative schema definition.</p></td>
</tr>
- <tr>
- <td>COLUMN_REQUIRE_DEFAULT</td>
- <td>84</td>
- <td><p></p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RevisionService">RevisionService</h3>
+ <p>RevisionService manages schema revision history.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>COLUMN_DEFAULT_DISALLOW_VOLATILE</td>
- <td>85</td>
- <td><p></p></td>
+ <td>ListRevisions</td>
+ <td><a href="#bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</a></td>
+ <td><a href="#bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</a></td>
+ <td><p>Lists schema revisions for a database.
+Permissions required: bb.revisions.list</p></td>
</tr>
<tr>
- <td>COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT</td>
- <td>86</td>
- <td><p></p></td>
+ <td>GetRevision</td>
+ <td><a href="#bytebase.v1.GetRevisionRequest">GetRevisionRequest</a></td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td><p>Retrieves a schema revision by name.
+Permissions required: bb.revisions.get</p></td>
</tr>
<tr>
- <td>COLUMN_REQUIRE_CHARSET</td>
- <td>87</td>
- <td><p></p></td>
+ <td>BatchCreateRevisions</td>
+ <td><a href="#bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</a></td>
+ <td><p>Creates multiple schema revisions in a single operation.
+Permissions required: bb.revisions.create</p></td>
</tr>
<tr>
- <td>COLUMN_REQUIRE_COLLATION</td>
- <td>88</td>
- <td><p></p></td>
+ <td>DeleteRevision</td>
+ <td><a href="#bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a schema revision.
+Permissions required: bb.revisions.delete</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>SCHEMA_BACKWARD_COMPATIBILITY</td>
- <td>89</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>DATABASE_DROP_EMPTY_DATABASE</td>
- <td>90</td>
- <td><p></p></td>
+ <td>ListRevisions</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*/databases/*}/revisions</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>INDEX_NO_DUPLICATE_COLUMN</td>
- <td>91</td>
- <td><p></p></td>
+ <td>GetRevision</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>INDEX_KEY_NUMBER_LIMIT</td>
- <td>92</td>
- <td><p></p></td>
+ <td>BatchCreateRevisions</td>
+ <td>POST</td>
+ <td>/v1/{parent=instances/*/databases/*}/revisions:batchCreate</td>
+ <td>*</td>
</tr>
+
+
+
<tr>
- <td>INDEX_PK_TYPE_LIMIT</td>
- <td>93</td>
- <td><p></p></td>
+ <td>DeleteRevision</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
+ <td></td>
</tr>
+
- <tr>
- <td>INDEX_TYPE_NO_BLOB</td>
- <td>94</td>
- <td><p></p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/role_service.proto">v1/role_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateRoleRequest">CreateRoleRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>role</td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td></td>
+ <td><p>The role to create. </p></td>
+ </tr>
+
+ <tr>
+ <td>role_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The ID to use for the role, which will become the final component
+of the role&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][A-Z][0-9]/. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the role to delete.
+Format: roles/{role} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetRoleRequest">GetRoleRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the role to retrieve.
+Format: roles/{role} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRolesRequest">ListRolesRequest</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRolesResponse">ListRolesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td>repeated</td>
+ <td><p>The roles from the specified request. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Role">Role</h3>
+ <p>Role defines a set of permissions that can be assigned to users.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Resource name. Format: roles/{role} </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Human-readable title. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Optional description of the role. </p></td>
+ </tr>
+
+ <tr>
+ <td>permissions</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>List of permission identifiers granted by this role. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Role.Type">Role.Type</a></td>
+ <td></td>
+ <td><p>Role type indicating if it&#39;s built-in or custom. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>role</td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td></td>
+ <td><p>The role to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the role is not found, a new role will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.Role.Type">Role.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>INDEX_TOTAL_NUMBER_LIMIT</td>
- <td>95</td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
<td><p></p></td>
</tr>
<tr>
- <td>INDEX_PRIMARY_KEY_TYPE_ALLOWLIST</td>
- <td>96</td>
- <td><p></p></td>
+ <td>BUILT_IN</td>
+ <td>1</td>
+ <td><p>System-defined role that cannot be modified.</p></td>
</tr>
<tr>
- <td>INDEX_CREATE_CONCURRENTLY</td>
- <td>97</td>
- <td><p></p></td>
+ <td>CUSTOM</td>
+ <td>2</td>
+ <td><p>User-defined role that can be modified.</p></td>
</tr>
- <tr>
- <td>INDEX_TYPE_ALLOW_LIST</td>
- <td>98</td>
- <td><p></p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RoleService">RoleService</h3>
+ <p>RoleService manages workspace roles and permissions.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>INDEX_NOT_REDUNDANT</td>
- <td>99</td>
- <td><p></p></td>
+ <td>ListRoles</td>
+ <td><a href="#bytebase.v1.ListRolesRequest">ListRolesRequest</a></td>
+ <td><a href="#bytebase.v1.ListRolesResponse">ListRolesResponse</a></td>
+ <td><p>Lists roles in the workspace.
+Permissions required: bb.roles.list</p></td>
</tr>
-
- <tr>
- <td>SYSTEM_CHARSET_ALLOWLIST</td>
- <td>100</td>
- <td><p></p></td>
+
+ <tr>
+ <td>GetRole</td>
+ <td><a href="#bytebase.v1.GetRoleRequest">GetRoleRequest</a></td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td><p>Retrieves a role by name.
+Permissions required: bb.roles.get</p></td>
</tr>
<tr>
- <td>SYSTEM_COLLATION_ALLOWLIST</td>
- <td>101</td>
- <td><p></p></td>
+ <td>CreateRole</td>
+ <td><a href="#bytebase.v1.CreateRoleRequest">CreateRoleRequest</a></td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td><p>Creates a new custom role.
+Permissions required: bb.roles.create</p></td>
</tr>
<tr>
- <td>SYSTEM_COMMENT_LENGTH</td>
- <td>102</td>
- <td><p></p></td>
+ <td>UpdateRole</td>
+ <td><a href="#bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</a></td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td><p>Updates a role&#39;s properties.
+Permissions required: bb.roles.update
+When allow_missing=true, also requires: bb.roles.create</p></td>
</tr>
<tr>
- <td>SYSTEM_PROCEDURE_DISALLOW_CREATE</td>
- <td>103</td>
- <td><p></p></td>
+ <td>DeleteRole</td>
+ <td><a href="#bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a custom role.
+Permissions required: bb.roles.delete</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>SYSTEM_EVENT_DISALLOW_CREATE</td>
- <td>104</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>SYSTEM_VIEW_DISALLOW_CREATE</td>
- <td>105</td>
- <td><p></p></td>
+ <td>ListRoles</td>
+ <td>GET</td>
+ <td>/v1/roles</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>SYSTEM_FUNCTION_DISALLOW_CREATE</td>
- <td>106</td>
- <td><p></p></td>
+ <td>GetRole</td>
+ <td>GET</td>
+ <td>/v1/{name=roles/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>SYSTEM_FUNCTION_DISALLOWED_LIST</td>
- <td>107</td>
- <td><p></p></td>
+ <td>CreateRole</td>
+ <td>POST</td>
+ <td>/v1/roles</td>
+ <td>role</td>
</tr>
+
+
+
<tr>
- <td>ADVICE_ONLINE_MIGRATION</td>
- <td>108</td>
- <td><p></p></td>
+ <td>UpdateRole</td>
+ <td>PATCH</td>
+ <td>/v1/{role.name=roles/*}</td>
+ <td>role</td>
</tr>
+
+
+
<tr>
- <td>BUILTIN_PRIOR_BACKUP_CHECK</td>
- <td>109</td>
- <td><p></p></td>
+ <td>DeleteRole</td>
+ <td>DELETE</td>
+ <td>/v1/{name=roles/*}</td>
+ <td></td>
</tr>
+
- </tbody>
- </table>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/rollout_service.proto">v1/rollout_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The task name for the taskRuns.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
+Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. </p></td>
+ </tr>
+
+ <tr>
+ <td>task_runs</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The taskRuns to cancel.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The stage name for the tasks.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
+ </tr>
+
+ <tr>
+ <td>tasks</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The tasks to run.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ </tr>
+
+ <tr>
+ <td>run_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The task run should run after run_time. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The stage name for the tasks.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
+ </tr>
+
+ <tr>
+ <td>tasks</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The tasks to skip.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ </tr>
+
+ <tr>
+ <td>reason</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The reason for skipping the tasks. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent plan for which this rollout will be created.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Create the rollout only for the specified target.
+Format: environments/{environment}
+If unspecified, all stages are created.
+If set to &#34;&#34;, no stages are created. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetRolloutRequest">GetRolloutRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the rollout to retrieve.
+This is the rollout resource name, which is the plan name plus /rollout suffix.
+Format: projects/{project}/plans/{plan}/rollout </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent, which owns this collection of rollouts.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list all rollouts from all projects. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of rollouts to return. The service may return fewer than
+this value.
+If unspecified, at most 10 rollouts will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListRollouts` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListRollouts` must match
+the call that provided the page token. </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter rollouts returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+- task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
+
+For example:
+update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
+task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>rollouts</td>
+ <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
+ <td>repeated</td>
+ <td><p>The rollouts from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent, which owns this collection of taskRuns.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
+Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>task_runs</td>
+ <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
+ <td>repeated</td>
+ <td><p>The taskRuns from the specified request. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The rollback SQL statement that would undo the task run. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Rollout">Rollout</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The resource name of the rollout.
+Format: projects/{project}/plans/{plan}/rollout </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The title of the rollout, inherited from the associated plan.
+This field is output only and cannot be directly set. </p></td>
+ </tr>
+
+ <tr>
+ <td>stages</td>
+ <td><a href="#bytebase.v1.Stage">Stage</a></td>
+ <td>repeated</td>
+ <td><p>Stages and thus tasks of the rollout. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Stage">Stage</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}
+Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. </p></td>
+ </tr>
+
+ <tr>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>id is the environment id of the stage.
+e.g., &#34;prod&#34;.
+Use &#34;-&#34; when the stage has no environment or deleted environment. </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>environment is the environment of the stage.
+Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. </p></td>
+ </tr>
+
+ <tr>
+ <td>tasks</td>
+ <td><a href="#bytebase.v1.Task">Task</a></td>
+ <td>repeated</td>
+ <td><p>The tasks within this stage. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Task">Task</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ </tr>
+
+ <tr>
+ <td>spec_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A UUID4 string that uniquely identifies the Spec. </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Task.Status">Task.Status</a></td>
+ <td></td>
+ <td><p>Status is the status of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>skipped_reason</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The reason why the task was skipped. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Task.Type">Task.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: instances/{instance} if the task is DatabaseCreate.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>database_create</td>
+ <td><a href="#bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>database_update</td>
+ <td><a href="#bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>database_data_export</td>
+ <td><a href="#bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The update_time is the update time of latest task run.
+If there are no task runs, it will be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>run_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The run_time is the scheduled run time of latest task run.
+If there are no task runs or the task run is not scheduled, it will be empty. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h3 id="bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</h3>
+ <p>Payload for creating a new database.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+ <h3 id="bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</h3>
+ <p>Payload for exporting database data.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The resource name of the sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.ReviewConfigService">ReviewConfigService</h3>
- <p>ReviewConfigService manages approval flow configurations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>CreateReviewConfig</td>
- <td><a href="#bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</a></td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td><p>Creates a new SQL review configuration.
-Permissions required: bb.reviewConfigs.create</p></td>
- </tr>
-
- <tr>
- <td>ListReviewConfigs</td>
- <td><a href="#bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</a></td>
- <td><a href="#bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</a></td>
- <td><p>Lists all SQL review configurations.
-Permissions required: bb.reviewConfigs.list</p></td>
- </tr>
-
- <tr>
- <td>GetReviewConfig</td>
- <td><a href="#bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</a></td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td><p>Retrieves a SQL review configuration by name.
-Permissions required: bb.reviewConfigs.get</p></td>
- </tr>
-
- <tr>
- <td>UpdateReviewConfig</td>
- <td><a href="#bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</a></td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td><p>Updates a SQL review configuration.
-Permissions required: bb.reviewConfigs.update
-When allow_missing=true, also requires: bb.reviewConfigs.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteReviewConfig</td>
- <td><a href="#bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a SQL review configuration.
-Permissions required: bb.reviewConfigs.delete</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</h3>
+ <p>Payload for updating a database schema.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>release</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/releases/{release} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRun">TaskRun</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ <tr>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.TaskRun.Status">TaskRun.Status</a></td>
+ <td></td>
+ <td><p>The current execution status of the task run. </p></td>
+ </tr>
+
+ <tr>
+ <td>detail</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Below are the results of a task run.
+Detailed information about the task run result. </p></td>
+ </tr>
+
+ <tr>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The time when the task run started execution. </p></td>
+ </tr>
+
+ <tr>
+ <td>export_archive_status</td>
+ <td><a href="#bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</a></td>
+ <td></td>
+ <td><p>The export archive status for data export tasks. </p></td>
+ </tr>
+
+ <tr>
+ <td>has_prior_backup</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Indicates whether a prior backup was created for this task run.
+When true, rollback SQL can be generated via PreviewTaskRunRollback.
+Backup details are available in the task run logs. </p></td>
+ </tr>
+
+ <tr>
+ <td>scheduler_info</td>
+ <td><a href="#bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</a></td>
+ <td></td>
+ <td><p>Scheduling information about the task run. </p></td>
+ </tr>
+
+ <tr>
+ <td>run_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The task run should run after run_time.
+This can only be set when creating the task run calling BatchRunTasks. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</h3>
+ <p>Information about task run scheduling.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>report_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The time when the scheduling info was reported. </p></td>
+ </tr>
+
+ <tr>
+ <td>waiting_cause</td>
+ <td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</a></td>
+ <td></td>
+ <td><p>The cause for the task run waiting. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+
+
+
+ <h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</h3>
+ <p>Information about why a task run is waiting.</p>
+
+
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
-
- <tr>
- <td>CreateReviewConfig</td>
- <td>POST</td>
- <td>/v1/reviewConfigs</td>
- <td>review_config</td>
- </tr>
-
-
-
- <tr>
- <td>ListReviewConfigs</td>
- <td>GET</td>
- <td>/v1/reviewConfigs</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetReviewConfig</td>
- <td>GET</td>
- <td>/v1/{name=reviewConfigs/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateReviewConfig</td>
- <td>PATCH</td>
- <td>/v1/{review_config.name=reviewConfigs/*}</td>
- <td>review_config</td>
- </tr>
+ <tr>
+ <td>parallel_tasks_limit</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Waiting due to parallel tasks limit. </p></td>
+ </tr>
-
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRunLog">TaskRunLog</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log </p></td>
+ </tr>
- <tr>
- <td>DeleteReviewConfig</td>
- <td>DELETE</td>
- <td>/v1/{name=reviewConfigs/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>entries</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</a></td>
+ <td>repeated</td>
+ <td><p>The log entries for this task run. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/revision_service.proto">v1/revision_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</h3>
+ <h3 id="bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</h3>
<p></p>
@@ -25448,19 +25279,80 @@ Permissions required: bb.reviewConfigs.delete</p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</a></td>
+ <td></td>
+ <td><p>The type of this log entry. </p></td>
+ </tr>
+
+ <tr>
+ <td>log_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The time when the log was recorded. </p></td>
+ </tr>
+
+ <tr>
+ <td>replica_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all revisions being created.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The replica ID for this log entry. </p></td>
</tr>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</a></td>
- <td>repeated</td>
- <td><p>The request message specifying the revisions to create.
-A maximum of 100 revisions can be created in a batch. </p></td>
+ <td>schema_dump</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</a></td>
+ <td></td>
+ <td><p>Schema dump details (if type is SCHEMA_DUMP). </p></td>
+ </tr>
+
+ <tr>
+ <td>command_execute</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</a></td>
+ <td></td>
+ <td><p>Command execution details (if type is COMMAND_EXECUTE). </p></td>
+ </tr>
+
+ <tr>
+ <td>database_sync</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</a></td>
+ <td></td>
+ <td><p>Database sync details (if type is DATABASE_SYNC). </p></td>
+ </tr>
+
+ <tr>
+ <td>transaction_control</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</a></td>
+ <td></td>
+ <td><p>Transaction control details (if type is TRANSACTION_CONTROL). </p></td>
+ </tr>
+
+ <tr>
+ <td>prior_backup</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</a></td>
+ <td></td>
+ <td><p>Prior backup details (if type is PRIOR_BACKUP). </p></td>
+ </tr>
+
+ <tr>
+ <td>retry_info</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</a></td>
+ <td></td>
+ <td><p>Retry information details (if type is RETRY_INFO). </p></td>
+ </tr>
+
+ <tr>
+ <td>compute_diff</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</a></td>
+ <td></td>
+ <td><p>Compute diff details (if type is COMPUTE_DIFF). </p></td>
+ </tr>
+
+ <tr>
+ <td>release_file_execute</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</a></td>
+ <td></td>
+ <td><p>Release file execution details (if type is RELEASE_FILE_EXECUTE). </p></td>
</tr>
</tbody>
@@ -25470,8 +25362,8 @@ A maximum of 100 revisions can be created in a batch. </p></td>
- <h3 id="bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</h3>
+ <p>Command execution details.</p>
<table class="field-table">
@@ -25481,10 +25373,33 @@ A maximum of 100 revisions can be created in a batch. </p></td>
<tbody>
<tr>
- <td>revisions</td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
- <td>repeated</td>
- <td><p>The created revisions. </p></td>
+ <td>log_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the command was logged. </p></td>
+ </tr>
+
+ <tr>
+ <td>range</td>
+ <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td></td>
+ <td><p>The byte offset range of the executed command in the sheet.
+Uses byte offsets (not character indices) for efficient slicing of sheet content bytes.
+Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. </p></td>
+ </tr>
+
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The executed statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>response</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</a></td>
+ <td></td>
+ <td><p>The response from executing the command. </p></td>
</tr>
</tbody>
@@ -25494,8 +25409,8 @@ A maximum of 100 revisions can be created in a batch. </p></td>
- <h3 id="bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</h3>
+ <p>Command execution response.</p>
<table class="field-table">
@@ -25505,17 +25420,32 @@ A maximum of 100 revisions can be created in a batch. </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>log_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the response was logged. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>Error message if command execution failed. </p></td>
</tr>
<tr>
- <td>revision</td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The revision to create. </p></td>
+ <td><p>Total affected rows. </p></td>
+ </tr>
+
+ <tr>
+ <td>all_affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td>repeated</td>
+ <td><p>`all_affected_rows` is the affected rows of each command.
+`all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. </p></td>
</tr>
</tbody>
@@ -25525,8 +25455,8 @@ A maximum of 100 revisions can be created in a batch. </p></td>
- <h3 id="bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</h3>
+ <p>Schema diff computation details.</p>
<table class="field-table">
@@ -25536,11 +25466,24 @@ A maximum of 100 revisions can be created in a batch. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When diff computation started. </p></td>
+ </tr>
+
+ <tr>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When diff computation ended. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the revision to delete.
-Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ <td><p>Error message if computation failed. </p></td>
</tr>
</tbody>
@@ -25550,8 +25493,8 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
- <h3 id="bytebase.v1.GetRevisionRequest">GetRevisionRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</h3>
+ <p>Database synchronization details.</p>
<table class="field-table">
@@ -25561,11 +25504,24 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the database sync started. </p></td>
+ </tr>
+
+ <tr>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the database sync ended. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the revision.
-Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ <td><p>Error message if sync failed. </p></td>
</tr>
</tbody>
@@ -25575,8 +25531,8 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
- <h3 id="bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</h3>
+ <p>Prior backup operation details.</p>
<table class="field-table">
@@ -25586,38 +25542,31 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The parent of the revisions.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>When the backup started. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The maximum number of revisions to return. The service may return fewer
-than this value. If unspecified, at most 10 revisions will be returned. The
-maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>When the backup ended. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>prior_backup_detail</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListRevisions` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRevisions` must
-match the call that provided the page token. </p></td>
+ <td><p>The backup details. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to include deleted revisions in the results. </p></td>
+ <td><p>Error message if the backup failed. </p></td>
</tr>
</tbody>
@@ -25627,8 +25576,8 @@ match the call that provided the page token. </p></td>
- <h3 id="bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</h3>
+ <p>Prior backup detail for rollback purposes.</p>
<table class="field-table">
@@ -25638,18 +25587,10 @@ match the call that provided the page token. </p></td>
<tbody>
<tr>
- <td>revisions</td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td>items</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</a></td>
<td>repeated</td>
- <td><p>The revisions from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>The list of backed up tables. </p></td>
</tr>
</tbody>
@@ -25659,8 +25600,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Revision">Revision</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</h3>
+ <p>A single backup table mapping.</p>
<table class="field-table">
@@ -25670,86 +25611,31 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release}
-Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>deleter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected]
-Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>delete_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>file</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release}/files/{id}
-Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema version string for this revision. </p></td>
- </tr>
-
- <tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
+ <td>source_table</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
<td></td>
- <td><p>The sheet that holds the content.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>The original table information. </p></td>
</tr>
<tr>
- <td>sheet_sha256</td>
- <td><a href="#string">string</a></td>
+ <td>target_table</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
<td></td>
- <td><p>The SHA256 hash value of the sheet. </p></td>
+ <td><p>The target backup table information. </p></td>
</tr>
<tr>
- <td>task_run</td>
- <td><a href="#string">string</a></td>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
<td></td>
- <td><p>The task run associated with the revision.
-Can be empty.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>The start position in the SQL statement. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Revision.Type">Revision.Type</a></td>
+ <td>end_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
<td></td>
- <td><p>The type of the revision. </p></td>
+ <td><p>The end position in the SQL statement. </p></td>
</tr>
</tbody>
@@ -25759,153 +25645,116 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task
-
-
- <h3 id="bytebase.v1.Revision.Type">Revision.Type</h3>
- <p>The type of schema revision.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>VERSIONED</td>
- <td>1</td>
- <td><p>Versioned schema migration.</p></td>
- </tr>
-
- <tr>
- <td>DECLARATIVE</td>
- <td>2</td>
- <td><p>Declarative schema definition.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RevisionService">RevisionService</h3>
- <p>RevisionService manages schema revision history.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ListRevisions</td>
- <td><a href="#bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</a></td>
- <td><a href="#bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</a></td>
- <td><p>Lists schema revisions for a database.
-Permissions required: bb.revisions.list</p></td>
- </tr>
-
- <tr>
- <td>GetRevision</td>
- <td><a href="#bytebase.v1.GetRevisionRequest">GetRevisionRequest</a></td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
- <td><p>Retrieves a schema revision by name.
-Permissions required: bb.revisions.get</p></td>
- </tr>
-
- <tr>
- <td>BatchCreateRevisions</td>
- <td><a href="#bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</a></td>
- <td><a href="#bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</a></td>
- <td><p>Creates multiple schema revisions in a single operation.
-Permissions required: bb.revisions.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteRevision</td>
- <td><a href="#bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a schema revision.
-Permissions required: bb.revisions.delete</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</h3>
+ <p>Table information.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>database</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The database information.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
- <tr>
- <td>ListRevisions</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*/databases/*}/revisions</td>
- <td></td>
- </tr>
-
-
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema name. </p></td>
+ </tr>
+ <tr>
+ <td>table</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The table name. </p></td>
+ </tr>
- <tr>
- <td>GetRevision</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
- <td></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</h3>
+ <p>Release file execution details.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
-
+ <tr>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The version of the file being executed (e.g., &#34;0001&#34;). </p></td>
+ </tr>
+ <tr>
+ <td>file_path</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). </p></td>
+ </tr>
- <tr>
- <td>BatchCreateRevisions</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*/databases/*}/revisions:batchCreate</td>
- <td>*</td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</h3>
+ <p>Retry information for failed operations.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
-
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The error that triggered the retry. </p></td>
+ </tr>
+ <tr>
+ <td>retry_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Current retry attempt number. </p></td>
+ </tr>
- <tr>
- <td>DeleteRevision</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>maximum_retries</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Maximum number of retries allowed. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/role_service.proto">v1/role_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.CreateRoleRequest">CreateRoleRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</h3>
+ <p>Schema dump operation details.</p>
<table class="field-table">
@@ -25915,21 +25764,24 @@ Permissions required: bb.revisions.delete</p></td>
<tbody>
<tr>
- <td>role</td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The role to create. </p></td>
+ <td><p>When the schema dump started. </p></td>
</tr>
<tr>
- <td>role_id</td>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the schema dump ended. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The ID to use for the role, which will become the final component
-of the role&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][A-Z][0-9]/. </p></td>
+ <td><p>Error message if the schema dump failed. </p></td>
</tr>
</tbody>
@@ -25939,8 +25791,8 @@ are /[a-z][A-Z][0-9]/. </p></td>
- <h3 id="bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</h3>
+ <p>Transaction control operation details.</p>
<table class="field-table">
@@ -25950,11 +25802,17 @@ are /[a-z][A-Z][0-9]/. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</a></td>
+ <td></td>
+ <td><p>The type of transaction control. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the role to delete.
-Format: roles/{role} </p></td>
+ <td><p>Error message if the operation failed. </p></td>
</tr>
</tbody>
@@ -25964,7 +25822,7 @@ Format: roles/{role} </p></td>
- <h3 id="bytebase.v1.GetRoleRequest">GetRoleRequest</h3>
+ <h3 id="bytebase.v1.TaskRunSession">TaskRunSession</h3>
<p></p>
@@ -25978,8 +25836,14 @@ Format: roles/{role} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the role to retrieve.
-Format: roles/{role} </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session </p></td>
+ </tr>
+
+ <tr>
+ <td>postgres</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</a></td>
+ <td></td>
+ <td><p>PostgreSQL session information. </p></td>
</tr>
</tbody>
@@ -25989,15 +25853,8 @@ Format: roles/{role} </p></td>
- <h3 id="bytebase.v1.ListRolesRequest">ListRolesRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListRolesResponse">ListRolesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</h3>
+ <p>PostgreSQL session information.</p>
<table class="field-table">
@@ -26007,10 +25864,24 @@ Format: roles/{role} </p></td>
<tbody>
<tr>
- <td>roles</td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td>session</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
+ <td></td>
+ <td><p>`session` is the session of the task run executing commands. </p></td>
+ </tr>
+
+ <tr>
+ <td>blocking_sessions</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
<td>repeated</td>
- <td><p>The roles from the specified request. </p></td>
+ <td><p>`blocking_sessions` block `session`. </p></td>
+ </tr>
+
+ <tr>
+ <td>blocked_sessions</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
+ <td>repeated</td>
+ <td><p>`blocked_sessions` are blocked by `session`. </p></td>
</tr>
</tbody>
@@ -26020,8 +25891,8 @@ Format: roles/{role} </p></td>
- <h3 id="bytebase.v1.Role">Role</h3>
- <p>Role defines a set of permissions that can be assigned to users.</p>
+ <h3 id="bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</h3>
+ <p>PostgreSQL session information read from `pg_stat_activity`.</p>
<table class="field-table">
@@ -26031,77 +25902,101 @@ Format: roles/{role} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>pid</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Process ID of the session. </p></td>
+ </tr>
+
+ <tr>
+ <td>blocked_by_pids</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>PIDs of sessions blocking this session. </p></td>
+ </tr>
+
+ <tr>
+ <td>query</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Current query being executed. </p></td>
+ </tr>
+
+ <tr>
+ <td>state</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Session state (active, idle, etc.). </p></td>
+ </tr>
+
+ <tr>
+ <td>wait_event_type</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Wait event type if session is waiting. </p></td>
+ </tr>
+
+ <tr>
+ <td>wait_event</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Resource name. Format: roles/{role} </p></td>
+ <td>optional</td>
+ <td><p>Specific wait event if session is waiting. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>datname</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Human-readable title. </p></td>
+ <td>optional</td>
+ <td><p>Database name. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>usename</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Optional description of the role. </p></td>
+ <td>optional</td>
+ <td><p>User name. </p></td>
</tr>
<tr>
- <td>permissions</td>
+ <td>application_name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>List of permission identifiers granted by this role. </p></td>
+ <td></td>
+ <td><p>Application name. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Role.Type">Role.Type</a></td>
- <td></td>
- <td><p>Role type indicating if it&#39;s built-in or custom. </p></td>
+ <td>client_addr</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Client IP address. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>client_port</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Client port number. </p></td>
+ </tr>
<tr>
- <td>role</td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td>backend_start</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The role to update. </p></td>
+ <td><p>When the backend process started. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to update. </p></td>
+ <td>xact_start</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>When the current transaction started. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, and the role is not found, a new role will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td>query_start</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>When the current query started. </p></td>
</tr>
</tbody>
@@ -26111,10 +26006,230 @@ In this situation, `update_mask` is ignored. </p></td>
-
+
+
+ <h3 id="bytebase.v1.Task.Status">Task.Status</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>NOT_STARTED</td>
+ <td>1</td>
+ <td><p>Task has not started and is awaiting its turn in the deployment sequence.</p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>2</td>
+ <td><p>Task is ready to run and waiting for approval or scheduled time.</p></td>
+ </tr>
+
+ <tr>
+ <td>RUNNING</td>
+ <td>3</td>
+ <td><p>Task is currently executing.</p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>4</td>
+ <td><p>Task completed successfully.</p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>5</td>
+ <td><p>Task execution failed with errors.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>6</td>
+ <td><p>Task execution was canceled by a user.</p></td>
+ </tr>
+
+ <tr>
+ <td>SKIPPED</td>
+ <td>7</td>
+ <td><p>Task was skipped and will not be executed.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Task.Type">Task.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified task type.</p></td>
+ </tr>
+
+ <tr>
+ <td>GENERAL</td>
+ <td>1</td>
+ <td><p>General task for miscellaneous operations.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_CREATE</td>
+ <td>2</td>
+ <td><p>Database creation task that creates a new database.
+Use payload DatabaseCreate.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_MIGRATE</td>
+ <td>3</td>
+ <td><p>Database migration task that applies versioned schema changes.
+Use payload DatabaseUpdate.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_EXPORT</td>
+ <td>4</td>
+ <td><p>Database export task that exports query results or table data.
+Use payload DatabaseDataExport.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>EXPORT_ARCHIVE_STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified export archive status.</p></td>
+ </tr>
+
+ <tr>
+ <td>READY</td>
+ <td>1</td>
+ <td><p>Export archive is ready for download.</p></td>
+ </tr>
+
+ <tr>
+ <td>EXPORTED</td>
+ <td>2</td>
+ <td><p>Export archive has been downloaded by the user.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.TaskRun.Status">TaskRun.Status</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p>Task run is queued and waiting to start execution.</p></td>
+ </tr>
+
+ <tr>
+ <td>RUNNING</td>
+ <td>2</td>
+ <td><p>Task run is currently executing.</p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>3</td>
+ <td><p>Task run completed successfully.</p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>4</td>
+ <td><p>Task run execution failed with errors.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>5</td>
+ <td><p>Task run execution was canceled by a user.</p></td>
+ </tr>
+
+ <tr>
+ <td>AVAILABLE</td>
+ <td>6</td>
+ <td><p>Task run is ready for immediate execution.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</h3>
+ <p>Transaction control type.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>BEGIN</td>
+ <td>1</td>
+ <td><p>Begin transaction.</p></td>
+ </tr>
+
+ <tr>
+ <td>COMMIT</td>
+ <td>2</td>
+ <td><p>Commit transaction.</p></td>
+ </tr>
+
+ <tr>
+ <td>ROLLBACK</td>
+ <td>3</td>
+ <td><p>Rollback transaction.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.Role.Type">Role.Type</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</h3>
+ <p>The type of log entry.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -26124,19 +26239,55 @@ In this situation, `update_mask` is ignored. </p></td>
<tr>
<td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified type.</p></td>
</tr>
<tr>
- <td>BUILT_IN</td>
+ <td>SCHEMA_DUMP</td>
<td>1</td>
- <td><p>System-defined role that cannot be modified.</p></td>
+ <td><p>Schema dump operation.</p></td>
</tr>
<tr>
- <td>CUSTOM</td>
+ <td>COMMAND_EXECUTE</td>
<td>2</td>
- <td><p>User-defined role that can be modified.</p></td>
+ <td><p>Command execution.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_SYNC</td>
+ <td>3</td>
+ <td><p>Database synchronization.</p></td>
+ </tr>
+
+ <tr>
+ <td>TRANSACTION_CONTROL</td>
+ <td>5</td>
+ <td><p>Transaction control (BEGIN, COMMIT, ROLLBACK).</p></td>
+ </tr>
+
+ <tr>
+ <td>PRIOR_BACKUP</td>
+ <td>6</td>
+ <td><p>Prior backup operation.</p></td>
+ </tr>
+
+ <tr>
+ <td>RETRY_INFO</td>
+ <td>7</td>
+ <td><p>Retry information.</p></td>
+ </tr>
+
+ <tr>
+ <td>COMPUTE_DIFF</td>
+ <td>8</td>
+ <td><p>Schema diff computation.</p></td>
+ </tr>
+
+ <tr>
+ <td>RELEASE_FILE_EXECUTE</td>
+ <td>9</td>
+ <td><p>Release file execution.</p></td>
</tr>
</tbody>
@@ -26146,8 +26297,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.RoleService">RoleService</h3>
- <p>RoleService manages workspace roles and permissions.</p>
+ <h3 id="bytebase.v1.RolloutService">RolloutService</h3>
+ <p>RolloutService manages the execution of deployment plans.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -26155,44 +26306,91 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>ListRoles</td>
- <td><a href="#bytebase.v1.ListRolesRequest">ListRolesRequest</a></td>
- <td><a href="#bytebase.v1.ListRolesResponse">ListRolesResponse</a></td>
- <td><p>Lists roles in the workspace.
-Permissions required: bb.roles.list</p></td>
+ <td>GetRollout</td>
+ <td><a href="#bytebase.v1.GetRolloutRequest">GetRolloutRequest</a></td>
+ <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
+ <td><p>Retrieves a rollout by its plan name.
+Permissions required: bb.rollouts.get</p></td>
</tr>
<tr>
- <td>GetRole</td>
- <td><a href="#bytebase.v1.GetRoleRequest">GetRoleRequest</a></td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td><p>Retrieves a role by name.
-Permissions required: bb.roles.get</p></td>
+ <td>ListRollouts</td>
+ <td><a href="#bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</a></td>
+ <td><a href="#bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</a></td>
+ <td><p>Lists rollouts in a project.
+Permissions required: bb.rollouts.list</p></td>
</tr>
<tr>
- <td>CreateRole</td>
- <td><a href="#bytebase.v1.CreateRoleRequest">CreateRoleRequest</a></td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td><p>Creates a new custom role.
-Permissions required: bb.roles.create</p></td>
+ <td>CreateRollout</td>
+ <td><a href="#bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</a></td>
+ <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
+ <td><p>Creates a new rollout for a plan.
+Permissions required: bb.rollouts.create</p></td>
</tr>
<tr>
- <td>UpdateRole</td>
- <td><a href="#bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</a></td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td><p>Updates a role&#39;s properties.
-Permissions required: bb.roles.update
-When allow_missing=true, also requires: bb.roles.create</p></td>
+ <td>ListTaskRuns</td>
+ <td><a href="#bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</a></td>
+ <td><a href="#bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</a></td>
+ <td><p>Lists task run executions for a task.
+Permissions required: bb.taskRuns.list</p></td>
</tr>
<tr>
- <td>DeleteRole</td>
- <td><a href="#bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a custom role.
-Permissions required: bb.roles.delete</p></td>
+ <td>GetTaskRun</td>
+ <td><a href="#bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</a></td>
+ <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
+ <td><p>Retrieves a task run by name.
+Permissions required: bb.taskRuns.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetTaskRunLog</td>
+ <td><a href="#bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</a></td>
+ <td><a href="#bytebase.v1.TaskRunLog">TaskRunLog</a></td>
+ <td><p>Retrieves execution logs for a task run.
+Permissions required: bb.taskRuns.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetTaskRunSession</td>
+ <td><a href="#bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</a></td>
+ <td><a href="#bytebase.v1.TaskRunSession">TaskRunSession</a></td>
+ <td><p>Retrieves database session information for a running task.
+Permissions required: bb.taskRuns.list</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchRunTasks</td>
+ <td><a href="#bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</a></td>
+ <td><a href="#bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</a></td>
+ <td><p>Executes multiple tasks in a rollout stage.
+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchSkipTasks</td>
+ <td><a href="#bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</a></td>
+ <td><a href="#bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</a></td>
+ <td><p>Skips multiple tasks in a rollout stage.
+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchCancelTaskRuns</td>
+ <td><a href="#bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</a></td>
+ <td><p>Cancels multiple running task executions.
+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ </tr>
+
+ <tr>
+ <td>PreviewTaskRunRollback</td>
+ <td><a href="#bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</a></td>
+ <td><a href="#bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</a></td>
+ <td><p>Generates rollback SQL for a completed task run.
+Permissions required: bb.taskRuns.list</p></td>
</tr>
</tbody>
@@ -26210,15 +26408,75 @@ Permissions required: bb.roles.delete</p></td>
<td>Pattern</td>
<td>Body</td>
</tr>
- </thead>
- <tbody>
+ </thead>
+ <tbody>
+
+
+
+ <tr>
+ <td>GetRollout</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*/rollout}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListRollouts</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/rollouts</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateRollout</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*}/rollout</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListTaskRuns</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetTaskRun</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetTaskRunLog</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/log</td>
+ <td></td>
+ </tr>
+
<tr>
- <td>ListRoles</td>
+ <td>GetTaskRunSession</td>
<td>GET</td>
- <td>/v1/roles</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/session</td>
<td></td>
</tr>
@@ -26226,40 +26484,40 @@ Permissions required: bb.roles.delete</p></td>
<tr>
- <td>GetRole</td>
- <td>GET</td>
- <td>/v1/{name=roles/*}</td>
- <td></td>
+ <td>BatchRunTasks</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchRun</td>
+ <td>*</td>
</tr>
<tr>
- <td>CreateRole</td>
+ <td>BatchSkipTasks</td>
<td>POST</td>
- <td>/v1/roles</td>
- <td>role</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchSkip</td>
+ <td>*</td>
</tr>
<tr>
- <td>UpdateRole</td>
- <td>PATCH</td>
- <td>/v1/{role.name=roles/*}</td>
- <td>role</td>
+ <td>BatchCancelTaskRuns</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns:batchCancel</td>
+ <td>*</td>
</tr>
<tr>
- <td>DeleteRole</td>
- <td>DELETE</td>
- <td>/v1/{name=roles/*}</td>
- <td></td>
+ <td>PreviewTaskRunRollback</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}:previewRollback</td>
+ <td>*</td>
</tr>
@@ -26270,12 +26528,12 @@ Permissions required: bb.roles.delete</p></td>
<div class="file-heading">
- <h2 id="v1/rollout_service.proto">v1/rollout_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/setting_service.proto">v1/setting_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</h3>
+ <h3 id="bytebase.v1.AISetting">AISetting</h3>
<p></p>
@@ -26286,114 +26544,45 @@ Permissions required: bb.roles.delete</p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>enabled</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The task name for the taskRuns.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
-Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. </p></td>
- </tr>
-
- <tr>
- <td>task_runs</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The taskRuns to cancel.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>provider</td>
+ <td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td>
<td></td>
- <td><p>The stage name for the tasks.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>tasks</td>
+ <td>endpoint</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The tasks to run.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
- </tr>
-
- <tr>
- <td>run_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The task run should run after run_time. </p></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>parent</td>
+ <td>api_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The stage name for the tasks.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>tasks</td>
+ <td>model</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The tasks to skip.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>reason</td>
+ <td>version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The reason for skipping the tasks. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26403,14 +26592,7 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p>
- <h3 id="bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</h3>
+ <h3 id="bytebase.v1.Algorithm">Algorithm</h3>
<p></p>
@@ -26421,95 +26603,31 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>full_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>
<td></td>
- <td><p>The parent plan for which this rollout will be created.
-Format: projects/{project}/plans/{plan} </p></td>
- </tr>
-
- <tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Create the rollout only for the specified target.
-Format: environments/{environment}
-If unspecified, all stages are created.
-If set to &#34;&#34;, no stages are created. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetRolloutRequest">GetRolloutRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>range_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td>
<td></td>
- <td><p>The name of the rollout to retrieve.
-This is the rollout resource name, which is the plan name plus /rollout suffix.
-Format: projects/{project}/plans/{plan}/rollout </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>md5_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>inner_outer_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26519,7 +26637,7 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
- <h3 id="bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</h3>
+ <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>
<p></p>
@@ -26530,10 +26648,11 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>substitution is the string used to replace the original value, the
+max length of the string is 16 bytes. </p></td>
</tr>
</tbody>
@@ -26543,7 +26662,7 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
- <h3 id="bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</h3>
+ <h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>
<p></p>
@@ -26554,49 +26673,31 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>prefix_len</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The parent, which owns this collection of rollouts.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list all rollouts from all projects. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_size</td>
+ <td>suffix_len</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of rollouts to return. The service may return fewer than
-this value.
-If unspecified, at most 10 rollouts will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListRollouts` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRollouts` must match
-the call that provided the page token. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter rollouts returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-- task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
-
-For example:
-update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
-task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26606,7 +26707,7 @@ task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
- <h3 id="bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</h3>
+ <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>
<p></p>
@@ -26617,18 +26718,10 @@ task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
<tbody>
<tr>
- <td>rollouts</td>
- <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
- <td>repeated</td>
- <td><p>The rollouts from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
+ <td>salt</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td>
</tr>
</tbody>
@@ -26638,7 +26731,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</h3>
+ <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</h3>
<p></p>
@@ -26649,12 +26742,11 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent, which owns this collection of taskRuns.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
-Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. </p></td>
+ <td>slices</td>
+ <td><a href="#bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</a></td>
+ <td>repeated</td>
+ <td><p>We store it as a repeated field to face the fact that the original value may have multiple parts should be masked.
+But frontend can be started with a single rule easily. </p></td>
</tr>
</tbody>
@@ -26664,7 +26756,7 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</h3>
+ <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3>
<p></p>
@@ -26675,10 +26767,27 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<tbody>
<tr>
- <td>task_runs</td>
- <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
- <td>repeated</td>
- <td><p>The taskRuns from the specified request. </p></td>
+ <td>start</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>start is the start character index (0-based) of the original value, should be less than end.
+Uses character indices (not byte offsets) for display-oriented masking.
+Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). </p></td>
+ </tr>
+
+ <tr>
+ <td>end</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>end is the end character index (exclusive) of the original value.
+Uses character indices (not byte offsets) for display-oriented masking. </p></td>
+ </tr>
+
+ <tr>
+ <td>substitution</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>
</tr>
</tbody>
@@ -26688,7 +26797,7 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</h3>
+ <h3 id="bytebase.v1.Announcement">Announcement</h3>
<p></p>
@@ -26699,10 +26808,24 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<tbody>
<tr>
- <td>name</td>
+ <td>level</td>
+ <td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td>
+ <td></td>
+ <td><p>The alert level of announcement </p></td>
+ </tr>
+
+ <tr>
+ <td>text</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>The text of announcement </p></td>
+ </tr>
+
+ <tr>
+ <td>link</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The optional link, user can follow the link to check extra details </p></td>
</tr>
</tbody>
@@ -26712,7 +26835,7 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</h3>
+ <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>
<p></p>
@@ -26723,10 +26846,10 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<tbody>
<tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The rollback SQL statement that would undo the task run. </p></td>
+ <td>settings</td>
+ <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26736,7 +26859,7 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.Rollout">Rollout</h3>
+ <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>
<p></p>
@@ -26747,38 +26870,22 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<tbody>
<tr>
- <td>name</td>
+ <td>client_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the rollout.
-Format: projects/{project}/plans/{plan}/rollout </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>client_secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the rollout, inherited from the associated plan.
-This field is output only and cannot be directly set. </p></td>
- </tr>
-
- <tr>
- <td>stages</td>
- <td><a href="#bytebase.v1.Stage">Stage</a></td>
- <td>repeated</td>
- <td><p>Stages and thus tasks of the rollout. </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>robot_code</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -26790,7 +26897,7 @@ This field is output only and cannot be directly set. </p></td>
- <h3 id="bytebase.v1.Stage">Stage</h3>
+ <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>
<p></p>
@@ -26801,35 +26908,17 @@ This field is output only and cannot be directly set. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}
-Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. </p></td>
- </tr>
-
- <tr>
- <td>id</td>
+ <td>app_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>id is the environment id of the stage.
-e.g., &#34;prod&#34;.
-Use &#34;-&#34; when the stage has no environment or deleted environment. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>environment</td>
+ <td>app_secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>environment is the environment of the stage.
-Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. </p></td>
- </tr>
-
- <tr>
- <td>tasks</td>
- <td><a href="#bytebase.v1.Task">Task</a></td>
- <td>repeated</td>
- <td><p>The tasks within this stage. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26839,7 +26928,7 @@ Format: environments/{environment} for valid environments, or &#34;environments/
- <h3 id="bytebase.v1.Task">Task</h3>
+ <h3 id="bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3>
<p></p>
@@ -26850,85 +26939,54 @@ Format: environments/{environment} for valid environments, or &#34;environments/
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
- </tr>
-
- <tr>
- <td>spec_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A UUID4 string that uniquely identifies the Spec. </p></td>
- </tr>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Task.Status">Task.Status</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>
<td></td>
- <td><p>Status is the status of the task. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>skipped_reason</td>
- <td><a href="#string">string</a></td>
+ <td>slack</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td>
<td></td>
- <td><p>The reason why the task was skipped. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Task.Type">Task.Type</a></td>
+ <td>feishu</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
+ <td>wecom</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>
<td></td>
- <td><p>Format: instances/{instance} if the task is DatabaseCreate.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>database_create</td>
- <td><a href="#bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</a></td>
+ <td>lark</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>database_update</td>
- <td><a href="#bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</a></td>
+ <td>dingtalk</td>
+ <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>database_data_export</td>
- <td><a href="#bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</a></td>
+ <td>teams</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td>
<td></td>
<td><p> </p></td>
</tr>
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The update_time is the update time of latest task run.
-If there are no task runs, it will be empty. </p></td>
- </tr>
-
- <tr>
- <td>run_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The run_time is the scheduled run time of latest task run.
-If there are no task runs or the task run is not scheduled, it will be empty. </p></td>
- </tr>
-
</tbody>
</table>
@@ -26936,8 +26994,8 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
- <h3 id="bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</h3>
- <p>Payload for creating a new database.</p>
+ <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3>
+ <p></p>
<table class="field-table">
@@ -26947,10 +27005,17 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
<tbody>
<tr>
- <td>sheet</td>
+ <td>app_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>app_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26960,8 +27025,8 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
- <h3 id="bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</h3>
- <p>Payload for exporting database data.</p>
+ <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3>
+ <p></p>
<table class="field-table">
@@ -26971,11 +27036,10 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
<tbody>
<tr>
- <td>sheet</td>
+ <td>token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -26985,8 +27049,8 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</h3>
- <p>Payload for updating a database schema.</p>
+ <h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</h3>
+ <p></p>
<table class="field-table">
@@ -26996,17 +27060,24 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tbody>
<tr>
- <td>sheet</td>
+ <td>tenant_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>Azure AD tenant ID (Directory ID). </p></td>
</tr>
<tr>
- <td>release</td>
+ <td>client_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/releases/{release} </p></td>
+ <td><p>Azure AD application (client) ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Azure AD client secret. </p></td>
</tr>
</tbody>
@@ -27016,7 +27087,7 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.v1.TaskRun">TaskRun</h3>
+ <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>
<p></p>
@@ -27027,84 +27098,24 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
+ <td>corp_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>agent_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.TaskRun.Status">TaskRun.Status</a></td>
- <td></td>
- <td><p>The current execution status of the task run. </p></td>
- </tr>
-
- <tr>
- <td>detail</td>
+ <td>secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Below are the results of a task run.
-Detailed information about the task run result. </p></td>
- </tr>
-
- <tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The time when the task run started execution. </p></td>
- </tr>
-
- <tr>
- <td>export_archive_status</td>
- <td><a href="#bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</a></td>
- <td></td>
- <td><p>The export archive status for data export tasks. </p></td>
- </tr>
-
- <tr>
- <td>has_prior_backup</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Indicates whether a prior backup was created for this task run.
-When true, rollback SQL can be generated via PreviewTaskRunRollback.
-Backup details are available in the task run logs. </p></td>
- </tr>
-
- <tr>
- <td>scheduler_info</td>
- <td><a href="#bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</a></td>
- <td></td>
- <td><p>Scheduling information about the task run. </p></td>
- </tr>
-
- <tr>
- <td>run_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The task run should run after run_time.
-This can only be set when creating the task run calling BatchRunTasks. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27114,8 +27125,8 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
- <h3 id="bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</h3>
- <p>Information about task run scheduling.</p>
+ <h3 id="bytebase.v1.DataClassificationSetting">DataClassificationSetting</h3>
+ <p></p>
<table class="field-table">
@@ -27125,17 +27136,10 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
<tbody>
<tr>
- <td>report_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The time when the scheduling info was reported. </p></td>
- </tr>
-
- <tr>
- <td>waiting_cause</td>
- <td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</a></td>
- <td></td>
- <td><p>The cause for the task run waiting. </p></td>
+ <td>configs</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27145,8 +27149,8 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
- <h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</h3>
- <p>Information about why a task run is waiting.</p>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3>
+ <p></p>
<table class="field-table">
@@ -27156,10 +27160,33 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
<tbody>
<tr>
- <td>parallel_tasks_limit</td>
- <td><a href="#bool">bool</a></td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Waiting due to parallel tasks limit. </p></td>
+ <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>levels</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</a></td>
+ <td>repeated</td>
+ <td><p>levels is user defined level list for classification.
+The order for the level decides its priority. </p></td>
+ </tr>
+
+ <tr>
+ <td>classification</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></td>
+ <td>repeated</td>
+ <td><p>classification is the id - DataClassification map.
+The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
</tr>
</tbody>
@@ -27169,7 +27196,7 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
- <h3 id="bytebase.v1.TaskRunLog">TaskRunLog</h3>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3>
<p></p>
@@ -27180,17 +27207,17 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>entries</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</a></td>
- <td>repeated</td>
- <td><p>The log entries for this task run. </p></td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27200,7 +27227,7 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</h3>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3>
<p></p>
@@ -27211,80 +27238,31 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</a></td>
- <td></td>
- <td><p>The type of this log entry. </p></td>
- </tr>
-
- <tr>
- <td>log_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The time when the log was recorded. </p></td>
- </tr>
-
- <tr>
- <td>replica_id</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The replica ID for this log entry. </p></td>
- </tr>
-
- <tr>
- <td>schema_dump</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</a></td>
- <td></td>
- <td><p>Schema dump details (if type is SCHEMA_DUMP). </p></td>
- </tr>
-
- <tr>
- <td>command_execute</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</a></td>
- <td></td>
- <td><p>Command execution details (if type is COMMAND_EXECUTE). </p></td>
- </tr>
-
- <tr>
- <td>database_sync</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</a></td>
- <td></td>
- <td><p>Database sync details (if type is DATABASE_SYNC). </p></td>
- </tr>
-
- <tr>
- <td>transaction_control</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</a></td>
- <td></td>
- <td><p>Transaction control details (if type is TRANSACTION_CONTROL). </p></td>
- </tr>
-
- <tr>
- <td>prior_backup</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</a></td>
- <td></td>
- <td><p>Prior backup details (if type is PRIOR_BACKUP). </p></td>
+ <td><p>id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
</tr>
<tr>
- <td>retry_info</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Retry information details (if type is RETRY_INFO). </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>compute_diff</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</a></td>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Compute diff details (if type is COMPUTE_DIFF). </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>release_file_execute</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</a></td>
- <td></td>
- <td><p>Release file execution details (if type is RELEASE_FILE_EXECUTE). </p></td>
+ <td>level_id</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27294,8 +27272,8 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</h3>
- <p>Command execution details.</p>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3>
+ <p></p>
<table class="field-table">
@@ -27305,33 +27283,48 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
<tbody>
<tr>
- <td>log_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When the command was logged. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>range</td>
- <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The byte offset range of the executed command in the sheet.
-Uses byte offsets (not character indices) for efficient slicing of sheet content bytes.
-Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>statement</td>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The executed statement. </p></td>
+ <td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>response</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</a></td>
- <td></td>
- <td><p>The response from executing the command. </p></td>
+ <td>environments</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27341,8 +27334,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</h3>
- <p>Command execution response.</p>
+ <h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3>
+ <p></p>
<table class="field-table">
@@ -27352,32 +27345,42 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>log_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When the response was logged. </p></td>
+ <td><p>The resource name of the environment.
+Format: environments/{environment}.
+Output only. </p></td>
</tr>
<tr>
- <td>error</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if command execution failed. </p></td>
+ <td><p>The resource id of the environment.
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
<tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Total affected rows. </p></td>
+ <td><p>The display name of the environment. </p></td>
</tr>
<tr>
- <td>all_affected_rows</td>
- <td><a href="#int64">int64</a></td>
+ <td>tags</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</a></td>
<td>repeated</td>
- <td><p>`all_affected_rows` is the affected rows of each command.
-`all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>color</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27387,8 +27390,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</h3>
- <p>Schema diff computation details.</p>
+ <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -27398,24 +27401,17 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When diff computation started. </p></td>
- </tr>
-
- <tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When diff computation ended. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>error</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if computation failed. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27425,8 +27421,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</h3>
- <p>Database synchronization details.</p>
+ <h3 id="bytebase.v1.GetSettingRequest">GetSettingRequest</h3>
+ <p>The request message for getting a setting.</p>
<table class="field-table">
@@ -27436,24 +27432,10 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the database sync started. </p></td>
- </tr>
-
- <tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the database sync ended. </p></td>
- </tr>
-
- <tr>
- <td>error</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if sync failed. </p></td>
+ <td><p>The resource name of the setting. </p></td>
</tr>
</tbody>
@@ -27463,8 +27445,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</h3>
- <p>Prior backup operation details.</p>
+ <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>
+ <p>The response message for getting a setting.</p>
<table class="field-table">
@@ -27474,31 +27456,10 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the backup started. </p></td>
- </tr>
-
- <tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the backup ended. </p></td>
- </tr>
-
- <tr>
- <td>prior_backup_detail</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</a></td>
- <td></td>
- <td><p>The backup details. </p></td>
- </tr>
-
- <tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
+ <td>setting</td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
<td></td>
- <td><p>Error message if the backup failed. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27508,8 +27469,15 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</h3>
- <p>Prior backup detail for rollback purposes.</p>
+ <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3>
+ <p></p>
<table class="field-table">
@@ -27519,10 +27487,10 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>items</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</a></td>
+ <td>settings</td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
<td>repeated</td>
- <td><p>The list of backed up tables. </p></td>
+ <td><p>The settings from the specified request. </p></td>
</tr>
</tbody>
@@ -27532,8 +27500,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</h3>
- <p>A single backup table mapping.</p>
+ <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>
+ <p></p>
<table class="field-table">
@@ -27543,31 +27511,10 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>source_table</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
- <td></td>
- <td><p>The original table information. </p></td>
- </tr>
-
- <tr>
- <td>target_table</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
- <td></td>
- <td><p>The target backup table information. </p></td>
- </tr>
-
- <tr>
- <td>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
- <td></td>
- <td><p>The start position in the SQL statement. </p></td>
- </tr>
-
- <tr>
- <td>end_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
- <td></td>
- <td><p>The end position in the SQL statement. </p></td>
+ <td>types</td>
+ <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27577,8 +27524,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</h3>
- <p>Table information.</p>
+ <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>
+ <p></p>
<table class="field-table">
@@ -27588,56 +27535,38 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>database</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The database information.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>id is the uuid for semantic type. </p></td>
</tr>
<tr>
- <td>schema</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema name. </p></td>
+ <td><p>the title of the semantic type, it should not be empty. </p></td>
</tr>
<tr>
- <td>table</td>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The table name. </p></td>
+ <td><p>the description of the semantic type, it can be empty. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</h3>
- <p>Release file execution details.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
+ <td>algorithm</td>
+ <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>
<td></td>
- <td><p>The version of the file being executed (e.g., &#34;0001&#34;). </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>file_path</td>
+ <td>icon</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). </p></td>
+ <td><p>icon is the icon for semantic type, it can be emoji or base64 encoded image. </p></td>
</tr>
</tbody>
@@ -27647,8 +27576,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</h3>
- <p>Retry information for failed operations.</p>
+ <h3 id="bytebase.v1.Setting">Setting</h3>
+ <p>The schema of setting.</p>
<table class="field-table">
@@ -27658,24 +27587,19 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>error</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The error that triggered the retry. </p></td>
- </tr>
-
- <tr>
- <td>retry_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Current retry attempt number. </p></td>
+ <td><p>The resource name of the setting.
+Format: settings/{setting}
+Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
</tr>
<tr>
- <td>maximum_retries</td>
- <td><a href="#int32">int32</a></td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.SettingValue">SettingValue</a></td>
<td></td>
- <td><p>Maximum number of retries allowed. </p></td>
+ <td><p>The configuration value of the setting. </p></td>
</tr>
</tbody>
@@ -27685,8 +27609,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</h3>
- <p>Schema dump operation details.</p>
+ <h3 id="bytebase.v1.SettingValue">SettingValue</h3>
+ <p>The data in setting value.</p>
<table class="field-table">
@@ -27696,24 +27620,52 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>app_im</td>
+ <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td>
<td></td>
- <td><p>When the schema dump started. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>workspace_profile</td>
+ <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>
<td></td>
- <td><p>When the schema dump ended. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
+ <td>workspace_approval</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td>
<td></td>
- <td><p>Error message if the schema dump failed. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>data_classification</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>semantic_type</td>
+ <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>ai</td>
+ <td><a href="#bytebase.v1.AISetting">AISetting</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27723,8 +27675,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</h3>
- <p>Transaction control operation details.</p>
+ <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>
+ <p>The request message for updating or creating a setting.</p>
<table class="field-table">
@@ -27734,17 +27686,32 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</a></td>
+ <td>setting</td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
<td></td>
- <td><p>The type of transaction control. </p></td>
+ <td><p>The setting to update. </p></td>
</tr>
<tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Error message if the operation failed. </p></td>
+ <td><p>validate_only is a flag to indicate whether to validate the setting value,
+server would not persist the setting value if it is true. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27754,7 +27721,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunSession">TaskRunSession</h3>
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3>
<p></p>
@@ -27765,17 +27732,10 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session </p></td>
- </tr>
-
- <tr>
- <td>postgres</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</a></td>
- <td></td>
- <td><p>PostgreSQL session information. </p></td>
+ <td>rules</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27785,8 +27745,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</h3>
- <p>PostgreSQL session information.</p>
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3>
+ <p></p>
<table class="field-table">
@@ -27796,24 +27756,50 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>session</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
+ <td>template</td>
+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
<td></td>
- <td><p>`session` is the session of the task run executing commands. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>blocking_sessions</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
- <td>repeated</td>
- <td><p>`blocking_sessions` block `session`. </p></td>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td></td>
+ <td><p>The condition that is associated with the rule.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+The `source` field filters which rules apply. The `condition` field then evaluates with full context.
+
+All supported variables:
+statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
+statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
+resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
+resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values.
+statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
+resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
+request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+
+When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*)
+When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name
+When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name
+When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
+
+For examples:
+resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100
+resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; </p></td>
</tr>
<tr>
- <td>blocked_sessions</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
- <td>repeated</td>
- <td><p>`blocked_sessions` are blocked by `session`. </p></td>
+ <td>source</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -27823,8 +27809,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</h3>
- <p>PostgreSQL session information read from `pg_stat_activity`.</p>
+ <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3>
+ <p></p>
<table class="field-table">
@@ -27834,101 +27820,197 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>pid</td>
+ <td>external_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Process ID of the session. </p></td>
+ <td><p>The external URL is used for sso authentication callback. </p></td>
</tr>
<tr>
- <td>blocked_by_pids</td>
+ <td>disallow_signup</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Disallow self-service signup, users can only be invited by the owner. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_2fa</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Require 2FA for all users. </p></td>
+ </tr>
+
+ <tr>
+ <td>refresh_token_duration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration for refresh token. Default is 7 days. </p></td>
+ </tr>
+
+ <tr>
+ <td>access_token_duration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration for access token. Default is 1 hour. </p></td>
+ </tr>
+
+ <tr>
+ <td>announcement</td>
+ <td><a href="#bytebase.v1.Announcement">Announcement</a></td>
+ <td></td>
+ <td><p>The setting of custom announcement </p></td>
+ </tr>
+
+ <tr>
+ <td>maximum_role_expiration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The max duration for role expired. </p></td>
+ </tr>
+
+ <tr>
+ <td>domains</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>PIDs of sessions blocking this session. </p></td>
+ <td><p>The workspace domain, e.g., bytebase.com. </p></td>
</tr>
<tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
+ <td>enforce_identity_domain</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Current query being executed. </p></td>
+ <td><p>Only user and group from the domains can be created and login. </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Session state (active, idle, etc.). </p></td>
+ <td>database_change_mode</td>
+ <td><a href="#bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</a></td>
+ <td></td>
+ <td><p>The workspace database change mode. </p></td>
+ </tr>
+
+ <tr>
+ <td>disallow_password_signin</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to disallow password signin. (Except workspace admins) </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_metric_collection</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enable metric collection for the workspace. </p></td>
+ </tr>
+
+ <tr>
+ <td>inactive_session_timeout</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_audit_log_stdout</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enable audit logging to stdout in structured JSON format.
+Requires TEAM or ENTERPRISE license. </p></td>
+ </tr>
+
+ <tr>
+ <td>watermark</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to display watermark on pages.
+Requires ENTERPRISE license. </p></td>
</tr>
<tr>
- <td>wait_event_type</td>
+ <td>directory_sync_token</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Wait event type if session is waiting. </p></td>
+ <td></td>
+ <td><p>The token for directory sync authentication. </p></td>
</tr>
<tr>
- <td>wait_event</td>
+ <td>branding_logo</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Specific wait event if session is waiting. </p></td>
+ <td></td>
+ <td><p>The branding logo as a data URI (e.g. data:image/png;base64,...). </p></td>
</tr>
<tr>
- <td>datname</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Database name. </p></td>
+ <td>password_restriction</td>
+ <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>
+ <td></td>
+ <td><p>Password restriction settings. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>usename</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>User name. </p></td>
+ <td>min_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>min_length is the minimum length for password, should no less than 8. </p></td>
</tr>
<tr>
- <td>application_name</td>
- <td><a href="#string">string</a></td>
+ <td>require_number</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Application name. </p></td>
+ <td><p>require_number requires the password must contains at least one number. </p></td>
</tr>
<tr>
- <td>client_addr</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Client IP address. </p></td>
+ <td>require_letter</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td>
</tr>
<tr>
- <td>client_port</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Client port number. </p></td>
+ <td>require_uppercase_letter</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>require_uppercase_letter requires the password must contains at least one upper case letter. </p></td>
</tr>
<tr>
- <td>backend_start</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>require_special_character</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>When the backend process started. </p></td>
+ <td><p>require_special_character requires the password must contains at least one special character. </p></td>
</tr>
<tr>
- <td>xact_start</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>When the current transaction started. </p></td>
+ <td>require_reset_password_for_first_login</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td>
</tr>
<tr>
- <td>query_start</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>When the current query started. </p></td>
+ <td>password_rotation</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>password_rotation requires users to reset their password after the duration. </p></td>
</tr>
</tbody>
@@ -27940,66 +28022,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.Task.Status">Task.Status</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>NOT_STARTED</td>
- <td>1</td>
- <td><p>Task has not started and is awaiting its turn in the deployment sequence.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>2</td>
- <td><p>Task is ready to run and waiting for approval or scheduled time.</p></td>
- </tr>
-
- <tr>
- <td>RUNNING</td>
- <td>3</td>
- <td><p>Task is currently executing.</p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>4</td>
- <td><p>Task completed successfully.</p></td>
- </tr>
-
- <tr>
- <td>FAILED</td>
- <td>5</td>
- <td><p>Task execution failed with errors.</p></td>
- </tr>
-
- <tr>
- <td>CANCELED</td>
- <td>6</td>
- <td><p>Task execution was canceled by a user.</p></td>
- </tr>
-
- <tr>
- <td>SKIPPED</td>
- <td>7</td>
- <td><p>Task was skipped and will not be executed.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Task.Type">Task.Type</h3>
+ <h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -28008,42 +28031,39 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>PROVIDER_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified task type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>GENERAL</td>
+ <td>OPEN_AI</td>
<td>1</td>
- <td><p>General task for miscellaneous operations.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DATABASE_CREATE</td>
+ <td>CLAUDE</td>
<td>2</td>
- <td><p>Database creation task that creates a new database.
-Use payload DatabaseCreate.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DATABASE_MIGRATE</td>
+ <td>GEMINI</td>
<td>3</td>
- <td><p>Database migration task that applies versioned schema changes.
-Use payload DatabaseUpdate.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DATABASE_EXPORT</td>
+ <td>AZURE_OPENAI</td>
<td>4</td>
- <td><p>Database export task that exports query results or table data.
-Use payload DatabaseDataExport.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</h3>
+ <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -28052,28 +28072,28 @@ Use payload DatabaseDataExport.</p></td>
<tbody>
<tr>
- <td>EXPORT_ARCHIVE_STATUS_UNSPECIFIED</td>
+ <td>MASK_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified export archive status.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>READY</td>
+ <td>INNER</td>
<td>1</td>
- <td><p>Export archive is ready for download.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>EXPORTED</td>
+ <td>OUTER</td>
<td>2</td>
- <td><p>Export archive has been downloaded by the user.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.TaskRun.Status">TaskRun.Status</h3>
- <p></p>
+ <h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3>
+ <p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -28081,52 +28101,34 @@ Use payload DatabaseDataExport.</p></td>
<tbody>
<tr>
- <td>STATUS_UNSPECIFIED</td>
+ <td>ALERT_LEVEL_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified status.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>PENDING</td>
+ <td>INFO</td>
<td>1</td>
- <td><p>Task run is queued and waiting to start execution.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>RUNNING</td>
+ <td>WARNING</td>
<td>2</td>
- <td><p>Task run is currently executing.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DONE</td>
+ <td>CRITICAL</td>
<td>3</td>
- <td><p>Task run completed successfully.</p></td>
- </tr>
-
- <tr>
- <td>FAILED</td>
- <td>4</td>
- <td><p>Task run execution failed with errors.</p></td>
- </tr>
-
- <tr>
- <td>CANCELED</td>
- <td>5</td>
- <td><p>Task run execution was canceled by a user.</p></td>
- </tr>
-
- <tr>
- <td>AVAILABLE</td>
- <td>6</td>
- <td><p>Task run is ready for immediate execution.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</h3>
- <p>Transaction control type.</p>
+ <h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -28134,34 +28136,29 @@ Use payload DatabaseDataExport.</p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>DATABASE_CHANGE_MODE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>BEGIN</td>
+ <td>PIPELINE</td>
<td>1</td>
- <td><p>Begin transaction.</p></td>
+ <td><p>A more advanced database change process, including custom approval workflows and other advanced features.
+Default to this mode.</p></td>
</tr>
<tr>
- <td>COMMIT</td>
+ <td>EDITOR</td>
<td>2</td>
- <td><p>Commit transaction.</p></td>
- </tr>
-
- <tr>
- <td>ROLLBACK</td>
- <td>3</td>
- <td><p>Rollback transaction.</p></td>
+ <td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</h3>
- <p>The type of log entry.</p>
+ <h3 id="bytebase.v1.Setting.SettingName">Setting.SettingName</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -28169,160 +28166,131 @@ Use payload DatabaseDataExport.</p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>SETTING_NAME_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>SCHEMA_DUMP</td>
+ <td>WORKSPACE_PROFILE</td>
<td>1</td>
- <td><p>Schema dump operation.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>COMMAND_EXECUTE</td>
+ <td>WORKSPACE_APPROVAL</td>
<td>2</td>
- <td><p>Command execution.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DATABASE_SYNC</td>
+ <td>APP_IM</td>
<td>3</td>
- <td><p>Database synchronization.</p></td>
- </tr>
-
- <tr>
- <td>TRANSACTION_CONTROL</td>
- <td>5</td>
- <td><p>Transaction control (BEGIN, COMMIT, ROLLBACK).</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>PRIOR_BACKUP</td>
- <td>6</td>
- <td><p>Prior backup operation.</p></td>
+ <td>AI</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>RETRY_INFO</td>
- <td>7</td>
- <td><p>Retry information.</p></td>
+ <td>DATA_CLASSIFICATION</td>
+ <td>5</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>COMPUTE_DIFF</td>
- <td>8</td>
- <td><p>Schema diff computation.</p></td>
+ <td>SEMANTIC_TYPES</td>
+ <td>6</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>RELEASE_FILE_EXECUTE</td>
- <td>9</td>
- <td><p>Release file execution.</p></td>
+ <td>ENVIRONMENT</td>
+ <td>7</td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h3 id="bytebase.v1.RolloutService">RolloutService</h3>
- <p>RolloutService manages the execution of deployment plans.</p>
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>GetRollout</td>
- <td><a href="#bytebase.v1.GetRolloutRequest">GetRolloutRequest</a></td>
- <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
- <td><p>Retrieves a rollout by its plan name.
-Permissions required: bb.rollouts.get</p></td>
- </tr>
-
- <tr>
- <td>ListRollouts</td>
- <td><a href="#bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</a></td>
- <td><a href="#bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</a></td>
- <td><p>Lists rollouts in a project.
-Permissions required: bb.rollouts.list</p></td>
- </tr>
-
- <tr>
- <td>CreateRollout</td>
- <td><a href="#bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</a></td>
- <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
- <td><p>Creates a new rollout for a plan.
-Permissions required: bb.rollouts.create</p></td>
+ <td>SOURCE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ListTaskRuns</td>
- <td><a href="#bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</a></td>
- <td><a href="#bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</a></td>
- <td><p>Lists task run executions for a task.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>CHANGE_DATABASE</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>GetTaskRun</td>
- <td><a href="#bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</a></td>
- <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
- <td><p>Retrieves a task run by name.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>CREATE_DATABASE</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>GetTaskRunLog</td>
- <td><a href="#bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</a></td>
- <td><a href="#bytebase.v1.TaskRunLog">TaskRunLog</a></td>
- <td><p>Retrieves execution logs for a task run.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>EXPORT_DATA</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>GetTaskRunSession</td>
- <td><a href="#bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</a></td>
- <td><a href="#bytebase.v1.TaskRunSession">TaskRunSession</a></td>
- <td><p>Retrieves database session information for a running task.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>REQUEST_ROLE</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
- <tr>
- <td>BatchRunTasks</td>
- <td><a href="#bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</a></td>
- <td><a href="#bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</a></td>
- <td><p>Executes multiple tasks in a rollout stage.
-Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SettingService">SettingService</h3>
+ <p>SettingService manages workspace-level settings and configurations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>BatchSkipTasks</td>
- <td><a href="#bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</a></td>
- <td><a href="#bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</a></td>
- <td><p>Skips multiple tasks in a rollout stage.
-Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ <td>ListSettings</td>
+ <td><a href="#bytebase.v1.ListSettingsRequest">ListSettingsRequest</a></td>
+ <td><a href="#bytebase.v1.ListSettingsResponse">ListSettingsResponse</a></td>
+ <td><p>Lists all workspace settings.
+Permissions required: bb.settings.list</p></td>
</tr>
<tr>
- <td>BatchCancelTaskRuns</td>
- <td><a href="#bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</a></td>
- <td><a href="#bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</a></td>
- <td><p>Cancels multiple running task executions.
-Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ <td>GetSetting</td>
+ <td><a href="#bytebase.v1.GetSettingRequest">GetSettingRequest</a></td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
+ <td><p>Retrieves a workspace setting by name.
+Permissions required: bb.settings.get</p></td>
</tr>
<tr>
- <td>PreviewTaskRunRollback</td>
- <td><a href="#bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</a></td>
- <td><a href="#bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</a></td>
- <td><p>Generates rollback SQL for a completed task run.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>UpdateSetting</td>
+ <td><a href="#bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</a></td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
+ <td><p>Updates a workspace setting.
+Permissions required: bb.settings.set</p></td>
</tr>
</tbody>
@@ -28346,59 +28314,9 @@ Permissions required: bb.taskRuns.list</p></td>
<tr>
- <td>GetRollout</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/plans/*/rollout}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListRollouts</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/rollouts</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateRollout</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*}/rollout</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListTaskRuns</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetTaskRun</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetTaskRunLog</td>
+ <td>ListSettings</td>
<td>GET</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/log</td>
+ <td>/v1/settings</td>
<td></td>
</tr>
@@ -28406,9 +28324,9 @@ Permissions required: bb.taskRuns.list</p></td>
<tr>
- <td>GetTaskRunSession</td>
+ <td>GetSetting</td>
<td>GET</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/session</td>
+ <td>/v1/{name=settings/*}</td>
<td></td>
</tr>
@@ -28416,40 +28334,10 @@ Permissions required: bb.taskRuns.list</p></td>
<tr>
- <td>BatchRunTasks</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchRun</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchSkipTasks</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchSkip</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchCancelTaskRuns</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns:batchCancel</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>PreviewTaskRunRollback</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}:previewRollback</td>
- <td>*</td>
+ <td>UpdateSetting</td>
+ <td>PATCH</td>
+ <td>/v1/{setting.name=settings/*}</td>
+ <td>setting</td>
</tr>
diff --git a/proto/v1/v1/actuator_service.proto b/proto/v1/v1/actuator_service.proto
index 69b3c75d51..dc151e7cc0 100644
--- a/proto/v1/v1/actuator_service.proto
+++ b/proto/v1/v1/actuator_service.proto
@@ -5,13 +5,11 @@ package bytebase.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
-import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "v1/annotation.proto";
import "v1/common.proto";
-import "v1/setting_service.proto";
import "v1/user_service.proto";
option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";
@@ -96,38 +94,6 @@ message UpdateActuatorInfoRequest {
// Request message for deleting cache.
message DeleteCacheRequest {}
-message Restriction {
- // Whether self-service user signup is disabled.
- bool disallow_signup = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Whether two-factor authentication is required for all users.
- bool require_2fa = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Whether password-based signin is disabled (except for workspace admins).
- bool disallow_password_signin = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Password complexity and restriction requirements.
- WorkspaceProfileSetting.PasswordRestriction password_restriction = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Whether to display watermark on pages.
- bool watermark = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The workspace database change mode.
- DatabaseChangeMode database_change_mode = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The session expiration time if not activity detected for the user. Value <= 0 means no limit.
- google.protobuf.Duration inactive_session_timeout = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The workspace domain, e.g., bytebase.com.
- repeated string domains = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Only user and group from the domains can be created and login.
- bool enforce_identity_domain = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The max duration for role expired.
- google.protobuf.Duration maximum_role_expiration = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
-
// System information and configuration for the Bytebase instance.
// Actuator concept is similar to the Spring Boot Actuator.
message ActuatorInfo {
@@ -199,12 +165,4 @@ message ActuatorInfo {
// Whether the external URL is set via command-line flag (and thus cannot be changed via UI).
bool external_url_from_flag = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The setting of custom announcement
- Announcement announcement = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Whether to enable metric collection for the workspace.
- bool enable_metric_collection = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- Restriction restriction = 26 [(google.api.field_behavior) = OUTPUT_ONLY];
}