Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix: skip drift detection on dump format version mismatch (#18406)
Vincent Huanga1531d9ae7b8
diff --git a/backend/api/v1/database_service_changelog.go b/backend/api/v1/database_service_changelog.goindex 00caeb8d2a..dc0d66a692 100644--- a/backend/api/v1/database_service_changelog.go+++ b/backend/api/v1/database_service_changelog.go@@ -12,7 +12,6 @@ import ("github.com/bytebase/bytebase/backend/common"storepb "github.com/bytebase/bytebase/backend/generated-go/store"v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"- "github.com/bytebase/bytebase/backend/plugin/schema""github.com/bytebase/bytebase/backend/store")@@ -25,14 +24,6 @@ func (s *DatabaseService) ListChangelogs(ctx context.Context, req *connect.Requereturn nil, connect.NewError(connect.CodeNotFound, errors.Errorf("database %q not found", req.Msg.Parent))}- instance, err := s.store.GetInstance(ctx, &store.FindInstanceMessage{ResourceID: &database.InstanceID})- if err != nil {- return nil, connect.NewError(connect.CodeInternal, err)- }- if instance == nil {- return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("instance %q not found", database.InstanceID))- }-offset, err := parseLimitAndOffset(&pageSize{token: req.Msg.PageToken,limit: int(req.Msg.PageSize),@@ -86,7 +77,7 @@ func (s *DatabaseService) ListChangelogs(ctx context.Context, req *connect.Reque}// no subsequent pages- converted := s.convertToChangelogs(database, changelogs, instance.Metadata.GetEngine())+ converted := s.convertToChangelogs(database, changelogs)return connect.NewResponse(&v1pb.ListChangelogsResponse{Changelogs: converted,NextPageToken: nextPageToken,@@ -136,45 +127,39 @@ func (s *DatabaseService) GetChangelog(ctx context.Context, req *connect.Requestreturn nil, connect.NewError(connect.CodeNotFound, errors.Errorf("database %q not found", databaseName))}- converted := s.convertToChangelog(database, changelog, instance.Metadata.GetEngine())+ converted := s.convertToChangelog(database, changelog)return connect.NewResponse(converted), nil}-func (s *DatabaseService) convertToChangelogs(d *store.DatabaseMessage, cs []*store.ChangelogMessage, engine storepb.Engine) []*v1pb.Changelog {+func (s *DatabaseService) convertToChangelogs(d *store.DatabaseMessage, cs []*store.ChangelogMessage) []*v1pb.Changelog {var changelogs []*v1pb.Changelogfor _, c := range cs {- changelog := s.convertToChangelog(d, c, engine)+ changelog := s.convertToChangelog(d, c)changelogs = append(changelogs, changelog)}return changelogs}-func (*DatabaseService) convertToChangelog(d *store.DatabaseMessage, c *store.ChangelogMessage, engine storepb.Engine) *v1pb.Changelog {+func (*DatabaseService) convertToChangelog(d *store.DatabaseMessage, c *store.ChangelogMessage) *v1pb.Changelog {changelogType := convertToChangelogType(c.Payload.GetType())- // Compute dump version mismatch- storedVersion := c.Payload.GetDumpVersion()- currentVersion := schema.GetDumpFormatVersion(engine)- dumpVersionMismatch := storedVersion != currentVersion-cl := &v1pb.Changelog{- Name: common.FormatChangelog(d.InstanceID, d.DatabaseName, c.UID),- CreateTime: timestamppb.New(c.CreatedAt),- Status: convertToChangelogStatus(c.Status),- Statement: "",- StatementSize: 0,- StatementSheet: "",- Schema: "",- SchemaSize: 0,- PrevSchema: "",- PrevSchemaSize: 0,- Issue: c.Payload.GetIssue(),- TaskRun: c.Payload.GetTaskRun(),- Version: c.Payload.GetVersion(),- Revision: "",- ChangedResources: convertToChangedResources(c.Payload.GetChangedResources()),- Type: changelogType,- DumpVersionMismatch: dumpVersionMismatch,+ Name: common.FormatChangelog(d.InstanceID, d.DatabaseName, c.UID),+ CreateTime: timestamppb.New(c.CreatedAt),+ Status: convertToChangelogStatus(c.Status),+ Statement: "",+ StatementSize: 0,+ StatementSheet: "",+ Schema: "",+ SchemaSize: 0,+ PrevSchema: "",+ PrevSchemaSize: 0,+ Issue: c.Payload.GetIssue(),+ TaskRun: c.Payload.GetTaskRun(),+ Version: c.Payload.GetVersion(),+ Revision: "",+ ChangedResources: convertToChangedResources(c.Payload.GetChangedResources()),+ Type: changelogType,}if sheet := c.Payload.GetSheet(); sheet != "" {diff --git a/backend/generated-go/store/setting.pb.go b/backend/generated-go/store/setting.pb.goindex 46e27f98ce..4456555e91 100644--- a/backend/generated-go/store/setting.pb.go+++ b/backend/generated-go/store/setting.pb.go@@ -2361,7 +2361,7 @@ var File_store_setting_proto protoreflect.FileDescriptorconst file_store_setting_proto_rawDesc = "" +"\n" +- "\x13store/setting.proto\x12\x0ebytebase.store\x1a\x1egoogle/protobuf/duration.proto\x1a\x16google/type/expr.proto\x1a\x14store/approval.proto\x1a\x12store/common.proto\x1a\x1bstore/project_webhook.proto\"m\n" ++ "\x13store/setting.proto\x12\x0ebytebase.store\x1a\x1egoogle/protobuf/duration.proto\x1a\x16google/type/expr.proto\x1a\x14store/approval.proto\x1a\x12store/common.proto\"m\n" +"\rSystemSetting\x12\x1f\n" +"\vauth_secret\x18\x01 \x01(\tR\n" +"authSecret\x12!\n" +@@ -2660,7 +2660,6 @@ func file_store_setting_proto_init() {}file_store_approval_proto_init()file_store_common_proto_init()- file_store_project_webhook_proto_init()file_store_setting_proto_msgTypes[4].OneofWrappers = []any{(*Algorithm_FullMask_)(nil),(*Algorithm_RangeMask_)(nil),diff --git a/backend/generated-go/v1/database_service.pb.go b/backend/generated-go/v1/database_service.pb.goindex 1291da2a13..ba5d219d6e 100644--- a/backend/generated-go/v1/database_service.pb.go+++ b/backend/generated-go/v1/database_service.pb.go@@ -5776,11 +5776,8 @@ type Changelog struct {Revision string `protobuf:"bytes,15,opt,name=revision,proto3" json:"revision,omitempty"`ChangedResources *ChangedResources `protobuf:"bytes,16,opt,name=changed_resources,json=changedResources,proto3" json:"changed_resources,omitempty"`Type Changelog_Type `protobuf:"varint,17,opt,name=type,proto3,enum=bytebase.v1.Changelog_Type" json:"type,omitempty"`- // True if this changelog's dump version differs from current engine dump version.- // When true and drift is detected, the drift may be a false positive from Bytebase upgrade.- DumpVersionMismatch bool `protobuf:"varint,18,opt,name=dump_version_mismatch,json=dumpVersionMismatch,proto3" json:"dump_version_mismatch,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *Changelog) Reset() {@@ -5925,13 +5922,6 @@ func (x *Changelog) GetType() Changelog_Type {return Changelog_TYPE_UNSPECIFIED}-func (x *Changelog) GetDumpVersionMismatch() bool {- if x != nil {- return x.DumpVersionMismatch- }- return false-}-type GetSchemaStringRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// The name of the database.@@ -6552,7 +6542,7 @@ const file_v1_database_service_proto_rawDesc = "" +"\x13GetChangelogRequest\x12:\n" +"\x04name\x18\x01 \x01(\tB&\xe0A\x02\xfaA \n" +"\x1ebytebase.com/DatabaseChangelogR\x04name\x12.\n" +- "\x04view\x18\x02 \x01(\x0e2\x1a.bytebase.v1.ChangelogViewR\x04view\"\x8b\a\n" ++ "\x04view\x18\x02 \x01(\x0e2\x1a.bytebase.v1.ChangelogViewR\x04view\"\xd7\x06\n" +"\tChangelog\x12\x12\n" +"\x04name\x18\x01 \x01(\tR\x04name\x12;\n" +"\vcreate_time\x18\x03 \x01(\v2\x1a.google.protobuf.TimestampR\n" +@@ -6573,8 +6563,7 @@ const file_v1_database_service_proto_rawDesc = "" +"\aversion\x18\x0e \x01(\tR\aversion\x12\x1a\n" +"\brevision\x18\x0f \x01(\tR\brevision\x12J\n" +"\x11changed_resources\x18\x10 \x01(\v2\x1d.bytebase.v1.ChangedResourcesR\x10changedResources\x12/\n" +- "\x04type\x18\x11 \x01(\x0e2\x1b.bytebase.v1.Changelog.TypeR\x04type\x122\n" +- "\x15dump_version_mismatch\x18\x12 \x01(\bR\x13dumpVersionMismatch\"C\n" ++ "\x04type\x18\x11 \x01(\x0e2\x1b.bytebase.v1.Changelog.TypeR\x04type\"C\n" +"\x06Status\x12\x16\n" +"\x12STATUS_UNSPECIFIED\x10\x00\x12\v\n" +"\aPENDING\x10\x01\x12\b\n" +diff --git a/backend/generated-go/v1/database_service_equal.pb.go b/backend/generated-go/v1/database_service_equal.pb.goindex c5f77876d9..cd2d122d22 100644--- a/backend/generated-go/v1/database_service_equal.pb.go+++ b/backend/generated-go/v1/database_service_equal.pb.go@@ -1893,9 +1893,6 @@ func (x *Changelog) Equal(y *Changelog) bool {if x.Type != y.Type {return false}- if x.DumpVersionMismatch != y.DumpVersionMismatch {- return false- }return true}diff --git a/backend/generated-go/v1/setting_service.pb.go b/backend/generated-go/v1/setting_service.pb.goindex dddcbdaac3..e0371d01d1 100644--- a/backend/generated-go/v1/setting_service.pb.go+++ b/backend/generated-go/v1/setting_service.pb.go@@ -2797,7 +2797,7 @@ var File_v1_setting_service_proto protoreflect.FileDescriptorconst file_v1_setting_service_proto_rawDesc = "" +"\n" +- "\x18v1/setting_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1egoogle/protobuf/duration.proto\x1a google/protobuf/field_mask.proto\x1a\x16google/type/expr.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a\x16v1/issue_service.proto\x1a\x18v1/project_service.proto\"\x15\n" ++ "\x18v1/setting_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1egoogle/protobuf/duration.proto\x1a google/protobuf/field_mask.proto\x1a\x16google/type/expr.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a\x16v1/issue_service.proto\"\x15\n" +"\x13ListSettingsRequest\"H\n" +"\x14ListSettingsResponse\x120\n" +"\bsettings\x18\x01 \x03(\v2\x14.bytebase.v1.SettingR\bsettings\"E\n" +@@ -3150,7 +3150,6 @@ func file_v1_setting_service_proto_init() {file_v1_annotation_proto_init()file_v1_common_proto_init()file_v1_issue_service_proto_init()- file_v1_project_service_proto_init()file_v1_setting_service_proto_msgTypes[6].OneofWrappers = []any{(*SettingValue_AppIm)(nil),(*SettingValue_WorkspaceProfile)(nil),diff --git a/backend/runner/schemasync/syncer.go b/backend/runner/schemasync/syncer.goindex 278cbdd347..37aefa4cfe 100644--- a/backend/runner/schemasync/syncer.go+++ b/backend/runner/schemasync/syncer.go@@ -490,35 +490,14 @@ func (s *Syncer) getSchemaDrifted(ctx context.Context, instance *store.InstanceMreturn false, errors.Errorf("expect sync history but get nil")}- // Get current dump version for this engine+ // Skip drift detection if dump format version changed to avoid false positives after Bytebase upgrade.currentVersion := schema.GetDumpFormatVersion(instance.Metadata.GetEngine())baselineVersion := changelog.Payload.GetDumpVersion()- versionMismatch := baselineVersion != currentVersion-- // Always compare schemas- latestSchema := string(rawDump)- drifted = changelog.Schema != latestSchema-- // If versions mismatch but schemas match, update the baseline version (auto-heal).- // This is safe because identical strings mean the format change didn't affect this database's output.- if versionMismatch && !drifted {- if err := s.store.UpdateChangelog(ctx, &store.UpdateChangelogMessage{- UID: changelog.UID,- DumpVersion: ¤tVersion,- }); err != nil {- slog.Warn("Failed to update changelog format version",- slog.String("database", database.DatabaseName),- log.BBError(err))- // Non-fatal: continue with drift detection result- } else {- slog.Info("Updated changelog format version (schemas match)",- slog.String("database", database.DatabaseName),- slog.Int("old_version", int(baselineVersion)),- slog.Int("new_version", int(currentVersion)))- }+ if baselineVersion != currentVersion {+ return false, nil}- return drifted, nil+ return changelog.Schema != rawDump, nil}func (s *Syncer) databaseBackupAvailable(ctx context.Context, instance *store.InstanceMessage, dbMetadata *storepb.DatabaseSchemaMetadata) bool {diff --git a/frontend/src/components/DatabaseDetail/DriftedDatabaseAlert.vue b/frontend/src/components/DatabaseDetail/DriftedDatabaseAlert.vueindex 9bf5d0b41b..7a7a31173d 100644--- a/frontend/src/components/DatabaseDetail/DriftedDatabaseAlert.vue+++ b/frontend/src/components/DatabaseDetail/DriftedDatabaseAlert.vue@@ -4,31 +4,26 @@type="warning":title="$t('database.drifted.schema-drift-detected.self')">- <div class="flex flex-col gap-2">- <div class="flex items-center justify-between gap-4">- <div class="flex-1">- {{ $t("database.drifted.schema-drift-detected.description") }}- <LearnMoreLink- class="ml-1"- url="https://docs.bytebase.com/change-database/drift-detection/?source=console"- />- </div>- <div class="flex justify-end items-center gap-x-2">- <NButton size="small" @click="state.showSchemaDiffModal = true">- {{ $t("database.drifted.view-diff") }}- </NButton>- <NButton- v-if="database.project !== DEFAULT_PROJECT_NAME"- size="small"- type="primary"- @click="updateDatabaseDrift"- >- {{ $t("database.drifted.new-baseline.self") }}- </NButton>- </div>+ <div class="flex items-center justify-between gap-4">+ <div class="flex-1">+ {{ $t("database.drifted.schema-drift-detected.description") }}+ <LearnMoreLink+ class="ml-1"+ url="https://docs.bytebase.com/change-database/drift-detection/?source=console"+ /></div>- <div v-if="formatVersionMismatch" class="text-sm text-gray-500">- {{ $t("database.drifted.format-version-mismatch-caveat") }}+ <div class="flex justify-end items-center gap-x-2">+ <NButton size="small" @click="state.showSchemaDiffModal = true">+ {{ $t("database.drifted.view-diff") }}+ </NButton>+ <NButton+ v-if="database.project !== DEFAULT_PROJECT_NAME"+ size="small"+ type="primary"+ @click="updateDatabaseDrift"+ >+ {{ $t("database.drifted.new-baseline.self") }}+ </NButton></div></div></NAlert>@@ -96,7 +91,6 @@ const state = reactive<LocalState>({const latestChangelogSchema = ref("-- Loading latest changelog schema...");const currentDatabaseSchema = ref("-- Loading current database schema...");-const formatVersionMismatch = ref(false);const updateDatabaseDrift = async () => {await databaseStore.updateDatabase(@@ -126,15 +120,12 @@ const fetchLatestChangelogSchema = async () => {const latestChangelog = changelogs[0];latestChangelogSchema.value =latestChangelog.schema || "-- No schema found in latest changelog";- formatVersionMismatch.value = latestChangelog.dumpVersionMismatch;} else {latestChangelogSchema.value = "-- No changelogs found for this database";- formatVersionMismatch.value = false;}} catch (error) {console.error("Failed to fetch changelog:", error);latestChangelogSchema.value = "-- Failed to load changelog schema";- formatVersionMismatch.value = false;}};diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.jsonindex 460fe51f0f..221f5993c0 100644--- a/frontend/src/locales/en-US.json+++ b/frontend/src/locales/en-US.json@@ -1779,7 +1779,6 @@"self": "Schema drift detected","description": "The schema is different from the last applied schema. This may cause application errors and should be resolved."},- "format-version-mismatch-caveat": "Note: If you recently upgraded Bytebase, this may be a false positive due to schema dump format changes.","new-baseline": {"self": "New baseline","successfully-established": "Successfully established new baseline"diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.jsonindex f0eddef395..581a24405f 100644--- a/frontend/src/locales/es-ES.json+++ b/frontend/src/locales/es-ES.json@@ -1779,7 +1779,6 @@"self": "Se detectó una desviación del esquema","description": "El esquema es diferente del último aplicado. Esto puede causar errores de aplicación y debe solucionarse."},- "format-version-mismatch-caveat": "Nota: Si actualizó Bytebase recientemente, esto puede ser un falso positivo debido a cambios en el formato de volcado del esquema.","new-baseline": {"self": "Nueva línea base","successfully-established": "Se estableció con éxito una nueva línea base"diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.jsonindex 72018694c7..e6f09c9440 100644--- a/frontend/src/locales/ja-JP.json+++ b/frontend/src/locales/ja-JP.json@@ -1779,7 +1779,6 @@"self": "スキーマドリフトが検出されました","description": "スキーマが最後に適用されたスキーマと異なります。アプリケーションエラーが発生する可能性があるため、解決する必要があります。"},- "format-version-mismatch-caveat": "注意:最近 Bytebase をアップグレードした場合、スキーマダンプ形式の変更により誤検知の可能性があります。","new-baseline": {"self": "新しいベースライン","successfully-established": "新しいベースラインを確立しました"diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.jsonindex 9bfd04b858..c50cc5393e 100644--- a/frontend/src/locales/vi-VN.json+++ b/frontend/src/locales/vi-VN.json@@ -1779,7 +1779,6 @@"self": "Đã phát hiện sự trôi dạt của sơ đồ","description": "Sơ đồ khác với sơ đồ được áp dụng lần cuối. Điều này có thể gây ra lỗi ứng dụng và cần được giải quyết."},- "format-version-mismatch-caveat": "Lưu ý: Nếu bạn vừa nâng cấp Bytebase, đây có thể là cảnh báo sai do thay đổi định dạng kết xuất schema.","new-baseline": {"self": "Đường cơ sở mới","successfully-established": "Đã thiết lập thành công đường cơ sở mới"diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.jsonindex beee0be960..31d27461da 100644--- a/frontend/src/locales/zh-CN.json+++ b/frontend/src/locales/zh-CN.json@@ -1779,7 +1779,6 @@"self": "检测到 Schema 偏差","description": "当前数据库 Schema 与 Bytebase 中记录的 Schema 不一致。请及时检查并修复以避免潜在问题。"},- "format-version-mismatch-caveat": "注意:如果您最近升级了 Bytebase,这可能是由于 Schema 转储格式变更导致的误报。","new-baseline": {"self": "建立新基线","successfully-established": "成功建立新的基线"diff --git a/frontend/src/types/proto-es/v1/database_service_pb.d.ts b/frontend/src/types/proto-es/v1/database_service_pb.d.tsindex b9c89a95c9..8c4b276869 100644--- a/frontend/src/types/proto-es/v1/database_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/database_service_pb.d.ts@@ -3290,14 +3290,6 @@ export declare type Changelog = Message<"bytebase.v1.Changelog"> & {* @generated from field: bytebase.v1.Changelog.Type type = 17;*/type: Changelog_Type;-- /**- * True if this changelog's dump version differs from current engine dump version.- * When true and drift is detected, the drift may be a false positive from Bytebase upgrade.- *- * @generated from field: bool dump_version_mismatch = 18;- */- dumpVersionMismatch: boolean;};/**diff --git a/frontend/src/types/proto-es/v1/database_service_pb.js b/frontend/src/types/proto-es/v1/database_service_pb.jsindex 65415d5746..90fe866442 100644--- a/frontend/src/types/proto-es/v1/database_service_pb.js+++ b/frontend/src/types/proto-es/v1/database_service_pb.js@@ -16,7 +16,7 @@ import { file_v1_instance_service } from "./instance_service_pb";* Describes the file v1/database_service.proto.*/export const file_v1_database_service = /*@__PURE__*/- fileDesc("Chl2MS9kYXRhYmFzZV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJBChJHZXREYXRhYmFzZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vRGF0YWJhc2UidwoYQmF0Y2hHZXREYXRhYmFzZXNSZXF1ZXN0Ei0KBnBhcmVudBgBIAEoCUId4EEC+kEXEhVieXRlYmFzZS5jb20vRGF0YWJhc2USLAoFbmFtZXMYAiADKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlIkUKGUJhdGNoR2V0RGF0YWJhc2VzUmVzcG9uc2USKAoJZGF0YWJhc2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuRGF0YWJhc2UikgEKFExpc3REYXRhYmFzZXNSZXF1ZXN0Ei0KBnBhcmVudBgBIAEoCUId4EEC+kEXEhVieXRlYmFzZS5jb20vRGF0YWJhc2USEQoJcGFnZV9zaXplGAIgASgFEhIKCnBhZ2VfdG9rZW4YAyABKAkSDgoGZmlsdGVyGAQgASgJEhQKDHNob3dfZGVsZXRlZBgFIAEoCCJaChVMaXN0RGF0YWJhc2VzUmVzcG9uc2USKAoJZGF0YWJhc2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuRGF0YWJhc2USFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIo0BChVVcGRhdGVEYXRhYmFzZVJlcXVlc3QSLAoIZGF0YWJhc2UYASABKAsyFS5ieXRlYmFzZS52MS5EYXRhYmFzZUID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg1hbGxvd19taXNzaW5nGAMgASgIImgKG0JhdGNoVXBkYXRlRGF0YWJhc2VzUmVxdWVzdBIOCgZwYXJlbnQYASABKAkSOQoIcmVxdWVzdHMYAiADKAsyIi5ieXRlYmFzZS52MS5VcGRhdGVEYXRhYmFzZVJlcXVlc3RCA+BBAiJIChxCYXRjaFVwZGF0ZURhdGFiYXNlc1Jlc3BvbnNlEigKCWRhdGFiYXNlcxgBIAMoCzIVLmJ5dGViYXNlLnYxLkRhdGFiYXNlIlkKGUJhdGNoU3luY0RhdGFiYXNlc1JlcXVlc3QSDgoGcGFyZW50GAEgASgJEiwKBW5hbWVzGAIgAygJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9EYXRhYmFzZSIcChpCYXRjaFN5bmNEYXRhYmFzZXNSZXNwb25zZSJCChNTeW5jRGF0YWJhc2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlIhYKFFN5bmNEYXRhYmFzZVJlc3BvbnNlInAKGkdldERhdGFiYXNlTWV0YWRhdGFSZXF1ZXN0EjMKBG5hbWUYASABKAlCJeBBAvpBHwodYnl0ZWJhc2UuY29tL0RhdGFiYXNlTWV0YWRhdGESDgoGZmlsdGVyGAIgASgJEg0KBWxpbWl0GAMgASgFIk0KGEdldERhdGFiYXNlU2NoZW1hUmVxdWVzdBIxCgRuYW1lGAEgASgJQiPgQQL6QR0KG2J5dGViYXNlLmNvbS9EYXRhYmFzZVNjaGVtYSLYAQobR2V0RGF0YWJhc2VTRExTY2hlbWFSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlEkIKBmZvcm1hdBgCIAEoDjIyLmJ5dGViYXNlLnYxLkdldERhdGFiYXNlU0RMU2NoZW1hUmVxdWVzdC5TRExGb3JtYXQiSAoJU0RMRm9ybWF0EhoKFlNETF9GT1JNQVRfVU5TUEVDSUZJRUQQABIPCgtTSU5HTEVfRklMRRABEg4KCk1VTFRJX0ZJTEUQAiJxChFEaWZmU2NoZW1hUmVxdWVzdBIrCgRuYW1lGAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9EYXRhYmFzZRIQCgZzY2hlbWEYAiABKAlIABITCgljaGFuZ2Vsb2cYAyABKAlIAEIICgZ0YXJnZXQiIgoSRGlmZlNjaGVtYVJlc3BvbnNlEgwKBGRpZmYYASABKAkiwgQKCERhdGFiYXNlEgwKBG5hbWUYASABKAkSJgoFc3RhdGUYAyABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZUID4EEDEj0KFHN1Y2Nlc3NmdWxfc3luY190aW1lGAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEg8KB3Byb2plY3QYBSABKAkSGwoOc2NoZW1hX3ZlcnNpb24YBiABKAlCA+BBAxIdCgtlbnZpcm9ubWVudBgHIAEoCUID4EEBSACIAQESJwoVZWZmZWN0aXZlX2Vudmlyb25tZW50GAggASgJQgPgQQNIAYgBARIxCgZsYWJlbHMYCSADKAsyIS5ieXRlYmFzZS52MS5EYXRhYmFzZS5MYWJlbHNFbnRyeRI9ChFpbnN0YW5jZV9yZXNvdXJjZRgKIAEoCzIdLmJ5dGViYXNlLnYxLkluc3RhbmNlUmVzb3VyY2VCA+BBAxIdChBiYWNrdXBfYXZhaWxhYmxlGAsgASgIQgPgQQMSFAoHZHJpZnRlZBgMIAEoCEID4EEDGi0KC0xhYmVsc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAE6RepBQgoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlEilpbnN0YW5jZXMve2luc3RhbmNlfS9kYXRhYmFzZXMve2RhdGFiYXNlfUIOCgxfZW52aXJvbm1lbnRCGAoWX2VmZmVjdGl2ZV9lbnZpcm9ubWVudEoECAIQAyKoAgoQRGF0YWJhc2VNZXRhZGF0YRIMCgRuYW1lGAEgASgJEiwKB3NjaGVtYXMYAiADKAsyGy5ieXRlYmFzZS52MS5TY2hlbWFNZXRhZGF0YRIVCg1jaGFyYWN0ZXJfc2V0GAMgASgJEhEKCWNvbGxhdGlvbhgEIAEoCRIyCgpleHRlbnNpb25zGAUgAygLMh4uYnl0ZWJhc2UudjEuRXh0ZW5zaW9uTWV0YWRhdGESDQoFb3duZXIYByABKAkSEwoLc2VhcmNoX3BhdGgYCCABKAk6VupBUwodYnl0ZWJhc2UuY29tL0RhdGFiYXNlTWV0YWRhdGESMmluc3RhbmNlcy97aW5zdGFuY2V9L2RhdGFiYXNlcy97ZGF0YWJhc2V9L21ldGFkYXRhIqYFCg5TY2hlbWFNZXRhZGF0YRIMCgRuYW1lGAEgASgJEioKBnRhYmxlcxgCIAMoCzIaLmJ5dGViYXNlLnYxLlRhYmxlTWV0YWRhdGESOwoPZXh0ZXJuYWxfdGFibGVzGAMgAygLMiIuYnl0ZWJhc2UudjEuRXh0ZXJuYWxUYWJsZU1ldGFkYXRhEigKBXZpZXdzGAQgAygLMhkuYnl0ZWJhc2UudjEuVmlld01ldGFkYXRhEjAKCWZ1bmN0aW9ucxgFIAMoCzIdLmJ5dGViYXNlLnYxLkZ1bmN0aW9uTWV0YWRhdGESMgoKcHJvY2VkdXJlcxgGIAMoCzIeLmJ5dGViYXNlLnYxLlByb2NlZHVyZU1ldGFkYXRhEiwKB3N0cmVhbXMYByADKAsyGy5ieXRlYmFzZS52MS5TdHJlYW1NZXRhZGF0YRIoCgV0YXNrcxgIIAMoCzIZLmJ5dGViYXNlLnYxLlRhc2tNZXRhZGF0YRJBChJtYXRlcmlhbGl6ZWRfdmlld3MYCSADKAsyJS5ieXRlYmFzZS52MS5NYXRlcmlhbGl6ZWRWaWV3TWV0YWRhdGESLgoIcGFja2FnZXMYCiADKAsyHC5ieXRlYmFzZS52MS5QYWNrYWdlTWV0YWRhdGESDQoFb3duZXIYCyABKAkSMAoJc2VxdWVuY2VzGA0gAygLMh0uYnl0ZWJhc2UudjEuU2VxdWVuY2VNZXRhZGF0YRIqCgZldmVudHMYDiADKAsyGi5ieXRlYmFzZS52MS5FdmVudE1ldGFkYXRhEjEKCmVudW1fdHlwZXMYDyADKAsyHS5ieXRlYmFzZS52MS5FbnVtVHlwZU1ldGFkYXRhEhEKCXNraXBfZHVtcBgQIAEoCBIPCgdjb21tZW50GBEgASgJIlQKEEVudW1UeXBlTWV0YWRhdGESDAoEbmFtZRgBIAEoCRIOCgZ2YWx1ZXMYAiADKAkSDwoHY29tbWVudBgDIAEoCRIRCglza2lwX2R1bXAYBCABKAgiowEKDUV2ZW50TWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgpkZWZpbml0aW9uGAIgASgJEhEKCXRpbWVfem9uZRgDIAEoCRIQCghzcWxfbW9kZRgEIAEoCRIcChRjaGFyYWN0ZXJfc2V0X2NsaWVudBgFIAEoCRIcChRjb2xsYXRpb25fY29ubmVjdGlvbhgGIAEoCRIPCgdjb21tZW50GAcgASgJIoECChBTZXF1ZW5jZU1ldGFkYXRhEgwKBG5hbWUYASABKAkSEQoJZGF0YV90eXBlGAIgASgJEg0KBXN0YXJ0GAMgASgJEhEKCW1pbl92YWx1ZRgEIAEoCRIRCgltYXhfdmFsdWUYBSABKAkSEQoJaW5jcmVtZW50GAYgASgJEg0KBWN5Y2xlGAcgASgIEhIKCmNhY2hlX3NpemUYCCABKAkSEgoKbGFzdF92YWx1ZRgJIAEoCRITCgtvd25lcl90YWJsZRgKIAEoCRIUCgxvd25lcl9jb2x1bW4YCyABKAkSDwoHY29tbWVudBgMIAEoCRIRCglza2lwX2R1bXAYDSABKAgivgEKD1RyaWdnZXJNZXRhZGF0YRIMCgRuYW1lGAEgASgJEg0KBWV2ZW50GAMgASgJEg4KBnRpbWluZxgEIAEoCRIMCgRib2R5GAUgASgJEhAKCHNxbF9tb2RlGAYgASgJEhwKFGNoYXJhY3Rlcl9zZXRfY2xpZW50GAcgASgJEhwKFGNvbGxhdGlvbl9jb25uZWN0aW9uGAggASgJEg8KB2NvbW1lbnQYCSABKAkSEQoJc2tpcF9kdW1wGAogASgIIpEBChVFeHRlcm5hbFRhYmxlTWV0YWRhdGESDAoEbmFtZRgBIAEoCRIcChRleHRlcm5hbF9zZXJ2ZXJfbmFtZRgCIAEoCRIeChZleHRlcm5hbF9kYXRhYmFzZV9uYW1lGAMgASgJEiwKB2NvbHVtbnMYBCADKAsyGy5ieXRlYmFzZS52MS5Db2x1bW5NZXRhZGF0YSLsBAoNVGFibGVNZXRhZGF0YRIMCgRuYW1lGAEgASgJEiwKB2NvbHVtbnMYAiADKAsyGy5ieXRlYmFzZS52MS5Db2x1bW5NZXRhZGF0YRIrCgdpbmRleGVzGAMgAygLMhouYnl0ZWJhc2UudjEuSW5kZXhNZXRhZGF0YRIOCgZlbmdpbmUYBCABKAkSEQoJY29sbGF0aW9uGAUgASgJEg8KB2NoYXJzZXQYESABKAkSEQoJcm93X2NvdW50GAYgASgDEhEKCWRhdGFfc2l6ZRgHIAEoAxISCgppbmRleF9zaXplGAggASgDEhEKCWRhdGFfZnJlZRgJIAEoAxIWCg5jcmVhdGVfb3B0aW9ucxgKIAEoCRIPCgdjb21tZW50GAsgASgJEjUKDGZvcmVpZ25fa2V5cxgMIAMoCzIfLmJ5dGViYXNlLnYxLkZvcmVpZ25LZXlNZXRhZGF0YRI3CgpwYXJ0aXRpb25zGA8gAygLMiMuYnl0ZWJhc2UudjEuVGFibGVQYXJ0aXRpb25NZXRhZGF0YRI/ChFjaGVja19jb25zdHJhaW50cxgQIAMoCzIkLmJ5dGViYXNlLnYxLkNoZWNrQ29uc3RyYWludE1ldGFkYXRhEg0KBW93bmVyGBIgASgJEhQKDHNvcnRpbmdfa2V5cxgTIAMoCRIuCgh0cmlnZ2VycxgUIAMoCzIcLmJ5dGViYXNlLnYxLlRyaWdnZXJNZXRhZGF0YRIRCglza2lwX2R1bXAYFSABKAgSFQoNc2hhcmRpbmdfaW5mbxgWIAEoCRIYChBwcmltYXJ5X2tleV90eXBlGBcgASgJIjsKF0NoZWNrQ29uc3RyYWludE1ldGFkYXRhEgwKBG5hbWUYASABKAkSEgoKZXhwcmVzc2lvbhgCIAEoCSLNAwoWVGFibGVQYXJ0aXRpb25NZXRhZGF0YRIMCgRuYW1lGAEgASgJEjYKBHR5cGUYAiABKA4yKC5ieXRlYmFzZS52MS5UYWJsZVBhcnRpdGlvbk1ldGFkYXRhLlR5cGUSEgoKZXhwcmVzc2lvbhgDIAEoCRINCgV2YWx1ZRgEIAEoCRITCgt1c2VfZGVmYXVsdBgFIAEoCRI6Cg1zdWJwYXJ0aXRpb25zGAYgAygLMiMuYnl0ZWJhc2UudjEuVGFibGVQYXJ0aXRpb25NZXRhZGF0YRIrCgdpbmRleGVzGAcgAygLMhouYnl0ZWJhc2UudjEuSW5kZXhNZXRhZGF0YRI/ChFjaGVja19jb25zdHJhaW50cxgIIAMoCzIkLmJ5dGViYXNlLnYxLkNoZWNrQ29uc3RyYWludE1ldGFkYXRhIooBCgRUeXBlEhQKEFRZUEVfVU5TUEVDSUZJRUQQABIJCgVSQU5HRRABEhEKDVJBTkdFX0NPTFVNTlMQAhIICgRMSVNUEAMSEAoMTElTVF9DT0xVTU5TEAQSCAoESEFTSBAFEg8KC0xJTkVBUl9IQVNIEAYSBwoDS0VZEAcSDgoKTElORUFSX0tFWRAIIp8ECg5Db2x1bW5NZXRhZGF0YRIMCgRuYW1lGAEgASgJEhAKCHBvc2l0aW9uGAIgASgFEhMKC2hhc19kZWZhdWx0GAMgASgIEg8KB2RlZmF1bHQYFyABKAkSFwoPZGVmYXVsdF9vbl9udWxsGBIgASgIEhEKCW9uX3VwZGF0ZRgPIAEoCRIQCghudWxsYWJsZRgHIAEoCBIMCgR0eXBlGAggASgJEhUKDWNoYXJhY3Rlcl9zZXQYCSABKAkSEQoJY29sbGF0aW9uGAogASgJEg8KB2NvbW1lbnQYCyABKAkSMwoKZ2VuZXJhdGlvbhgQIAEoCzIfLmJ5dGViYXNlLnYxLkdlbmVyYXRpb25NZXRhZGF0YRITCgtpc19pZGVudGl0eRgTIAEoCBJLChNpZGVudGl0eV9nZW5lcmF0aW9uGBEgASgOMi4uYnl0ZWJhc2UudjEuQ29sdW1uTWV0YWRhdGEuSWRlbnRpdHlHZW5lcmF0aW9uEhUKDWlkZW50aXR5X3NlZWQYFCABKAMSGgoSaWRlbnRpdHlfaW5jcmVtZW50GBUgASgDEh8KF2RlZmF1bHRfY29uc3RyYWludF9uYW1lGBYgASgJIlUKEklkZW50aXR5R2VuZXJhdGlvbhIjCh9JREVOVElUWV9HRU5FUkFUSU9OX1VOU1BFQ0lGSUVEEAASCgoGQUxXQVlTEAESDgoKQllfREVGQVVMVBACIpMBChJHZW5lcmF0aW9uTWV0YWRhdGESMgoEdHlwZRgBIAEoDjIkLmJ5dGViYXNlLnYxLkdlbmVyYXRpb25NZXRhZGF0YS5UeXBlEhIKCmV4cHJlc3Npb24YAiABKAkiNQoEVHlwZRIUChBUWVBFX1VOU1BFQ0lGSUVEEAASCwoHVklSVFVBTBABEgoKBlNUT1JFRBACIu0BCgxWaWV3TWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgpkZWZpbml0aW9uGAIgASgJEg8KB2NvbW1lbnQYAyABKAkSOQoSZGVwZW5kZW5jeV9jb2x1bW5zGAQgAygLMh0uYnl0ZWJhc2UudjEuRGVwZW5kZW5jeUNvbHVtbhIsCgdjb2x1bW5zGAUgAygLMhsuYnl0ZWJhc2UudjEuQ29sdW1uTWV0YWRhdGESLgoIdHJpZ2dlcnMYBiADKAsyHC5ieXRlYmFzZS52MS5UcmlnZ2VyTWV0YWRhdGESEQoJc2tpcF9kdW1wGAcgASgIIkEKEERlcGVuZGVuY3lDb2x1bW4SDgoGc2NoZW1hGAEgASgJEg0KBXRhYmxlGAIgASgJEg4KBmNvbHVtbhgDIAEoCSL4AQoYTWF0ZXJpYWxpemVkVmlld01ldGFkYXRhEgwKBG5hbWUYASABKAkSEgoKZGVmaW5pdGlvbhgCIAEoCRIPCgdjb21tZW50GAMgASgJEjkKEmRlcGVuZGVuY3lfY29sdW1ucxgEIAMoCzIdLmJ5dGViYXNlLnYxLkRlcGVuZGVuY3lDb2x1bW4SLgoIdHJpZ2dlcnMYBSADKAsyHC5ieXRlYmFzZS52MS5UcmlnZ2VyTWV0YWRhdGESKwoHaW5kZXhlcxgGIAMoCzIaLmJ5dGViYXNlLnYxLkluZGV4TWV0YWRhdGESEQoJc2tpcF9kdW1wGAcgASgIIjAKD0RlcGVuZGVuY3lUYWJsZRIOCgZzY2hlbWEYASABKAkSDQoFdGFibGUYAiABKAkijgIKEEZ1bmN0aW9uTWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgpkZWZpbml0aW9uGAIgASgJEhEKCXNpZ25hdHVyZRgDIAEoCRIcChRjaGFyYWN0ZXJfc2V0X2NsaWVudBgEIAEoCRIcChRjb2xsYXRpb25fY29ubmVjdGlvbhgFIAEoCRIaChJkYXRhYmFzZV9jb2xsYXRpb24YBiABKAkSEAoIc3FsX21vZGUYByABKAkSDwoHY29tbWVudBgIIAEoCRI3ChFkZXBlbmRlbmN5X3RhYmxlcxgJIAMoCzIcLmJ5dGViYXNlLnYxLkRlcGVuZGVuY3lUYWJsZRIRCglza2lwX2R1bXAYCiABKAgi1gEKEVByb2NlZHVyZU1ldGFkYXRhEgwKBG5hbWUYASABKAkSEgoKZGVmaW5pdGlvbhgCIAEoCRIRCglzaWduYXR1cmUYAyABKAkSHAoUY2hhcmFjdGVyX3NldF9jbGllbnQYBCABKAkSHAoUY29sbGF0aW9uX2Nvbm5lY3Rpb24YBSABKAkSGgoSZGF0YWJhc2VfY29sbGF0aW9uGAYgASgJEhAKCHNxbF9tb2RlGAcgASgJEg8KB2NvbW1lbnQYCSABKAkSEQoJc2tpcF9kdW1wGAggASgIIjMKD1BhY2thZ2VNZXRhZGF0YRIMCgRuYW1lGAEgASgJEhIKCmRlZmluaXRpb24YAiABKAkilgIKDFRhc2tNZXRhZGF0YRIMCgRuYW1lGAEgASgJEgoKAmlkGAIgASgJEg0KBW93bmVyGAMgASgJEg8KB2NvbW1lbnQYBCABKAkSEQoJd2FyZWhvdXNlGAUgASgJEhAKCHNjaGVkdWxlGAYgASgJEhQKDHByZWRlY2Vzc29ycxgHIAMoCRIuCgVzdGF0ZRgIIAEoDjIfLmJ5dGViYXNlLnYxLlRhc2tNZXRhZGF0YS5TdGF0ZRIRCgljb25kaXRpb24YCSABKAkSEgoKZGVmaW5pdGlvbhgKIAEoCSI6CgVTdGF0ZRIVChFTVEFURV9VTlNQRUNJRklFRBAAEgsKB1NUQVJURUQQARINCglTVVNQRU5ERUQQAiLLAgoOU3RyZWFtTWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgp0YWJsZV9uYW1lGAIgASgJEg0KBW93bmVyGAMgASgJEg8KB2NvbW1lbnQYBCABKAkSLgoEdHlwZRgFIAEoDjIgLmJ5dGViYXNlLnYxLlN0cmVhbU1ldGFkYXRhLlR5cGUSDQoFc3RhbGUYBiABKAgSLgoEbW9kZRgHIAEoDjIgLmJ5dGViYXNlLnYxLlN0cmVhbU1ldGFkYXRhLk1vZGUSEgoKZGVmaW5pdGlvbhgIIAEoCSInCgRUeXBlEhQKEFRZUEVfVU5TUEVDSUZJRUQQABIJCgVERUxUQRABIksKBE1vZGUSFAoQTU9ERV9VTlNQRUNJRklFRBAAEgsKB0RFRkFVTFQQARIPCgtBUFBFTkRfT05MWRACEg8KC0lOU0VSVF9PTkxZEAMivQEKElNwYXRpYWxJbmRleENvbmZpZxIOCgZtZXRob2QYASABKAkSNQoMdGVzc2VsbGF0aW9uGAIgASgLMh8uYnl0ZWJhc2UudjEuVGVzc2VsbGF0aW9uQ29uZmlnEisKB3N0b3JhZ2UYAyABKAsyGi5ieXRlYmFzZS52MS5TdG9yYWdlQ29uZmlnEjMKC2RpbWVuc2lvbmFsGAQgASgLMh4uYnl0ZWJhc2UudjEuRGltZW5zaW9uYWxDb25maWcimwEKElRlc3NlbGxhdGlvbkNvbmZpZxIOCgZzY2hlbWUYASABKAkSKwoLZ3JpZF9sZXZlbHMYAiADKAsyFi5ieXRlYmFzZS52MS5HcmlkTGV2ZWwSGAoQY2VsbHNfcGVyX29iamVjdBgDIAEoBRIuCgxib3VuZGluZ19ib3gYBCABKAsyGC5ieXRlYmFzZS52MS5Cb3VuZGluZ0JveCIrCglHcmlkTGV2ZWwSDQoFbGV2ZWwYASABKAUSDwoHZGVuc2l0eRgCIAEoCSJFCgtCb3VuZGluZ0JveBIMCgR4bWluGAEgASgBEgwKBHltaW4YAiABKAESDAoEeG1heBgDIAEoARIMCgR5bWF4GAQgASgBIr4CCg1TdG9yYWdlQ29uZmlnEhIKCmZpbGxmYWN0b3IYASABKAUSEQoJYnVmZmVyaW5nGAIgASgJEhIKCnRhYmxlc3BhY2UYAyABKAkSFwoPd29ya190YWJsZXNwYWNlGAQgASgJEhEKCXNkb19sZXZlbBgFIAEoBRIXCg9jb21taXRfaW50ZXJ2YWwYBiABKAUSEQoJcGFkX2luZGV4GAcgASgIEhYKDnNvcnRfaW5fdGVtcGRiGAggASgJEhUKDWRyb3BfZXhpc3RpbmcYCSABKAgSDgoGb25saW5lGAogASgIEhcKD2FsbG93X3Jvd19sb2NrcxgLIAEoCBIYChBhbGxvd19wYWdlX2xvY2tzGAwgASgIEg4KBm1heGRvcBgNIAEoBRIYChBkYXRhX2NvbXByZXNzaW9uGA4gASgJIn8KEURpbWVuc2lvbmFsQ29uZmlnEhIKCmRpbWVuc2lvbnMYASABKAUSEQoJZGF0YV90eXBlGAIgASgJEgwKBHNyaWQYAyABKAUSNQoLY29uc3RyYWludHMYBCADKAsyIC5ieXRlYmFzZS52MS5EaW1lbnNpb25Db25zdHJhaW50ImEKE0RpbWVuc2lvbkNvbnN0cmFpbnQSEQoJZGltZW5zaW9uGAEgASgJEhEKCW1pbl92YWx1ZRgCIAEoARIRCgltYXhfdmFsdWUYAyABKAESEQoJdG9sZXJhbmNlGAQgASgBIo0DCg1JbmRleE1ldGFkYXRhEgwKBG5hbWUYASABKAkSEwoLZXhwcmVzc2lvbnMYAiADKAkSEgoKa2V5X2xlbmd0aBgJIAMoAxISCgpkZXNjZW5kaW5nGAogAygIEgwKBHR5cGUYAyABKAkSDgoGdW5pcXVlGAQgASgIEg8KB3ByaW1hcnkYBSABKAgSDwoHdmlzaWJsZRgGIAEoCBIPCgdjb21tZW50GAcgASgJEhIKCmRlZmluaXRpb24YCCABKAkSGwoTcGFyZW50X2luZGV4X3NjaGVtYRgLIAEoCRIZChFwYXJlbnRfaW5kZXhfbmFtZRgMIAEoCRITCgtncmFudWxhcml0eRgNIAEoAxIVCg1pc19jb25zdHJhaW50GA4gASgIEjcKDnNwYXRpYWxfY29uZmlnGA8gASgLMh8uYnl0ZWJhc2UudjEuU3BhdGlhbEluZGV4Q29uZmlnEhUKDW9wY2xhc3NfbmFtZXMYECADKAkSGAoQb3BjbGFzc19kZWZhdWx0cxgRIAMoCCJXChFFeHRlbnNpb25NZXRhZGF0YRIMCgRuYW1lGAEgASgJEg4KBnNjaGVtYRgCIAEoCRIPCgd2ZXJzaW9uGAMgASgJEhMKC2Rlc2NyaXB0aW9uGAQgASgJIr4BChJGb3JlaWduS2V5TWV0YWRhdGESDAoEbmFtZRgBIAEoCRIPCgdjb2x1bW5zGAIgAygJEhkKEXJlZmVyZW5jZWRfc2NoZW1hGAMgASgJEhgKEHJlZmVyZW5jZWRfdGFibGUYBCABKAkSGgoScmVmZXJlbmNlZF9jb2x1bW5zGAUgAygJEhEKCW9uX2RlbGV0ZRgGIAEoCRIRCglvbl91cGRhdGUYByABKAkSEgoKbWF0Y2hfdHlwZRgIIAEoCSIgCg5EYXRhYmFzZVNjaGVtYRIOCgZzY2hlbWEYASABKAkiPgoRRGF0YWJhc2VTRExTY2hlbWESDgoGc2NoZW1hGAEgASgMEhkKDGNvbnRlbnRfdHlwZRgCIAEoCUID4EEDIksKEENoYW5nZWRSZXNvdXJjZXMSNwoJZGF0YWJhc2VzGAEgAygLMiQuYnl0ZWJhc2UudjEuQ2hhbmdlZFJlc291cmNlRGF0YWJhc2UiXAoXQ2hhbmdlZFJlc291cmNlRGF0YWJhc2USDAoEbmFtZRgBIAEoCRIzCgdzY2hlbWFzGAIgAygLMiIuYnl0ZWJhc2UudjEuQ2hhbmdlZFJlc291cmNlU2NoZW1hIv0BChVDaGFuZ2VkUmVzb3VyY2VTY2hlbWESDAoEbmFtZRgBIAEoCRIxCgZ0YWJsZXMYAiADKAsyIS5ieXRlYmFzZS52MS5DaGFuZ2VkUmVzb3VyY2VUYWJsZRIvCgV2aWV3cxgDIAMoCzIgLmJ5dGViYXNlLnYxLkNoYW5nZWRSZXNvdXJjZVZpZXcSNwoJZnVuY3Rpb25zGAQgAygLMiQuYnl0ZWJhc2UudjEuQ2hhbmdlZFJlc291cmNlRnVuY3Rpb24SOQoKcHJvY2VkdXJlcxgFIAMoCzIlLmJ5dGViYXNlLnYxLkNoYW5nZWRSZXNvdXJjZVByb2NlZHVyZSJIChRDaGFuZ2VkUmVzb3VyY2VUYWJsZRIMCgRuYW1lGAEgASgJEiIKBnJhbmdlcxgDIAMoCzISLmJ5dGViYXNlLnYxLlJhbmdlIkcKE0NoYW5nZWRSZXNvdXJjZVZpZXcSDAoEbmFtZRgBIAEoCRIiCgZyYW5nZXMYAiADKAsyEi5ieXRlYmFzZS52MS5SYW5nZSJLChdDaGFuZ2VkUmVzb3VyY2VGdW5jdGlvbhIMCgRuYW1lGAEgASgJEiIKBnJhbmdlcxgCIAMoCzISLmJ5dGViYXNlLnYxLlJhbmdlIkwKGENoYW5nZWRSZXNvdXJjZVByb2NlZHVyZRIMCgRuYW1lGAEgASgJEiIKBnJhbmdlcxgCIAMoCzISLmJ5dGViYXNlLnYxLlJhbmdlIqcBChVMaXN0Q2hhbmdlbG9nc1JlcXVlc3QSLQoGcGFyZW50GAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9EYXRhYmFzZRIRCglwYWdlX3NpemUYAiABKAUSEgoKcGFnZV90b2tlbhgDIAEoCRIoCgR2aWV3GAQgASgOMhouYnl0ZWJhc2UudjEuQ2hhbmdlbG9nVmlldxIOCgZmaWx0ZXIYBSABKAkiXQoWTGlzdENoYW5nZWxvZ3NSZXNwb25zZRIqCgpjaGFuZ2Vsb2dzGAEgAygLMhYuYnl0ZWJhc2UudjEuQ2hhbmdlbG9nEhcKD25leHRfcGFnZV90b2tlbhgCIAEoCSJ1ChNHZXRDaGFuZ2Vsb2dSZXF1ZXN0EjQKBG5hbWUYASABKAlCJuBBAvpBIAoeYnl0ZWJhc2UuY29tL0RhdGFiYXNlQ2hhbmdlbG9nEigKBHZpZXcYAiABKA4yGi5ieXRlYmFzZS52MS5DaGFuZ2Vsb2dWaWV3IscFCglDaGFuZ2Vsb2cSDAoEbmFtZRgBIAEoCRIvCgtjcmVhdGVfdGltZRgDIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLQoGc3RhdHVzGAQgASgOMh0uYnl0ZWJhc2UudjEuQ2hhbmdlbG9nLlN0YXR1cxIRCglzdGF0ZW1lbnQYBSABKAkSFgoOc3RhdGVtZW50X3NpemUYBiABKAMSFwoPc3RhdGVtZW50X3NoZWV0GAcgASgJEg4KBnNjaGVtYRgIIAEoCRITCgtzY2hlbWFfc2l6ZRgJIAEoAxITCgtwcmV2X3NjaGVtYRgKIAEoCRIYChBwcmV2X3NjaGVtYV9zaXplGAsgASgDEg0KBWlzc3VlGAwgASgJEhAKCHRhc2tfcnVuGA0gASgJEg8KB3ZlcnNpb24YDiABKAkSEAoIcmV2aXNpb24YDyABKAkSOAoRY2hhbmdlZF9yZXNvdXJjZXMYECABKAsyHS5ieXRlYmFzZS52MS5DaGFuZ2VkUmVzb3VyY2VzEikKBHR5cGUYESABKA4yGy5ieXRlYmFzZS52MS5DaGFuZ2Vsb2cuVHlwZRIdChVkdW1wX3ZlcnNpb25fbWlzbWF0Y2gYEiABKAgiQwoGU3RhdHVzEhYKElNUQVRVU19VTlNQRUNJRklFRBAAEgsKB1BFTkRJTkcQARIICgRET05FEAISCgoGRkFJTEVEEAMiQAoEVHlwZRIUChBUWVBFX1VOU1BFQ0lGSUVEEAASDAoIQkFTRUxJTkUQARILCgdNSUdSQVRFEAISBwoDU0RMEAM6ZepBYgoeYnl0ZWJhc2UuY29tL0RhdGFiYXNlQ2hhbmdlbG9nEkBpbnN0YW5jZXMve2luc3RhbmNlfS9kYXRhYmFzZXMve2RhdGFiYXNlfS9jaGFuZ2Vsb2dzL3tjaGFuZ2Vsb2d9IvECChZHZXRTY2hlbWFTdHJpbmdSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlEjwKBHR5cGUYAiABKA4yLi5ieXRlYmFzZS52MS5HZXRTY2hlbWFTdHJpbmdSZXF1ZXN0Lk9iamVjdFR5cGUSDgoGc2NoZW1hGAMgASgJEg4KBm9iamVjdBgEIAEoCRIvCghtZXRhZGF0YRgFIAEoCzIdLmJ5dGViYXNlLnYxLkRhdGFiYXNlTWV0YWRhdGEimgEKCk9iamVjdFR5cGUSGwoXT0JKRUNUX1RZUEVfVU5TUEVDSUZJRUQQABIMCghEQVRBQkFTRRABEgoKBlNDSEVNQRACEgkKBVRBQkxFEAMSCAoEVklFVxAEEhUKEU1BVEVSSUFMSVpFRF9WSUVXEAUSDAoIRlVOQ1RJT04QBhINCglQUk9DRURVUkUQBxIMCghTRVFVRU5DRRAIIjAKF0dldFNjaGVtYVN0cmluZ1Jlc3BvbnNlEhUKDXNjaGVtYV9zdHJpbmcYASABKAkqYgoNQ2hhbmdlbG9nVmlldxIeChpDSEFOR0VMT0dfVklFV19VTlNQRUNJRklFRBAAEhgKFENIQU5HRUxPR19WSUVXX0JBU0lDEAESFwoTQ0hBTkdFTE9HX1ZJRVdfRlVMTBACMuwUCg9EYXRhYmFzZVNlcnZpY2USkAEKC0dldERhdGFiYXNlEh8uYnl0ZWJhc2UudjEuR2V0RGF0YWJhc2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuRGF0YWJhc2UiSdpBBG5hbWWK6jAQYmIuZGF0YWJhc2VzLmdldJDqMAGC0+STAiQSIi92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKn0S3QEKEUJhdGNoR2V0RGF0YWJhc2VzEiUuYnl0ZWJhc2UudjEuQmF0Y2hHZXREYXRhYmFzZXNSZXF1ZXN0GiYuYnl0ZWJhc2UudjEuQmF0Y2hHZXREYXRhYmFzZXNSZXNwb25zZSJ5iuowEGJiLmRhdGFiYXNlcy5nZXSQ6jACgtPkkwJbWi0SKy92MS97cGFyZW50PWluc3RhbmNlcy8qfS9kYXRhYmFzZXM6YmF0Y2hHZXQSKi92MS97cGFyZW50PXByb2plY3RzLyp9L2RhdGFiYXNlczpiYXRjaEdldBLrAQoNTGlzdERhdGFiYXNlcxIhLmJ5dGViYXNlLnYxLkxpc3REYXRhYmFzZXNSZXF1ZXN0GiIuYnl0ZWJhc2UudjEuTGlzdERhdGFiYXNlc1Jlc3BvbnNlIpIB2kEAiuowEWJiLmRhdGFiYXNlcy5saXN0kOowAoLT5JMCcFokEiIvdjEve3BhcmVudD1pbnN0YW5jZXMvKn0vZGF0YWJhc2VzWiUSIy92MS97cGFyZW50PXdvcmtzcGFjZXMvKn0vZGF0YWJhc2VzEiEvdjEve3BhcmVudD1wcm9qZWN0cy8qfS9kYXRhYmFzZXMSwAEKDlVwZGF0ZURhdGFiYXNlEiIuYnl0ZWJhc2UudjEuVXBkYXRlRGF0YWJhc2VSZXF1ZXN0GhUuYnl0ZWJhc2UudjEuRGF0YWJhc2Uic9pBFGRhdGFiYXNlLHVwZGF0ZV9tYXNriuowE2JiLmRhdGFiYXNlcy51cGRhdGWQ6jABmOowAYLT5JMCNzoIZGF0YWJhc2UyKy92MS97ZGF0YWJhc2UubmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKn0SxQEKFEJhdGNoVXBkYXRlRGF0YWJhc2VzEiguYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVEYXRhYmFzZXNSZXF1ZXN0GikuYnl0ZWJhc2UudjEuQmF0Y2hVcGRhdGVEYXRhYmFzZXNSZXNwb25zZSJYiuowE2JiLmRhdGFiYXNlcy51cGRhdGWQ6jABmOowAYLT5JMCMzoBKiIuL3YxL3twYXJlbnQ9aW5zdGFuY2VzLyp9L2RhdGFiYXNlczpiYXRjaFVwZGF0ZRKgAQoMU3luY0RhdGFiYXNlEiAuYnl0ZWJhc2UudjEuU3luY0RhdGFiYXNlUmVxdWVzdBohLmJ5dGViYXNlLnYxLlN5bmNEYXRhYmFzZVJlc3BvbnNlIkuK6jARYmIuZGF0YWJhc2VzLnN5bmOQ6jABgtPkkwIsOgEqIicvdjEve25hbWU9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyp9OnN5bmMStwEKEkJhdGNoU3luY0RhdGFiYXNlcxImLmJ5dGViYXNlLnYxLkJhdGNoU3luY0RhdGFiYXNlc1JlcXVlc3QaJy5ieXRlYmFzZS52MS5CYXRjaFN5bmNEYXRhYmFzZXNSZXNwb25zZSJQiuowEWJiLmRhdGFiYXNlcy5zeW5jkOowAYLT5JMCMToBKiIsL3YxL3twYXJlbnQ9aW5zdGFuY2VzLyp9L2RhdGFiYXNlczpiYXRjaFN5bmMSsAEKE0dldERhdGFiYXNlTWV0YWRhdGESJy5ieXRlYmFzZS52MS5HZXREYXRhYmFzZU1ldGFkYXRhUmVxdWVzdBodLmJ5dGViYXNlLnYxLkRhdGFiYXNlTWV0YWRhdGEiUYrqMBZiYi5kYXRhYmFzZXMuZ2V0U2NoZW1hkOowAYLT5JMCLRIrL3YxL3tuYW1lPWluc3RhbmNlcy8qL2RhdGFiYXNlcy8qL21ldGFkYXRhfRKoAQoRR2V0RGF0YWJhc2VTY2hlbWESJS5ieXRlYmFzZS52MS5HZXREYXRhYmFzZVNjaGVtYVJlcXVlc3QaGy5ieXRlYmFzZS52MS5EYXRhYmFzZVNjaGVtYSJPiuowFmJiLmRhdGFiYXNlcy5nZXRTY2hlbWGQ6jABgtPkkwIrEikvdjEve25hbWU9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyovc2NoZW1hfRK0AQoUR2V0RGF0YWJhc2VTRExTY2hlbWESKC5ieXRlYmFzZS52MS5HZXREYXRhYmFzZVNETFNjaGVtYVJlcXVlc3QaHi5ieXRlYmFzZS52MS5EYXRhYmFzZVNETFNjaGVtYSJSiuowFmJiLmRhdGFiYXNlcy5nZXRTY2hlbWGQ6jABgtPkkwIuEiwvdjEve25hbWU9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyovc2RsU2NoZW1hfRLhAQoKRGlmZlNjaGVtYRIeLmJ5dGViYXNlLnYxLkRpZmZTY2hlbWFSZXF1ZXN0Gh8uYnl0ZWJhc2UudjEuRGlmZlNjaGVtYVJlc3BvbnNlIpEBiuowEGJiLmRhdGFiYXNlcy5nZXSQ6jABgtPkkwJzOgEqWj86ASoiOi92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKi9jaGFuZ2Vsb2dzLyp9OmRpZmZTY2hlbWEiLS92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKn06ZGlmZlNjaGVtYRK1AQoOTGlzdENoYW5nZWxvZ3MSIi5ieXRlYmFzZS52MS5MaXN0Q2hhbmdlbG9nc1JlcXVlc3QaIy5ieXRlYmFzZS52MS5MaXN0Q2hhbmdlbG9nc1Jlc3BvbnNlIlraQQZwYXJlbnSK6jASYmIuY2hhbmdlbG9ncy5saXN0kOowAYLT5JMCMRIvL3YxL3twYXJlbnQ9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyp9L2NoYW5nZWxvZ3MSoQEKDEdldENoYW5nZWxvZxIgLmJ5dGViYXNlLnYxLkdldENoYW5nZWxvZ1JlcXVlc3QaFi5ieXRlYmFzZS52MS5DaGFuZ2Vsb2ciV9pBBG5hbWWK6jARYmIuY2hhbmdlbG9ncy5nZXSQ6jABgtPkkwIxEi8vdjEve25hbWU9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyovY2hhbmdlbG9ncy8qfRK6AQoPR2V0U2NoZW1hU3RyaW5nEiMuYnl0ZWJhc2UudjEuR2V0U2NoZW1hU3RyaW5nUmVxdWVzdBokLmJ5dGViYXNlLnYxLkdldFNjaGVtYVN0cmluZ1Jlc3BvbnNlIlzaQQRuYW1liuowFmJiLmRhdGFiYXNlcy5nZXRTY2hlbWGQ6jABgtPkkwIxEi8vdjEve25hbWU9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyovc2NoZW1hU3RyaW5nfUKqAQoPY29tLmJ5dGViYXNlLnYxQhREYXRhYmFzZVNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_instance_service]);+ fileDesc("Chl2MS9kYXRhYmFzZV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJBChJHZXREYXRhYmFzZVJlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vRGF0YWJhc2UidwoYQmF0Y2hHZXREYXRhYmFzZXNSZXF1ZXN0Ei0KBnBhcmVudBgBIAEoCUId4EEC+kEXEhVieXRlYmFzZS5jb20vRGF0YWJhc2USLAoFbmFtZXMYAiADKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlIkUKGUJhdGNoR2V0RGF0YWJhc2VzUmVzcG9uc2USKAoJZGF0YWJhc2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuRGF0YWJhc2UikgEKFExpc3REYXRhYmFzZXNSZXF1ZXN0Ei0KBnBhcmVudBgBIAEoCUId4EEC+kEXEhVieXRlYmFzZS5jb20vRGF0YWJhc2USEQoJcGFnZV9zaXplGAIgASgFEhIKCnBhZ2VfdG9rZW4YAyABKAkSDgoGZmlsdGVyGAQgASgJEhQKDHNob3dfZGVsZXRlZBgFIAEoCCJaChVMaXN0RGF0YWJhc2VzUmVzcG9uc2USKAoJZGF0YWJhc2VzGAEgAygLMhUuYnl0ZWJhc2UudjEuRGF0YWJhc2USFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIo0BChVVcGRhdGVEYXRhYmFzZVJlcXVlc3QSLAoIZGF0YWJhc2UYASABKAsyFS5ieXRlYmFzZS52MS5EYXRhYmFzZUID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzaxIVCg1hbGxvd19taXNzaW5nGAMgASgIImgKG0JhdGNoVXBkYXRlRGF0YWJhc2VzUmVxdWVzdBIOCgZwYXJlbnQYASABKAkSOQoIcmVxdWVzdHMYAiADKAsyIi5ieXRlYmFzZS52MS5VcGRhdGVEYXRhYmFzZVJlcXVlc3RCA+BBAiJIChxCYXRjaFVwZGF0ZURhdGFiYXNlc1Jlc3BvbnNlEigKCWRhdGFiYXNlcxgBIAMoCzIVLmJ5dGViYXNlLnYxLkRhdGFiYXNlIlkKGUJhdGNoU3luY0RhdGFiYXNlc1JlcXVlc3QSDgoGcGFyZW50GAEgASgJEiwKBW5hbWVzGAIgAygJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9EYXRhYmFzZSIcChpCYXRjaFN5bmNEYXRhYmFzZXNSZXNwb25zZSJCChNTeW5jRGF0YWJhc2VSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlIhYKFFN5bmNEYXRhYmFzZVJlc3BvbnNlInAKGkdldERhdGFiYXNlTWV0YWRhdGFSZXF1ZXN0EjMKBG5hbWUYASABKAlCJeBBAvpBHwodYnl0ZWJhc2UuY29tL0RhdGFiYXNlTWV0YWRhdGESDgoGZmlsdGVyGAIgASgJEg0KBWxpbWl0GAMgASgFIk0KGEdldERhdGFiYXNlU2NoZW1hUmVxdWVzdBIxCgRuYW1lGAEgASgJQiPgQQL6QR0KG2J5dGViYXNlLmNvbS9EYXRhYmFzZVNjaGVtYSLYAQobR2V0RGF0YWJhc2VTRExTY2hlbWFSZXF1ZXN0EisKBG5hbWUYASABKAlCHeBBAvpBFwoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlEkIKBmZvcm1hdBgCIAEoDjIyLmJ5dGViYXNlLnYxLkdldERhdGFiYXNlU0RMU2NoZW1hUmVxdWVzdC5TRExGb3JtYXQiSAoJU0RMRm9ybWF0EhoKFlNETF9GT1JNQVRfVU5TUEVDSUZJRUQQABIPCgtTSU5HTEVfRklMRRABEg4KCk1VTFRJX0ZJTEUQAiJxChFEaWZmU2NoZW1hUmVxdWVzdBIrCgRuYW1lGAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9EYXRhYmFzZRIQCgZzY2hlbWEYAiABKAlIABITCgljaGFuZ2Vsb2cYAyABKAlIAEIICgZ0YXJnZXQiIgoSRGlmZlNjaGVtYVJlc3BvbnNlEgwKBGRpZmYYASABKAkiwgQKCERhdGFiYXNlEgwKBG5hbWUYASABKAkSJgoFc3RhdGUYAyABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZUID4EEDEj0KFHN1Y2Nlc3NmdWxfc3luY190aW1lGAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEg8KB3Byb2plY3QYBSABKAkSGwoOc2NoZW1hX3ZlcnNpb24YBiABKAlCA+BBAxIdCgtlbnZpcm9ubWVudBgHIAEoCUID4EEBSACIAQESJwoVZWZmZWN0aXZlX2Vudmlyb25tZW50GAggASgJQgPgQQNIAYgBARIxCgZsYWJlbHMYCSADKAsyIS5ieXRlYmFzZS52MS5EYXRhYmFzZS5MYWJlbHNFbnRyeRI9ChFpbnN0YW5jZV9yZXNvdXJjZRgKIAEoCzIdLmJ5dGViYXNlLnYxLkluc3RhbmNlUmVzb3VyY2VCA+BBAxIdChBiYWNrdXBfYXZhaWxhYmxlGAsgASgIQgPgQQMSFAoHZHJpZnRlZBgMIAEoCEID4EEDGi0KC0xhYmVsc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAE6RepBQgoVYnl0ZWJhc2UuY29tL0RhdGFiYXNlEilpbnN0YW5jZXMve2luc3RhbmNlfS9kYXRhYmFzZXMve2RhdGFiYXNlfUIOCgxfZW52aXJvbm1lbnRCGAoWX2VmZmVjdGl2ZV9lbnZpcm9ubWVudEoECAIQAyKoAgoQRGF0YWJhc2VNZXRhZGF0YRIMCgRuYW1lGAEgASgJEiwKB3NjaGVtYXMYAiADKAsyGy5ieXRlYmFzZS52MS5TY2hlbWFNZXRhZGF0YRIVCg1jaGFyYWN0ZXJfc2V0GAMgASgJEhEKCWNvbGxhdGlvbhgEIAEoCRIyCgpleHRlbnNpb25zGAUgAygLMh4uYnl0ZWJhc2UudjEuRXh0ZW5zaW9uTWV0YWRhdGESDQoFb3duZXIYByABKAkSEwoLc2VhcmNoX3BhdGgYCCABKAk6VupBUwodYnl0ZWJhc2UuY29tL0RhdGFiYXNlTWV0YWRhdGESMmluc3RhbmNlcy97aW5zdGFuY2V9L2RhdGFiYXNlcy97ZGF0YWJhc2V9L21ldGFkYXRhIqYFCg5TY2hlbWFNZXRhZGF0YRIMCgRuYW1lGAEgASgJEioKBnRhYmxlcxgCIAMoCzIaLmJ5dGViYXNlLnYxLlRhYmxlTWV0YWRhdGESOwoPZXh0ZXJuYWxfdGFibGVzGAMgAygLMiIuYnl0ZWJhc2UudjEuRXh0ZXJuYWxUYWJsZU1ldGFkYXRhEigKBXZpZXdzGAQgAygLMhkuYnl0ZWJhc2UudjEuVmlld01ldGFkYXRhEjAKCWZ1bmN0aW9ucxgFIAMoCzIdLmJ5dGViYXNlLnYxLkZ1bmN0aW9uTWV0YWRhdGESMgoKcHJvY2VkdXJlcxgGIAMoCzIeLmJ5dGViYXNlLnYxLlByb2NlZHVyZU1ldGFkYXRhEiwKB3N0cmVhbXMYByADKAsyGy5ieXRlYmFzZS52MS5TdHJlYW1NZXRhZGF0YRIoCgV0YXNrcxgIIAMoCzIZLmJ5dGViYXNlLnYxLlRhc2tNZXRhZGF0YRJBChJtYXRlcmlhbGl6ZWRfdmlld3MYCSADKAsyJS5ieXRlYmFzZS52MS5NYXRlcmlhbGl6ZWRWaWV3TWV0YWRhdGESLgoIcGFja2FnZXMYCiADKAsyHC5ieXRlYmFzZS52MS5QYWNrYWdlTWV0YWRhdGESDQoFb3duZXIYCyABKAkSMAoJc2VxdWVuY2VzGA0gAygLMh0uYnl0ZWJhc2UudjEuU2VxdWVuY2VNZXRhZGF0YRIqCgZldmVudHMYDiADKAsyGi5ieXRlYmFzZS52MS5FdmVudE1ldGFkYXRhEjEKCmVudW1fdHlwZXMYDyADKAsyHS5ieXRlYmFzZS52MS5FbnVtVHlwZU1ldGFkYXRhEhEKCXNraXBfZHVtcBgQIAEoCBIPCgdjb21tZW50GBEgASgJIlQKEEVudW1UeXBlTWV0YWRhdGESDAoEbmFtZRgBIAEoCRIOCgZ2YWx1ZXMYAiADKAkSDwoHY29tbWVudBgDIAEoCRIRCglza2lwX2R1bXAYBCABKAgiowEKDUV2ZW50TWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgpkZWZpbml0aW9uGAIgASgJEhEKCXRpbWVfem9uZRgDIAEoCRIQCghzcWxfbW9kZRgEIAEoCRIcChRjaGFyYWN0ZXJfc2V0X2NsaWVudBgFIAEoCRIcChRjb2xsYXRpb25fY29ubmVjdGlvbhgGIAEoCRIPCgdjb21tZW50GAcgASgJIoECChBTZXF1ZW5jZU1ldGFkYXRhEgwKBG5hbWUYASABKAkSEQoJZGF0YV90eXBlGAIgASgJEg0KBXN0YXJ0GAMgASgJEhEKCW1pbl92YWx1ZRgEIAEoCRIRCgltYXhfdmFsdWUYBSABKAkSEQoJaW5jcmVtZW50GAYgASgJEg0KBWN5Y2xlGAcgASgIEhIKCmNhY2hlX3NpemUYCCABKAkSEgoKbGFzdF92YWx1ZRgJIAEoCRITCgtvd25lcl90YWJsZRgKIAEoCRIUCgxvd25lcl9jb2x1bW4YCyABKAkSDwoHY29tbWVudBgMIAEoCRIRCglza2lwX2R1bXAYDSABKAgivgEKD1RyaWdnZXJNZXRhZGF0YRIMCgRuYW1lGAEgASgJEg0KBWV2ZW50GAMgASgJEg4KBnRpbWluZxgEIAEoCRIMCgRib2R5GAUgASgJEhAKCHNxbF9tb2RlGAYgASgJEhwKFGNoYXJhY3Rlcl9zZXRfY2xpZW50GAcgASgJEhwKFGNvbGxhdGlvbl9jb25uZWN0aW9uGAggASgJEg8KB2NvbW1lbnQYCSABKAkSEQoJc2tpcF9kdW1wGAogASgIIpEBChVFeHRlcm5hbFRhYmxlTWV0YWRhdGESDAoEbmFtZRgBIAEoCRIcChRleHRlcm5hbF9zZXJ2ZXJfbmFtZRgCIAEoCRIeChZleHRlcm5hbF9kYXRhYmFzZV9uYW1lGAMgASgJEiwKB2NvbHVtbnMYBCADKAsyGy5ieXRlYmFzZS52MS5Db2x1bW5NZXRhZGF0YSLsBAoNVGFibGVNZXRhZGF0YRIMCgRuYW1lGAEgASgJEiwKB2NvbHVtbnMYAiADKAsyGy5ieXRlYmFzZS52MS5Db2x1bW5NZXRhZGF0YRIrCgdpbmRleGVzGAMgAygLMhouYnl0ZWJhc2UudjEuSW5kZXhNZXRhZGF0YRIOCgZlbmdpbmUYBCABKAkSEQoJY29sbGF0aW9uGAUgASgJEg8KB2NoYXJzZXQYESABKAkSEQoJcm93X2NvdW50GAYgASgDEhEKCWRhdGFfc2l6ZRgHIAEoAxISCgppbmRleF9zaXplGAggASgDEhEKCWRhdGFfZnJlZRgJIAEoAxIWCg5jcmVhdGVfb3B0aW9ucxgKIAEoCRIPCgdjb21tZW50GAsgASgJEjUKDGZvcmVpZ25fa2V5cxgMIAMoCzIfLmJ5dGViYXNlLnYxLkZvcmVpZ25LZXlNZXRhZGF0YRI3CgpwYXJ0aXRpb25zGA8gAygLMiMuYnl0ZWJhc2UudjEuVGFibGVQYXJ0aXRpb25NZXRhZGF0YRI/ChFjaGVja19jb25zdHJhaW50cxgQIAMoCzIkLmJ5dGViYXNlLnYxLkNoZWNrQ29uc3RyYWludE1ldGFkYXRhEg0KBW93bmVyGBIgASgJEhQKDHNvcnRpbmdfa2V5cxgTIAMoCRIuCgh0cmlnZ2VycxgUIAMoCzIcLmJ5dGViYXNlLnYxLlRyaWdnZXJNZXRhZGF0YRIRCglza2lwX2R1bXAYFSABKAgSFQoNc2hhcmRpbmdfaW5mbxgWIAEoCRIYChBwcmltYXJ5X2tleV90eXBlGBcgASgJIjsKF0NoZWNrQ29uc3RyYWludE1ldGFkYXRhEgwKBG5hbWUYASABKAkSEgoKZXhwcmVzc2lvbhgCIAEoCSLNAwoWVGFibGVQYXJ0aXRpb25NZXRhZGF0YRIMCgRuYW1lGAEgASgJEjYKBHR5cGUYAiABKA4yKC5ieXRlYmFzZS52MS5UYWJsZVBhcnRpdGlvbk1ldGFkYXRhLlR5cGUSEgoKZXhwcmVzc2lvbhgDIAEoCRINCgV2YWx1ZRgEIAEoCRITCgt1c2VfZGVmYXVsdBgFIAEoCRI6Cg1zdWJwYXJ0aXRpb25zGAYgAygLMiMuYnl0ZWJhc2UudjEuVGFibGVQYXJ0aXRpb25NZXRhZGF0YRIrCgdpbmRleGVzGAcgAygLMhouYnl0ZWJhc2UudjEuSW5kZXhNZXRhZGF0YRI/ChFjaGVja19jb25zdHJhaW50cxgIIAMoCzIkLmJ5dGViYXNlLnYxLkNoZWNrQ29uc3RyYWludE1ldGFkYXRhIooBCgRUeXBlEhQKEFRZUEVfVU5TUEVDSUZJRUQQABIJCgVSQU5HRRABEhEKDVJBTkdFX0NPTFVNTlMQAhIICgRMSVNUEAMSEAoMTElTVF9DT0xVTU5TEAQSCAoESEFTSBAFEg8KC0xJTkVBUl9IQVNIEAYSBwoDS0VZEAcSDgoKTElORUFSX0tFWRAIIp8ECg5Db2x1bW5NZXRhZGF0YRIMCgRuYW1lGAEgASgJEhAKCHBvc2l0aW9uGAIgASgFEhMKC2hhc19kZWZhdWx0GAMgASgIEg8KB2RlZmF1bHQYFyABKAkSFwoPZGVmYXVsdF9vbl9udWxsGBIgASgIEhEKCW9uX3VwZGF0ZRgPIAEoCRIQCghudWxsYWJsZRgHIAEoCBIMCgR0eXBlGAggASgJEhUKDWNoYXJhY3Rlcl9zZXQYCSABKAkSEQoJY29sbGF0aW9uGAogASgJEg8KB2NvbW1lbnQYCyABKAkSMwoKZ2VuZXJhdGlvbhgQIAEoCzIfLmJ5dGViYXNlLnYxLkdlbmVyYXRpb25NZXRhZGF0YRITCgtpc19pZGVudGl0eRgTIAEoCBJLChNpZGVudGl0eV9nZW5lcmF0aW9uGBEgASgOMi4uYnl0ZWJhc2UudjEuQ29sdW1uTWV0YWRhdGEuSWRlbnRpdHlHZW5lcmF0aW9uEhUKDWlkZW50aXR5X3NlZWQYFCABKAMSGgoSaWRlbnRpdHlfaW5jcmVtZW50GBUgASgDEh8KF2RlZmF1bHRfY29uc3RyYWludF9uYW1lGBYgASgJIlUKEklkZW50aXR5R2VuZXJhdGlvbhIjCh9JREVOVElUWV9HRU5FUkFUSU9OX1VOU1BFQ0lGSUVEEAASCgoGQUxXQVlTEAESDgoKQllfREVGQVVMVBACIpMBChJHZW5lcmF0aW9uTWV0YWRhdGESMgoEdHlwZRgBIAEoDjIkLmJ5dGViYXNlLnYxLkdlbmVyYXRpb25NZXRhZGF0YS5UeXBlEhIKCmV4cHJlc3Npb24YAiABKAkiNQoEVHlwZRIUChBUWVBFX1VOU1BFQ0lGSUVEEAASCwoHVklSVFVBTBABEgoKBlNUT1JFRBACIu0BCgxWaWV3TWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgpkZWZpbml0aW9uGAIgASgJEg8KB2NvbW1lbnQYAyABKAkSOQoSZGVwZW5kZW5jeV9jb2x1bW5zGAQgAygLMh0uYnl0ZWJhc2UudjEuRGVwZW5kZW5jeUNvbHVtbhIsCgdjb2x1bW5zGAUgAygLMhsuYnl0ZWJhc2UudjEuQ29sdW1uTWV0YWRhdGESLgoIdHJpZ2dlcnMYBiADKAsyHC5ieXRlYmFzZS52MS5UcmlnZ2VyTWV0YWRhdGESEQoJc2tpcF9kdW1wGAcgASgIIkEKEERlcGVuZGVuY3lDb2x1bW4SDgoGc2NoZW1hGAEgASgJEg0KBXRhYmxlGAIgASgJEg4KBmNvbHVtbhgDIAEoCSL4AQoYTWF0ZXJpYWxpemVkVmlld01ldGFkYXRhEgwKBG5hbWUYASABKAkSEgoKZGVmaW5pdGlvbhgCIAEoCRIPCgdjb21tZW50GAMgASgJEjkKEmRlcGVuZGVuY3lfY29sdW1ucxgEIAMoCzIdLmJ5dGViYXNlLnYxLkRlcGVuZGVuY3lDb2x1bW4SLgoIdHJpZ2dlcnMYBSADKAsyHC5ieXRlYmFzZS52MS5UcmlnZ2VyTWV0YWRhdGESKwoHaW5kZXhlcxgGIAMoCzIaLmJ5dGViYXNlLnYxLkluZGV4TWV0YWRhdGESEQoJc2tpcF9kdW1wGAcgASgIIjAKD0RlcGVuZGVuY3lUYWJsZRIOCgZzY2hlbWEYASABKAkSDQoFdGFibGUYAiABKAkijgIKEEZ1bmN0aW9uTWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgpkZWZpbml0aW9uGAIgASgJEhEKCXNpZ25hdHVyZRgDIAEoCRIcChRjaGFyYWN0ZXJfc2V0X2NsaWVudBgEIAEoCRIcChRjb2xsYXRpb25fY29ubmVjdGlvbhgFIAEoCRIaChJkYXRhYmFzZV9jb2xsYXRpb24YBiABKAkSEAoIc3FsX21vZGUYByABKAkSDwoHY29tbWVudBgIIAEoCRI3ChFkZXBlbmRlbmN5X3RhYmxlcxgJIAMoCzIcLmJ5dGViYXNlLnYxLkRlcGVuZGVuY3lUYWJsZRIRCglza2lwX2R1bXAYCiABKAgi1gEKEVByb2NlZHVyZU1ldGFkYXRhEgwKBG5hbWUYASABKAkSEgoKZGVmaW5pdGlvbhgCIAEoCRIRCglzaWduYXR1cmUYAyABKAkSHAoUY2hhcmFjdGVyX3NldF9jbGllbnQYBCABKAkSHAoUY29sbGF0aW9uX2Nvbm5lY3Rpb24YBSABKAkSGgoSZGF0YWJhc2VfY29sbGF0aW9uGAYgASgJEhAKCHNxbF9tb2RlGAcgASgJEg8KB2NvbW1lbnQYCSABKAkSEQoJc2tpcF9kdW1wGAggASgIIjMKD1BhY2thZ2VNZXRhZGF0YRIMCgRuYW1lGAEgASgJEhIKCmRlZmluaXRpb24YAiABKAkilgIKDFRhc2tNZXRhZGF0YRIMCgRuYW1lGAEgASgJEgoKAmlkGAIgASgJEg0KBW93bmVyGAMgASgJEg8KB2NvbW1lbnQYBCABKAkSEQoJd2FyZWhvdXNlGAUgASgJEhAKCHNjaGVkdWxlGAYgASgJEhQKDHByZWRlY2Vzc29ycxgHIAMoCRIuCgVzdGF0ZRgIIAEoDjIfLmJ5dGViYXNlLnYxLlRhc2tNZXRhZGF0YS5TdGF0ZRIRCgljb25kaXRpb24YCSABKAkSEgoKZGVmaW5pdGlvbhgKIAEoCSI6CgVTdGF0ZRIVChFTVEFURV9VTlNQRUNJRklFRBAAEgsKB1NUQVJURUQQARINCglTVVNQRU5ERUQQAiLLAgoOU3RyZWFtTWV0YWRhdGESDAoEbmFtZRgBIAEoCRISCgp0YWJsZV9uYW1lGAIgASgJEg0KBW93bmVyGAMgASgJEg8KB2NvbW1lbnQYBCABKAkSLgoEdHlwZRgFIAEoDjIgLmJ5dGViYXNlLnYxLlN0cmVhbU1ldGFkYXRhLlR5cGUSDQoFc3RhbGUYBiABKAgSLgoEbW9kZRgHIAEoDjIgLmJ5dGViYXNlLnYxLlN0cmVhbU1ldGFkYXRhLk1vZGUSEgoKZGVmaW5pdGlvbhgIIAEoCSInCgRUeXBlEhQKEFRZUEVfVU5TUEVDSUZJRUQQABIJCgVERUxUQRABIksKBE1vZGUSFAoQTU9ERV9VTlNQRUNJRklFRBAAEgsKB0RFRkFVTFQQARIPCgtBUFBFTkRfT05MWRACEg8KC0lOU0VSVF9PTkxZEAMivQEKElNwYXRpYWxJbmRleENvbmZpZxIOCgZtZXRob2QYASABKAkSNQoMdGVzc2VsbGF0aW9uGAIgASgLMh8uYnl0ZWJhc2UudjEuVGVzc2VsbGF0aW9uQ29uZmlnEisKB3N0b3JhZ2UYAyABKAsyGi5ieXRlYmFzZS52MS5TdG9yYWdlQ29uZmlnEjMKC2RpbWVuc2lvbmFsGAQgASgLMh4uYnl0ZWJhc2UudjEuRGltZW5zaW9uYWxDb25maWcimwEKElRlc3NlbGxhdGlvbkNvbmZpZxIOCgZzY2hlbWUYASABKAkSKwoLZ3JpZF9sZXZlbHMYAiADKAsyFi5ieXRlYmFzZS52MS5HcmlkTGV2ZWwSGAoQY2VsbHNfcGVyX29iamVjdBgDIAEoBRIuCgxib3VuZGluZ19ib3gYBCABKAsyGC5ieXRlYmFzZS52MS5Cb3VuZGluZ0JveCIrCglHcmlkTGV2ZWwSDQoFbGV2ZWwYASABKAUSDwoHZGVuc2l0eRgCIAEoCSJFCgtCb3VuZGluZ0JveBIMCgR4bWluGAEgASgBEgwKBHltaW4YAiABKAESDAoEeG1heBgDIAEoARIMCgR5bWF4GAQgASgBIr4CCg1TdG9yYWdlQ29uZmlnEhIKCmZpbGxmYWN0b3IYASABKAUSEQoJYnVmZmVyaW5nGAIgASgJEhIKCnRhYmxlc3BhY2UYAyABKAkSFwoPd29ya190YWJsZXNwYWNlGAQgASgJEhEKCXNkb19sZXZlbBgFIAEoBRIXCg9jb21taXRfaW50ZXJ2YWwYBiABKAUSEQoJcGFkX2luZGV4GAcgASgIEhYKDnNvcnRfaW5fdGVtcGRiGAggASgJEhUKDWRyb3BfZXhpc3RpbmcYCSABKAgSDgoGb25saW5lGAogASgIEhcKD2FsbG93X3Jvd19sb2NrcxgLIAEoCBIYChBhbGxvd19wYWdlX2xvY2tzGAwgASgIEg4KBm1heGRvcBgNIAEoBRIYChBkYXRhX2NvbXByZXNzaW9uGA4gASgJIn8KEURpbWVuc2lvbmFsQ29uZmlnEhIKCmRpbWVuc2lvbnMYASABKAUSEQoJZGF0YV90eXBlGAIgASgJEgwKBHNyaWQYAyABKAUSNQoLY29uc3RyYWludHMYBCADKAsyIC5ieXRlYmFzZS52MS5EaW1lbnNpb25Db25zdHJhaW50ImEKE0RpbWVuc2lvbkNvbnN0cmFpbnQSEQoJZGltZW5zaW9uGAEgASgJEhEKCW1pbl92YWx1ZRgCIAEoARIRCgltYXhfdmFsdWUYAyABKAESEQoJdG9sZXJhbmNlGAQgASgBIo0DCg1JbmRleE1ldGFkYXRhEgwKBG5hbWUYASABKAkSEwoLZXhwcmVzc2lvbnMYAiADKAkSEgoKa2V5X2xlbmd0aBgJIAMoAxISCgpkZXNjZW5kaW5nGAogAygIEgwKBHR5cGUYAyABKAkSDgoGdW5pcXVlGAQgASgIEg8KB3ByaW1hcnkYBSABKAgSDwoHdmlzaWJsZRgGIAEoCBIPCgdjb21tZW50GAcgASgJEhIKCmRlZmluaXRpb24YCCABKAkSGwoTcGFyZW50X2luZGV4X3NjaGVtYRgLIAEoCRIZChFwYXJlbnRfaW5kZXhfbmFtZRgMIAEoCRITCgtncmFudWxhcml0eRgNIAEoAxIVCg1pc19jb25zdHJhaW50GA4gASgIEjcKDnNwYXRpYWxfY29uZmlnGA8gASgLMh8uYnl0ZWJhc2UudjEuU3BhdGlhbEluZGV4Q29uZmlnEhUKDW9wY2xhc3NfbmFtZXMYECADKAkSGAoQb3BjbGFzc19kZWZhdWx0cxgRIAMoCCJXChFFeHRlbnNpb25NZXRhZGF0YRIMCgRuYW1lGAEgASgJEg4KBnNjaGVtYRgCIAEoCRIPCgd2ZXJzaW9uGAMgASgJEhMKC2Rlc2NyaXB0aW9uGAQgASgJIr4BChJGb3JlaWduS2V5TWV0YWRhdGESDAoEbmFtZRgBIAEoCRIPCgdjb2x1bW5zGAIgAygJEhkKEXJlZmVyZW5jZWRfc2NoZW1hGAMgASgJEhgKEHJlZmVyZW5jZWRfdGFibGUYBCABKAkSGgoScmVmZXJlbmNlZF9jb2x1bW5zGAUgAygJEhEKCW9uX2RlbGV0ZRgGIAEoCRIRCglvbl91cGRhdGUYByABKAkSEgoKbWF0Y2hfdHlwZRgIIAEoCSIgCg5EYXRhYmFzZVNjaGVtYRIOCgZzY2hlbWEYASABKAkiPgoRRGF0YWJhc2VTRExTY2hlbWESDgoGc2NoZW1hGAEgASgMEhkKDGNvbnRlbnRfdHlwZRgCIAEoCUID4EEDIksKEENoYW5nZWRSZXNvdXJjZXMSNwoJZGF0YWJhc2VzGAEgAygLMiQuYnl0ZWJhc2UudjEuQ2hhbmdlZFJlc291cmNlRGF0YWJhc2UiXAoXQ2hhbmdlZFJlc291cmNlRGF0YWJhc2USDAoEbmFtZRgBIAEoCRIzCgdzY2hlbWFzGAIgAygLMiIuYnl0ZWJhc2UudjEuQ2hhbmdlZFJlc291cmNlU2NoZW1hIv0BChVDaGFuZ2VkUmVzb3VyY2VTY2hlbWESDAoEbmFtZRgBIAEoCRIxCgZ0YWJsZXMYAiADKAsyIS5ieXRlYmFzZS52MS5DaGFuZ2VkUmVzb3VyY2VUYWJsZRIvCgV2aWV3cxgDIAMoCzIgLmJ5dGViYXNlLnYxLkNoYW5nZWRSZXNvdXJjZVZpZXcSNwoJZnVuY3Rpb25zGAQgAygLMiQuYnl0ZWJhc2UudjEuQ2hhbmdlZFJlc291cmNlRnVuY3Rpb24SOQoKcHJvY2VkdXJlcxgFIAMoCzIlLmJ5dGViYXNlLnYxLkNoYW5nZWRSZXNvdXJjZVByb2NlZHVyZSJIChRDaGFuZ2VkUmVzb3VyY2VUYWJsZRIMCgRuYW1lGAEgASgJEiIKBnJhbmdlcxgDIAMoCzISLmJ5dGViYXNlLnYxLlJhbmdlIkcKE0NoYW5nZWRSZXNvdXJjZVZpZXcSDAoEbmFtZRgBIAEoCRIiCgZyYW5nZXMYAiADKAsyEi5ieXRlYmFzZS52MS5SYW5nZSJLChdDaGFuZ2VkUmVzb3VyY2VGdW5jdGlvbhIMCgRuYW1lGAEgASgJEiIKBnJhbmdlcxgCIAMoCzISLmJ5dGViYXNlLnYxLlJhbmdlIkwKGENoYW5nZWRSZXNvdXJjZVByb2NlZHVyZRIMCgRuYW1lGAEgASgJEiIKBnJhbmdlcxgCIAMoCzISLmJ5dGViYXNlLnYxLlJhbmdlIqcBChVMaXN0Q2hhbmdlbG9nc1JlcXVlc3QSLQoGcGFyZW50GAEgASgJQh3gQQL6QRcKFWJ5dGViYXNlLmNvbS9EYXRhYmFzZRIRCglwYWdlX3NpemUYAiABKAUSEgoKcGFnZV90b2tlbhgDIAEoCRIoCgR2aWV3GAQgASgOMhouYnl0ZWJhc2UudjEuQ2hhbmdlbG9nVmlldxIOCgZmaWx0ZXIYBSABKAkiXQoWTGlzdENoYW5nZWxvZ3NSZXNwb25zZRIqCgpjaGFuZ2Vsb2dzGAEgAygLMhYuYnl0ZWJhc2UudjEuQ2hhbmdlbG9nEhcKD25leHRfcGFnZV90b2tlbhgCIAEoCSJ1ChNHZXRDaGFuZ2Vsb2dSZXF1ZXN0EjQKBG5hbWUYASABKAlCJuBBAvpBIAoeYnl0ZWJhc2UuY29tL0RhdGFiYXNlQ2hhbmdlbG9nEigKBHZpZXcYAiABKA4yGi5ieXRlYmFzZS52MS5DaGFuZ2Vsb2dWaWV3IqgFCglDaGFuZ2Vsb2cSDAoEbmFtZRgBIAEoCRIvCgtjcmVhdGVfdGltZRgDIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLQoGc3RhdHVzGAQgASgOMh0uYnl0ZWJhc2UudjEuQ2hhbmdlbG9nLlN0YXR1cxIRCglzdGF0ZW1lbnQYBSABKAkSFgoOc3RhdGVtZW50X3NpemUYBiABKAMSFwoPc3RhdGVtZW50X3NoZWV0GAcgASgJEg4KBnNjaGVtYRgIIAEoCRITCgtzY2hlbWFfc2l6ZRgJIAEoAxITCgtwcmV2X3NjaGVtYRgKIAEoCRIYChBwcmV2X3NjaGVtYV9zaXplGAsgASgDEg0KBWlzc3VlGAwgASgJEhAKCHRhc2tfcnVuGA0gASgJEg8KB3ZlcnNpb24YDiABKAkSEAoIcmV2aXNpb24YDyABKAkSOAoRY2hhbmdlZF9yZXNvdXJjZXMYECABKAsyHS5ieXRlYmFzZS52MS5DaGFuZ2VkUmVzb3VyY2VzEikKBHR5cGUYESABKA4yGy5ieXRlYmFzZS52MS5DaGFuZ2Vsb2cuVHlwZSJDCgZTdGF0dXMSFgoSU1RBVFVTX1VOU1BFQ0lGSUVEEAASCwoHUEVORElORxABEggKBERPTkUQAhIKCgZGQUlMRUQQAyJACgRUeXBlEhQKEFRZUEVfVU5TUEVDSUZJRUQQABIMCghCQVNFTElORRABEgsKB01JR1JBVEUQAhIHCgNTREwQAzpl6kFiCh5ieXRlYmFzZS5jb20vRGF0YWJhc2VDaGFuZ2Vsb2cSQGluc3RhbmNlcy97aW5zdGFuY2V9L2RhdGFiYXNlcy97ZGF0YWJhc2V9L2NoYW5nZWxvZ3Mve2NoYW5nZWxvZ30i8QIKFkdldFNjaGVtYVN0cmluZ1JlcXVlc3QSKwoEbmFtZRgBIAEoCUId4EEC+kEXChVieXRlYmFzZS5jb20vRGF0YWJhc2USPAoEdHlwZRgCIAEoDjIuLmJ5dGViYXNlLnYxLkdldFNjaGVtYVN0cmluZ1JlcXVlc3QuT2JqZWN0VHlwZRIOCgZzY2hlbWEYAyABKAkSDgoGb2JqZWN0GAQgASgJEi8KCG1ldGFkYXRhGAUgASgLMh0uYnl0ZWJhc2UudjEuRGF0YWJhc2VNZXRhZGF0YSKaAQoKT2JqZWN0VHlwZRIbChdPQkpFQ1RfVFlQRV9VTlNQRUNJRklFRBAAEgwKCERBVEFCQVNFEAESCgoGU0NIRU1BEAISCQoFVEFCTEUQAxIICgRWSUVXEAQSFQoRTUFURVJJQUxJWkVEX1ZJRVcQBRIMCghGVU5DVElPThAGEg0KCVBST0NFRFVSRRAHEgwKCFNFUVVFTkNFEAgiMAoXR2V0U2NoZW1hU3RyaW5nUmVzcG9uc2USFQoNc2NoZW1hX3N0cmluZxgBIAEoCSpiCg1DaGFuZ2Vsb2dWaWV3Eh4KGkNIQU5HRUxPR19WSUVXX1VOU1BFQ0lGSUVEEAASGAoUQ0hBTkdFTE9HX1ZJRVdfQkFTSUMQARIXChNDSEFOR0VMT0dfVklFV19GVUxMEAIy7BQKD0RhdGFiYXNlU2VydmljZRKQAQoLR2V0RGF0YWJhc2USHy5ieXRlYmFzZS52MS5HZXREYXRhYmFzZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5EYXRhYmFzZSJJ2kEEbmFtZYrqMBBiYi5kYXRhYmFzZXMuZ2V0kOowAYLT5JMCJBIiL3YxL3tuYW1lPWluc3RhbmNlcy8qL2RhdGFiYXNlcy8qfRLdAQoRQmF0Y2hHZXREYXRhYmFzZXMSJS5ieXRlYmFzZS52MS5CYXRjaEdldERhdGFiYXNlc1JlcXVlc3QaJi5ieXRlYmFzZS52MS5CYXRjaEdldERhdGFiYXNlc1Jlc3BvbnNlInmK6jAQYmIuZGF0YWJhc2VzLmdldJDqMAKC0+STAltaLRIrL3YxL3twYXJlbnQ9aW5zdGFuY2VzLyp9L2RhdGFiYXNlczpiYXRjaEdldBIqL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vZGF0YWJhc2VzOmJhdGNoR2V0EusBCg1MaXN0RGF0YWJhc2VzEiEuYnl0ZWJhc2UudjEuTGlzdERhdGFiYXNlc1JlcXVlc3QaIi5ieXRlYmFzZS52MS5MaXN0RGF0YWJhc2VzUmVzcG9uc2UikgHaQQCK6jARYmIuZGF0YWJhc2VzLmxpc3SQ6jACgtPkkwJwWiQSIi92MS97cGFyZW50PWluc3RhbmNlcy8qfS9kYXRhYmFzZXNaJRIjL3YxL3twYXJlbnQ9d29ya3NwYWNlcy8qfS9kYXRhYmFzZXMSIS92MS97cGFyZW50PXByb2plY3RzLyp9L2RhdGFiYXNlcxLAAQoOVXBkYXRlRGF0YWJhc2USIi5ieXRlYmFzZS52MS5VcGRhdGVEYXRhYmFzZVJlcXVlc3QaFS5ieXRlYmFzZS52MS5EYXRhYmFzZSJz2kEUZGF0YWJhc2UsdXBkYXRlX21hc2uK6jATYmIuZGF0YWJhc2VzLnVwZGF0ZZDqMAGY6jABgtPkkwI3OghkYXRhYmFzZTIrL3YxL3tkYXRhYmFzZS5uYW1lPWluc3RhbmNlcy8qL2RhdGFiYXNlcy8qfRLFAQoUQmF0Y2hVcGRhdGVEYXRhYmFzZXMSKC5ieXRlYmFzZS52MS5CYXRjaFVwZGF0ZURhdGFiYXNlc1JlcXVlc3QaKS5ieXRlYmFzZS52MS5CYXRjaFVwZGF0ZURhdGFiYXNlc1Jlc3BvbnNlIliK6jATYmIuZGF0YWJhc2VzLnVwZGF0ZZDqMAGY6jABgtPkkwIzOgEqIi4vdjEve3BhcmVudD1pbnN0YW5jZXMvKn0vZGF0YWJhc2VzOmJhdGNoVXBkYXRlEqABCgxTeW5jRGF0YWJhc2USIC5ieXRlYmFzZS52MS5TeW5jRGF0YWJhc2VSZXF1ZXN0GiEuYnl0ZWJhc2UudjEuU3luY0RhdGFiYXNlUmVzcG9uc2UiS4rqMBFiYi5kYXRhYmFzZXMuc3luY5DqMAGC0+STAiw6ASoiJy92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKn06c3luYxK3AQoSQmF0Y2hTeW5jRGF0YWJhc2VzEiYuYnl0ZWJhc2UudjEuQmF0Y2hTeW5jRGF0YWJhc2VzUmVxdWVzdBonLmJ5dGViYXNlLnYxLkJhdGNoU3luY0RhdGFiYXNlc1Jlc3BvbnNlIlCK6jARYmIuZGF0YWJhc2VzLnN5bmOQ6jABgtPkkwIxOgEqIiwvdjEve3BhcmVudD1pbnN0YW5jZXMvKn0vZGF0YWJhc2VzOmJhdGNoU3luYxKwAQoTR2V0RGF0YWJhc2VNZXRhZGF0YRInLmJ5dGViYXNlLnYxLkdldERhdGFiYXNlTWV0YWRhdGFSZXF1ZXN0Gh0uYnl0ZWJhc2UudjEuRGF0YWJhc2VNZXRhZGF0YSJRiuowFmJiLmRhdGFiYXNlcy5nZXRTY2hlbWGQ6jABgtPkkwItEisvdjEve25hbWU9aW5zdGFuY2VzLyovZGF0YWJhc2VzLyovbWV0YWRhdGF9EqgBChFHZXREYXRhYmFzZVNjaGVtYRIlLmJ5dGViYXNlLnYxLkdldERhdGFiYXNlU2NoZW1hUmVxdWVzdBobLmJ5dGViYXNlLnYxLkRhdGFiYXNlU2NoZW1hIk+K6jAWYmIuZGF0YWJhc2VzLmdldFNjaGVtYZDqMAGC0+STAisSKS92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKi9zY2hlbWF9ErQBChRHZXREYXRhYmFzZVNETFNjaGVtYRIoLmJ5dGViYXNlLnYxLkdldERhdGFiYXNlU0RMU2NoZW1hUmVxdWVzdBoeLmJ5dGViYXNlLnYxLkRhdGFiYXNlU0RMU2NoZW1hIlKK6jAWYmIuZGF0YWJhc2VzLmdldFNjaGVtYZDqMAGC0+STAi4SLC92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKi9zZGxTY2hlbWF9EuEBCgpEaWZmU2NoZW1hEh4uYnl0ZWJhc2UudjEuRGlmZlNjaGVtYVJlcXVlc3QaHy5ieXRlYmFzZS52MS5EaWZmU2NoZW1hUmVzcG9uc2UikQGK6jAQYmIuZGF0YWJhc2VzLmdldJDqMAGC0+STAnM6ASpaPzoBKiI6L3YxL3tuYW1lPWluc3RhbmNlcy8qL2RhdGFiYXNlcy8qL2NoYW5nZWxvZ3MvKn06ZGlmZlNjaGVtYSItL3YxL3tuYW1lPWluc3RhbmNlcy8qL2RhdGFiYXNlcy8qfTpkaWZmU2NoZW1hErUBCg5MaXN0Q2hhbmdlbG9ncxIiLmJ5dGViYXNlLnYxLkxpc3RDaGFuZ2Vsb2dzUmVxdWVzdBojLmJ5dGViYXNlLnYxLkxpc3RDaGFuZ2Vsb2dzUmVzcG9uc2UiWtpBBnBhcmVudIrqMBJiYi5jaGFuZ2Vsb2dzLmxpc3SQ6jABgtPkkwIxEi8vdjEve3BhcmVudD1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKn0vY2hhbmdlbG9ncxKhAQoMR2V0Q2hhbmdlbG9nEiAuYnl0ZWJhc2UudjEuR2V0Q2hhbmdlbG9nUmVxdWVzdBoWLmJ5dGViYXNlLnYxLkNoYW5nZWxvZyJX2kEEbmFtZYrqMBFiYi5jaGFuZ2Vsb2dzLmdldJDqMAGC0+STAjESLy92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKi9jaGFuZ2Vsb2dzLyp9EroBCg9HZXRTY2hlbWFTdHJpbmcSIy5ieXRlYmFzZS52MS5HZXRTY2hlbWFTdHJpbmdSZXF1ZXN0GiQuYnl0ZWJhc2UudjEuR2V0U2NoZW1hU3RyaW5nUmVzcG9uc2UiXNpBBG5hbWWK6jAWYmIuZGF0YWJhc2VzLmdldFNjaGVtYZDqMAGC0+STAjESLy92MS97bmFtZT1pbnN0YW5jZXMvKi9kYXRhYmFzZXMvKi9zY2hlbWFTdHJpbmd9QqoBCg9jb20uYnl0ZWJhc2UudjFCFERhdGFiYXNlU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_instance_service]);/*** Describes the message bytebase.v1.GetDatabaseRequest.diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yamlindex 58c37cff26..d789c6fa01 100644--- a/proto/gen/grpc-doc/openapi.yaml+++ b/proto/gen/grpc-doc/openapi.yaml@@ -8916,11 +8916,6 @@ components:- SDLtype: stringformat: enum- dumpVersionMismatch:- type: boolean- description: |-- True if this changelog's dump version differs from current engine dump version.- When true and drift is detected, the drift may be a false positive from Bytebase upgrade.CheckConstraintMetadata:type: objectproperties:diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.mdindex 21cb6d0870..b0949d9c42 100644--- a/proto/gen/grpc-doc/v1/README.md+++ b/proto/gen/grpc-doc/v1/README.md@@ -63,46 +63,6 @@- [IssueService](#bytebase-v1-IssueService)-- [v1/iam_policy.proto](#v1_iam_policy-proto)- - [Binding](#bytebase-v1-Binding)- - [BindingDelta](#bytebase-v1-BindingDelta)- - [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest)- - [IamPolicy](#bytebase-v1-IamPolicy)- - [PolicyDelta](#bytebase-v1-PolicyDelta)- - [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest)-- - [BindingDelta.Action](#bytebase-v1-BindingDelta-Action)--- [v1/project_service.proto](#v1_project_service-proto)- - [Activity](#bytebase-v1-Activity)- - [AddWebhookRequest](#bytebase-v1-AddWebhookRequest)- - [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest)- - [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest)- - [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse)- - [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult)- - [CreateProjectRequest](#bytebase-v1-CreateProjectRequest)- - [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest)- - [GetProjectRequest](#bytebase-v1-GetProjectRequest)- - [Label](#bytebase-v1-Label)- - [ListProjectsRequest](#bytebase-v1-ListProjectsRequest)- - [ListProjectsResponse](#bytebase-v1-ListProjectsResponse)- - [Project](#bytebase-v1-Project)- - [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy)- - [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry)- - [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest)- - [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest)- - [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse)- - [TestWebhookRequest](#bytebase-v1-TestWebhookRequest)- - [TestWebhookResponse](#bytebase-v1-TestWebhookResponse)- - [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest)- - [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest)- - [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest)- - [Webhook](#bytebase-v1-Webhook)-- - [Activity.Type](#bytebase-v1-Activity-Type)-- - [ProjectService](#bytebase-v1-ProjectService)-- [v1/setting_service.proto](#v1_setting_service-proto)- [AISetting](#bytebase-v1-AISetting)- [Algorithm](#bytebase-v1-Algorithm)@@ -180,6 +140,16 @@- [ActuatorService](#bytebase-v1-ActuatorService)+- [v1/iam_policy.proto](#v1_iam_policy-proto)+ - [Binding](#bytebase-v1-Binding)+ - [BindingDelta](#bytebase-v1-BindingDelta)+ - [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest)+ - [IamPolicy](#bytebase-v1-IamPolicy)+ - [PolicyDelta](#bytebase-v1-PolicyDelta)+ - [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest)++ - [BindingDelta.Action](#bytebase-v1-BindingDelta-Action)+- [v1/audit_log_service.proto](#v1_audit_log_service-proto)- [AuditData](#bytebase-v1-AuditData)- [AuditLog](#bytebase-v1-AuditLog)@@ -518,6 +488,36 @@- [PlanService](#bytebase-v1-PlanService)+- [v1/project_service.proto](#v1_project_service-proto)+ - [Activity](#bytebase-v1-Activity)+ - [AddWebhookRequest](#bytebase-v1-AddWebhookRequest)+ - [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest)+ - [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest)+ - [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse)+ - [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult)+ - [CreateProjectRequest](#bytebase-v1-CreateProjectRequest)+ - [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest)+ - [GetProjectRequest](#bytebase-v1-GetProjectRequest)+ - [Label](#bytebase-v1-Label)+ - [ListProjectsRequest](#bytebase-v1-ListProjectsRequest)+ - [ListProjectsResponse](#bytebase-v1-ListProjectsResponse)+ - [Project](#bytebase-v1-Project)+ - [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy)+ - [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry)+ - [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest)+ - [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest)+ - [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse)+ - [TestWebhookRequest](#bytebase-v1-TestWebhookRequest)+ - [TestWebhookResponse](#bytebase-v1-TestWebhookResponse)+ - [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest)+ - [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest)+ - [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest)+ - [Webhook](#bytebase-v1-Webhook)++ - [Activity.Type](#bytebase-v1-Activity-Type)++ - [ProjectService](#bytebase-v1-ProjectService)+- [v1/release_service.proto](#v1_release_service-proto)- [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest)- [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse)@@ -1567,1255 +1567,1266 @@ IssueService manages issues for tracking database changes and tasks.-<a name="v1_iam_policy-proto"></a>+<a name="v1_setting_service-proto"></a><p align="right"><a href="#top">Top</a></p>-## v1/iam_policy.proto+## v1/setting_service.proto-<a name="bytebase-v1-Binding"></a>+<a name="bytebase-v1-AISetting"></a>++### AISetting-### 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 "instances/{instance}/databases/{database}" format, used by the "roles/sqlEditorUser" role, support "==" operator. resource.schema_name: the schema name, used by the "roles/sqlEditorUser" role, support "==" operator. resource.table_name: the table name, used by the "roles/sqlEditorUser" role, support "==" operator. request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")`.+| enabled | [bool](#bool) | | |+| provider | [AISetting.Provider](#bytebase-v1-AISetting-Provider) | | |+| endpoint | [string](#string) | | |+| api_key | [string](#string) | | |+| model | [string](#string) | | |+| version | [string](#string) | | |-For example: resource.database == "instances/local-pg/databases/postgres" && resource.schema_name in ["public","another_schema"] resource.database == "instances/local-pg/databases/bytebase" && resource.schema_name == "public" && resource.table_name in ["audit_log"] request.time < timestamp("2025-04-26T11:24:48.655Z") |-| parsed_expr | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | | The parsed expression of the condition. |+<a name="bytebase-v1-Algorithm"></a>-<a name="bytebase-v1-BindingDelta"></a>+### Algorithm-### 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. |+| 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-GetIamPolicyRequest"></a>+<a name="bytebase-v1-Algorithm-FullMask"></a>++### Algorithm.FullMask-### 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} |+| 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-IamPolicy"></a>+<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>++### Algorithm.InnerOuterMask-### 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. |+| prefix_len | [int32](#int32) | | |+| suffix_len | [int32](#int32) | | |+| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |+| substitution | [string](#string) | | |-<a name="bytebase-v1-PolicyDelta"></a>+<a name="bytebase-v1-Algorithm-MD5Mask"></a>++### Algorithm.MD5Mask-### 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. |+| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |-<a name="bytebase-v1-SetIamPolicyRequest"></a>+<a name="bytebase-v1-Algorithm-RangeMask"></a>++### Algorithm.RangeMask-### 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. |-+| 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-BindingDelta-Action"></a>+<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>-### BindingDelta.Action-Type of action performed on a binding.+### Algorithm.RangeMask.Slice-| Name | Number | Description |-| ---- | ------ | ----------- |-| ACTION_UNSPECIFIED | 0 | Unspecified action. |-| ADD | 1 | Add a binding. |-| REMOVE | 2 | Remove a binding. |-+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| start | [int32](#int32) | | start is the start index of the original value, start from 0 and should be less than stop. |+| end | [int32](#int32) | | stop is the stop index of the original value, should be less than the length of the original value. |+| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |---<a name="v1_project_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/project_service.proto+<a name="bytebase-v1-Announcement"></a>+### Announcement-<a name="bytebase-v1-Activity"></a>-### Activity-Activity types for webhook notifications.+| 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 |-<a name="bytebase-v1-AddWebhookRequest"></a>+<a name="bytebase-v1-AppIMSetting"></a>-### AddWebhookRequest+### AppIMSetting| 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. |+| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |-<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>+<a name="bytebase-v1-AppIMSetting-DingTalk"></a>-### BatchDeleteProjectsRequest+### AppIMSetting.DingTalk| 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. |+| client_id | [string](#string) | | |+| client_secret | [string](#string) | | |+| robot_code | [string](#string) | | |-<a name="bytebase-v1-BatchGetIamPolicyRequest"></a>+<a name="bytebase-v1-AppIMSetting-Feishu"></a>-### BatchGetIamPolicyRequest+### AppIMSetting.Feishu| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| scope | [string](#string) | | The scope of the batch get. Typically it's "projects/-". |-| names | [string](#string) | repeated | |+| app_id | [string](#string) | | |+| app_secret | [string](#string) | | |-<a name="bytebase-v1-BatchGetIamPolicyResponse"></a>+<a name="bytebase-v1-AppIMSetting-IMSetting"></a>-### BatchGetIamPolicyResponse+### AppIMSetting.IMSetting| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| policy_results | [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult) | repeated | The policy results for each requested project. |+| 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-BatchGetIamPolicyResponse-PolicyResult"></a>+<a name="bytebase-v1-AppIMSetting-Lark"></a>++### AppIMSetting.Lark-### BatchGetIamPolicyResponse.PolicyResult-Result for a single project's IAM policy.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| project | [string](#string) | | The project resource name. |-| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | The IAM policy for the project. |+| app_id | [string](#string) | | |+| app_secret | [string](#string) | | |-<a name="bytebase-v1-CreateProjectRequest"></a>+<a name="bytebase-v1-AppIMSetting-Slack"></a>-### CreateProjectRequest+### AppIMSetting.Slack| 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's resource name.--This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |+| token | [string](#string) | | |-<a name="bytebase-v1-DeleteProjectRequest"></a>+<a name="bytebase-v1-AppIMSetting-Teams"></a>-### DeleteProjectRequest+### AppIMSetting.Teams| 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. |+| 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-GetProjectRequest"></a>+<a name="bytebase-v1-AppIMSetting-Wecom"></a>-### GetProjectRequest+### AppIMSetting.Wecom| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |+| corp_id | [string](#string) | | |+| agent_id | [string](#string) | | |+| secret | [string](#string) | | |-<a name="bytebase-v1-Label"></a>+<a name="bytebase-v1-DataClassificationSetting"></a>++### DataClassificationSetting-### 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. |+| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |-<a name="bytebase-v1-ListProjectsRequest"></a>+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>-### ListProjectsRequest+### DataClassificationSetting.DataClassificationConfig| 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 == "production"). |+| 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]+-[0-9]+-[0-9]+ format. |-<a name="bytebase-v1-ListProjectsResponse"></a>+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>-### ListProjectsResponse+### DataClassificationSetting.DataClassificationConfig.ClassificationEntry| 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. |+| key | [string](#string) | | |+| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |-<a name="bytebase-v1-Project"></a>+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>-### Project+### DataClassificationSetting.DataClassificationConfig.DataClassification| 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'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. |-| allow_modify_statement | [bool](#bool) | | Allow modifying SQL statements after issue is created. |-| auto_resolve_issue | [bool](#bool) | | Enable automatic issue resolution when tasks complete. |-| 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 "set role <db_owner>" 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, { "environment": "production", "team": "backend" } |-| 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. |+| id | [string](#string) | | id is the classification id in [0-9]+-[0-9]+-[0-9]+ format. |+| title | [string](#string) | | |+| description | [string](#string) | | |+| level_id | [string](#string) | optional | |-<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>++### DataClassificationSetting.DataClassificationConfig.Level-### Project.ExecutionRetryPolicy-Execution retry policy configuration.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |+| id | [string](#string) | | |+| title | [string](#string) | | |+| description | [string](#string) | | |-<a name="bytebase-v1-Project-LabelsEntry"></a>+<a name="bytebase-v1-EnvironmentSetting"></a>-### Project.LabelsEntry+### EnvironmentSetting| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |+| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |-<a name="bytebase-v1-RemoveWebhookRequest"></a>+<a name="bytebase-v1-EnvironmentSetting-Environment"></a>-### RemoveWebhookRequest+### EnvironmentSetting.Environment| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |+| 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-SearchProjectsRequest"></a>+<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>-### SearchProjectsRequest+### EnvironmentSetting.Environment.TagsEntry| 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 "==" and ".matches()" operator. - resource_id: the project id, support "==" and ".matches()" operator. - exclude_default: if not include the default project, should be "true" or "false", support "==" operator. - state: check the State enum for the values, support "==" operator. - labels.{key}: the project label, support "==" and "in" operators.--For example: name == "project name" name.matches("project name") resource_id == "project id" resource_id.matches("project id") exclude_default == true state == "DELETED" labels.environment == "production" labels.tier == "critical" labels.environment in ["staging", "prod"] You can combine filter conditions like: name == "project name" && resource_id.matches("project id") name.matches("project name") || resource_id == "project id" labels.environment == "production" && labels.tier == "critical" |-| 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. |-+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-SearchProjectsResponse"></a>-### SearchProjectsResponse+<a name="bytebase-v1-GetSettingRequest"></a>+### GetSettingRequest+The request message for getting a setting.| 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. |-+| name | [string](#string) | | The resource name of the setting. |-<a name="bytebase-v1-TestWebhookRequest"></a>-### TestWebhookRequest+<a name="bytebase-v1-GetSettingResponse"></a>+### GetSettingResponse+The response message for getting a setting.| 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. |--+| setting | [Setting](#bytebase-v1-Setting) | | |-<a name="bytebase-v1-TestWebhookResponse"></a>-### TestWebhookResponse+<a name="bytebase-v1-ListSettingsRequest"></a>+### ListSettingsRequest-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| error | [string](#string) | | The result of the test, empty if the test is successful. |-<a name="bytebase-v1-UndeleteProjectRequest"></a>+<a name="bytebase-v1-ListSettingsResponse"></a>-### UndeleteProjectRequest+### ListSettingsResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |+| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |-<a name="bytebase-v1-UpdateProjectRequest"></a>+<a name="bytebase-v1-SemanticTypeSetting"></a>-### UpdateProjectRequest+### SemanticTypeSetting| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| project | [Project](#bytebase-v1-Project) | | The project to update.--The project'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. |+| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |-<a name="bytebase-v1-UpdateWebhookRequest"></a>+<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>-### UpdateWebhookRequest+### SemanticTypeSetting.SemanticType| 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. |-+| 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-Webhook"></a>-### Webhook+<a name="bytebase-v1-Setting"></a>+### Setting+The schema of setting.| 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_CREATE - ISSUE_COMMENT_CREATE - ISSUE_FIELD_UPDATE - ISSUE_STATUS_UPDATE - ISSUE_APPROVAL_NOTIFY - ISSUE_PIPELINE_STAGE_STATUS_UPDATE - ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE - NOTIFY_ISSUE_APPROVED - NOTIFY_PIPELINE_ROLLOUT |--+| name | [string](#string) | | The resource name of the setting. Format: settings/{setting} Example: "settings/SEMANTIC_TYPES" |+| value | [SettingValue](#bytebase-v1-SettingValue) | | The configuration value of the setting. |--<a name="bytebase-v1-Activity-Type"></a>-### Activity.Type-Activity type enumeration.+<a name="bytebase-v1-SettingValue"></a>-| Name | Number | Description |-| ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | Unspecified type. |-| NOTIFY_ISSUE_APPROVED | 23 | Notifications via webhooks.+### SettingValue+The data in setting value.-NOTIFY_ISSUE_APPROVED represents the issue approved notification. |-| NOTIFY_PIPELINE_ROLLOUT | 24 | NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification. |-| ISSUE_CREATE | 1 | Issue related activity types.-ISSUE_CREATE represents creating an issue. |-| ISSUE_COMMENT_CREATE | 2 | ISSUE_COMMENT_CREATE represents commenting on an issue. |-| ISSUE_FIELD_UPDATE | 3 | ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc. |-| ISSUE_STATUS_UPDATE | 4 | ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now. |-| ISSUE_APPROVAL_NOTIFY | 21 | ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval. |-| ISSUE_PIPELINE_STAGE_STATUS_UPDATE | 5 | ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now. |-| ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE | 22 | ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED. |+| 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) | | |---<a name="bytebase-v1-ProjectService"></a>-### ProjectService-ProjectService manages projects that group databases and changes.+<a name="bytebase-v1-UpdateSettingRequest"></a>-| Method Name | Request Type | Response Type | Description |-| ----------- | ------------ | ------------- | ------------|-| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with "bb.projects.get" permission on the workspace or the project owner can access this method. 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'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 |-| BatchGetIamPolicy | [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest) | [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse) | Deprecated. No permission check implemented. Permissions required: None |-| 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 |+### UpdateSettingRequest+The request message for updating or creating a setting.-+| 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) | | |-<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>+<a name="bytebase-v1-WorkspaceApprovalSetting"></a>-### AISetting+### WorkspaceApprovalSetting| 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) | | |+| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |-<a name="bytebase-v1-Algorithm"></a>+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>-### Algorithm+### WorkspaceApprovalSetting.Rule| 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="bytebase-v1-Algorithm-FullMask"></a>+| 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-### Algorithm.FullMask+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 "==", "!=", "<", "<=", ">", ">=" operations. statement.table_rows: table row count number, support "==", "!=", "<", "<=", ">", ">=" operations. resource.environment_id: the environment resource id, support "==", "!=", "in [xx]", "!(in [xx])" operations. resource.project_id: the project resource id, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.db_engine: the database engine type, support "==", "!=", "in [xx]", "!(in [xx])" operations. Check the Engine enum for values. statement.sql_type: the SQL type, support "==", "!=", "in [xx]", "!(in [xx])" operations. resource.database_name: the database name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.schema_name: the schema name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.table_name: the table name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. statement.text: the SQL statement, support "contains()", "matches()", "startsWith()", "endsWith()" operations. request.expiration_days: the role expiration days for the request, support "==", "!=", "<", "<=", ">", ">=" operations. request.role: the request role full name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" 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-| 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. |+For examples: resource.environment_id == "prod" && statement.affected_rows >= 100 resource.table_name.matches("sensitive_.*") && resource.db_engine == "MYSQL" |+| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |-<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>+<a name="bytebase-v1-WorkspaceProfileSetting"></a>-### Algorithm.InnerOuterMask+### WorkspaceProfileSetting| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| prefix_len | [int32](#int32) | | |-| suffix_len | [int32](#int32) | | |-| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |-| substitution | [string](#string) | | |+| 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. |+| token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for token. |+| 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 <= 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-Algorithm-MD5Mask"></a>+<a name="bytebase-v1-WorkspaceProfileSetting-PasswordRestriction"></a>-### Algorithm.MD5Mask+### WorkspaceProfileSetting.PasswordRestriction| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |--+| 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-Algorithm-RangeMask"></a>-### Algorithm.RangeMask++<a name="bytebase-v1-AISetting-Provider"></a>-| 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. |+### AISetting.Provider+| Name | Number | Description |+| ---- | ------ | ----------- |+| PROVIDER_UNSPECIFIED | 0 | |+| OPEN_AI | 1 | |+| CLAUDE | 2 | |+| GEMINI | 3 | |+| AZURE_OPENAI | 4 | |+<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>-<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>+### Algorithm.InnerOuterMask.MaskType-### Algorithm.RangeMask.Slice+| Name | Number | Description |+| ---- | ------ | ----------- |+| MASK_TYPE_UNSPECIFIED | 0 | |+| INNER | 1 | |+| OUTER | 2 | |-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| start | [int32](#int32) | | start is the start index of the original value, start from 0 and should be less than stop. |-| end | [int32](#int32) | | stop is the stop index of the original value, should be less than the length of the original value. |-| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |+<a name="bytebase-v1-Announcement-AlertLevel"></a>+### Announcement.AlertLevel+We support three levels of AlertLevel: INFO, WARNING, and ERROR.+| Name | Number | Description |+| ---- | ------ | ----------- |+| ALERT_LEVEL_UNSPECIFIED | 0 | |+| INFO | 1 | |+| WARNING | 2 | |+| CRITICAL | 3 | |-<a name="bytebase-v1-Announcement"></a>+<a name="bytebase-v1-DatabaseChangeMode"></a>-### Announcement+### DatabaseChangeMode+| 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. |-| 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 |+<a name="bytebase-v1-Setting-SettingName"></a>+### Setting.SettingName+| Name | Number | Description |+| ---- | ------ | ----------- |+| SETTING_NAME_UNSPECIFIED | 0 | |+| WORKSPACE_PROFILE | 4 | |+| WORKSPACE_APPROVAL | 5 | |+| APP_IM | 8 | |+| AI | 10 | |+| DATA_CLASSIFICATION | 14 | |+| SEMANTIC_TYPES | 15 | |+| ENVIRONMENT | 19 | |-<a name="bytebase-v1-AppIMSetting"></a>-### AppIMSetting+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>+### WorkspaceApprovalSetting.Rule.Source-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |+| Name | Number | Description |+| ---- | ------ | ----------- |+| SOURCE_UNSPECIFIED | 0 | |+| CHANGE_DATABASE | 1 | |+| CREATE_DATABASE | 2 | |+| EXPORT_DATA | 3 | |+| REQUEST_ROLE | 4 | |++-<a name="bytebase-v1-AppIMSetting-DingTalk"></a>+<a name="bytebase-v1-SettingService"></a>-### AppIMSetting.DingTalk+### SettingService+SettingService manages workspace-level settings and configurations.+| 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 |+-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| client_id | [string](#string) | | |-| client_secret | [string](#string) | | |-| robot_code | [string](#string) | | |+<a name="v1_user_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/user_service.proto-<a name="bytebase-v1-AppIMSetting-Feishu"></a>+<a name="bytebase-v1-BatchGetUsersRequest"></a>-### AppIMSetting.Feishu+### BatchGetUsersRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| app_id | [string](#string) | | |-| app_secret | [string](#string) | | |+| names | [string](#string) | repeated | The user names to retrieve. Format: users/{user uid or user email} |-<a name="bytebase-v1-AppIMSetting-IMSetting"></a>+<a name="bytebase-v1-BatchGetUsersResponse"></a>-### AppIMSetting.IMSetting+### BatchGetUsersResponse| 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) | | |+| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |-<a name="bytebase-v1-AppIMSetting-Lark"></a>+<a name="bytebase-v1-CreateUserRequest"></a>-### AppIMSetting.Lark+### CreateUserRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| app_id | [string](#string) | | |-| app_secret | [string](#string) | | |+| user | [User](#bytebase-v1-User) | | The user to create. |-<a name="bytebase-v1-AppIMSetting-Slack"></a>+<a name="bytebase-v1-DeleteUserRequest"></a>-### AppIMSetting.Slack+### DeleteUserRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| token | [string](#string) | | |+| name | [string](#string) | | The name of the user to delete. Format: users/{user} |-<a name="bytebase-v1-AppIMSetting-Teams"></a>+<a name="bytebase-v1-GetUserRequest"></a>-### AppIMSetting.Teams+### GetUserRequest| 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. |+| name | [string](#string) | | The name of the user to retrieve. Format: users/{user uid or user email} |-<a name="bytebase-v1-AppIMSetting-Wecom"></a>+<a name="bytebase-v1-ListUsersRequest"></a>-### AppIMSetting.Wecom+### ListUsersRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| corp_id | [string](#string) | | |-| agent_id | [string](#string) | | |-| secret | [string](#string) | | |+| 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 "==" and ".matches()" operator. - email: the user email, support "==" and ".matches()" operator. - user_type: the type, check UserType enum for values, support "==", "in [xx]", "!(in [xx])" operator. - state: check State enum for values, support "==" operator. - project: the project full name in "projects/{id}" format, support "==" operator.+For example: name == "ed" name.matches("ed") email == "[email protected]" email.matches("ed") user_type == "SERVICE_ACCOUNT" user_type in ["SERVICE_ACCOUNT", "USER"] !(user_type in ["SERVICE_ACCOUNT", "USER"]) state == "DELETED" project == "projects/sample-project" You can combine filter conditions like: name.matches("ed") && project == "projects/sample-project" (name == "ed" || email == "[email protected]") && project == "projects/sample-project" |-<a name="bytebase-v1-DataClassificationSetting"></a>-### DataClassificationSetting+++<a name="bytebase-v1-ListUsersResponse"></a>++### ListUsersResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |+| 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-DataClassificationSetting-DataClassificationConfig"></a>+<a name="bytebase-v1-UndeleteUserRequest"></a>-### DataClassificationSetting.DataClassificationConfig+### UndeleteUserRequest| 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]+-[0-9]+-[0-9]+ format. |+| name | [string](#string) | | The name of the deleted user. Format: users/{user} |-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>+<a name="bytebase-v1-UpdateUserRequest"></a>-### DataClassificationSetting.DataClassificationConfig.ClassificationEntry+### UpdateUserRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |+| user | [User](#bytebase-v1-User) | | The user to update.+The user's `name` field is used to identify the user to update. Format: users/{user} |+| 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'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-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>-### DataClassificationSetting.DataClassificationConfig.DataClassification+<a name="bytebase-v1-User"></a>++### User| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| id | [string](#string) | | id is the classification id in [0-9]+-[0-9]+-[0-9]+ format. |-| title | [string](#string) | | |-| description | [string](#string) | | |-| level_id | [string](#string) | optional | |+| name | [string](#string) | | The name of the user. Format: users/{user}. {user} is a system-generated unique ID. |+| 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} |-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>+<a name="bytebase-v1-User-Profile"></a>-### DataClassificationSetting.DataClassificationConfig.Level+### User.Profile| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| id | [string](#string) | | |-| title | [string](#string) | | |-| description | [string](#string) | | |--+| 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-EnvironmentSetting"></a>-### EnvironmentSetting++<a name="bytebase-v1-UserType"></a>-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |+### 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. |++-<a name="bytebase-v1-EnvironmentSetting-Environment"></a>-### EnvironmentSetting.Environment+<a name="bytebase-v1-UserService"></a>+### UserService+UserService manages user accounts and authentication.+| 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. 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 |-| 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) | | |++<a name="v1_actuator_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/actuator_service.proto-<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>-### EnvironmentSetting.Environment.TagsEntry+<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 || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |+| 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. |+| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |+| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |+| require_2fa | [bool](#bool) | | Whether two-factor authentication is required for all users. |+| 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. |+| 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. |+| 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-GetSettingRequest"></a>+<a name="bytebase-v1-ActuatorInfo-StatUser"></a>-### GetSettingRequest-The request message for getting a setting.+### ActuatorInfo.StatUser+User statistics by type and state.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The resource name of the setting. |+| 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-GetSettingResponse"></a>+<a name="bytebase-v1-DeleteCacheRequest"></a>-### GetSettingResponse-The response message for getting a setting.+### DeleteCacheRequest+Request message for deleting cache.-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| setting | [Setting](#bytebase-v1-Setting) | | |+<a name="bytebase-v1-GetActuatorInfoRequest"></a>+### GetActuatorInfoRequest+Request message for getting actuator information.-<a name="bytebase-v1-ListSettingsRequest"></a>-### ListSettingsRequest+<a name="bytebase-v1-GetResourcePackageRequest"></a>+### GetResourcePackageRequest+Request message for getting branding resources.-<a name="bytebase-v1-ListSettingsResponse"></a>-### ListSettingsResponse+<a name="bytebase-v1-ResourcePackage"></a>++### ResourcePackage+Custom branding resources for the Bytebase instance.++| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |+| logo | [bytes](#bytes) | | The branding logo. |-<a name="bytebase-v1-SemanticTypeSetting"></a>+<a name="bytebase-v1-SetupSampleRequest"></a>-### SemanticTypeSetting+### SetupSampleRequest+Request message for setting up sample data.-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |+<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>+### UpdateActuatorInfoRequest+Request message for updating actuator information.-<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>+| 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. |-### SemanticTypeSetting.SemanticType-| 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. |++++<a name="bytebase-v1-ActuatorService"></a>-<a name="bytebase-v1-Setting"></a>+### ActuatorService+ActuatorService manages system health and operational information.-### Setting-The schema of setting.+| 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 |-| ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The resource name of the setting. Format: settings/{setting} Example: "settings/SEMANTIC_TYPES" |-| value | [SettingValue](#bytebase-v1-SettingValue) | | The configuration value of the setting. |+<a name="v1_iam_policy-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/iam_policy.proto-<a name="bytebase-v1-SettingValue"></a>+<a name="bytebase-v1-Binding"></a>-### SettingValue-The data in setting value.+### Binding+Binding associates members with a role and optional conditions.| 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) | | |+| 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 "instances/{instance}/databases/{database}" format, used by the "roles/sqlEditorUser" role, support "==" operator. resource.schema_name: the schema name, used by the "roles/sqlEditorUser" role, support "==" operator. resource.table_name: the table name, used by the "roles/sqlEditorUser" role, support "==" operator. request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")`.+For example: resource.database == "instances/local-pg/databases/postgres" && resource.schema_name in ["public","another_schema"] resource.database == "instances/local-pg/databases/bytebase" && resource.schema_name == "public" && resource.table_name in ["audit_log"] request.time < timestamp("2025-04-26T11:24:48.655Z") |+| parsed_expr | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | | The parsed expression of the condition. |-<a name="bytebase-v1-UpdateSettingRequest"></a>-### UpdateSettingRequest-The request message for updating or creating a setting.+<a name="bytebase-v1-BindingDelta"></a>++### BindingDelta+A single change to a binding.| 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) | | |-+| 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. |-<a name="bytebase-v1-WorkspaceApprovalSetting"></a>-### WorkspaceApprovalSetting+<a name="bytebase-v1-GetIamPolicyRequest"></a>+### GetIamPolicyRequest+Request message for getting an IAM policy.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |-+| resource | [string](#string) | | The name of the resource to get the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>-### WorkspaceApprovalSetting.Rule+<a name="bytebase-v1-IamPolicy"></a>+### IamPolicy+IAM policy that binds members to roles.| 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+| 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. |-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 "==", "!=", "<", "<=", ">", ">=" operations. statement.table_rows: table row count number, support "==", "!=", "<", "<=", ">", ">=" operations. resource.environment_id: the environment resource id, support "==", "!=", "in [xx]", "!(in [xx])" operations. resource.project_id: the project resource id, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.db_engine: the database engine type, support "==", "!=", "in [xx]", "!(in [xx])" operations. Check the Engine enum for values. statement.sql_type: the SQL type, support "==", "!=", "in [xx]", "!(in [xx])" operations. resource.database_name: the database name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.schema_name: the schema name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. resource.table_name: the table name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations. statement.text: the SQL statement, support "contains()", "matches()", "startsWith()", "endsWith()" operations. request.expiration_days: the role expiration days for the request, support "==", "!=", "<", "<=", ">", ">=" operations. request.role: the request role full name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" 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 == "prod" && statement.affected_rows >= 100 resource.table_name.matches("sensitive_.*") && resource.db_engine == "MYSQL" |-| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |+<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="bytebase-v1-WorkspaceProfileSetting"></a>-### WorkspaceProfileSetting-| 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. |-| token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for token. |-| 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 <= 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-SetIamPolicyRequest"></a>---<a name="bytebase-v1-WorkspaceProfileSetting-PasswordRestriction"></a>--### WorkspaceProfileSetting.PasswordRestriction-+### SetIamPolicyRequest+Request message for setting an IAM policy.| 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. |+| 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. |@@ -2824,876 +2835,907 @@ For examples: resource.environment_id == "prod" && statement.aff-<a name="bytebase-v1-AISetting-Provider"></a>--### AISetting.Provider+<a name="bytebase-v1-BindingDelta-Action"></a>+### BindingDelta.Action+Type of action performed on a binding.| Name | Number | Description || ---- | ------ | ----------- |-| PROVIDER_UNSPECIFIED | 0 | |-| OPEN_AI | 1 | |-| CLAUDE | 2 | |-| GEMINI | 3 | |-| AZURE_OPENAI | 4 | |+| ACTION_UNSPECIFIED | 0 | Unspecified action. |+| ADD | 1 | Add a binding. |+| REMOVE | 2 | Remove a binding. |+-<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>+-### Algorithm.InnerOuterMask.MaskType+-| Name | Number | Description |-| ---- | ------ | ----------- |-| MASK_TYPE_UNSPECIFIED | 0 | |-| INNER | 1 | |-| OUTER | 2 | |+<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-Announcement-AlertLevel"></a>-### Announcement.AlertLevel-We support three levels of AlertLevel: INFO, WARNING, and ERROR.-| Name | Number | Description |-| ---- | ------ | ----------- |-| ALERT_LEVEL_UNSPECIFIED | 0 | |-| INFO | 1 | |-| WARNING | 2 | |-| CRITICAL | 3 | |+<a name="bytebase-v1-AuditData"></a>+### AuditData+Additional audit data specific to certain operations.-<a name="bytebase-v1-DatabaseChangeMode"></a>+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |-### DatabaseChangeMode-| 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. |-<a name="bytebase-v1-Setting-SettingName"></a>+<a name="bytebase-v1-AuditLog"></a>-### Setting.SettingName+### AuditLog+Audit log entry recording system activity or API call.-| Name | Number | Description |-| ---- | ------ | ----------- |-| SETTING_NAME_UNSPECIFIED | 0 | |-| WORKSPACE_PROFILE | 4 | |-| WORKSPACE_APPROVAL | 5 | |-| APP_IM | 8 | |-| AI | 10 | |-| DATA_CLASSIFICATION | 14 | |-| SEMANTIC_TYPES | 15 | |-| ENVIRONMENT | 19 | |+| 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. |-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>-### WorkspaceApprovalSetting.Rule.Source-| Name | Number | Description |-| ---- | ------ | ----------- |-| SOURCE_UNSPECIFIED | 0 | |-| CHANGE_DATABASE | 1 | |-| CREATE_DATABASE | 2 | |-| EXPORT_DATA | 3 | |-| REQUEST_ROLE | 4 | |+<a name="bytebase-v1-ExportAuditLogsRequest"></a>+### 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. For example: - order_by = "create_time asc" - order_by = "create_time desc" |+| 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-SettingService"></a>-### SettingService-SettingService manages workspace-level settings and configurations.-| 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 |-+<a name="bytebase-v1-ExportAuditLogsResponse"></a>+### ExportAuditLogsResponse+Response message for exporting audit logs.-<a name="v1_user_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/user_service.proto+| 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. |-<a name="bytebase-v1-BatchGetUsersRequest"></a>-### BatchGetUsersRequest+<a name="bytebase-v1-RequestMetadata"></a>++### RequestMetadata+Metadata about the incoming request.+| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| names | [string](#string) | repeated | The user names to retrieve. Format: users/{user uid or user email} |-+| 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-BatchGetUsersResponse"></a>-### BatchGetUsersResponse+<a name="bytebase-v1-SearchAuditLogsRequest"></a>+### SearchAuditLogsRequest+Request message for searching audit logs.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |+| 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 "/bytebase.v1." prefix. For example "/bytebase.v1.UserService/CreateUser". Support "==" operator. - severity: support "==" operator, check Severity enum in AuditLog message for values. - user: the actor, should in "users/{email}" format, support "==" operator. - create_time: support ">=" and "<=" operator.+For example: - filter = "method == '/bytebase.v1.SQLService/Query'" - filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR'" - filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR' && user == 'users/[email protected]'" - filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR' && create_time <= '2021-01-01T00:00:00Z' && create_time >= '2020-01-01T00:00:00Z'" |+| order_by | [string](#string) | | The order by of the log. Only support order by create_time. For example: - order_by = "create_time asc" - order_by = "create_time desc" |+| 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-CreateUserRequest"></a>-### CreateUserRequest+<a name="bytebase-v1-SearchAuditLogsResponse"></a>+### SearchAuditLogsResponse+Response message for searching audit logs.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| user | [User](#bytebase-v1-User) | | The user to create. |+| 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-DeleteUserRequest"></a>+<a name="bytebase-v1-AuditLog-Severity"></a>-### DeleteUserRequest+### 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. |-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the user to delete. Format: users/{user} |+++++<a name="bytebase-v1-AuditLogService"></a>+### 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 |+-<a name="bytebase-v1-GetUserRequest"></a>-### GetUserRequest+<a name="v1_auth_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/auth_service.proto++++<a name="bytebase-v1-IdentityProviderContext"></a>++### IdentityProviderContext+Context for identity provider authentication.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the user to retrieve. Format: users/{user uid or user email} |+| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |+| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |-<a name="bytebase-v1-ListUsersRequest"></a>+<a name="bytebase-v1-LoginRequest"></a>-### ListUsersRequest+### LoginRequest| 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.+| email | [string](#string) | | User's email address. |+| password | [string](#string) | | User's password for authentication. |+| web | [bool](#bool) | | If web is set, we will set access token, refresh token, and user to the cookie. |+| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |+| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is using to get the user information from identity provider. |+| otp_code | [string](#string) | optional | The otp_code is used to verify the user's identity by MFA. |+| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user's identity with MFA. |+| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user's identity by MFA. |-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 "==" and ".matches()" operator. - email: the user email, support "==" and ".matches()" operator. - user_type: the type, check UserType enum for values, support "==", "in [xx]", "!(in [xx])" operator. - state: check State enum for values, support "==" operator. - project: the project full name in "projects/{id}" format, support "==" operator.-For example: name == "ed" name.matches("ed") email == "[email protected]" email.matches("ed") user_type == "SERVICE_ACCOUNT" user_type in ["SERVICE_ACCOUNT", "USER"] !(user_type in ["SERVICE_ACCOUNT", "USER"]) state == "DELETED" project == "projects/sample-project" You can combine filter conditions like: name.matches("ed") && project == "projects/sample-project" (name == "ed" || email == "[email protected]") && project == "projects/sample-project" |+<a name="bytebase-v1-LoginResponse"></a>+### LoginResponse-<a name="bytebase-v1-ListUsersResponse"></a>-### ListUsersResponse+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| token | [string](#string) | | Access token for authenticated requests. |+| 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. |-| 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. |+<a name="bytebase-v1-LogoutRequest"></a>+### LogoutRequest+Request to logout current user session.-<a name="bytebase-v1-UndeleteUserRequest"></a>-### UndeleteUserRequest+<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>++### OAuth2IdentityProviderContext+OAuth2 authentication context.++| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the deleted user. Format: users/{user} |-+| code | [string](#string) | | Authorization code from OAuth2 provider. |-<a name="bytebase-v1-UpdateUserRequest"></a>-### UpdateUserRequest+<a name="bytebase-v1-OIDCIdentityProviderContext"></a>+### OIDCIdentityProviderContext+OpenID Connect authentication context.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| user | [User](#bytebase-v1-User) | | The user to update.+| code | [string](#string) | | Authorization code from OIDC provider. |+-The user's `name` field is used to identify the user to update. Format: users/{user} |-| 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'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-User"></a>-### User+<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 |++++++<a name="v1_cel_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>++## v1/cel_service.proto++<a name="bytebase-v1-BatchDeparseRequest"></a>++### BatchDeparseRequest+Request message for batch deparsing CEL expressions.+| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the user. Format: users/{user}. {user} is a system-generated unique ID. |-| 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} |+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |-<a name="bytebase-v1-User-Profile"></a>+<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. |+-### User.Profile++<a name="bytebase-v1-BatchParseRequest"></a>++### BatchParseRequest+Request message for batch parsing CEL expressions.++| 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. |+| expressions | [string](#string) | repeated | The CEL expression strings to parse. |-+<a name="bytebase-v1-BatchParseResponse"></a>-<a name="bytebase-v1-UserType"></a>+### 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. |-### 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. |+-<a name="bytebase-v1-UserService"></a>-### UserService-UserService manages user accounts and authentication.+<a name="bytebase-v1-CelService"></a>++### CelService+CelService manages CEL (Common Expression Language) parsing and formatting operations.| 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. 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 |+| 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_actuator_service-proto"></a>+<a name="v1_database_catalog_service-proto"></a><p align="right"><a href="#top">Top</a></p>-## v1/actuator_service.proto+## v1/database_catalog_service.proto-<a name="bytebase-v1-ActuatorInfo"></a>+<a name="bytebase-v1-ColumnCatalog"></a>-### ActuatorInfo-System information and configuration for the Bytebase instance.-Actuator concept is similar to the Spring Boot Actuator.+### ColumnCatalog+Column metadata within a table.| 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. |-| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |-| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |-| require_2fa | [bool](#bool) | | Whether two-factor authentication is required for all users. |-| 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. |-| 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. |-| 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). |+| 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-ActuatorInfo-StatUser"></a>+<a name="bytebase-v1-ColumnCatalog-LabelsEntry"></a>++### ColumnCatalog.LabelsEntry-### 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. |---+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-DeleteCacheRequest"></a>-### DeleteCacheRequest-Request message for deleting cache.+<a name="bytebase-v1-DatabaseCatalog"></a>+### DatabaseCatalog+Catalog metadata for a database including schemas, tables, and columns.+| 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. |-<a name="bytebase-v1-GetActuatorInfoRequest"></a>-### GetActuatorInfoRequest-Request message for getting actuator information.+<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>+### GetDatabaseCatalogRequest+Request message for getting a database catalog.-<a name="bytebase-v1-GetResourcePackageRequest"></a>-### GetResourcePackageRequest-Request message for getting branding resources.+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |-<a name="bytebase-v1-ResourcePackage"></a>+<a name="bytebase-v1-ObjectSchema"></a>-### ResourcePackage-Custom branding resources for the Bytebase instance.+### ObjectSchema+Schema definition for object-type columns.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| logo | [bytes](#bytes) | | The branding logo. |+| 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-SetupSampleRequest"></a>+<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>-### SetupSampleRequest-Request message for setting up sample data.+### ObjectSchema.ArrayKind+Array type with element schema.+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |-<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>-### UpdateActuatorInfoRequest-Request message for updating actuator information.++<a name="bytebase-v1-ObjectSchema-StructKind"></a>++### ObjectSchema.StructKind+Structure type with named properties.| 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. |+| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |--+<a name="bytebase-v1-ObjectSchema-StructKind-PropertiesEntry"></a>-+### ObjectSchema.StructKind.PropertiesEntry-<a name="bytebase-v1-ActuatorService"></a>--### 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 |+| ----- | ---- | ----- | ----------- |+| key | [string](#string) | | |+| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |-<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-AuditData"></a>+<a name="bytebase-v1-SchemaCatalog"></a>-### AuditData-Additional audit data specific to certain operations.+### SchemaCatalog+Schema metadata within a database.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |+| name | [string](#string) | | The schema name. |+| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |-<a name="bytebase-v1-AuditLog"></a>+<a name="bytebase-v1-TableCatalog"></a>-### AuditLog-Audit log entry recording system activity or API call.+### TableCatalog+Table metadata within a schema.| 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 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-ExportAuditLogsRequest"></a>+<a name="bytebase-v1-TableCatalog-Columns"></a>-### ExportAuditLogsRequest-Request message for exporting audit logs.+### TableCatalog.Columns+Column list for regular tables.| 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. For example: - order_by = "create_time asc" - order_by = "create_time desc" |-| 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. |+| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |-<a name="bytebase-v1-ExportAuditLogsResponse"></a>+<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>-### ExportAuditLogsResponse-Response message for exporting audit logs.+### UpdateDatabaseCatalogRequest+Request message for updating a database catalog.| 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. |-+| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.+The catalog'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-RequestMetadata"></a>-### 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. |+<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. |++-<a name="bytebase-v1-SearchAuditLogsRequest"></a>-### SearchAuditLogsRequest-Request message for searching audit logs.+<a name="bytebase-v1-DatabaseCatalogService"></a>+### DatabaseCatalogService+DatabaseCatalogService manages database schema metadata and classification.-| 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+| 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 |-Supported filter: - method: the API name, can be found in the docs, should start with "/bytebase.v1." prefix. For example "/bytebase.v1.UserService/CreateUser". Support "==" operator. - severity: support "==" operator, check Severity enum in AuditLog message for values. - user: the actor, should in "users/{email}" format, support "==" operator. - create_time: support ">=" and "<=" operator.+-For example: - filter = "method == '/bytebase.v1.SQLService/Query'" - filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR'" - filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR' && user == 'users/[email protected]'" - filter = "method == '/bytebase.v1.SQLService/Query' && severity == 'ERROR' && create_time <= '2021-01-01T00:00:00Z' && create_time >= '2020-01-01T00:00:00Z'" |-| order_by | [string](#string) | | The order by of the log. Only support order by create_time. For example: - order_by = "create_time asc" - order_by = "create_time desc" |-| 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="v1_database_group_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/database_group_service.proto-<a name="bytebase-v1-SearchAuditLogsResponse"></a>+<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>-### SearchAuditLogsResponse-Response message for searching audit logs.+### CreateDatabaseGroupRequest+Request message for creating a database group.| 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. |-------+| 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's resource name.-<a name="bytebase-v1-AuditLog-Severity"></a>+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. |-### 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-DatabaseGroup"></a>-<a name="bytebase-v1-AuditLogService"></a>+### DatabaseGroup+A group of databases matched by expressions.-### 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 |+| ----- | ---- | ----- | ----------- |+| 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 "==", "!=", "in [XX]", "!(in [xx])" operations. resource.instance_id: the instance resource id. Support "==", "!=", "in [XX]", "!(in [xx])", "contains", "matches", "startsWith", "endsWith" operations. resource.database_name: the database name. Support "==", "!=", "in [XX]", "!(in [xx])", "contains", "matches", "startsWith", "endsWith" operations. resource.database_labels: the database labels. Support map access operations. All variables should join with "&&" condition.+For example: resource.environment_id == "test" && resource.database_name.startsWith("sample_") resource.database_labels["tenant"] == "tenant1" |+| matched_databases | [DatabaseGroup.Database](#bytebase-v1-DatabaseGroup-Database) | repeated | The list of databases that match the database group condition. |-<a name="v1_auth_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/auth_service.proto-<a name="bytebase-v1-IdentityProviderContext"></a>+<a name="bytebase-v1-DatabaseGroup-Database"></a>-### IdentityProviderContext-Context for identity provider authentication.+### DatabaseGroup.Database+A database within a database group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |-| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |-+| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |-<a name="bytebase-v1-LoginRequest"></a>-### LoginRequest+<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>+### DeleteDatabaseGroupRequest+Request message for deleting a database group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| email | [string](#string) | | User's email address. |-| password | [string](#string) | | User's password for authentication. |-| web | [bool](#bool) | | If web is set, we will set access token, refresh token, and user to the cookie. |-| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |-| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is using to get the user information from identity provider. |-| otp_code | [string](#string) | optional | The otp_code is used to verify the user's identity by MFA. |-| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user's identity with MFA. |-| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user's identity by MFA. |-+| name | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |-<a name="bytebase-v1-LoginResponse"></a>-### LoginResponse+<a name="bytebase-v1-GetDatabaseGroupRequest"></a>+### GetDatabaseGroupRequest+Request message for getting a database group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| token | [string](#string) | | Access token for authenticated requests. |-| 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. |+| 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-LogoutRequest"></a>+<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>-### LogoutRequest-Request to logout current user session.+### ListDatabaseGroupsRequest+Request message for listing database groups.+| 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. |-<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>-### OAuth2IdentityProviderContext-OAuth2 authentication context.++<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>++### ListDatabaseGroupsResponse+Response message for listing database groups.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| code | [string](#string) | | Authorization code from OAuth2 provider. |+| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |-<a name="bytebase-v1-OIDCIdentityProviderContext"></a>+<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>-### OIDCIdentityProviderContext-OpenID Connect authentication context.+### UpdateDatabaseGroupRequest+Request message for updating a database group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| code | [string](#string) | | Authorization code from OIDC provider. |-+| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.+The database group'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-AuthService"></a>+<a name="bytebase-v1-DatabaseGroupView"></a>-### AuthService-AuthService handles user authentication operations.+### DatabaseGroupView+View options for database group responses.-| 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 |+| 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="v1_cel_service-proto"></a>+### DatabaseGroupService+DatabaseGroupService manages database groups for organizing databases by criteria.++| 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 |++++++<a name="v1_instance_role_service-proto"></a><p align="right"><a href="#top">Top</a></p>-## v1/cel_service.proto+## v1/instance_role_service.proto-<a name="bytebase-v1-BatchDeparseRequest"></a>+<a name="bytebase-v1-GetInstanceRoleRequest"></a>++### GetInstanceRoleRequest-### BatchDeparseRequest-Request message for batch deparsing CEL expressions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |+| name | [string](#string) | | The name of the role to retrieve. Format: instances/{instance}/roles/{role name} The role name is the unique name for the role. |-<a name="bytebase-v1-BatchDeparseResponse"></a>+<a name="bytebase-v1-InstanceRole"></a>-### BatchDeparseResponse-Response message for batch deparsing CEL expressions.+### InstanceRole+InstanceRole is the API message for instance role.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |+| 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'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'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's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |-<a name="bytebase-v1-BatchParseRequest"></a>+<a name="bytebase-v1-ListInstanceRolesRequest"></a>++### ListInstanceRolesRequest-### 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, 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-BatchParseResponse"></a>-### BatchParseResponse-Response message for batch parsing CEL expressions.+<a name="bytebase-v1-ListInstanceRolesResponse"></a>++### ListInstanceRolesResponse+| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |+| 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. |@@ -3706,2891 +3748,2754 @@ Response message for batch parsing CEL expressions.-<a name="bytebase-v1-CelService"></a>+<a name="bytebase-v1-InstanceRoleService"></a>-### CelService-CelService manages CEL (Common Expression Language) parsing and formatting operations.+### InstanceRoleService+InstanceRoleService manages database roles within instances.| 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 |+| GetInstanceRole | [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest) | [InstanceRole](#bytebase-v1-InstanceRole) | Gets a database role from an instance. Permissions required: bb.instanceRoles.get |+| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |-<a name="v1_database_catalog_service-proto"></a>+<a name="v1_instance_service-proto"></a><p align="right"><a href="#top">Top</a></p>-## v1/database_catalog_service.proto+## v1/instance_service.proto-<a name="bytebase-v1-ColumnCatalog"></a>+<a name="bytebase-v1-AddDataSourceRequest"></a>++### AddDataSourceRequest-### ColumnCatalog-Column metadata within a table.| 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. |+| 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-ColumnCatalog-LabelsEntry"></a>+<a name="bytebase-v1-BatchSyncInstancesRequest"></a>-### ColumnCatalog.LabelsEntry+### BatchSyncInstancesRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |+| 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-DatabaseCatalog"></a>+<a name="bytebase-v1-BatchSyncInstancesResponse"></a>-### DatabaseCatalog-Catalog metadata for a database including schemas, tables, and columns.+### BatchSyncInstancesResponse-| 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. |+<a name="bytebase-v1-BatchUpdateInstancesRequest"></a>-<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>+### BatchUpdateInstancesRequest-### 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 |+| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |-<a name="bytebase-v1-ObjectSchema"></a>+<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>++### BatchUpdateInstancesResponse-### ObjectSchema-Schema definition for object-type columns.| 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. |+| instances | [Instance](#bytebase-v1-Instance) | repeated | |-<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>+<a name="bytebase-v1-CreateInstanceRequest"></a>++### CreateInstanceRequest-### ObjectSchema.ArrayKind-Array type with element schema.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |+| 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's resource name.++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. |-<a name="bytebase-v1-ObjectSchema-StructKind"></a>+<a name="bytebase-v1-DataSource"></a>++### DataSource-### ObjectSchema.StructKind-Structure type with named properties.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |+| 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'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's empty string, no password is required. |+| ssh_private_key | [string](#string) | | The private key to login the server. If it's empty string, we will use the system default private key from os.Getenv("SSH_AUTH_SOCK"). |+| authentication_private_key | [string](#string) | | PKCS#8 private key in PEM format. If it'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-ObjectSchema-StructKind-PropertiesEntry"></a>+<a name="bytebase-v1-DataSource-AWSCredential"></a>-### ObjectSchema.StructKind.PropertiesEntry+### DataSource.AWSCredential| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |+| 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-SchemaCatalog"></a>+<a name="bytebase-v1-DataSource-Address"></a>++### DataSource.Address-### SchemaCatalog-Schema metadata within a database.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The schema name. |-| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |+| host | [string](#string) | | |+| port | [string](#string) | | |-<a name="bytebase-v1-TableCatalog"></a>+<a name="bytebase-v1-DataSource-AzureCredential"></a>++### DataSource.AzureCredential-### TableCatalog-Table metadata within a schema.| 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. |+| tenant_id | [string](#string) | | |+| client_id | [string](#string) | | |+| client_secret | [string](#string) | | |-<a name="bytebase-v1-TableCatalog-Columns"></a>+<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>++### DataSource.ExtraConnectionParametersEntry-### TableCatalog.Columns-Column list for regular tables.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>+<a name="bytebase-v1-DataSource-GCPCredential"></a>++### DataSource.GCPCredential-### UpdateDatabaseCatalogRequest-Request message for updating a database catalog.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.+| content | [string](#string) | | |-The catalog'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-DataSourceExternalSecret"></a>+### DataSourceExternalSecret-<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 |+| ----- | ---- | ----- | ----------- |+| 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-DatabaseCatalogService"></a>-### DatabaseCatalogService-DatabaseCatalogService manages database schema metadata and classification.+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption"></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 |+### DataSourceExternalSecret.AppRoleAuthOption-+++| 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. |-<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-DeleteInstanceRequest"></a>-<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>+### DeleteInstanceRequest-### CreateDatabaseGroupRequest-Request message for creating a database group.| 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's resource name.+| 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. |-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-GetInstanceRequest"></a>-<a name="bytebase-v1-DatabaseGroup"></a>+### GetInstanceRequest-### DatabaseGroup-A group of databases matched by expressions.| 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 "==", "!=", "in [XX]", "!(in [xx])" operations. resource.instance_id: the instance resource id. Support "==", "!=", "in [XX]", "!(in [xx])", "contains", "matches", "startsWith", "endsWith" operations. resource.database_name: the database name. Support "==", "!=", "in [XX]", "!(in [xx])", "contains", "matches", "startsWith", "endsWith" operations. resource.database_labels: the database labels. Support map access operations. All variables should join with "&&" condition.+| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |-For example: resource.environment_id == "test" && resource.database_name.startsWith("sample_") resource.database_labels["tenant"] == "tenant1" |-| matched_databases | [DatabaseGroup.Database](#bytebase-v1-DatabaseGroup-Database) | repeated | The list of databases that match the database group condition. |+<a name="bytebase-v1-Instance"></a>-<a name="bytebase-v1-DatabaseGroup-Database"></a>+### Instance-### DatabaseGroup.Database-A database within a database group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |+| 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. |+| maximum_connections | [int32](#int32) | | The maximum number of connections. The default is 10 if the value is unset or zero. |+| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas & 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, { "org_group": "infrastructure", "environment": "production" } |-<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>+<a name="bytebase-v1-Instance-LabelsEntry"></a>++### Instance.LabelsEntry-### 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} |+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-GetDatabaseGroupRequest"></a>+<a name="bytebase-v1-InstanceResource"></a>++### InstanceResource-### 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. |+| 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-ListDatabaseGroupsRequest"></a>+<a name="bytebase-v1-KerberosConfig"></a>++### KerberosConfig-### ListDatabaseGroupsRequest-Request message for listing database groups.| 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. |+| 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-ListDatabaseGroupsResponse"></a>+<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>++### ListInstanceDatabaseRequest-### 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 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. |-<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>+<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>++### ListInstanceDatabaseResponse-### UpdateDatabaseGroupRequest-Request message for updating a database group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.+| databases | [string](#string) | repeated | All database name list in the instance. |-The database group'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-ListInstancesRequest"></a>+### ListInstancesRequest-<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. |+| 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 "==" and ".matches()" operator. - resource_id: the instance id, support "==" and ".matches()" operator. - environment: the environment full name in "environments/{id}" format, support "==" operator. - state: the instance state, check State enum for values, support "==" operator. - engine: the instance engine, check Engine enum for values. Support "==", "in [xx]", "!(in [xx])" operator. - host: the instance host, support "==" and ".matches()" operator. - port: the instance port, support "==" and ".matches()" operator. - project: the project full name in "projects/{id}" format, support "==" operator. - labels.{key}: the instance label, support "==" and "in" operators.-+For example: name == "sample instance" name.matches("sample") resource_id == "sample-instance" resource_id.matches("sample") state == "DELETED" environment == "environments/test" environment == "" (find instances which environment is not set) engine == "MYSQL" engine in ["MYSQL", "POSTGRES"] !(engine in ["MYSQL", "POSTGRES"]) host == "127.0.0.1" host.matches("127.0") port == "54321" port.matches("543") labels.org_group == "infrastructure" labels.environment in ["prod", "production"] project == "projects/sample-project" You can combine filter conditions like: name.matches("sample") && environment == "environments/test" host == "127.0.0.1" && port == "54321" |-<a name="bytebase-v1-DatabaseGroupService"></a>-### DatabaseGroupService-DatabaseGroupService manages database groups for organizing databases by criteria.-| 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 |-+<a name="bytebase-v1-ListInstancesResponse"></a>+### ListInstancesResponse-<a name="v1_instance_role_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/instance_role_service.proto++| 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. |-<a name="bytebase-v1-GetInstanceRoleRequest"></a>-### GetInstanceRoleRequest+++<a name="bytebase-v1-RemoveDataSourceRequest"></a>++### RemoveDataSourceRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the role to retrieve. Format: instances/{instance}/roles/{role name} The role name is the unique name for the role. |+| 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-InstanceRole"></a>+<a name="bytebase-v1-SASLConfig"></a>++### SASLConfig-### 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'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'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's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |+| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |-<a name="bytebase-v1-ListInstanceRolesRequest"></a>+<a name="bytebase-v1-SyncInstanceRequest"></a>-### ListInstanceRolesRequest+### SyncInstanceRequest| 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.--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. |+| 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-ListInstanceRolesResponse"></a>+<a name="bytebase-v1-SyncInstanceResponse"></a>-### ListInstanceRolesResponse+### SyncInstanceResponse| 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. |-+| databases | [string](#string) | repeated | All database name list in the instance. |---+<a name="bytebase-v1-UndeleteInstanceRequest"></a>+### UndeleteInstanceRequest-<a name="bytebase-v1-InstanceRoleService"></a>-### InstanceRoleService-InstanceRoleService manages database roles within instances.-| Method Name | Request Type | Response Type | Description |-| ----------- | ------------ | ------------- | ------------|-| GetInstanceRole | [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest) | [InstanceRole](#bytebase-v1-InstanceRole) | Gets a database role from an instance. Permissions required: bb.instanceRoles.get |-| 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 deleted instance. Format: instances/{instance} |--<a name="v1_instance_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/instance_service.proto+<a name="bytebase-v1-UpdateDataSourceRequest"></a>--<a name="bytebase-v1-AddDataSourceRequest"></a>--### AddDataSourceRequest+### UpdateDataSourceRequest| 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. |+| 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-BatchSyncInstancesRequest"></a>+<a name="bytebase-v1-UpdateInstanceRequest"></a>-### BatchSyncInstancesRequest+### UpdateInstanceRequest| 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. |+| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.+The instance'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-BatchSyncInstancesResponse"></a>+-### BatchSyncInstancesResponse+<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-BatchUpdateInstancesRequest"></a>+<a name="bytebase-v1-DataSource-RedisType"></a>-### BatchUpdateInstancesRequest+### DataSource.RedisType+| Name | Number | Description |+| ---- | ------ | ----------- |+| REDIS_TYPE_UNSPECIFIED | 0 | |+| STANDALONE | 1 | |+| SENTINEL | 2 | |+| CLUSTER | 3 | |-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>+### DataSourceExternalSecret.AppRoleAuthOption.SecretType+| Name | Number | Description |+| ---- | ------ | ----------- |+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |+| PLAIN | 1 | Plain text secret. |+| ENVIRONMENT | 2 | Secret from environment variable. |-<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>-### BatchUpdateInstancesResponse+<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></a>+### DataSourceExternalSecret.AuthType-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| instances | [Instance](#bytebase-v1-Instance) | repeated | |+| 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 |+<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>+### DataSourceExternalSecret.SecretType-<a name="bytebase-v1-CreateInstanceRequest"></a>-### CreateInstanceRequest+| 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 |-| 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's resource name.+<a name="bytebase-v1-DataSourceType"></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. |+### 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-DataSource"></a>-### DataSource+<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 |++-| 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'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's empty string, no password is required. |-| ssh_private_key | [string](#string) | | The private key to login the server. If it's empty string, we will use the system default private key from os.Getenv("SSH_AUTH_SOCK"). |-| authentication_private_key | [string](#string) | | PKCS#8 private key in PEM format. If it'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="v1_database_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/database_service.proto-<a name="bytebase-v1-DataSource-AWSCredential"></a>+<a name="bytebase-v1-BatchGetDatabasesRequest"></a>-### DataSource.AWSCredential+### BatchGetDatabasesRequest| 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 |+| 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 "-" as wildcard to batch get databases across parent. |+| names | [string](#string) | repeated | The list of database names to retrieve. |-<a name="bytebase-v1-DataSource-Address"></a>+<a name="bytebase-v1-BatchGetDatabasesResponse"></a>-### DataSource.Address+### BatchGetDatabasesResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| host | [string](#string) | | |-| port | [string](#string) | | |+| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |-<a name="bytebase-v1-DataSource-AzureCredential"></a>+<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>-### DataSource.AzureCredential+### BatchSyncDatabasesRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| tenant_id | [string](#string) | | |-| client_id | [string](#string) | | |-| client_secret | [string](#string) | | |+| 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. |-<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>+<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>-### DataSource.ExtraConnectionParametersEntry+### BatchSyncDatabasesResponse++++++++<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>++### BatchUpdateDatabasesRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |+| 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-DataSource-GCPCredential"></a>+<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>-### DataSource.GCPCredential+### BatchUpdateDatabasesResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| content | [string](#string) | | |-+| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |-<a name="bytebase-v1-DataSourceExternalSecret"></a>-### DataSourceExternalSecret+<a name="bytebase-v1-BoundingBox"></a>+### BoundingBox+BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.| 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. |+| 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-DataSourceExternalSecret-AppRoleAuthOption"></a>+<a name="bytebase-v1-ChangedResourceDatabase"></a>-### DataSourceExternalSecret.AppRoleAuthOption+### ChangedResourceDatabase| 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) | | |+| schemas | [ChangedResourceSchema](#bytebase-v1-ChangedResourceSchema) | repeated | |-<a name="bytebase-v1-DeleteInstanceRequest"></a>+<a name="bytebase-v1-ChangedResourceFunction"></a>-### DeleteInstanceRequest+### ChangedResourceFunction| 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) | | |+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |-<a name="bytebase-v1-GetInstanceRequest"></a>+<a name="bytebase-v1-ChangedResourceProcedure"></a>-### GetInstanceRequest+### ChangedResourceProcedure| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |+| name | [string](#string) | | |+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |-<a name="bytebase-v1-Instance"></a>+<a name="bytebase-v1-ChangedResourceSchema"></a>-### Instance+### ChangedResourceSchema| 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. |-| maximum_connections | [int32](#int32) | | The maximum number of connections. The default is 10 if the value is unset or zero. |-| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas & 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, { "org_group": "infrastructure", "environment": "production" } |+| name | [string](#string) | | |+| tables | [ChangedResourceTable](#bytebase-v1-ChangedResourceTable) | repeated | |+| views | [ChangedResourceView](#bytebase-v1-ChangedResourceView) | repeated | |+| functions | [ChangedResourceFunction](#bytebase-v1-ChangedResourceFunction) | repeated | |+| procedures | [ChangedResourceProcedure](#bytebase-v1-ChangedResourceProcedure) | repeated | |-<a name="bytebase-v1-Instance-LabelsEntry"></a>+<a name="bytebase-v1-ChangedResourceTable"></a>-### Instance.LabelsEntry+### ChangedResourceTable| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |+| name | [string](#string) | | |+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |-<a name="bytebase-v1-InstanceResource"></a>+<a name="bytebase-v1-ChangedResourceView"></a>-### InstanceResource+### ChangedResourceView| 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) | | |+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |-<a name="bytebase-v1-KerberosConfig"></a>+<a name="bytebase-v1-ChangedResources"></a>-### KerberosConfig+### ChangedResources| 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). |+| databases | [ChangedResourceDatabase](#bytebase-v1-ChangedResourceDatabase) | repeated | |-<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>+<a name="bytebase-v1-Changelog"></a>-### ListInstanceDatabaseRequest+### Changelog| 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) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |+| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |+| statement | [string](#string) | | The statement is used for preview purpose. |+| statement_size | [int64](#int64) | | |+| statement_sheet | [string](#string) | | The name of the sheet resource. Format: projects/{project}/sheets/{sheet} |+| schema | [string](#string) | | |+| schema_size | [int64](#int64) | | |+| prev_schema | [string](#string) | | |+| prev_schema_size | [int64](#int64) | | |+| issue | [string](#string) | | Format: projects/{project}/issues/{issue} |+| task_run | [string](#string) | | Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |+| version | [string](#string) | | Could be empty |+| revision | [string](#string) | | Could be empty Or present but not found if deleted |+| changed_resources | [ChangedResources](#bytebase-v1-ChangedResources) | | |+| type | [Changelog.Type](#bytebase-v1-Changelog-Type) | | |-<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>-### ListInstanceDatabaseResponse+<a name="bytebase-v1-CheckConstraintMetadata"></a>+### CheckConstraintMetadata+CheckConstraintMetadata is the metadata for check constraints.| 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 check constraint. |+| expression | [string](#string) | | The expression is the expression of a check constraint. |-<a name="bytebase-v1-ListInstancesRequest"></a>-### ListInstancesRequest+<a name="bytebase-v1-ColumnMetadata"></a>+### ColumnMetadata+ColumnMetadata is the metadata for columns.| 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.+| 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'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's default value, you must reference the constraint by name. This field stores the actual constraint name from the database.-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+Example: A column definition like: CREATE TABLE employees ( status NVARCHAR(20) DEFAULT 'active' )-Supported filters: - name: the instance name, support "==" and ".matches()" operator. - resource_id: the instance id, support "==" and ".matches()" operator. - environment: the environment full name in "environments/{id}" format, support "==" operator. - state: the instance state, check State enum for values, support "==" operator. - engine: the instance engine, check Engine enum for values. Support "==", "in [xx]", "!(in [xx])" operator. - host: the instance host, support "==" and ".matches()" operator. - port: the instance port, support "==" and ".matches()" operator. - project: the project full name in "projects/{id}" format, support "==" operator. - labels.{key}: the instance label, support "==" and "in" operators.+Will create a constraint with an auto-generated name like 'DF__employees__statu__3B75D760' or a user-defined name if specified: ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT 'active' FOR status-For example: name == "sample instance" name.matches("sample") resource_id == "sample-instance" resource_id.matches("sample") state == "DELETED" environment == "environments/test" environment == "" (find instances which environment is not set) engine == "MYSQL" engine in ["MYSQL", "POSTGRES"] !(engine in ["MYSQL", "POSTGRES"]) host == "127.0.0.1" host.matches("127.0") port == "54321" port.matches("543") labels.org_group == "infrastructure" labels.environment in ["prod", "production"] project == "projects/sample-project" You can combine filter conditions like: name.matches("sample") && environment == "environments/test" host == "127.0.0.1" && port == "54321" |+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 'inactive' 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-ListInstancesResponse"></a>-### ListInstancesResponse+<a name="bytebase-v1-Database"></a>++### Database| 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. |+| 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-RemoveDataSourceRequest"></a>+<a name="bytebase-v1-Database-LabelsEntry"></a>-### RemoveDataSourceRequest+### Database.LabelsEntry| 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. |-+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-SASLConfig"></a>-### SASLConfig+<a name="bytebase-v1-DatabaseMetadata"></a>+### DatabaseMetadata+DatabaseMetadata is the metadata for databases.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |+| 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-SyncInstanceRequest"></a>-### SyncInstanceRequest+<a name="bytebase-v1-DatabaseSDLSchema"></a>+### DatabaseSDLSchema+DatabaseSDLSchema contains the schema in SDL format.| 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. |-+| 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: - "text/plain; charset=utf-8" for SINGLE_FILE format - "application/zip" for MULTI_FILE format |-<a name="bytebase-v1-SyncInstanceResponse"></a>-### SyncInstanceResponse+<a name="bytebase-v1-DatabaseSchema"></a>+### DatabaseSchema+DatabaseSchema is the metadata for databases.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| databases | [string](#string) | repeated | All database name list in the instance. |-+| schema | [string](#string) | | The schema dump from database. |-<a name="bytebase-v1-UndeleteInstanceRequest"></a>-### UndeleteInstanceRequest+<a name="bytebase-v1-DependencyColumn"></a>+### DependencyColumn+DependencyColumn is the metadata for dependency columns.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |+| 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. |-<a name="bytebase-v1-UpdateDataSourceRequest"></a>+<a name="bytebase-v1-DependencyTable"></a>-### UpdateDataSourceRequest+### DependencyTable| 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. |+| 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-UpdateInstanceRequest"></a>+<a name="bytebase-v1-DiffSchemaRequest"></a>-### UpdateInstanceRequest+### DiffSchemaRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.--The instance'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. |+| 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="bytebase-v1-DiffSchemaResponse"></a>-<a name="bytebase-v1-DataSource-AuthenticationType"></a>+### DiffSchemaResponse-### DataSource.AuthenticationType-| Name | Number | Description |-| ---- | ------ | ----------- |-| AUTHENTICATION_UNSPECIFIED | 0 | |-| PASSWORD | 1 | |-| GOOGLE_CLOUD_SQL_IAM | 2 | |-| AWS_RDS_IAM | 3 | |-| AZURE_IAM | 4 | |+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| diff | [string](#string) | | |-<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-DimensionConstraint"></a>+### DimensionConstraint+DimensionConstraint defines constraints for a spatial dimension.-<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>+| 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 |-### DataSourceExternalSecret.AppRoleAuthOption.SecretType-| Name | Number | Description |-| ---- | ------ | ----------- |-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |-| PLAIN | 1 | Plain text secret. |-| ENVIRONMENT | 2 | Secret from environment variable. |-<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></a>+<a name="bytebase-v1-DimensionalConfig"></a>-### DataSourceExternalSecret.AuthType---| 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 |+### 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 |-<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>-### DataSourceExternalSecret.SecretType-| 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 |+<a name="bytebase-v1-EnumTypeMetadata"></a>-<a name="bytebase-v1-DataSourceType"></a>+### EnumTypeMetadata-### 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. |+| 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. |---<a name="bytebase-v1-InstanceService"></a>-### InstanceService-InstanceService manages database instances and their connections.+<a name="bytebase-v1-EventMetadata"></a>-| 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 |+### EventMetadata-+| 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. |-<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+<a name="bytebase-v1-ExtensionMetadata"></a>+### ExtensionMetadata+ExtensionMetadata is the metadata for extensions.| 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 "-" as wildcard to batch get databases across parent. |-| names | [string](#string) | repeated | The list of database names to retrieve. |+| 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-BatchGetDatabasesResponse"></a>+<a name="bytebase-v1-ExternalTableMetadata"></a>-### BatchGetDatabasesResponse+### ExternalTableMetadata| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| databases | [Database](#bytebase-v1-Database) | repeated | The databases 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-BatchSyncDatabasesRequest"></a>-### BatchSyncDatabasesRequest+<a name="bytebase-v1-ForeignKeyMetadata"></a>+### ForeignKeyMetadata+ForeignKeyMetadata is the metadata for foreign keys.| 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. |+| 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's empty string for other databases. |-<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>+<a name="bytebase-v1-FunctionMetadata"></a>++### FunctionMetadata+FunctionMetadata is the metadata for functions.-### BatchSyncDatabasesResponse+| 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's the list of tables that the function depends on the return type definition. |+| skip_dump | [bool](#bool) | | |-<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>+<a name="bytebase-v1-GenerationMetadata"></a>-### BatchUpdateDatabasesRequest+### GenerationMetadata| 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. |+| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |+| expression | [string](#string) | | |-<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>+<a name="bytebase-v1-GetChangelogRequest"></a>-### BatchUpdateDatabasesResponse+### GetChangelogRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |+| 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-BoundingBox"></a>+<a name="bytebase-v1-GetDatabaseMetadataRequest"></a>++### GetDatabaseMetadataRequest-### BoundingBox-BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.| 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 |+| 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++Supported filter: - schema: the schema name, support "==" operator. - table: the table name, support "==" and ".matches()" operator.++For example: schema == "schema-a" table == "table-a" table.matches("table-a") schema == "schema-a" && table.matches("sample") The filter used to search table with wildcard "sample" in the schema "schemas/schema-a". 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-ChangedResourceDatabase"></a>+<a name="bytebase-v1-GetDatabaseRequest"></a>-### ChangedResourceDatabase+### GetDatabaseRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| schemas | [ChangedResourceSchema](#bytebase-v1-ChangedResourceSchema) | repeated | |+| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |-<a name="bytebase-v1-ChangedResourceFunction"></a>+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>-### ChangedResourceFunction+### GetDatabaseSDLSchemaRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |+| 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="bytebase-v1-ChangedResourceProcedure"></a>+<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>-### ChangedResourceProcedure+### GetDatabaseSchemaRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |+| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |-<a name="bytebase-v1-ChangedResourceSchema"></a>+<a name="bytebase-v1-GetSchemaStringRequest"></a>-### ChangedResourceSchema+### GetSchemaStringRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| tables | [ChangedResourceTable](#bytebase-v1-ChangedResourceTable) | repeated | |-| views | [ChangedResourceView](#bytebase-v1-ChangedResourceView) | repeated | |-| functions | [ChangedResourceFunction](#bytebase-v1-ChangedResourceFunction) | repeated | |-| procedures | [ChangedResourceProcedure](#bytebase-v1-ChangedResourceProcedure) | repeated | |+| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} |+| type | [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType) | | |+| schema | [string](#string) | | It's empty for DATABASE. |+| object | [string](#string) | | It'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-ChangedResourceTable"></a>+<a name="bytebase-v1-GetSchemaStringResponse"></a>-### ChangedResourceTable+### GetSchemaStringResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |-+| schema_string | [string](#string) | | |-<a name="bytebase-v1-ChangedResourceView"></a>-### ChangedResourceView+<a name="bytebase-v1-GridLevel"></a>+### GridLevel+GridLevel defines a tessellation grid level with its density.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | |-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |-+| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |+| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |-<a name="bytebase-v1-ChangedResources"></a>-### ChangedResources+<a name="bytebase-v1-IndexMetadata"></a>+### IndexMetadata+IndexMetadata is the metadata for indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| databases | [ChangedResourceDatabase](#bytebase-v1-ChangedResourceDatabase) | 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'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's a ClickHouse specific field. |+| is_constraint | [bool](#bool) | | It'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-Changelog"></a>+<a name="bytebase-v1-ListChangelogsRequest"></a>-### Changelog+### ListChangelogsRequest| 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) | | |-| statement | [string](#string) | | The statement is used for preview purpose. |-| statement_size | [int64](#int64) | | |-| statement_sheet | [string](#string) | | The name of the sheet resource. Format: projects/{project}/sheets/{sheet} |-| schema | [string](#string) | | |-| schema_size | [int64](#int64) | | |-| prev_schema | [string](#string) | | |-| prev_schema_size | [int64](#int64) | | |-| issue | [string](#string) | | Format: projects/{project}/issues/{issue} |-| task_run | [string](#string) | | Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |-| version | [string](#string) | | Could be empty |-| revision | [string](#string) | | Could be empty Or present but not found if deleted |-| changed_resources | [ChangedResources](#bytebase-v1-ChangedResources) | | |-| type | [Changelog.Type](#bytebase-v1-Changelog-Type) | | |-| dump_version_mismatch | [bool](#bool) | | True if this changelog's dump version differs from current engine dump version. When true and drift is detected, the drift may be a false positive from Bytebase upgrade. |----+| 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) | | The filter of the changelogs. follow the [ebnf](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) syntax. Support filter by type, source or table. For example: table = "tableExists('{database}', '{schema}', '{table}')" table = "tableExists('db', 'public', 'table1') || tableExists('db', 'public', 'table2')"-<a name="bytebase-v1-CheckConstraintMetadata"></a>+The table filter follow the CEL syntax. currently, we have one function for CEL: - tableExists(database, schema, table): return true if the table exists in changed resources.-### CheckConstraintMetadata-CheckConstraintMetadata is the metadata for check constraints.+examples: Use tableExists("db", "public", "table1") to filter the changelogs which have the table "table1" in the schema "public" of the database "db". For MySQL, the schema is always "", such as tableExists("db", "", "table1").+Combine multiple functions with "&&" and "||", we MUST use the Disjunctive Normal Form(DNF). In other words, the CEL expression consists of several parts connected by OR operators. For example, the following expression is valid: ( tableExists("db", "public", "table1") && tableExists("db", "public", "table2") ) || ( tableExists("db", "public", "table3") ) |-| 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. |+<a name="bytebase-v1-ListChangelogsResponse"></a>-<a name="bytebase-v1-ColumnMetadata"></a>+### ListChangelogsResponse-### ColumnMetadata-ColumnMetadata is the metadata for columns.| 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'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's default value, you must reference the constraint by name. This field stores the actual constraint name from the database.+| 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. |-Example: A column definition like: CREATE TABLE employees ( status NVARCHAR(20) DEFAULT 'active' )-Will create a constraint with an auto-generated name like 'DF__employees__statu__3B75D760' or a user-defined name if specified: ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT 'active' 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 'inactive' 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-ListDatabasesRequest"></a>+### ListDatabasesRequest-<a name="bytebase-v1-Database"></a>+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| parent | [string](#string) | | - projects/{project}: list databases in a project, require "bb.projects.get" permission. - workspaces/-: list databases in the workspace, require "bb.databases.list" permission. - instances/{instances}: list databases in a instance, require "bb.instances.get" 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.-### Database+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 "environments/{id}" format, support "==" operator. - name: the database name, support ".matches()" operator. - project: the project full name in "projects/{id}" format, support "==" operator. - instance: the instance full name in "instances/{id}" format, support "==" operator. - engine: the database engine, check Engine enum for values. Support "==", "in [xx]", "!(in [xx])" operator. - exclude_unassigned: should be "true" or "false", will not show unassigned databases if it's true, support "==" operator. - drifted: should be "true" or "false", show drifted databases if it's true, support "==" operator. - table: filter by the database table, support "==" and ".matches()" operator. - labels.{key}: the database label, support "==" and "in" operators.+For example: environment == "environments/{environment resource id}" environment == "" (find databases which environment is not set) project == "projects/{project resource id}" instance == "instances/{instance resource id}" name.matches("database name") engine == "MYSQL" engine in ["MYSQL", "POSTGRES"] !(engine in ["MYSQL", "POSTGRES"]) exclude_unassigned == true drifted == true table == "sample" table.matches("sam") labels.environment == "production" labels.region == "asia" labels.region in ["asia", "europe"]-| 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. |+You can combine filter conditions like: environment == "environments/prod" && name.matches("employee") |+| show_deleted | [bool](#bool) | | Show deleted database if specified. |-<a name="bytebase-v1-Database-LabelsEntry"></a>+<a name="bytebase-v1-ListDatabasesResponse"></a>-### Database.LabelsEntry+### ListDatabasesResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [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-DatabaseMetadata"></a>+<a name="bytebase-v1-MaterializedViewMetadata"></a>-### DatabaseMetadata-DatabaseMetadata is the metadata for databases.+### MaterializedViewMetadata+MaterializedViewMetadata is the metadata for materialized views.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| 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. |+| 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-DatabaseSDLSchema"></a>+<a name="bytebase-v1-PackageMetadata"></a>-### DatabaseSDLSchema-DatabaseSDLSchema contains the schema in SDL format.+### PackageMetadata+PackageMetadata is the metadata for packages.| 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: - "text/plain; charset=utf-8" for SINGLE_FILE format - "application/zip" for MULTI_FILE format |+| 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-DatabaseSchema"></a>+<a name="bytebase-v1-ProcedureMetadata"></a>-### DatabaseSchema-DatabaseSchema is the metadata for databases.+### ProcedureMetadata+ProcedureMetadata is the metadata for procedures.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| schema | [string](#string) | | The schema dump from database. |+| 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-DependencyColumn"></a>+<a name="bytebase-v1-SchemaMetadata"></a>-### DependencyColumn-DependencyColumn is the metadata for dependency columns.+### SchemaMetadata+SchemaMetadata is the metadata for schemas.+This is the concept of schema in Postgres, but it's a no-op for MySQL.| 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 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-DependencyTable"></a>+<a name="bytebase-v1-SequenceMetadata"></a>-### DependencyTable+### SequenceMetadata| 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 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-DiffSchemaRequest"></a>-### DiffSchemaRequest+<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 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} |-+| method | [string](#string) | | Spatial indexing method (e.g., "SPATIAL", "R-TREE", "GIST") |+| 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-DiffSchemaResponse"></a>-### DiffSchemaResponse+<a name="bytebase-v1-StorageConfig"></a>+### StorageConfig+StorageConfig defines storage and performance parameters for spatial indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| diff | [string](#string) | | |+| 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-DimensionConstraint"></a>+<a name="bytebase-v1-StreamMetadata"></a>++### StreamMetadata-### DimensionConstraint-DimensionConstraint defines constraints for a spatial dimension.| 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 |+| 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-DimensionalConfig"></a>+<a name="bytebase-v1-SyncDatabaseRequest"></a>++### SyncDatabaseRequest-### 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 |---+| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |-<a name="bytebase-v1-EnumTypeMetadata"></a>-### EnumTypeMetadata+<a name="bytebase-v1-SyncDatabaseResponse"></a>-| 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. |+### SyncDatabaseResponse-<a name="bytebase-v1-EventMetadata"></a>-### EventMetadata+<a name="bytebase-v1-TableMetadata"></a>+### TableMetadata+TableMetadata is the metadata for tables.| 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. |+| 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-ExtensionMetadata"></a>+<a name="bytebase-v1-TablePartitionMetadata"></a>-### ExtensionMetadata-ExtensionMetadata is the metadata for extensions.+### TablePartitionMetadata+TablePartitionMetadata is the metadata for table partitions.| 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. |-------<a name="bytebase-v1-ExternalTableMetadata"></a>--### ExternalTableMetadata--+| 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'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's VALUES IN clause, which is a list of comma-separated integer values. - For others, it'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's [INT] type, 0 means not use default partition, otherwise, it'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 | |-| 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. |+<a name="bytebase-v1-TaskMetadata"></a>-<a name="bytebase-v1-ForeignKeyMetadata"></a>+### TaskMetadata-### 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's empty string for other databases. |+| 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-FunctionMetadata"></a>+<a name="bytebase-v1-TessellationConfig"></a>-### FunctionMetadata-FunctionMetadata is the metadata for functions.+### TessellationConfig+TessellationConfig defines tessellation parameters for spatial indexes.| 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's the list of tables that the function depends on the return type definition. |-| skip_dump | [bool](#bool) | | |+| scheme | [string](#string) | | Tessellation scheme (e.g., "GEOMETRY_GRID", "GEOGRAPHY_GRID", "GEOMETRY_AUTO_GRID") |+| 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-GenerationMetadata"></a>+<a name="bytebase-v1-TriggerMetadata"></a>-### GenerationMetadata+### TriggerMetadata| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |-| expression | [string](#string) | | |+| 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-GetChangelogRequest"></a>+<a name="bytebase-v1-UpdateDatabaseRequest"></a>-### GetChangelogRequest+### UpdateDatabaseRequest| 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) | | |+| database | [Database](#bytebase-v1-Database) | | The database to update.+The database'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-GetDatabaseMetadataRequest"></a>-### GetDatabaseMetadataRequest+<a name="bytebase-v1-ViewMetadata"></a>+### ViewMetadata+ViewMetadata is the metadata for views.| 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+| 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) | | |-Supported filter: - schema: the schema name, support "==" operator. - table: the table name, support "==" and ".matches()" operator.-For example: schema == "schema-a" table == "table-a" table.matches("table-a") schema == "schema-a" && table.matches("sample") The filter used to search table with wildcard "sample" in the schema "schemas/schema-a". 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-Changelog-Status"></a>-<a name="bytebase-v1-GetDatabaseRequest"></a>+### Changelog.Status-### GetDatabaseRequest+| Name | Number | Description |+| ---- | ------ | ----------- |+| STATUS_UNSPECIFIED | 0 | |+| PENDING | 1 | |+| DONE | 2 | |+| FAILED | 3 | |-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |+<a name="bytebase-v1-Changelog-Type"></a>+### Changelog.Type+| Name | Number | Description |+| ---- | ------ | ----------- |+| TYPE_UNSPECIFIED | 0 | |+| BASELINE | 1 | |+| MIGRATE | 2 | |+| SDL | 3 | |-<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>-### GetDatabaseSDLSchemaRequest+<a name="bytebase-v1-ChangelogView"></a>+### ChangelogView-| 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 |+| ---- | ------ | ----------- |+| 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-ColumnMetadata-IdentityGeneration"></a>+### ColumnMetadata.IdentityGeneration-<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>+| Name | Number | Description |+| ---- | ------ | ----------- |+| IDENTITY_GENERATION_UNSPECIFIED | 0 | |+| ALWAYS | 1 | |+| BY_DEFAULT | 2 | |-### GetDatabaseSchemaRequest+<a name="bytebase-v1-GenerationMetadata-Type"></a>-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |+### GenerationMetadata.Type+| Name | Number | Description |+| ---- | ------ | ----------- |+| TYPE_UNSPECIFIED | 0 | |+| VIRTUAL | 1 | |+| STORED | 2 | |+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat"></a>-<a name="bytebase-v1-GetSchemaStringRequest"></a>+### GetDatabaseSDLSchemaRequest.SDLFormat+SDLFormat specifies the output format for SDL schema.-### GetSchemaStringRequest+| 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.). |-| 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's empty for DATABASE. |-| object | [string](#string) | | It'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-GetSchemaStringRequest-ObjectType"></a>+### GetSchemaStringRequest.ObjectType+| Name | Number | Description |+| ---- | ------ | ----------- |+| 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-GetSchemaStringResponse"></a>+<a name="bytebase-v1-StreamMetadata-Mode"></a>-### GetSchemaStringResponse+### StreamMetadata.Mode+| Name | Number | Description |+| ---- | ------ | ----------- |+| MODE_UNSPECIFIED | 0 | |+| DEFAULT | 1 | |+| APPEND_ONLY | 2 | |+| INSERT_ONLY | 3 | |-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| schema_string | [string](#string) | | |+<a name="bytebase-v1-StreamMetadata-Type"></a>+### StreamMetadata.Type+| Name | Number | Description |+| ---- | ------ | ----------- |+| TYPE_UNSPECIFIED | 0 | |+| DELTA | 1 | |-<a name="bytebase-v1-GridLevel"></a>-### GridLevel-GridLevel defines a tessellation grid level with its density.+<a name="bytebase-v1-TablePartitionMetadata-Type"></a>-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |-| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |+### 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-TaskMetadata-State"></a>+### TaskMetadata.State-<a name="bytebase-v1-IndexMetadata"></a>-### IndexMetadata-IndexMetadata is the metadata for indexes.+| Name | Number | Description |+| ---- | ------ | ----------- |+| STATE_UNSPECIFIED | 0 | |+| STARTED | 1 | |+| SUSPENDED | 2 | |-| 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'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's a ClickHouse specific field. |-| is_constraint | [bool](#bool) | | It'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-DatabaseService"></a>+### 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 |+-<a name="bytebase-v1-ListChangelogsRequest"></a>-### ListChangelogsRequest+<a name="v1_group_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/group_service.proto-| 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) | | The filter of the changelogs. follow the [ebnf](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) syntax. Support filter by type, source or table. For example: table = "tableExists('{database}', '{schema}', '{table}')" table = "tableExists('db', 'public', 'table1') || tableExists('db', 'public', 'table2')"-The table filter follow the CEL syntax. currently, we have one function for CEL: - tableExists(database, schema, table): return true if the table exists in changed resources.+<a name="bytebase-v1-BatchGetGroupsRequest"></a>-examples: Use tableExists("db", "public", "table1") to filter the changelogs which have the table "table1" in the schema "public" of the database "db". For MySQL, the schema is always "", such as tableExists("db", "", "table1").+### BatchGetGroupsRequest+Request message for batch getting groups.-Combine multiple functions with "&&" and "||", we MUST use the Disjunctive Normal Form(DNF). In other words, the CEL expression consists of several parts connected by OR operators. For example, the following expression is valid: ( tableExists("db", "public", "table1") && tableExists("db", "public", "table2") ) || ( tableExists("db", "public", "table3") ) |+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| names | [string](#string) | repeated | The group names to retrieve. Format: groups/{email} |-<a name="bytebase-v1-ListChangelogsResponse"></a>-### ListChangelogsResponse+<a name="bytebase-v1-BatchGetGroupsResponse"></a>+### BatchGetGroupsResponse+Response message for batch getting groups.| 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. |-+| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |-<a name="bytebase-v1-ListDatabasesRequest"></a>-### ListDatabasesRequest+<a name="bytebase-v1-CreateGroupRequest"></a>+### CreateGroupRequest+Request message for creating a group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | - projects/{project}: list databases in a project, require "bb.projects.get" permission. - workspaces/-: list databases in the workspace, require "bb.databases.list" permission. - instances/{instances}: list databases in a instance, require "bb.instances.get" 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--Supported filter: - environment: the environment full name in "environments/{id}" format, support "==" operator. - name: the database name, support ".matches()" operator. - project: the project full name in "projects/{id}" format, support "==" operator. - instance: the instance full name in "instances/{id}" format, support "==" operator. - engine: the database engine, check Engine enum for values. Support "==", "in [xx]", "!(in [xx])" operator. - exclude_unassigned: should be "true" or "false", will not show unassigned databases if it's true, support "==" operator. - drifted: should be "true" or "false", show drifted databases if it's true, support "==" operator. - table: filter by the database table, support "==" and ".matches()" operator. - labels.{key}: the database label, support "==" and "in" operators.--For example: environment == "environments/{environment resource id}" environment == "" (find databases which environment is not set) project == "projects/{project resource id}" instance == "instances/{instance resource id}" name.matches("database name") engine == "MYSQL" engine in ["MYSQL", "POSTGRES"] !(engine in ["MYSQL", "POSTGRES"]) exclude_unassigned == true drifted == true table == "sample" table.matches("sam") labels.environment == "production" labels.region == "asia" labels.region in ["asia", "europe"]--You can combine filter conditions like: environment == "environments/prod" && name.matches("employee") |-| show_deleted | [bool](#bool) | | Show deleted database if specified. |-+| 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's resource name. |-<a name="bytebase-v1-ListDatabasesResponse"></a>-### ListDatabasesResponse+<a name="bytebase-v1-DeleteGroupRequest"></a>+### DeleteGroupRequest+Request message for deleting a group.| 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. |+| name | [string](#string) | | The name of the group to delete. Format: groups/{email} |-<a name="bytebase-v1-MaterializedViewMetadata"></a>+<a name="bytebase-v1-GetGroupRequest"></a>-### MaterializedViewMetadata-MaterializedViewMetadata is the metadata for materialized views.+### GetGroupRequest+Request message for getting a group.| 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 group to retrieve. Format: groups/{email} |-<a name="bytebase-v1-PackageMetadata"></a>+<a name="bytebase-v1-Group"></a>-### PackageMetadata-PackageMetadata is the metadata for packages.+### Group+A group of users within the workspace.| 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. |+| 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-ProcedureMetadata"></a>+<a name="bytebase-v1-GroupMember"></a>-### ProcedureMetadata-ProcedureMetadata is the metadata for procedures.+### GroupMember+A member of a group with a role.| 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) | | |+| 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's role in the group. |-<a name="bytebase-v1-SchemaMetadata"></a>+<a name="bytebase-v1-ListGroupsRequest"></a>-### SchemaMetadata-SchemaMetadata is the metadata for schemas.-This is the concept of schema in Postgres, but it's a no-op for MySQL.+### ListGroupsRequest+Request message for listing groups.| 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. |+| 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 "==" and ".matches()" operator. - email: the group email, support "==" and ".matches()" operator. - project: the project full name in "projects/{id}" format, support "==" operator.+For example: title == "dba" email == "[email protected]" title.matches("dba") email.matches("dba") project == "projects/sample-project" You can combine filter conditions like: title.matches("dba") || email.matches("dba") |-<a name="bytebase-v1-SequenceMetadata"></a>-### SequenceMetadata+<a name="bytebase-v1-ListGroupsResponse"></a>++### ListGroupsResponse+Response message for listing groups.+| 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. |+| 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-SpatialIndexConfig"></a>+<a name="bytebase-v1-UpdateGroupRequest"></a>-### SpatialIndexConfig-SpatialIndexConfig defines the spatial index configuration for spatial databases.+### UpdateGroupRequest+Request message for updating a group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| method | [string](#string) | | Spatial indexing method (e.g., "SPATIAL", "R-TREE", "GIST") |-| 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 |+| group | [Group](#bytebase-v1-Group) | | The group to update.+The group'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-StorageConfig"></a>+-### StorageConfig-StorageConfig defines storage and performance parameters for spatial indexes.+<a name="bytebase-v1-GroupMember-Role"></a>-| 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 |+### GroupMember.Role+The role of a group member.+| Name | Number | Description |+| ---- | ------ | ----------- |+| ROLE_UNSPECIFIED | 0 | Unspecified role. |+| OWNER | 1 | Group owner. |+| MEMBER | 2 | Group member. |++-<a name="bytebase-v1-StreamMetadata"></a>+<a name="bytebase-v1-GroupService"></a>-### StreamMetadata+### GroupService+GroupService manages user groups for organizing users and permissions.+| 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 |-| ----- | ---- | ----- | ----------- |-| 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="v1_idp_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/idp_service.proto-<a name="bytebase-v1-SyncDatabaseRequest"></a>+<a name="bytebase-v1-CreateIdentityProviderRequest"></a>-### SyncDatabaseRequest+### CreateIdentityProviderRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |-------<a name="bytebase-v1-SyncDatabaseResponse"></a>+| 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's resource name.-### SyncDatabaseResponse+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-DeleteIdentityProviderRequest"></a>-<a name="bytebase-v1-TableMetadata"></a>+### DeleteIdentityProviderRequest-### TableMetadata-TableMetadata is the metadata for tables.| 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 identity provider to delete. Format: idps/{identity_provider} |-<a name="bytebase-v1-TablePartitionMetadata"></a>+<a name="bytebase-v1-FieldMapping"></a>-### TablePartitionMetadata-TablePartitionMetadata is the metadata for table partitions.+### 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 || ----- | ---- | ----- | ----------- |-| 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'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's VALUES IN clause, which is a list of comma-separated integer values. - For others, it'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's [INT] type, 0 means not use default partition, otherwise, it'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-TaskMetadata"></a>--### TaskMetadata--+| 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/ |-| 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. |+<a name="bytebase-v1-GetIdentityProviderRequest"></a>-<a name="bytebase-v1-TessellationConfig"></a>+### GetIdentityProviderRequest-### TessellationConfig-TessellationConfig defines tessellation parameters for spatial indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| scheme | [string](#string) | | Tessellation scheme (e.g., "GEOMETRY_GRID", "GEOGRAPHY_GRID", "GEOMETRY_AUTO_GRID") |-| 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) |+| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |-<a name="bytebase-v1-TriggerMetadata"></a>+<a name="bytebase-v1-IdentityProvider"></a>-### TriggerMetadata+### IdentityProvider| 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. |+| 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-UpdateDatabaseRequest"></a>+<a name="bytebase-v1-IdentityProviderConfig"></a>-### UpdateDatabaseRequest+### IdentityProviderConfig| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| database | [Database](#bytebase-v1-Database) | | The database to update.--The database'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. |+| 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-ViewMetadata"></a>+<a name="bytebase-v1-LDAPIdentityProviderConfig"></a>-### ViewMetadata-ViewMetadata is the metadata for views.+### LDAPIdentityProviderConfig+LDAPIdentityProviderConfig is the structure for LDAP identity provider config.| 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-Changelog-Status"></a>--### Changelog.Status---| Name | Number | Description |-| ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| DONE | 2 | |-| FAILED | 3 | |----<a name="bytebase-v1-Changelog-Type"></a>--### Changelog.Type---| Name | Number | Description |-| ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| BASELINE | 1 | |-| MIGRATE | 2 | |-| SDL | 3 | |----<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-ColumnMetadata-IdentityGeneration"></a>--### ColumnMetadata.IdentityGeneration---| Name | Number | Description |-| ---- | ------ | ----------- |-| IDENTITY_GENERATION_UNSPECIFIED | 0 | |-| ALWAYS | 1 | |-| BY_DEFAULT | 2 | |----<a name="bytebase-v1-GenerationMetadata-Type"></a>--### GenerationMetadata.Type---| Name | Number | Description |-| ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| VIRTUAL | 1 | |-| STORED | 2 | |----<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="bytebase-v1-GetSchemaStringRequest-ObjectType"></a>--### GetSchemaStringRequest.ObjectType---| Name | Number | Description |-| ---- | ------ | ----------- |-| 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-StreamMetadata-Mode"></a>--### StreamMetadata.Mode---| Name | Number | Description |-| ---- | ------ | ----------- |-| MODE_UNSPECIFIED | 0 | |-| DEFAULT | 1 | |-| APPEND_ONLY | 2 | |-| INSERT_ONLY | 3 | |----<a name="bytebase-v1-StreamMetadata-Type"></a>--### StreamMetadata.Type---| Name | Number | Description |-| ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | |-| DELTA | 1 | |----<a name="bytebase-v1-TablePartitionMetadata-Type"></a>+| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., "ldap.example.com". |+| 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., "ou=users,dc=example,dc=com". |+| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., "(uid=%s)". |+| 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. |-### 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-TaskMetadata-State"></a>-### TaskMetadata.State+<a name="bytebase-v1-ListIdentityProvidersRequest"></a>+### ListIdentityProvidersRequest-| Name | Number | Description |-| ---- | ------ | ----------- |-| STATE_UNSPECIFIED | 0 | |-| STARTED | 1 | |-| SUSPENDED | 2 | |---<a name="bytebase-v1-DatabaseService"></a>-### DatabaseService-DatabaseService manages databases and their schemas.+<a name="bytebase-v1-ListIdentityProvidersResponse"></a>-| 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 |+### ListIdentityProvidersResponse-+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| identity_providers | [IdentityProvider](#bytebase-v1-IdentityProvider) | repeated | The identity providers from the specified request. |-<a name="v1_group_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/group_service.proto-<a name="bytebase-v1-BatchGetGroupsRequest"></a>-### BatchGetGroupsRequest-Request message for batch getting groups.+<a name="bytebase-v1-OAuth2IdentityProviderConfig"></a>++### OAuth2IdentityProviderConfig+OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| names | [string](#string) | repeated | The group names to retrieve. Format: groups/{email} |+| 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-BatchGetGroupsResponse"></a>+<a name="bytebase-v1-OAuth2IdentityProviderTestRequestContext"></a>++### OAuth2IdentityProviderTestRequestContext-### BatchGetGroupsResponse-Response message for batch getting groups.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |+| code | [string](#string) | | Authorize code from website. |-<a name="bytebase-v1-CreateGroupRequest"></a>+<a name="bytebase-v1-OIDCIdentityProviderConfig"></a>-### CreateGroupRequest-Request message for creating a group.+### OIDCIdentityProviderConfig+OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| 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's resource name. |+| 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-DeleteGroupRequest"></a>+<a name="bytebase-v1-OIDCIdentityProviderTestRequestContext"></a>++### OIDCIdentityProviderTestRequestContext-### DeleteGroupRequest-Request message for deleting a group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the group to delete. Format: groups/{email} |+| code | [string](#string) | | Authorize code from OIDC provider. |-<a name="bytebase-v1-GetGroupRequest"></a>+<a name="bytebase-v1-TestIdentityProviderRequest"></a>++### TestIdentityProviderRequest-### GetGroupRequest-Request message for getting a group.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the group to retrieve. Format: groups/{email} |+| 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-Group"></a>+<a name="bytebase-v1-TestIdentityProviderResponse"></a>++### TestIdentityProviderResponse-### Group-A group of users within the workspace.| 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. |+| 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-GroupMember"></a>+<a name="bytebase-v1-TestIdentityProviderResponse-ClaimsEntry"></a>++### TestIdentityProviderResponse.ClaimsEntry-### GroupMember-A member of a group with a role.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| member | [string](#string) | | Member is the principal who belong to this group.+| key | [string](#string) | | |+| value | [string](#string) | | |-Format: users/[email protected] |-| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | The member's role in the group. |+<a name="bytebase-v1-TestIdentityProviderResponse-UserInfoEntry"></a>-<a name="bytebase-v1-ListGroupsRequest"></a>+### TestIdentityProviderResponse.UserInfoEntry-### ListGroupsRequest-Request message for listing groups.| 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.--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 "==" and ".matches()" operator. - email: the group email, support "==" and ".matches()" operator. - project: the project full name in "projects/{id}" format, support "==" operator.+| key | [string](#string) | | |+| value | [string](#string) | | |-For example: title == "dba" email == "[email protected]" title.matches("dba") email.matches("dba") project == "projects/sample-project" You can combine filter conditions like: title.matches("dba") || email.matches("dba") |+<a name="bytebase-v1-UpdateIdentityProviderRequest"></a>-<a name="bytebase-v1-ListGroupsResponse"></a>+### UpdateIdentityProviderRequest-### ListGroupsResponse-Response message for listing groups.| 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. |+| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to update.+The identity provider'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. |-<a name="bytebase-v1-UpdateGroupRequest"></a>+-### UpdateGroupRequest-Request message for updating a group.+<a name="bytebase-v1-IdentityProviderType"></a>-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| group | [Group](#bytebase-v1-Group) | | The group to update.+### IdentityProviderType-The group'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. |++| 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. |+<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-GroupMember-Role"></a>-### GroupMember.Role-The role of a group member.+<a name="bytebase-v1-OAuth2AuthStyle"></a>++### OAuth2AuthStyle+| Name | Number | Description || ---- | ------ | ----------- |-| ROLE_UNSPECIFIED | 0 | Unspecified role. |-| OWNER | 1 | Group owner. |-| MEMBER | 2 | Group member. |+| OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | |+| IN_PARAMS | 1 | IN_PARAMS sends the "client_id" and "client_secret" 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. |@@ -6598,311 +6503,313 @@ The role of a group member.-<a name="bytebase-v1-GroupService"></a>+<a name="bytebase-v1-IdentityProviderService"></a>-### GroupService-GroupService manages user groups for organizing users and permissions.+### IdentityProviderService+IdentityProviderService manages external identity providers for SSO authentication.| 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 |+| 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="v1_idp_service-proto"></a>+<a name="v1_org_policy_service-proto"></a><p align="right"><a href="#top">Top</a></p>-## v1/idp_service.proto+## v1/org_policy_service.proto-<a name="bytebase-v1-CreateIdentityProviderRequest"></a>+<a name="bytebase-v1-CreatePolicyRequest"></a>-### CreateIdentityProviderRequest+### CreatePolicyRequest| 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'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. |-+| parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: "". 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-DeleteIdentityProviderRequest"></a>-### DeleteIdentityProviderRequest+<a name="bytebase-v1-DataSourceQueryPolicy"></a>+### DataSourceQueryPolicy+Policy for controlling which data sources can be queried in the SQL editor.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the identity provider to delete. Format: idps/{identity_provider} |+| 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. |-<a name="bytebase-v1-FieldMapping"></a>+<a name="bytebase-v1-DeletePolicyRequest"></a>++### DeletePolicyRequest-### 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/ |+| name | [string](#string) | | The policy's `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: "". Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |-<a name="bytebase-v1-GetIdentityProviderRequest"></a>+<a name="bytebase-v1-GetPolicyRequest"></a>-### GetIdentityProviderRequest+### GetPolicyRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |+| name | [string](#string) | | The name of the policy to retrieve. Format: {resource type}/{resource id}/policies/{policy type} |-<a name="bytebase-v1-IdentityProvider"></a>+<a name="bytebase-v1-ListPoliciesRequest"></a>-### IdentityProvider+### ListPoliciesRequest| 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. |+| 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-IdentityProviderConfig"></a>+<a name="bytebase-v1-ListPoliciesResponse"></a>-### IdentityProviderConfig+### ListPoliciesResponse| 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. |+| policies | [Policy](#bytebase-v1-Policy) | repeated | The policies from the specified request. |-<a name="bytebase-v1-LDAPIdentityProviderConfig"></a>+<a name="bytebase-v1-MaskingExceptionPolicy"></a>-### LDAPIdentityProviderConfig-LDAPIdentityProviderConfig is the structure for LDAP identity provider config.+### MaskingExceptionPolicy+MaskingExceptionPolicy is the allowlist of users who can access sensitive data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., "ldap.example.com". |-| 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., "ou=users,dc=example,dc=com". |-| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., "(uid=%s)". |-| 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. |+| masking_exceptions | [MaskingExceptionPolicy.MaskingException](#bytebase-v1-MaskingExceptionPolicy-MaskingException) | repeated | The list of masking exceptions. |++<a name="bytebase-v1-MaskingExceptionPolicy-MaskingException"></a>++### MaskingExceptionPolicy.MaskingException+An exception allowing specific users to access masked data.+-<a name="bytebase-v1-ListIdentityProvidersRequest"></a>+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| action | [MaskingExceptionPolicy.MaskingException.Action](#bytebase-v1-MaskingExceptionPolicy-MaskingException-Action) | | The action that the user can perform on sensitive data. |+| member | [string](#string) | | Member is the principal who bind to this exception policy instance.-### ListIdentityProvidersRequest+- `user:{email}`: An email address that represents a specific Bytebase account. For example, `[email protected]`. - `group:{email}`: An email address for group. |+| 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 "==" operation. resource.database_name: the database name. Only support "==" operation. resource.schema_name: the schema name. Only support "==" operation. resource.table_name: the table name. Only support "==" operation. resource.column_name: the column name. Only support "==" operation. request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")` All variables should join with "&&" condition.+For example: resource.instance_id == "local" && resource.database_name == "employee" && request.time < timestamp("2025-04-30T11:10:39.000Z") resource.instance_id == "local" && resource.database_name == "employee" |-<a name="bytebase-v1-ListIdentityProvidersResponse"></a>-### ListIdentityProvidersResponse+<a name="bytebase-v1-MaskingRulePolicy"></a>+### MaskingRulePolicy+Policy for configuring data masking rules.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| identity_providers | [IdentityProvider](#bytebase-v1-IdentityProvider) | repeated | The identity providers from the specified request. |+| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |-<a name="bytebase-v1-OAuth2IdentityProviderConfig"></a>+<a name="bytebase-v1-MaskingRulePolicy-MaskingRule"></a>-### OAuth2IdentityProviderConfig-OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.+### MaskingRulePolicy.MaskingRule+A rule that defines when and how to mask data.| 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. |+| 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 == "test" && resource.project_id == "sample-project" resource.instance_id == "sample-instance" && resource.database_name == "employee" && resource.table_name in ["table1", "table2"] resource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"]) resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2") |+| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., "SSN", "EMAIL"). |-<a name="bytebase-v1-OAuth2IdentityProviderTestRequestContext"></a>-### OAuth2IdentityProviderTestRequestContext+++<a name="bytebase-v1-Policy"></a>++### Policy| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| code | [string](#string) | | Authorize code from website. |+| name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: "". 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_exception_policy | [MaskingExceptionPolicy](#bytebase-v1-MaskingExceptionPolicy) | | |+| 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-OIDCIdentityProviderConfig"></a>+<a name="bytebase-v1-QueryDataPolicy"></a>-### OIDCIdentityProviderConfig-OIDCIdentityProviderConfig is the structure for OIDC identity provider config.+### QueryDataPolicy+QueryDataPolicy is the policy configuration for querying data.| 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. |-+| 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 <= 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-OIDCIdentityProviderTestRequestContext"></a>-### OIDCIdentityProviderTestRequestContext+<a name="bytebase-v1-RolloutPolicy"></a>+### RolloutPolicy+Rollout policy configuration.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| code | [string](#string) | | Authorize code from OIDC provider. |+| automatic | [bool](#bool) | | Whether rollout is automatic without manual approval. |+| roles | [string](#string) | repeated | The roles that can approve rollout execution. |+| checkers | [RolloutPolicy.Checkers](#bytebase-v1-RolloutPolicy-Checkers) | | Checkers that must pass before rollout execution. These checks are performed in UI workflows only. |-<a name="bytebase-v1-TestIdentityProviderRequest"></a>+<a name="bytebase-v1-RolloutPolicy-Checkers"></a>-### TestIdentityProviderRequest+### RolloutPolicy.Checkers| 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. |+| required_issue_approval | [bool](#bool) | | Whether issue approval is required before proceeding with rollout. |+| required_status_checks | [RolloutPolicy.Checkers.RequiredStatusChecks](#bytebase-v1-RolloutPolicy-Checkers-RequiredStatusChecks) | | Status checks that must pass before rollout can be executed. |-<a name="bytebase-v1-TestIdentityProviderResponse"></a>+<a name="bytebase-v1-RolloutPolicy-Checkers-RequiredStatusChecks"></a>-### TestIdentityProviderResponse+### RolloutPolicy.Checkers.RequiredStatusChecks| 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. |-+| plan_check_enforcement | [RolloutPolicy.Checkers.PlanCheckEnforcement](#bytebase-v1-RolloutPolicy-Checkers-PlanCheckEnforcement) | | Enforcement level for plan check results during rollout validation. |-<a name="bytebase-v1-TestIdentityProviderResponse-ClaimsEntry"></a>-### TestIdentityProviderResponse.ClaimsEntry+<a name="bytebase-v1-TagPolicy"></a>+### TagPolicy+Policy for tagging resources with metadata.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |+| 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 "bb.tag.review_config": "reviewConfigs/{review config resource id}" |-<a name="bytebase-v1-TestIdentityProviderResponse-UserInfoEntry"></a>+<a name="bytebase-v1-TagPolicy-TagsEntry"></a>-### TestIdentityProviderResponse.UserInfoEntry+### TagPolicy.TagsEntry@@ -6916,19 +6823,19 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.-<a name="bytebase-v1-UpdateIdentityProviderRequest"></a>+<a name="bytebase-v1-UpdatePolicyRequest"></a>-### UpdateIdentityProviderRequest+### UpdatePolicyRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to update.+| policy | [Policy](#bytebase-v1-Policy) | | The policy to update.-The identity provider's `name` field is used to identify the identity provider to update. Format: idps/{identity_provider} |+The policy's `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: "". 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 identity provider is not found, a new identity provider 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. |@@ -6937,43 +6844,73 @@ The identity provider's `name` field is used to identify the identity provid-<a name="bytebase-v1-IdentityProviderType"></a>+<a name="bytebase-v1-DataSourceQueryPolicy-Restriction"></a>-### IdentityProviderType+### 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. |++++<a name="bytebase-v1-MaskingExceptionPolicy-MaskingException-Action"></a>+### MaskingExceptionPolicy.MaskingException.Action+The action that the exception permits.| 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. |+| ACTION_UNSPECIFIED | 0 | Unspecified action. |+| QUERY | 1 | Allow querying sensitive data. |+| EXPORT | 2 | Allow exporting sensitive data. |-<a name="bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol"></a>+<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. |+-### LDAPIdentityProviderConfig.SecurityProtocol+<a name="bytebase-v1-PolicyType"></a>++### PolicyType+The type of organizational policy.| 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. |+| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |+| ROLLOUT_POLICY | 11 | Rollout deployment policy. |+| MASKING_RULE | 9 | Data masking rule policy. |+| MASKING_EXCEPTION | 10 | Data masking exception policy. |+| TAG | 13 | Resource tag policy. |+| DATA_SOURCE_QUERY | 14 | Data source query restrictions policy. |+| DATA_QUERY | 16 | Query data access policy. |-<a name="bytebase-v1-OAuth2AuthStyle"></a>+<a name="bytebase-v1-RolloutPolicy-Checkers-PlanCheckEnforcement"></a>-### OAuth2AuthStyle+### RolloutPolicy.Checkers.PlanCheckEnforcement| Name | Number | Description || ---- | ------ | ----------- |-| OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | |-| IN_PARAMS | 1 | IN_PARAMS sends the "client_id" and "client_secret" 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. |+| PLAN_CHECK_ENFORCEMENT_UNSPECIFIED | 0 | Allow rollout regardless of plan check results (no enforcement). |+| ERROR_ONLY | 1 | Block rollout only when plan check finds errors. |+| STRICT | 2 | Block rollout when plan check finds errors or warnings. |@@ -6981,1556 +6918,1618 @@ The identity provider's `name` field is used to identify the identity provid-<a name="bytebase-v1-IdentityProviderService"></a>+<a name="bytebase-v1-OrgPolicyService"></a>-### IdentityProviderService-IdentityProviderService manages external identity providers for SSO authentication.+### OrgPolicyService+OrgPolicyService manages organizational policies at various resource levels.| 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 |+| 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_org_policy_service-proto"></a>+<a name="v1_sql_service-proto"></a><p align="right"><a href="#top">Top</a></p>-## v1/org_policy_service.proto+## v1/sql_service.proto-<a name="bytebase-v1-CreatePolicyRequest"></a>+<a name="bytebase-v1-AICompletionRequest"></a>++### AICompletionRequest++++| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| messages | [AICompletionRequest.Message](#bytebase-v1-AICompletionRequest-Message) | repeated | |+++++++<a name="bytebase-v1-AICompletionRequest-Message"></a>++### AICompletionRequest.Message++++| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| role | [string](#string) | | |+| content | [string](#string) | | |+++++++<a name="bytebase-v1-AICompletionResponse"></a>++### AICompletionResponse++++| 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. |+++++++<a name="bytebase-v1-AICompletionResponse-Candidate"></a>-### CreatePolicyRequest+### AICompletionResponse.Candidate| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: "". 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. |+| content | [AICompletionResponse.Candidate.Content](#bytebase-v1-AICompletionResponse-Candidate-Content) | | |-<a name="bytebase-v1-DataSourceQueryPolicy"></a>+<a name="bytebase-v1-AICompletionResponse-Candidate-Content"></a>++### AICompletionResponse.Candidate.Content-### DataSourceQueryPolicy-Policy for controlling which data sources can be queried in the SQL editor.| 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. |+| 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-DeletePolicyRequest"></a>+<a name="bytebase-v1-AICompletionResponse-Candidate-Content-Part"></a>-### DeletePolicyRequest+### AICompletionResponse.Candidate.Content.Part| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The policy's `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: "". Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |+| text | [string](#string) | | |-<a name="bytebase-v1-GetPolicyRequest"></a>+<a name="bytebase-v1-AdminExecuteRequest"></a>-### GetPolicyRequest+### AdminExecuteRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the policy to retrieve. Format: {resource type}/{resource id}/policies/{policy type} |+| 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-ListPoliciesRequest"></a>+<a name="bytebase-v1-AdminExecuteResponse"></a>-### ListPoliciesRequest+### AdminExecuteResponse| 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. |+| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |-<a name="bytebase-v1-ListPoliciesResponse"></a>+<a name="bytebase-v1-Advice"></a>-### ListPoliciesResponse+### Advice| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| policies | [Policy](#bytebase-v1-Policy) | repeated | The policies 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-MaskingExceptionPolicy"></a>+<a name="bytebase-v1-DiffMetadataRequest"></a>++### DiffMetadataRequest-### MaskingExceptionPolicy-MaskingExceptionPolicy is the allowlist of users who can access sensitive data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| masking_exceptions | [MaskingExceptionPolicy.MaskingException](#bytebase-v1-MaskingExceptionPolicy-MaskingException) | repeated | The list of masking exceptions. |+| source_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the source schema. |+| target_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the target schema. |+| source_catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | |+| target_catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | |+| engine | [Engine](#bytebase-v1-Engine) | | The database engine of the schema. |-<a name="bytebase-v1-MaskingExceptionPolicy-MaskingException"></a>+<a name="bytebase-v1-DiffMetadataResponse"></a>++### DiffMetadataResponse-### MaskingExceptionPolicy.MaskingException-An exception allowing specific users to access masked data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| action | [MaskingExceptionPolicy.MaskingException.Action](#bytebase-v1-MaskingExceptionPolicy-MaskingException-Action) | | The action that the user can perform on sensitive data. |-| member | [string](#string) | | Member is the principal who bind to this exception policy instance.--- `user:{email}`: An email address that represents a specific Bytebase account. For example, `[email protected]`. - `group:{email}`: An email address for group. |-| 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 "==" operation. resource.database_name: the database name. Only support "==" operation. resource.schema_name: the schema name. Only support "==" operation. resource.table_name: the table name. Only support "==" operation. resource.column_name: the column name. Only support "==" operation. request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")` All variables should join with "&&" condition.+| diff | [string](#string) | | The diff of the metadata. |-For example: resource.instance_id == "local" && resource.database_name == "employee" && request.time < timestamp("2025-04-30T11:10:39.000Z") resource.instance_id == "local" && resource.database_name == "employee" |+<a name="bytebase-v1-ExportRequest"></a>-<a name="bytebase-v1-MaskingRulePolicy"></a>+### ExportRequest-### MaskingRulePolicy-Policy for configuring data masking rules.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |+| 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-MaskingRulePolicy-MaskingRule"></a>+<a name="bytebase-v1-ExportResponse"></a>++### ExportResponse-### MaskingRulePolicy.MaskingRule-A rule that defines when and how to mask data.| 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--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 == "test" && resource.project_id == "sample-project" resource.instance_id == "sample-instance" && resource.database_name == "employee" && resource.table_name in ["table1", "table2"] resource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"]) resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2") |-| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., "SSN", "EMAIL"). |+| content | [bytes](#bytes) | | The export file content. |-<a name="bytebase-v1-Policy"></a>+<a name="bytebase-v1-MaskingReason"></a>-### Policy+### MaskingReason| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: "". 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_exception_policy | [MaskingExceptionPolicy](#bytebase-v1-MaskingExceptionPolicy) | | |-| 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. |+| semantic_type_id | [string](#string) | | The semantic type that triggered masking (e.g., "SSN", "email", "phone"). |+| 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., "Matched global rule: PII Protection"). |+| 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-QueryDataPolicy"></a>+<a name="bytebase-v1-QueryHistory"></a>++### QueryHistory-### QueryDataPolicy-QueryDataPolicy is the policy configuration for querying data.| 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 <= 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 | [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-RolloutPolicy"></a>+<a name="bytebase-v1-QueryOption"></a>++### QueryOption-### RolloutPolicy-Rollout policy configuration.| 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. |-| checkers | [RolloutPolicy.Checkers](#bytebase-v1-RolloutPolicy-Checkers) | | Checkers that must pass before rollout execution. These checks are performed in UI workflows only. |+| redis_run_commands_on | [QueryOption.RedisRunCommandsOn](#bytebase-v1-QueryOption-RedisRunCommandsOn) | | |+| mssql_explain_format | [QueryOption.MSSQLExplainFormat](#bytebase-v1-QueryOption-MSSQLExplainFormat) | | |-<a name="bytebase-v1-RolloutPolicy-Checkers"></a>+<a name="bytebase-v1-QueryRequest"></a>-### RolloutPolicy.Checkers+### QueryRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| required_issue_approval | [bool](#bool) | | Whether issue approval is required before proceeding with rollout. |-| required_status_checks | [RolloutPolicy.Checkers.RequiredStatusChecks](#bytebase-v1-RolloutPolicy-Checkers-RequiredStatusChecks) | | Status checks that must pass before rollout can be executed. |+| 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-RolloutPolicy-Checkers-RequiredStatusChecks"></a>+<a name="bytebase-v1-QueryResponse"></a>-### RolloutPolicy.Checkers.RequiredStatusChecks+### QueryResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| plan_check_enforcement | [RolloutPolicy.Checkers.PlanCheckEnforcement](#bytebase-v1-RolloutPolicy-Checkers-PlanCheckEnforcement) | | Enforcement level for plan check results during rollout validation. |+| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |-<a name="bytebase-v1-TagPolicy"></a>+<a name="bytebase-v1-QueryResult"></a>++### QueryResult-### 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 "bb.tag.review_config": "reviewConfigs/{review config resource id}" |+| 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's RAISE NOTICE, MSSQL's PRINT, or Oracle's DBMS_OUTPUT.PUT_LINE. |+| masked | [MaskingReason](#bytebase-v1-MaskingReason) | repeated | Masking reasons for each column (empty for non-masked columns). |-<a name="bytebase-v1-TagPolicy-TagsEntry"></a>+<a name="bytebase-v1-QueryResult-Message"></a>-### TagPolicy.TagsEntry+### QueryResult.Message| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |-+| level | [QueryResult.Message.Level](#bytebase-v1-QueryResult-Message-Level) | | |+| content | [string](#string) | | |-<a name="bytebase-v1-UpdatePolicyRequest"></a>-### UpdatePolicyRequest+<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 || ----- | ---- | ----- | ----------- |-| policy | [Policy](#bytebase-v1-Policy) | | The policy to update.--The policy's `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: "". 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. |-+| 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="bytebase-v1-DataSourceQueryPolicy-Restriction"></a>+<a name="bytebase-v1-QueryResult-PostgresError"></a>-### DataSourceQueryPolicy.Restriction-Restriction level for admin data source access.+### QueryResult.PostgresError+refer https://www.postgresql.org/docs/11/protocol-error-fields.html+for field description.-| 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 |+| ----- | ---- | ----- | ----------- |+| 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-MaskingExceptionPolicy-MaskingException-Action"></a>-### MaskingExceptionPolicy.MaskingException.Action-The action that the exception permits.-| Name | Number | Description |-| ---- | ------ | ----------- |-| ACTION_UNSPECIFIED | 0 | Unspecified action. |-| QUERY | 1 | Allow querying sensitive data. |-| EXPORT | 2 | Allow exporting sensitive data. |+<a name="bytebase-v1-QueryResult-SyntaxError"></a>-<a name="bytebase-v1-PolicyResourceType"></a>+### QueryResult.SyntaxError+Syntax error with position information for editor highlighting-### 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. |+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| start_position | [Position](#bytebase-v1-Position) | | Position information for highlighting in editor |-<a name="bytebase-v1-PolicyType"></a>-### PolicyType-The type of organizational policy.-| Name | Number | Description |-| ---- | ------ | ----------- |-| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |-| ROLLOUT_POLICY | 11 | Rollout deployment policy. |-| MASKING_RULE | 9 | Data masking rule policy. |-| MASKING_EXCEPTION | 10 | Data masking exception policy. |-| TAG | 13 | Resource tag policy. |-| DATA_SOURCE_QUERY | 14 | Data source query restrictions policy. |-| DATA_QUERY | 16 | Query data access policy. |+<a name="bytebase-v1-QueryRow"></a>+### QueryRow-<a name="bytebase-v1-RolloutPolicy-Checkers-PlanCheckEnforcement"></a>-### RolloutPolicy.Checkers.PlanCheckEnforcement+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| values | [RowValue](#bytebase-v1-RowValue) | repeated | Row values of the query result. |-| Name | Number | Description |-| ---- | ------ | ----------- |-| PLAN_CHECK_ENFORCEMENT_UNSPECIFIED | 0 | Allow rollout regardless of plan check results (no enforcement). |-| ERROR_ONLY | 1 | Block rollout only when plan check finds errors. |-| STRICT | 2 | Block rollout when plan check finds errors or warnings. |---<a name="bytebase-v1-OrgPolicyService"></a>+<a name="bytebase-v1-RowValue"></a>-### OrgPolicyService-OrgPolicyService manages organizational policies at various resource levels.+### RowValue-| 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 |-+| 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. |-<a name="v1_sql_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/sql_service.proto-<a name="bytebase-v1-AICompletionRequest"></a>+<a name="bytebase-v1-RowValue-Timestamp"></a>-### AICompletionRequest+### RowValue.Timestamp| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| messages | [AICompletionRequest.Message](#bytebase-v1-AICompletionRequest-Message) | repeated | |+| 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-AICompletionRequest-Message"></a>+<a name="bytebase-v1-RowValue-TimestampTZ"></a>-### AICompletionRequest.Message+### RowValue.TimestampTZ| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| role | [string](#string) | | |-| content | [string](#string) | | |+| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |+| zone | [string](#string) | | Zone is the time zone abbreviations in timezone database such as "PDT", "PST". 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-AICompletionResponse"></a>+<a name="bytebase-v1-SearchQueryHistoriesRequest"></a>-### AICompletionResponse+### SearchQueryHistoriesRequest| 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. |+| 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 "projects/{id}" format, support "==" operator. - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator. - instance: the instance full name in "instances/{id}" format, support "==" operator. - type: the type, should be "QUERY" or "EXPORT", support "==" operator. - statement: the SQL statement, support ".matches()" operator.+For example: project == "projects/{project}" database == "instances/{instance}/databases/{database}" instance == "instances/{instance}" type == "QUERY" type == "EXPORT" statement.matches("select") type == "QUERY" && statement.matches("select") |-<a name="bytebase-v1-AICompletionResponse-Candidate"></a>-### AICompletionResponse.Candidate++<a name="bytebase-v1-SearchQueryHistoriesResponse"></a>++### SearchQueryHistoriesResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| content | [AICompletionResponse.Candidate.Content](#bytebase-v1-AICompletionResponse-Candidate-Content) | | |+| 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. |+-<a name="bytebase-v1-AICompletionResponse-Candidate-Content"></a>-### AICompletionResponse.Candidate.Content+<a name="bytebase-v1-Advice-Level"></a>++### 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 |-| ----- | ---- | ----- | ----------- |-| 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-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-QueryHistory-Type"></a>-<a name="bytebase-v1-AICompletionResponse-Candidate-Content-Part"></a>+### QueryHistory.Type-### AICompletionResponse.Candidate.Content.Part+| Name | Number | Description |+| ---- | ------ | ----------- |+| TYPE_UNSPECIFIED | 0 | Unspecified query history type. |+| QUERY | 1 | Query execution for data retrieval. |+| EXPORT | 2 | Data export operation to file. |-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| text | [string](#string) | | |+<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-AdminExecuteRequest"></a>-### AdminExecuteRequest+<a name="bytebase-v1-QueryOption-RedisRunCommandsOn"></a>+### QueryOption.RedisRunCommandsOn-| 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. |+| 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>+### QueryResult.Message.Level-<a name="bytebase-v1-AdminExecuteResponse"></a>+| 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. |-### AdminExecuteResponse+<a name="bytebase-v1-QueryResult-PermissionDenied-CommandType"></a>-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |+### QueryResult.PermissionDenied.CommandType+| Name | Number | Description |+| ---- | ------ | ----------- |+| COMMAND_TYPE_UNSPECIFIED | 0 | |+| DDL | 1 | |+| DML | 2 | |+| NON_READ_ONLY | 3 | |++-<a name="bytebase-v1-Advice"></a>-### Advice+<a name="bytebase-v1-SQLService"></a>+### 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'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 |-| ----- | ---- | ----- | ----------- |-| 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="v1_plan_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>+## v1/plan_service.proto-<a name="bytebase-v1-DiffMetadataRequest"></a>+<a name="bytebase-v1-BatchCancelPlanCheckRunsRequest"></a>-### DiffMetadataRequest+### BatchCancelPlanCheckRunsRequest| 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. |-| source_catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | |-| target_catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | |-| engine | [Engine](#bytebase-v1-Engine) | | The database engine of the schema. |+| parent | [string](#string) | | The name of the parent of the planChecks. Format: projects/{project}/plans/{plan} |+| plan_check_runs | [string](#string) | repeated | TODO(d): update this API. The planCheckRuns to cancel. Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} |-<a name="bytebase-v1-DiffMetadataResponse"></a>+<a name="bytebase-v1-BatchCancelPlanCheckRunsResponse"></a>++### BatchCancelPlanCheckRunsResponse+++-### DiffMetadataResponse++++<a name="bytebase-v1-CreatePlanRequest"></a>++### CreatePlanRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| diff | [string](#string) | | The diff of the metadata. |+| parent | [string](#string) | | The parent project where this plan will be created. Format: projects/{project} |+| plan | [Plan](#bytebase-v1-Plan) | | The plan to create. |-<a name="bytebase-v1-ExportRequest"></a>+<a name="bytebase-v1-GetPlanRequest"></a>-### ExportRequest+### GetPlanRequest| 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. |+| name | [string](#string) | | The name of the plan to retrieve. Format: projects/{project}/plans/{plan} |-<a name="bytebase-v1-ExportResponse"></a>+<a name="bytebase-v1-ListPlanCheckRunsRequest"></a>-### ExportResponse+### ListPlanCheckRunsRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| content | [bytes](#bytes) | | The export file content. |+| parent | [string](#string) | | The parent, which owns this collection of plan check runs. Format: projects/{project}/plans/{plan} |+| latest_only | [bool](#bool) | | If set to true, only the latest plan check run will be returned. |+| filter | [string](#string) | | Filter is used to filter plan check runs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec++Supported filters: - status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values. - result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.+For example: status in ["DONE", "FAILED"] status == "RUNNING" result_status in ["SUCCESS", "ERROR"] result_status == "WARNING" |-<a name="bytebase-v1-MaskingReason"></a>-### MaskingReason+<a name="bytebase-v1-ListPlanCheckRunsResponse"></a>++### ListPlanCheckRunsResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| semantic_type_id | [string](#string) | | The semantic type that triggered masking (e.g., "SSN", "email", "phone"). |-| 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., "Matched global rule: PII Protection"). |-| classification_level | [string](#string) | | Whether masking was due to classification level. |-| semantic_type_icon | [string](#string) | | Icon associated with the semantic type (if any). |+| plan_check_runs | [PlanCheckRun](#bytebase-v1-PlanCheckRun) | repeated | The plan check runs from the specified request. |-<a name="bytebase-v1-QueryHistory"></a>+<a name="bytebase-v1-ListPlansRequest"></a>-### QueryHistory+### ListPlansRequest| 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) | | |+| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use "projects/-" 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. |-<a name="bytebase-v1-QueryOption"></a>-### QueryOption+<a name="bytebase-v1-ListPlansResponse"></a>++### ListPlansResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| redis_run_commands_on | [QueryOption.RedisRunCommandsOn](#bytebase-v1-QueryOption-RedisRunCommandsOn) | | |-| mssql_explain_format | [QueryOption.MSSQLExplainFormat](#bytebase-v1-QueryOption-MSSQLExplainFormat) | | |+| 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-QueryRequest"></a>+<a name="bytebase-v1-Plan"></a>-### QueryRequest+### Plan| 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. |+| 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} |+| rollout | [string](#string) | | The rollout associated with the plan. Can be empty. Format: projects/{project}/rollouts/{rollout} |+| 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 |+| deployment | [Plan.Deployment](#bytebase-v1-Plan-Deployment) | | |-<a name="bytebase-v1-QueryResponse"></a>+<a name="bytebase-v1-Plan-ChangeDatabaseConfig"></a>-### QueryResponse+### Plan.ChangeDatabaseConfig| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |+| 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} |+| type | [DatabaseChangeType](#bytebase-v1-DatabaseChangeType) | | Type is the database change type. |+| 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-QueryResult"></a>+<a name="bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry"></a>-### QueryResult+### Plan.ChangeDatabaseConfig.GhostFlagsEntry| 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's RAISE NOTICE, MSSQL's PRINT, or Oracle's DBMS_OUTPUT.PUT_LINE. |-| masked | [MaskingReason](#bytebase-v1-MaskingReason) | repeated | Masking reasons for each column (empty for non-masked columns). |+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-QueryResult-Message"></a>+<a name="bytebase-v1-Plan-CreateDatabaseConfig"></a>-### QueryResult.Message+### Plan.CreateDatabaseConfig| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| level | [QueryResult.Message.Level](#bytebase-v1-QueryResult-Message-Level) | | |-| content | [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 "ON CLUSTER <<cluster>>". |+| owner | [string](#string) | | owner is the owner of the database. This is only applicable to Postgres for "WITH OWNER <<owner>>". |+| environment | [string](#string) | | The environment resource. Format: environments/prod where prod is the environment resource ID. |-<a name="bytebase-v1-QueryResult-PermissionDenied"></a>+<a name="bytebase-v1-Plan-Deployment"></a>++### Plan.Deployment-### 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. |+| environments | [string](#string) | repeated | The environments deploy order. |+| database_group_mappings | [Plan.Deployment.DatabaseGroupMapping](#bytebase-v1-Plan-Deployment-DatabaseGroupMapping) | repeated | The database group mapping. |-<a name="bytebase-v1-QueryResult-PostgresError"></a>+<a name="bytebase-v1-Plan-Deployment-DatabaseGroupMapping"></a>++### Plan.Deployment.DatabaseGroupMapping-### 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) | | |+| database_group | [string](#string) | | Format: projects/{project}/databaseGroups/{databaseGroup}. |+| databases | [string](#string) | repeated | Format: instances/{instance-id}/databases/{database-name}. |-<a name="bytebase-v1-QueryResult-SyntaxError"></a>+<a name="bytebase-v1-Plan-ExportDataConfig"></a>++### Plan.ExportDataConfig-### 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 |+| 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-QueryRow"></a>+<a name="bytebase-v1-Plan-PlanCheckRunStatusCountEntry"></a>-### QueryRow+### Plan.PlanCheckRunStatusCountEntry| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| values | [RowValue](#bytebase-v1-RowValue) | repeated | Row values of the query result. |+| key | [string](#string) | | |+| value | [int32](#int32) | | |-<a name="bytebase-v1-RowValue"></a>+<a name="bytebase-v1-Plan-Spec"></a>-### RowValue+### Plan.Spec| 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. |+| 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-RowValue-Timestamp"></a>+<a name="bytebase-v1-PlanCheckRun"></a>-### RowValue.Timestamp+### PlanCheckRun| 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) | | Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} |+| type | [PlanCheckRun.Type](#bytebase-v1-PlanCheckRun-Type) | | |+| status | [PlanCheckRun.Status](#bytebase-v1-PlanCheckRun-Status) | | |+| target | [string](#string) | | Format: instances/{instance}/databases/{database} |+| sheet | [string](#string) | | Format: project/{project}/sheets/{sheet} |+| 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-RowValue-TimestampTZ"></a>+<a name="bytebase-v1-PlanCheckRun-Result"></a>-### RowValue.TimestampTZ+### PlanCheckRun.Result| 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 "PDT", "PST". 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) | | |+| status | [Advice.Level](#bytebase-v1-Advice-Level) | | |+| title | [string](#string) | | |+| content | [string](#string) | | |+| code | [int32](#int32) | | |+| 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-SearchQueryHistoriesRequest"></a>+<a name="bytebase-v1-PlanCheckRun-Result-SqlReviewReport"></a>-### SearchQueryHistoriesRequest+### PlanCheckRun.Result.SqlReviewReport| 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+| start_position | [Position](#bytebase-v1-Position) | | Position of the SQL statement. |+| end_position | [Position](#bytebase-v1-Position) | | |-Supported filter: - project: the project full name in "projects/{id}" format, support "==" operator. - database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator. - instance: the instance full name in "instances/{id}" format, support "==" operator. - type: the type, should be "QUERY" or "EXPORT", support "==" operator. - statement: the SQL statement, support ".matches()" operator.-For example: project == "projects/{project}" database == "instances/{instance}/databases/{database}" instance == "instances/{instance}" type == "QUERY" type == "EXPORT" statement.matches("select") type == "QUERY" && statement.matches("select") |+<a name="bytebase-v1-PlanCheckRun-Result-SqlSummaryReport"></a>++### PlanCheckRun.Result.SqlSummaryReport-<a name="bytebase-v1-SearchQueryHistoriesResponse"></a>-### SearchQueryHistoriesResponse+| 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) | | |+| changed_resources | [ChangedResources](#bytebase-v1-ChangedResources) | | |-| 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. |+<a name="bytebase-v1-RunPlanChecksRequest"></a>+### RunPlanChecksRequest--<a name="bytebase-v1-Advice-Level"></a>+| 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. |-### 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. |-<a name="bytebase-v1-Advice-RuleType"></a>-### Advice.RuleType-RuleType indicates the source of the linting rule.+<a name="bytebase-v1-RunPlanChecksResponse"></a>-| 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. |+### RunPlanChecksResponse-<a name="bytebase-v1-QueryHistory-Type"></a>-### QueryHistory.Type-| 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-SearchPlansRequest"></a>+### SearchPlansRequest-<a name="bytebase-v1-QueryOption-MSSQLExplainFormat"></a>-### QueryOption.MSSQLExplainFormat+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use "projects/-" 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 `SearchPlans` call. Provide this to retrieve the subsequent page.-| 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 |+When paginating, all other parameters provided to `SearchPlans` 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 "users/{email or id}" format, support "==" operator. - create_time: the plan create time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator. - has_pipeline: the plan has pipeline or not, support "==" operator, the value should be "true" or "false". - has_issue: the plan has issue or not, support "==" operator, the value should be "true" or "false". - title: the plan title, support "==" operator for exact match and ".matches()" operator for case-insensitive substring match. - spec_type: the plan spec config type, support "==" operator, the value should be "create_database_config", "change_database_config", or "export_data_config". - state: the plan state, support "==" operator, the value should be "ACTIVE" or "DELETED".+For example: creator == "users/[email protected]" && create_time >= "2025-01-02T15:04:05Z07:00" has_pipeline == false && has_issue == true title == "My Plan" title.matches("database migration") spec_type == "change_database_config" state == "ACTIVE" |-<a name="bytebase-v1-QueryOption-RedisRunCommandsOn"></a>-### 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-SearchPlansResponse"></a>-<a name="bytebase-v1-QueryResult-Message-Level"></a>+### SearchPlansResponse-### 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. |+| 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. |-<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-UpdatePlanRequest"></a>+### UpdatePlanRequest--+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| plan | [Plan](#bytebase-v1-Plan) | | The plan to update.-<a name="bytebase-v1-SQLService"></a>+The plan'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. |-### 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'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) |-+-<a name="v1_plan_service-proto"></a>-<p align="right"><a href="#top">Top</a></p>-## v1/plan_service.proto+<a name="bytebase-v1-PlanCheckRun-Status"></a>+### PlanCheckRun.Status-<a name="bytebase-v1-BatchCancelPlanCheckRunsRequest"></a>+| Name | Number | Description |+| ---- | ------ | ----------- |+| STATUS_UNSPECIFIED | 0 | |+| RUNNING | 1 | |+| DONE | 2 | |+| FAILED | 3 | |+| CANCELED | 4 | |-### BatchCancelPlanCheckRunsRequest+<a name="bytebase-v1-PlanCheckRun-Type"></a>-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | The name of the parent of the planChecks. Format: projects/{project}/plans/{plan} |-| plan_check_runs | [string](#string) | repeated | TODO(d): update this API. The planCheckRuns to cancel. Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} |+### PlanCheckRun.Type+| Name | Number | Description |+| ---- | ------ | ----------- |+| TYPE_UNSPECIFIED | 0 | Unspecified check type. |+| DATABASE_STATEMENT_FAKE_ADVISE | 1 | Fake advise check for testing purposes without executing against database. |+| DATABASE_STATEMENT_ADVISE | 3 | SQL review check that analyzes statements against configured SQL review rules. |+| DATABASE_STATEMENT_SUMMARY_REPORT | 5 | Summary report check that generates impact analysis for the statements. |+| DATABASE_CONNECT | 6 | Connection check that verifies database connectivity. |+| DATABASE_GHOST_SYNC | 7 | Ghost sync check that validates gh-ost online schema change compatibility. |++-<a name="bytebase-v1-BatchCancelPlanCheckRunsResponse"></a>-### BatchCancelPlanCheckRunsResponse+<a name="bytebase-v1-PlanService"></a>+### 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 |+| SearchPlans | [SearchPlansRequest](#bytebase-v1-SearchPlansRequest) | [SearchPlansResponse](#bytebase-v1-SearchPlansResponse) | Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query. Permissions required: bb.plans.get |+| 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) |+| ListPlanCheckRuns | [ListPlanCheckRunsRequest](#bytebase-v1-ListPlanCheckRunsRequest) | [ListPlanCheckRunsResponse](#bytebase-v1-ListPlanCheckRunsResponse) | Lists plan check runs for a deployment plan. Permissions required: bb.planCheckRuns.list |+| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |+| BatchCancelPlanCheckRuns | [BatchCancelPlanCheckRunsRequest](#bytebase-v1-BatchCancelPlanCheckRunsRequest) | [BatchCancelPlanCheckRunsResponse](#bytebase-v1-BatchCancelPlanCheckRunsResponse) | Cancels multiple plan check runs. Permissions required: bb.planCheckRuns.run |++<a name="v1_project_service-proto"></a>+<p align="right"><a href="#top">Top</a></p>-<a name="bytebase-v1-CreatePlanRequest"></a>+## v1/project_service.proto-### CreatePlanRequest+<a name="bytebase-v1-Activity"></a>-| 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. |+### Activity+Activity types for webhook notifications.-<a name="bytebase-v1-GetPlanRequest"></a>+<a name="bytebase-v1-AddWebhookRequest"></a>-### GetPlanRequest+### AddWebhookRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the plan to retrieve. Format: projects/{project}/plans/{plan} |+| 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-ListPlanCheckRunsRequest"></a>+<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>-### ListPlanCheckRunsRequest+### BatchDeleteProjectsRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | The parent, which owns this collection of plan check runs. Format: projects/{project}/plans/{plan} |-| latest_only | [bool](#bool) | | If set to true, only the latest plan check run will be returned. |-| filter | [string](#string) | | Filter is used to filter plan check runs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec--Supported filters: - status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values. - result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.--For example: status in ["DONE", "FAILED"] status == "RUNNING" result_status in ["SUCCESS", "ERROR"] result_status == "WARNING" |+| 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-ListPlanCheckRunsResponse"></a>+<a name="bytebase-v1-BatchGetIamPolicyRequest"></a>-### ListPlanCheckRunsResponse+### BatchGetIamPolicyRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| plan_check_runs | [PlanCheckRun](#bytebase-v1-PlanCheckRun) | repeated | The plan check runs from the specified request. |+| scope | [string](#string) | | The scope of the batch get. Typically it's "projects/-". |+| names | [string](#string) | repeated | |-<a name="bytebase-v1-ListPlansRequest"></a>+<a name="bytebase-v1-BatchGetIamPolicyResponse"></a>-### ListPlansRequest+### BatchGetIamPolicyResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use "projects/-" 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. |-+| policy_results | [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult) | repeated | The policy results for each requested project. |-<a name="bytebase-v1-ListPlansResponse"></a>-### ListPlansResponse+<a name="bytebase-v1-BatchGetIamPolicyResponse-PolicyResult"></a>+### BatchGetIamPolicyResponse.PolicyResult+Result for a single project's IAM policy.| 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. |+| project | [string](#string) | | The project resource name. |+| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | The IAM policy for the project. |-<a name="bytebase-v1-Plan"></a>+<a name="bytebase-v1-CreateProjectRequest"></a>-### Plan+### CreateProjectRequest| 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} |-| rollout | [string](#string) | | The rollout associated with the plan. Can be empty. Format: projects/{project}/rollouts/{rollout} |-| 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 |-| deployment | [Plan.Deployment](#bytebase-v1-Plan-Deployment) | | |+| 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's resource name.+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |-<a name="bytebase-v1-Plan-ChangeDatabaseConfig"></a>-### Plan.ChangeDatabaseConfig+<a name="bytebase-v1-DeleteProjectRequest"></a>++### DeleteProjectRequest| 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} |-| type | [DatabaseChangeType](#bytebase-v1-DatabaseChangeType) | | Type is the database change type. |-| 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. |+| 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-Plan-ChangeDatabaseConfig-GhostFlagsEntry"></a>+<a name="bytebase-v1-GetProjectRequest"></a>-### Plan.ChangeDatabaseConfig.GhostFlagsEntry+### GetProjectRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [string](#string) | | |-+| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |-<a name="bytebase-v1-Plan-CreateDatabaseConfig"></a>-### Plan.CreateDatabaseConfig+<a name="bytebase-v1-Label"></a>+### Label+A label for categorizing and organizing issues.| 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 "ON CLUSTER <<cluster>>". |-| owner | [string](#string) | | owner is the owner of the database. This is only applicable to Postgres for "WITH OWNER <<owner>>". |-| environment | [string](#string) | | The environment resource. Format: environments/prod where prod is the environment resource ID. |+| 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-Plan-Deployment"></a>+<a name="bytebase-v1-ListProjectsRequest"></a>-### Plan.Deployment+### ListProjectsRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| environments | [string](#string) | repeated | The environments deploy order. |-| database_group_mappings | [Plan.Deployment.DatabaseGroupMapping](#bytebase-v1-Plan-Deployment-DatabaseGroupMapping) | repeated | The database group mapping. |+| 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 == "production"). |-<a name="bytebase-v1-Plan-Deployment-DatabaseGroupMapping"></a>+<a name="bytebase-v1-ListProjectsResponse"></a>-### Plan.Deployment.DatabaseGroupMapping+### ListProjectsResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| database_group | [string](#string) | | Format: projects/{project}/databaseGroups/{databaseGroup}. |-| databases | [string](#string) | repeated | Format: instances/{instance-id}/databases/{database-name}. |+| 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-Plan-ExportDataConfig"></a>+<a name="bytebase-v1-Project"></a>-### Plan.ExportDataConfig+### Project| 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. |-+| 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'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. |+| allow_modify_statement | [bool](#bool) | | Allow modifying SQL statements after issue is created. |+| auto_resolve_issue | [bool](#bool) | | Enable automatic issue resolution when tasks complete. |+| 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 "set role <db_owner>" 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, { "environment": "production", "team": "backend" } |+| 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. |-<a name="bytebase-v1-Plan-PlanCheckRunStatusCountEntry"></a>-### Plan.PlanCheckRunStatusCountEntry+<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>+### Project.ExecutionRetryPolicy+Execution retry policy configuration.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| key | [string](#string) | | |-| value | [int32](#int32) | | |+| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |-<a name="bytebase-v1-Plan-Spec"></a>+<a name="bytebase-v1-Project-LabelsEntry"></a>-### Plan.Spec+### Project.LabelsEntry| 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) | | |+| key | [string](#string) | | |+| value | [string](#string) | | |-<a name="bytebase-v1-PlanCheckRun"></a>+<a name="bytebase-v1-RemoveWebhookRequest"></a>-### PlanCheckRun+### RemoveWebhookRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} |-| type | [PlanCheckRun.Type](#bytebase-v1-PlanCheckRun-Type) | | |-| status | [PlanCheckRun.Status](#bytebase-v1-PlanCheckRun-Status) | | |-| target | [string](#string) | | Format: instances/{instance}/databases/{database} |-| sheet | [string](#string) | | Format: project/{project}/sheets/{sheet} |-| 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) | | |+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |-<a name="bytebase-v1-PlanCheckRun-Result"></a>+<a name="bytebase-v1-SearchProjectsRequest"></a>-### PlanCheckRun.Result+### SearchProjectsRequest| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| status | [Advice.Level](#bytebase-v1-Advice-Level) | | |-| title | [string](#string) | | |-| content | [string](#string) | | |-| code | [int32](#int32) | | |-| sql_summary_report | [PlanCheckRun.Result.SqlSummaryReport](#bytebase-v1-PlanCheckRun-Result-SqlSummaryReport) | | |-| sql_review_report | [PlanCheckRun.Result.SqlReviewReport](#bytebase-v1-PlanCheckRun-Result-SqlReviewReport) | | |+| 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 "==" and ".matches()" operator. - resource_id: the project id, support "==" and ".matches()" operator. - exclude_default: if not include the default project, should be "true" or "false", support "==" operator. - state: check the State enum for the values, support "==" operator. - labels.{key}: the project label, support "==" and "in" operators.++For example: name == "project name" name.matches("project name") resource_id == "project id" resource_id.matches("project id") exclude_default == true state == "DELETED" labels.environment == "production" labels.tier == "critical" labels.environment in ["staging", "prod"] You can combine filter conditions like: name == "project name" && resource_id.matches("project id") name.matches("project name") || resource_id == "project id" labels.environment == "production" && labels.tier == "critical" |+| 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. |-<a name="bytebase-v1-PlanCheckRun-Result-SqlReviewReport"></a>-### PlanCheckRun.Result.SqlReviewReport+<a name="bytebase-v1-SearchProjectsResponse"></a>++### SearchProjectsResponse| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start_position | [Position](#bytebase-v1-Position) | | Position of the SQL statement. |-| end_position | [Position](#bytebase-v1-Position) | | |+| 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-PlanCheckRun-Result-SqlSummaryReport"></a>+<a name="bytebase-v1-TestWebhookRequest"></a>-### PlanCheckRun.Result.SqlSummaryReport+### TestWebhookRequest| 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) | | |-| changed_resources | [ChangedResources](#bytebase-v1-ChangedResources) | | |+| 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-RunPlanChecksRequest"></a>+<a name="bytebase-v1-TestWebhookResponse"></a>-### RunPlanChecksRequest+### TestWebhookResponse| 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. |+| error | [string](#string) | | The result of the test, empty if the test is successful. |-<a name="bytebase-v1-RunPlanChecksResponse"></a>+<a name="bytebase-v1-UndeleteProjectRequest"></a>-### RunPlanChecksResponse+### UndeleteProjectRequest+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |-<a name="bytebase-v1-SearchPlansRequest"></a>-### SearchPlansRequest+<a name="bytebase-v1-UpdateProjectRequest"></a>+### UpdateProjectRequest-| Field | Type | Label | Description |-| ----- | ---- | ----- | ----------- |-| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use "projects/-" 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 `SearchPlans` call. Provide this to retrieve the subsequent page.-When paginating, all other parameters provided to `SearchPlans` 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 "users/{email or id}" format, support "==" operator. - create_time: the plan create time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator. - has_pipeline: the plan has pipeline or not, support "==" operator, the value should be "true" or "false". - has_issue: the plan has issue or not, support "==" operator, the value should be "true" or "false". - title: the plan title, support "==" operator for exact match and ".matches()" operator for case-insensitive substring match. - spec_type: the plan spec config type, support "==" operator, the value should be "create_database_config", "change_database_config", or "export_data_config". - state: the plan state, support "==" operator, the value should be "ACTIVE" or "DELETED".+| Field | Type | Label | Description |+| ----- | ---- | ----- | ----------- |+| project | [Project](#bytebase-v1-Project) | | The project to update.-For example: creator == "users/[email protected]" && create_time >= "2025-01-02T15:04:05Z07:00" has_pipeline == false && has_issue == true title == "My Plan" title.matches("database migration") spec_type == "change_database_config" state == "ACTIVE" |+The project'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-SearchPlansResponse"></a>+<a name="bytebase-v1-UpdateWebhookRequest"></a>-### SearchPlansResponse+### UpdateWebhookRequest| 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. |+| 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-UpdatePlanRequest"></a>+<a name="bytebase-v1-Webhook"></a>-### UpdatePlanRequest+### Webhook| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| plan | [Plan](#bytebase-v1-Plan) | | The plan to update.--The plan'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. |+| 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_CREATE - ISSUE_COMMENT_CREATE - ISSUE_FIELD_UPDATE - ISSUE_STATUS_UPDATE - ISSUE_APPROVAL_NOTIFY - ISSUE_PIPELINE_STAGE_STATUS_UPDATE - ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE - NOTIFY_ISSUE_APPROVED - NOTIFY_PIPELINE_ROLLOUT |@@ -8539,34 +8538,27 @@ The plan's `name` field is used to identify the plan to update. Format: proj-<a name="bytebase-v1-PlanCheckRun-Status"></a>--### PlanCheckRun.Status+<a name="bytebase-v1-Activity-Type"></a>+### Activity.Type+Activity type enumeration.| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | |-| RUNNING | 1 | |-| DONE | 2 | |-| FAILED | 3 | |-| CANCELED | 4 | |----<a name="bytebase-v1-PlanCheckRun-Type"></a>--### PlanCheckRun.Type+| TYPE_UNSPECIFIED | 0 | Unspecified type. |+| NOTIFY_ISSUE_APPROVED | 23 | Notifications via webhooks.+NOTIFY_ISSUE_APPROVED represents the issue approved notification. |+| NOTIFY_PIPELINE_ROLLOUT | 24 | NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification. |+| ISSUE_CREATE | 1 | Issue related activity types.-| Name | Number | Description |-| ---- | ------ | ----------- |-| TYPE_UNSPECIFIED | 0 | Unspecified check type. |-| DATABASE_STATEMENT_FAKE_ADVISE | 1 | Fake advise check for testing purposes without executing against database. |-| DATABASE_STATEMENT_ADVISE | 3 | SQL review check that analyzes statements against configured SQL review rules. |-| DATABASE_STATEMENT_SUMMARY_REPORT | 5 | Summary report check that generates impact analysis for the statements. |-| DATABASE_CONNECT | 6 | Connection check that verifies database connectivity. |-| DATABASE_GHOST_SYNC | 7 | Ghost sync check that validates gh-ost online schema change compatibility. |+ISSUE_CREATE represents creating an issue. |+| ISSUE_COMMENT_CREATE | 2 | ISSUE_COMMENT_CREATE represents commenting on an issue. |+| ISSUE_FIELD_UPDATE | 3 | ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc. |+| ISSUE_STATUS_UPDATE | 4 | ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now. |+| ISSUE_APPROVAL_NOTIFY | 21 | ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval. |+| ISSUE_PIPELINE_STAGE_STATUS_UPDATE | 5 | ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now. |+| ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE | 22 | ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED. |@@ -8574,21 +8566,28 @@ The plan's `name` field is used to identify the plan to update. Format: proj-<a name="bytebase-v1-PlanService"></a>+<a name="bytebase-v1-ProjectService"></a>-### PlanService-PlanService manages deployment plans for database changes.+### ProjectService+ProjectService manages projects that group databases and 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 |-| SearchPlans | [SearchPlansRequest](#bytebase-v1-SearchPlansRequest) | [SearchPlansResponse](#bytebase-v1-SearchPlansResponse) | Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query. Permissions required: bb.plans.get |-| 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) |-| ListPlanCheckRuns | [ListPlanCheckRunsRequest](#bytebase-v1-ListPlanCheckRunsRequest) | [ListPlanCheckRunsResponse](#bytebase-v1-ListPlanCheckRunsResponse) | Lists plan check runs for a deployment plan. Permissions required: bb.planCheckRuns.list |-| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |-| BatchCancelPlanCheckRuns | [BatchCancelPlanCheckRunsRequest](#bytebase-v1-BatchCancelPlanCheckRunsRequest) | [BatchCancelPlanCheckRunsResponse](#bytebase-v1-BatchCancelPlanCheckRunsResponse) | Cancels multiple plan check runs. Permissions required: bb.planCheckRuns.run |+| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with "bb.projects.get" permission on the workspace or the project owner can access this method. 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'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 |+| BatchGetIamPolicy | [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest) | [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse) | Deprecated. No permission check implemented. Permissions required: None |+| 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 |diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.htmlindex c7b7bba00f..a47ff62915 100644--- a/proto/gen/grpc-doc/v1/index.html+++ b/proto/gen/grpc-doc/v1/index.html@@ -407,160 +407,6 @@</li>- <li>- <a href="#v1%2fiam_policy.proto">v1/iam_policy.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>- </li>-- <li>- <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>- </li>-- <li>- <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</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>- </li>---- </ul>- </li>--- <li>- <a href="#v1%2fproject_service.proto">v1/project_service.proto</a>- <ul>-- <li>- <a href="#bytebase.v1.Activity"><span class="badge">M</span>Activity</a>- </li>-- <li>- <a href="#bytebase.v1.AddWebhookRequest"><span class="badge">M</span>AddWebhookRequest</a>- </li>-- <li>- <a href="#bytebase.v1.BatchDeleteProjectsRequest"><span class="badge">M</span>BatchDeleteProjectsRequest</a>- </li>-- <li>- <a href="#bytebase.v1.BatchGetIamPolicyRequest"><span class="badge">M</span>BatchGetIamPolicyRequest</a>- </li>-- <li>- <a href="#bytebase.v1.BatchGetIamPolicyResponse"><span class="badge">M</span>BatchGetIamPolicyResponse</a>- </li>-- <li>- <a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult"><span class="badge">M</span>BatchGetIamPolicyResponse.PolicyResult</a>- </li>-- <li>- <a href="#bytebase.v1.CreateProjectRequest"><span class="badge">M</span>CreateProjectRequest</a>- </li>-- <li>- <a href="#bytebase.v1.DeleteProjectRequest"><span class="badge">M</span>DeleteProjectRequest</a>- </li>-- <li>- <a href="#bytebase.v1.GetProjectRequest"><span class="badge">M</span>GetProjectRequest</a>- </li>-- <li>- <a href="#bytebase.v1.Label"><span class="badge">M</span>Label</a>- </li>-- <li>- <a href="#bytebase.v1.ListProjectsRequest"><span class="badge">M</span>ListProjectsRequest</a>- </li>-- <li>- <a href="#bytebase.v1.ListProjectsResponse"><span class="badge">M</span>ListProjectsResponse</a>- </li>-- <li>- <a href="#bytebase.v1.Project"><span class="badge">M</span>Project</a>- </li>-- <li>- <a href="#bytebase.v1.Project.ExecutionRetryPolicy"><span class="badge">M</span>Project.ExecutionRetryPolicy</a>- </li>-- <li>- <a href="#bytebase.v1.Project.LabelsEntry"><span class="badge">M</span>Project.LabelsEntry</a>- </li>-- <li>- <a href="#bytebase.v1.RemoveWebhookRequest"><span class="badge">M</span>RemoveWebhookRequest</a>- </li>-- <li>- <a href="#bytebase.v1.SearchProjectsRequest"><span class="badge">M</span>SearchProjectsRequest</a>- </li>-- <li>- <a href="#bytebase.v1.SearchProjectsResponse"><span class="badge">M</span>SearchProjectsResponse</a>- </li>-- <li>- <a href="#bytebase.v1.TestWebhookRequest"><span class="badge">M</span>TestWebhookRequest</a>- </li>-- <li>- <a href="#bytebase.v1.TestWebhookResponse"><span class="badge">M</span>TestWebhookResponse</a>- </li>-- <li>- <a href="#bytebase.v1.UndeleteProjectRequest"><span class="badge">M</span>UndeleteProjectRequest</a>- </li>-- <li>- <a href="#bytebase.v1.UpdateProjectRequest"><span class="badge">M</span>UpdateProjectRequest</a>- </li>-- <li>- <a href="#bytebase.v1.UpdateWebhookRequest"><span class="badge">M</span>UpdateWebhookRequest</a>- </li>-- <li>- <a href="#bytebase.v1.Webhook"><span class="badge">M</span>Webhook</a>- </li>--- <li>- <a href="#bytebase.v1.Activity.Type"><span class="badge">E</span>Activity.Type</a>- </li>---- <li>- <a href="#bytebase.v1.ProjectService"><span class="badge">S</span>ProjectService</a>- </li>-- </ul>- </li>--<li><a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a><ul>@@ -858,6 +704,45 @@</li>+ <li>+ <a href="#v1%2fiam_policy.proto">v1/iam_policy.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>+ </li>++ <li>+ <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</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>+ </li>++++ </ul>+ </li>++<li><a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a><ul>@@ -2158,118 +2043,233 @@<li>- <a href="#v1%2frelease_service.proto">v1/release_service.proto</a>+ <a href="#v1%2fproject_service.proto">v1/project_service.proto</a><ul><li>- <a href="#bytebase.v1.CheckReleaseRequest"><span class="badge">M</span>CheckReleaseRequest</a>+ <a href="#bytebase.v1.Activity"><span class="badge">M</span>Activity</a></li><li>- <a href="#bytebase.v1.CheckReleaseResponse"><span class="badge">M</span>CheckReleaseResponse</a>+ <a href="#bytebase.v1.AddWebhookRequest"><span class="badge">M</span>AddWebhookRequest</a></li><li>- <a href="#bytebase.v1.CheckReleaseResponse.CheckResult"><span class="badge">M</span>CheckReleaseResponse.CheckResult</a>+ <a href="#bytebase.v1.BatchDeleteProjectsRequest"><span class="badge">M</span>BatchDeleteProjectsRequest</a></li><li>- <a href="#bytebase.v1.CreateReleaseRequest"><span class="badge">M</span>CreateReleaseRequest</a>+ <a href="#bytebase.v1.BatchGetIamPolicyRequest"><span class="badge">M</span>BatchGetIamPolicyRequest</a></li><li>- <a href="#bytebase.v1.DeleteReleaseRequest"><span class="badge">M</span>DeleteReleaseRequest</a>+ <a href="#bytebase.v1.BatchGetIamPolicyResponse"><span class="badge">M</span>BatchGetIamPolicyResponse</a></li><li>- <a href="#bytebase.v1.GetReleaseRequest"><span class="badge">M</span>GetReleaseRequest</a>+ <a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult"><span class="badge">M</span>BatchGetIamPolicyResponse.PolicyResult</a></li><li>- <a href="#bytebase.v1.ListReleasesRequest"><span class="badge">M</span>ListReleasesRequest</a>+ <a href="#bytebase.v1.CreateProjectRequest"><span class="badge">M</span>CreateProjectRequest</a></li><li>- <a href="#bytebase.v1.ListReleasesResponse"><span class="badge">M</span>ListReleasesResponse</a>+ <a href="#bytebase.v1.DeleteProjectRequest"><span class="badge">M</span>DeleteProjectRequest</a></li><li>- <a href="#bytebase.v1.Release"><span class="badge">M</span>Release</a>+ <a href="#bytebase.v1.GetProjectRequest"><span class="badge">M</span>GetProjectRequest</a></li><li>- <a href="#bytebase.v1.Release.File"><span class="badge">M</span>Release.File</a>+ <a href="#bytebase.v1.Label"><span class="badge">M</span>Label</a></li><li>- <a href="#bytebase.v1.Release.VCSSource"><span class="badge">M</span>Release.VCSSource</a>+ <a href="#bytebase.v1.ListProjectsRequest"><span class="badge">M</span>ListProjectsRequest</a></li><li>- <a href="#bytebase.v1.SearchReleasesRequest"><span class="badge">M</span>SearchReleasesRequest</a>+ <a href="#bytebase.v1.ListProjectsResponse"><span class="badge">M</span>ListProjectsResponse</a></li><li>- <a href="#bytebase.v1.SearchReleasesResponse"><span class="badge">M</span>SearchReleasesResponse</a>+ <a href="#bytebase.v1.Project"><span class="badge">M</span>Project</a></li><li>- <a href="#bytebase.v1.UndeleteReleaseRequest"><span class="badge">M</span>UndeleteReleaseRequest</a>+ <a href="#bytebase.v1.Project.ExecutionRetryPolicy"><span class="badge">M</span>Project.ExecutionRetryPolicy</a></li><li>- <a href="#bytebase.v1.UpdateReleaseRequest"><span class="badge">M</span>UpdateReleaseRequest</a>+ <a href="#bytebase.v1.Project.LabelsEntry"><span class="badge">M</span>Project.LabelsEntry</a></li>-<li>- <a href="#bytebase.v1.Release.File.Type"><span class="badge">E</span>Release.File.Type</a>+ <a href="#bytebase.v1.RemoveWebhookRequest"><span class="badge">M</span>RemoveWebhookRequest</a></li>--<li>- <a href="#bytebase.v1.ReleaseService"><span class="badge">S</span>ReleaseService</a>+ <a href="#bytebase.v1.SearchProjectsRequest"><span class="badge">M</span>SearchProjectsRequest</a></li>- </ul>- </li>--- <li>- <a href="#v1%2freview_config_service.proto">v1/review_config_service.proto</a>- <ul>-<li>- <a href="#bytebase.v1.CreateReviewConfigRequest"><span class="badge">M</span>CreateReviewConfigRequest</a>+ <a href="#bytebase.v1.SearchProjectsResponse"><span class="badge">M</span>SearchProjectsResponse</a></li><li>- <a href="#bytebase.v1.DeleteReviewConfigRequest"><span class="badge">M</span>DeleteReviewConfigRequest</a>+ <a href="#bytebase.v1.TestWebhookRequest"><span class="badge">M</span>TestWebhookRequest</a></li><li>- <a href="#bytebase.v1.GetReviewConfigRequest"><span class="badge">M</span>GetReviewConfigRequest</a>+ <a href="#bytebase.v1.TestWebhookResponse"><span class="badge">M</span>TestWebhookResponse</a></li><li>- <a href="#bytebase.v1.ListReviewConfigsRequest"><span class="badge">M</span>ListReviewConfigsRequest</a>+ <a href="#bytebase.v1.UndeleteProjectRequest"><span class="badge">M</span>UndeleteProjectRequest</a></li><li>- <a href="#bytebase.v1.ListReviewConfigsResponse"><span class="badge">M</span>ListReviewConfigsResponse</a>+ <a href="#bytebase.v1.UpdateProjectRequest"><span class="badge">M</span>UpdateProjectRequest</a></li><li>- <a href="#bytebase.v1.ReviewConfig"><span class="badge">M</span>ReviewConfig</a>+ <a href="#bytebase.v1.UpdateWebhookRequest"><span class="badge">M</span>UpdateWebhookRequest</a></li><li>- <a href="#bytebase.v1.SQLReviewRule"><span class="badge">M</span>SQLReviewRule</a>+ <a href="#bytebase.v1.Webhook"><span class="badge">M</span>Webhook</a></li>+<li>- <a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload"><span class="badge">M</span>SQLReviewRule.CommentConventionRulePayload</a>+ <a href="#bytebase.v1.Activity.Type"><span class="badge">E</span>Activity.Type</a>+ </li>++++ <li>+ <a href="#bytebase.v1.ProjectService"><span class="badge">S</span>ProjectService</a>+ </li>++ </ul>+ </li>+++ <li>+ <a href="#v1%2frelease_service.proto">v1/release_service.proto</a>+ <ul>++ <li>+ <a href="#bytebase.v1.CheckReleaseRequest"><span class="badge">M</span>CheckReleaseRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.CheckReleaseResponse"><span class="badge">M</span>CheckReleaseResponse</a>+ </li>++ <li>+ <a href="#bytebase.v1.CheckReleaseResponse.CheckResult"><span class="badge">M</span>CheckReleaseResponse.CheckResult</a>+ </li>++ <li>+ <a href="#bytebase.v1.CreateReleaseRequest"><span class="badge">M</span>CreateReleaseRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.DeleteReleaseRequest"><span class="badge">M</span>DeleteReleaseRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.GetReleaseRequest"><span class="badge">M</span>GetReleaseRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.ListReleasesRequest"><span class="badge">M</span>ListReleasesRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.ListReleasesResponse"><span class="badge">M</span>ListReleasesResponse</a>+ </li>++ <li>+ <a href="#bytebase.v1.Release"><span class="badge">M</span>Release</a>+ </li>++ <li>+ <a href="#bytebase.v1.Release.File"><span class="badge">M</span>Release.File</a>+ </li>++ <li>+ <a href="#bytebase.v1.Release.VCSSource"><span class="badge">M</span>Release.VCSSource</a>+ </li>++ <li>+ <a href="#bytebase.v1.SearchReleasesRequest"><span class="badge">M</span>SearchReleasesRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.SearchReleasesResponse"><span class="badge">M</span>SearchReleasesResponse</a>+ </li>++ <li>+ <a href="#bytebase.v1.UndeleteReleaseRequest"><span class="badge">M</span>UndeleteReleaseRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.UpdateReleaseRequest"><span class="badge">M</span>UpdateReleaseRequest</a>+ </li>+++ <li>+ <a href="#bytebase.v1.Release.File.Type"><span class="badge">E</span>Release.File.Type</a>+ </li>++++ <li>+ <a href="#bytebase.v1.ReleaseService"><span class="badge">S</span>ReleaseService</a>+ </li>++ </ul>+ </li>+++ <li>+ <a href="#v1%2freview_config_service.proto">v1/review_config_service.proto</a>+ <ul>++ <li>+ <a href="#bytebase.v1.CreateReviewConfigRequest"><span class="badge">M</span>CreateReviewConfigRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.DeleteReviewConfigRequest"><span class="badge">M</span>DeleteReviewConfigRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.GetReviewConfigRequest"><span class="badge">M</span>GetReviewConfigRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.ListReviewConfigsRequest"><span class="badge">M</span>ListReviewConfigsRequest</a>+ </li>++ <li>+ <a href="#bytebase.v1.ListReviewConfigsResponse"><span class="badge">M</span>ListReviewConfigsResponse</a>+ </li>++ <li>+ <a href="#bytebase.v1.ReviewConfig"><span class="badge">M</span>ReviewConfig</a>+ </li>++ <li>+ <a href="#bytebase.v1.SQLReviewRule"><span class="badge">M</span>SQLReviewRule</a>+ </li>++ <li>+ <a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload"><span class="badge">M</span>SQLReviewRule.CommentConventionRulePayload</a></li><li>@@ -5200,13 +5200,13 @@ Permissions required: None (determined by approval flow)</p></td><div class="file-heading">- <h2 id="v1/iam_policy.proto">v1/iam_policy.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.Binding">Binding</h3>- <p>Binding associates members with a role and optional conditions.</p>+ <h3 id="bytebase.v1.AISetting">AISetting</h3>+ <p></p><table class="field-table">@@ -5216,48 +5216,45 @@ Permissions required: None (determined by approval flow)</p></td><tbody><tr>- <td>role</td>+ <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></td>- <td><p>The role that is assigned to the members.-Format: roles/{role} </p></td>+ <td><p> </p></td></tr><tr>- <td>members</td>+ <td>api_key</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></td>+ <td><p> </p></td></tr><tr>- <td>condition</td>- <td><a href="#google.type.Expr">google.type.Expr</a></td>+ <td>model</td>+ <td><a href="#string">string</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 "instances/{instance}/databases/{database}" format, used by the "roles/sqlEditorUser" role, support "==" operator.-resource.schema_name: the schema name, used by the "roles/sqlEditorUser" role, support "==" operator.-resource.table_name: the table name, used by the "roles/sqlEditorUser" role, support "==" operator.-request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")`.--For example:-resource.database == "instances/local-pg/databases/postgres" && resource.schema_name in ["public","another_schema"]-resource.database == "instances/local-pg/databases/bytebase" && resource.schema_name == "public" && resource.table_name in ["audit_log"]-request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td>+ <td><p> </p></td></tr><tr>- <td>parsed_expr</td>- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>+ <td>version</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The parsed expression of the condition. </p></td>+ <td><p> </p></td></tr></tbody>@@ -5267,8 +5264,8 @@ request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td>- <h3 id="bytebase.v1.BindingDelta">BindingDelta</h3>- <p>A single change to a binding.</p>+ <h3 id="bytebase.v1.Algorithm">Algorithm</h3>+ <p></p><table class="field-table">@@ -5278,32 +5275,31 @@ request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td><tbody><tr>- <td>action</td>- <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td>+ <td>full_mask</td>+ <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td><td></td>- <td><p>The action that was performed on a Binding. </p></td>+ <td><p> </p></td></tr><tr>- <td>role</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>Role that is assigned to `members`.-For example, `roles/projectOwner`. </p></td>+ <td><p> </p></td></tr><tr>- <td>member</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>Follows the same format of Binding.members. </p></td>+ <td><p> </p></td></tr><tr>- <td>condition</td>- <td><a href="#google.type.Expr">google.type.Expr</a></td>+ <td>inner_outer_mask</td>+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td><td></td>- <td><p>The condition that is associated with this binding. </p></td>+ <td><p> </p></td></tr></tbody>@@ -5313,8 +5309,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.Algorithm.FullMask">Algorithm.FullMask</h3>+ <p></p><table class="field-table">@@ -5324,12 +5320,11 @@ For example, `roles/projectOwner`. </p></td><tbody><tr>- <td>resource</td>+ <td>substitution</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>substitution is the string used to replace the original value, the+max length of the string is 16 bytes. </p></td></tr></tbody>@@ -5339,8 +5334,8 @@ Format: workspaces/{workspace} </p></td>- <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>- <p>IAM policy that binds members to roles.</p>+ <h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>+ <p></p><table class="field-table">@@ -5350,44 +5345,31 @@ Format: workspaces/{workspace} </p></td><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>prefix_len</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p> </p></td></tr><tr>- <td>etag</td>- <td><a href="#string">string</a></td>+ <td>suffix_len</td>+ <td><a href="#int32">int32</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> </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>type</td>+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>+ <td></td>+ <td><p> </p></td>+ </tr><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>substitution</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -5397,8 +5379,8 @@ the call will be blocked and an ABORTED error will be returned. </p></td>- <h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>- <p>Request message for setting an IAM policy.</p>+ <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>+ <p></p><table class="field-table">@@ -5408,26 +5390,10 @@ the call will be blocked and an ABORTED error will be returned. </p></td><tbody><tr>- <td>resource</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>- </tr>-- <tr>- <td>policy</td>- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>etag</td>+ <td>salt</td><td><a href="#string">string</a></td><td></td>- <td><p>The current etag of the policy. </p></td>+ <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td></tr></tbody>@@ -5437,57 +5403,7 @@ 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/project_service.proto">v1/project_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.Algorithm.RangeMask">Algorithm.RangeMask</h3><p></p>@@ -5498,18 +5414,11 @@ Format: workspaces/{workspace} </p></td><tbody><tr>- <td>project</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>- </tr>-- <tr>- <td>webhook</td>- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>- <td></td>- <td><p>The webhook to add. </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>@@ -5519,7 +5428,7 @@ Format: projects/{project} </p></td>- <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>+ <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3><p></p>@@ -5530,21 +5439,24 @@ Format: projects/{project} </p></td><tbody><tr>- <td>names</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>start</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p>start is the start index of the original value, start from 0 and should be less than stop. </p></td></tr><tr>- <td>force</td>- <td><a href="#bool">bool</a></td>+ <td>end</td>+ <td><a href="#int32">int32</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>stop is the stop index of the original value, should be less than the length of the original value. </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>@@ -5554,7 +5466,7 @@ If set to false, the operation will fail if the project has databases or open is- <h3 id="bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</h3>+ <h3 id="bytebase.v1.Announcement">Announcement</h3><p></p>@@ -5565,17 +5477,24 @@ If set to false, the operation will fail if the project has databases or open is<tbody><tr>- <td>scope</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>The scope of the batch get. Typically it's "projects/-". </p></td>+ <td><p>The text of announcement </p></td></tr><tr>- <td>names</td>+ <td>link</td><td><a href="#string">string</a></td>- <td>repeated</td>- <td><p> </p></td>+ <td></td>+ <td><p>The optional link, user can follow the link to check extra details </p></td></tr></tbody>@@ -5585,7 +5504,7 @@ If set to false, the operation will fail if the project has databases or open is- <h3 id="bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</h3>+ <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3><p></p>@@ -5596,10 +5515,10 @@ If set to false, the operation will fail if the project has databases or open is<tbody><tr>- <td>policy_results</td>- <td><a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</a></td>+ <td>settings</td>+ <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td><td>repeated</td>- <td><p>The policy results for each requested project. </p></td>+ <td><p> </p></td></tr></tbody>@@ -5609,8 +5528,8 @@ If set to false, the operation will fail if the project has databases or open is- <h3 id="bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</h3>- <p>Result for a single project's IAM policy.</p>+ <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>+ <p></p><table class="field-table">@@ -5620,17 +5539,24 @@ If set to false, the operation will fail if the project has databases or open is<tbody><tr>- <td>project</td>+ <td>client_id</td><td><a href="#string">string</a></td><td></td>- <td><p>The project resource name. </p></td>+ <td><p> </p></td></tr><tr>- <td>policy</td>- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>+ <td>client_secret</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The IAM policy for the project. </p></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>robot_code</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -5640,7 +5566,7 @@ If set to false, the operation will fail if the project has databases or open is- <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3>+ <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3><p></p>@@ -5651,21 +5577,17 @@ If set to false, the operation will fail if the project has databases or open is<tbody><tr>- <td>project</td>- <td><a href="#bytebase.v1.Project">Project</a></td>+ <td>app_id</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The project to create. </p></td>+ <td><p> </p></td></tr><tr>- <td>project_id</td>+ <td>app_secret</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's resource name.--This value should be 4-63 characters, and valid characters-are /[a-z][0-9]-/. </p></td>+ <td><p> </p></td></tr></tbody>@@ -5675,7 +5597,7 @@ are /[a-z][0-9]-/. </p></td>- <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3>+ <h3 id="bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3><p></p>@@ -5686,94 +5608,52 @@ are /[a-z][0-9]-/. </p></td><tbody><tr>- <td>name</td>- <td><a href="#string">string</a></td>+ <td>type</td>+ <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td><td></td>- <td><p>The name of the project to delete.-Format: projects/{project} </p></td>+ <td><p> </p></td></tr><tr>- <td>force</td>- <td><a href="#bool">bool</a></td>+ <td>slack</td>+ <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</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> </p></td></tr><tr>- <td>purge</td>- <td><a href="#bool">bool</a></td>+ <td>feishu</td>+ <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</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> </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</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>wecom</td>+ <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td><td></td>- <td><p>The name of the project to retrieve.-Format: projects/{project} </p></td>+ <td><p> </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>value</td>- <td><a href="#string">string</a></td>+ <td>lark</td>+ <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td><td></td>- <td><p>The label value/name. </p></td>+ <td><p> </p></td></tr><tr>- <td>color</td>- <td><a href="#string">string</a></td>+ <td>dingtalk</td>+ <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td><td></td>- <td><p>The color code for the label (e.g., hex color). </p></td>+ <td><p> </p></td></tr><tr>- <td>group</td>- <td><a href="#string">string</a></td>+ <td>teams</td>+ <td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td><td></td>- <td><p>The group this label belongs to. </p></td>+ <td><p> </p></td></tr></tbody>@@ -5783,7 +5663,7 @@ Format: projects/{project} </p></td>- <h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</h3>+ <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3><p></p>@@ -5794,40 +5674,17 @@ Format: projects/{project} </p></td><tbody><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.-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>- </tr>-- <tr>- <td>page_token</td>+ <td>app_id</td><td><a href="#string">string</a></td><td></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>show_deleted</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Show deleted projects if specified. </p></td>+ <td><p> </p></td></tr><tr>- <td>filter</td>+ <td>app_secret</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 == "production"). </p></td>+ <td><p> </p></td></tr></tbody>@@ -5837,7 +5694,7 @@ Supports filtering by name, resource_id, state, and labels (e.g., labels.environ- <h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3>+ <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3><p></p>@@ -5848,18 +5705,10 @@ Supports filtering by name, resource_id, state, and labels (e.g., labels.environ<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>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> </p></td></tr></tbody>@@ -5869,7 +5718,7 @@ If this field is omitted, there are no subsequent pages. </p></td>- <h3 id="bytebase.v1.Project">Project</h3>+ <h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</h3><p></p>@@ -5880,141 +5729,24 @@ If this field is omitted, there are no subsequent pages. </p></td><tbody><tr>- <td>name</td>+ <td>tenant_id</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>Azure AD tenant ID (Directory ID). </p></td></tr><tr>- <td>title</td>+ <td>client_id</td><td><a href="#string">string</a></td><td></td>- <td><p>The title or name of a project. It's not unique within the workspace. </p></td>- </tr>-- <tr>- <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>+ <td><p>Azure AD application (client) ID. </p></td></tr><tr>- <td>data_classification_config_id</td>+ <td>client_secret</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>- </tr>-- <tr>- <td>force_issue_labels</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Force issue labels to be used when creating an issue. </p></td>- </tr>-- <tr>- <td>allow_modify_statement</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Allow modifying SQL statements after issue is created. </p></td>- </tr>-- <tr>- <td>auto_resolve_issue</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Enable automatic issue resolution when tasks complete. </p></td>- </tr>-- <tr>- <td>enforce_issue_title</td>- <td><a href="#bool">bool</a></td>- <td></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 "set role <db_owner>" 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, { "environment": "production", "team": "backend" } </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>+ <td><p>Azure AD client secret. </p></td></tr></tbody>@@ -6024,8 +5756,8 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>- <h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>- <p>Execution retry policy configuration.</p>+ <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>+ <p></p><table class="field-table">@@ -6035,38 +5767,21 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td><tbody><tr>- <td>maximum_retries</td>- <td><a href="#int32">int32</a></td>+ <td>corp_id</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> </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.Project.LabelsEntry">Project.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>agent_id</td><td><a href="#string">string</a></td><td></td><td><p> </p></td></tr><tr>- <td>value</td>+ <td>secret</td><td><a href="#string">string</a></td><td></td><td><p> </p></td>@@ -6079,7 +5794,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.DataClassificationSetting">DataClassificationSetting</h3><p></p>@@ -6090,10 +5805,10 @@ 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></td>- <td><p>The webhook to remove. Identified by its url. </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>@@ -6103,7 +5818,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.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3><p></p>@@ -6114,61 +5829,33 @@ 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>id</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Show deleted projects if specified. </p></td>+ <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td></tr><tr>- <td>filter</td>+ <td>title</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 "==" and ".matches()" operator.-- resource_id: the project id, support "==" and ".matches()" operator.-- exclude_default: if not include the default project, should be "true" or "false", support "==" operator.-- state: check the State enum for the values, support "==" operator.-- labels.{key}: the project label, support "==" and "in" operators.--For example:-name == "project name"-name.matches("project name")-resource_id == "project id"-resource_id.matches("project id")-exclude_default == true-state == "DELETED"-labels.environment == "production"-labels.tier == "critical"-labels.environment in ["staging", "prod"]-You can combine filter conditions like:-name == "project name" && resource_id.matches("project id")-name.matches("project name") || resource_id == "project id"-labels.environment == "production" && labels.tier == "critical" </p></td>+ <td><p> </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.-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>+ <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>page_token</td>- <td><a href="#string">string</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>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]+-[0-9]+-[0-9]+ format. </p></td></tr></tbody>@@ -6178,7 +5865,7 @@ the call that provided the page token. </p></td>- <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3><p></p>@@ -6189,18 +5876,17 @@ the call that provided the page token. </p></td><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>+ <td>key</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr><tr>- <td>next_page_token</td>- <td><a href="#string">string</a></td>+ <td>value</td>+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</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>@@ -6210,7 +5896,7 @@ If this field is omitted, there are no subsequent pages. </p></td>- <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3><p></p>@@ -6221,18 +5907,31 @@ If this field is omitted, there are no subsequent pages. </p></td><tbody><tr>- <td>project</td>+ <td>id</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>+ <td><p>id is the classification id in [0-9]+-[0-9]+-[0-9]+ format. </p></td></tr><tr>- <td>webhook</td>- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>+ <td>title</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The webhook to test. Identified by its url. </p></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>description</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>level_id</td>+ <td><a href="#string">string</a></td>+ <td>optional</td>+ <td><p> </p></td></tr></tbody>@@ -6242,7 +5941,7 @@ Format: projects/{project} </p></td>- <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3><p></p>@@ -6253,10 +5952,24 @@ Format: projects/{project} </p></td><tbody><tr>- <td>error</td>+ <td>id</td><td><a href="#string">string</a></td><td></td>- <td><p>The result of the test, empty if the test is successful. </p></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>description</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -6266,7 +5979,7 @@ Format: projects/{project} </p></td>- <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>+ <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3><p></p>@@ -6277,11 +5990,10 @@ Format: projects/{project} </p></td><tbody><tr>- <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>environments</td>+ <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>+ <td>repeated</td>+ <td><p> </p></td></tr></tbody>@@ -6291,7 +6003,7 @@ Format: projects/{project} </p></td>- <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>+ <h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3><p></p>@@ -6302,28 +6014,42 @@ Format: projects/{project} </p></td><tbody><tr>- <td>project</td>- <td><a href="#bytebase.v1.Project">Project</a></td>+ <td>name</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The project to update.--The project's `name` field is used to identify the project to update.-Format: projects/{project} </p></td>+ <td><p>The resource name of the environment.+Format: environments/{environment}.+Output only. </p></td></tr><tr>- <td>update_mask</td>- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>+ <td>id</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The list of fields to update. </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>allow_missing</td>- <td><a href="#bool">bool</a></td>+ <td>title</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 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><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -6333,7 +6059,7 @@ In this situation, `update_mask` is ignored. </p></td>- <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3>+ <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3><p></p>@@ -6344,25 +6070,17 @@ In this situation, `update_mask` is ignored. </p></td><tbody><tr>- <td>webhook</td>- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>- <td></td>- <td><p>The webhook to modify. </p></td>- </tr>-- <tr>- <td>update_mask</td>- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>+ <td>key</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>allow_missing</td>- <td><a href="#bool">bool</a></td>+ <td>value</td>+ <td><a href="#string">string</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> </p></td></tr></tbody>@@ -6372,8 +6090,8 @@ In this situation, `update_mask` is ignored. </p></td>- <h3 id="bytebase.v1.Webhook">Webhook</h3>- <p></p>+ <h3 id="bytebase.v1.GetSettingRequest">GetSettingRequest</h3>+ <p>The request message for getting a setting.</p><table class="field-table">@@ -6386,57 +6104,7 @@ In this situation, `update_mask` is ignored. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>name is the name of the webhook, generated by the server.-format: projects/{project}/webhooks/{webhook} </p></td>- </tr>-- <tr>- <td>type</td>- <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>- <td></td>- <td><p>Webhook integration type.-type is the type of the webhook. </p></td>- </tr>-- <tr>- <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 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_CREATE-- ISSUE_COMMENT_CREATE-- ISSUE_FIELD_UPDATE-- ISSUE_STATUS_UPDATE-- ISSUE_APPROVAL_NOTIFY-- ISSUE_PIPELINE_STAGE_STATUS_UPDATE-- ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE-- NOTIFY_ISSUE_APPROVED-- NOTIFY_PIPELINE_ROLLOUT </p></td>+ <td><p>The resource name of the setting. </p></td></tr></tbody>@@ -6446,397 +6114,62 @@ It should not be empty, and should be a subset of the following:+ <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>+ <p>The response message for getting a setting.</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>NOTIFY_ISSUE_APPROVED</td>- <td>23</td>- <td><p>Notifications via webhooks.++ <table class="field-table">+ <thead>+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>+ </thead>+ <tbody>++ <tr>+ <td>setting</td>+ <td><a href="#bytebase.v1.Setting">Setting</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ </tbody>+ </table>-NOTIFY_ISSUE_APPROVED represents the issue approved notification.</p></td>- </tr>-- <tr>- <td>NOTIFY_PIPELINE_ROLLOUT</td>- <td>24</td>- <td><p>NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification.</p></td>- </tr>-- <tr>- <td>ISSUE_CREATE</td>- <td>1</td>- <td><p>Issue related activity types.+-ISSUE_CREATE represents creating an issue.</p></td>- </tr>-- <tr>- <td>ISSUE_COMMENT_CREATE</td>- <td>2</td>- <td><p>ISSUE_COMMENT_CREATE represents commenting on an issue.</p></td>- </tr>-- <tr>- <td>ISSUE_FIELD_UPDATE</td>- <td>3</td>- <td><p>ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc.</p></td>- </tr>-- <tr>- <td>ISSUE_STATUS_UPDATE</td>- <td>4</td>- <td><p>ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now.</p></td>- </tr>-- <tr>- <td>ISSUE_APPROVAL_NOTIFY</td>- <td>21</td>- <td><p>ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval.</p></td>- </tr>-- <tr>- <td>ISSUE_PIPELINE_STAGE_STATUS_UPDATE</td>- <td>5</td>- <td><p>ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now.</p></td>- </tr>-- <tr>- <td>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE</td>- <td>22</td>- <td><p>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED.</p></td>- </tr>-- </tbody>- </table>++ <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</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>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 "bb.projects.get" permission on the workspace or the project owner can access this method.-Permissions required: bb.projects.get</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>- </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>- </tr>-- <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>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's properties.-Permissions required: bb.projects.update</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>- </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>- </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>- </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>- </tr>-- <tr>- <td>BatchGetIamPolicy</td>- <td><a href="#bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</a></td>- <td><a href="#bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</a></td>- <td><p>Deprecated. No permission check implemented.-Permissions required: None</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>- </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>- </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>- </table>+ <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</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>GetProject</td>- <td>GET</td>- <td>/v1/{name=projects/*}</td>- <td></td>- </tr>--+ <tr>+ <td>settings</td>+ <td><a href="#bytebase.v1.Setting">Setting</a></td>+ <td>repeated</td>+ <td><p>The settings from the specified request. </p></td>+ </tr>- <tr>- <td>ListProjects</td>- <td>GET</td>- <td>/v1/projects</td>- <td></td>- </tr>----- <tr>- <td>SearchProjects</td>- <td>POST</td>- <td>/v1/projects:search</td>- <td>*</td>- </tr>----- <tr>- <td>CreateProject</td>- <td>POST</td>- <td>/v1/projects</td>- <td>project</td>- </tr>----- <tr>- <td>UpdateProject</td>- <td>PATCH</td>- <td>/v1/{project.name=projects/*}</td>- <td>project</td>- </tr>----- <tr>- <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/{resource=projects/*}:getIamPolicy</td>- <td></td>- </tr>----- <tr>- <td>BatchGetIamPolicy</td>- <td>GET</td>- <td>/v1/{scope=*/*}/iamPolicies:batchGet</td>- <td></td>- </tr>----- <tr>- <td>SetIamPolicy</td>- <td>POST</td>- <td>/v1/{resource=projects/*}:setIamPolicy</td>- <td>*</td>- </tr>----- <tr>- <td>AddWebhook</td>- <td>POST</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>--</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>+ <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3><p></p>@@ -6847,44 +6180,9 @@ Permissions required: bb.projects.update</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></td>- <td><p> </p></td>- </tr>-- <tr>- <td>api_key</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>model</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>version</td>- <td><a href="#string">string</a></td>- <td></td>+ <td>types</td>+ <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>+ <td>repeated</td><td><p> </p></td></tr>@@ -6895,7 +6193,7 @@ Permissions required: bb.projects.update</p></td>- <h3 id="bytebase.v1.Algorithm">Algorithm</h3>+ <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3><p></p>@@ -6906,33 +6204,40 @@ Permissions required: bb.projects.update</p></td><tbody><tr>- <td>full_mask</td>- <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>+ <td>id</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>id is the uuid for semantic type. </p></td></tr><tr>- <td>range_mask</td>- <td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td>+ <td>title</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>the title of the semantic type, it should not be empty. </p></td></tr><tr>- <td>md5_mask</td>- <td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td>+ <td>description</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>the description of the semantic type, it can be empty. </p></td></tr><tr>- <td>inner_outer_mask</td>- <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td>+ <td>algorithm</td>+ <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td><td></td><td><p> </p></td></tr>+ <tr>+ <td>icon</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>+ </tr>+</tbody></table>@@ -6940,8 +6245,8 @@ Permissions required: bb.projects.update</p></td>- <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>- <p></p>+ <h3 id="bytebase.v1.Setting">Setting</h3>+ <p>The schema of setting.</p><table class="field-table">@@ -6951,11 +6256,19 @@ Permissions required: bb.projects.update</p></td><tbody><tr>- <td>substitution</td>+ <td>name</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><p>The resource name of the setting.+Format: settings/{setting}+Example: "settings/SEMANTIC_TYPES" </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></tr></tbody>@@ -6965,8 +6278,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.SettingValue">SettingValue</h3>+ <p>The data in setting value.</p><table class="field-table">@@ -6976,118 +6289,52 @@ max length of the string is 16 bytes. </p></td><tbody><tr>- <td>prefix_len</td>- <td><a href="#int32">int32</a></td>+ <td>app_im</td>+ <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td><td></td><td><p> </p></td></tr><tr>- <td>suffix_len</td>- <td><a href="#int32">int32</a></td>+ <td>workspace_profile</td>+ <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</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>workspace_approval</td>+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td><td></td><td><p> </p></td></tr><tr>- <td>substitution</td>- <td><a href="#string">string</a></td>+ <td>data_classification</td>+ <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td><td></td><td><p> </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</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>salt</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td>- </tr>-- </tbody>- </table>------ <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</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>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>- </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>start</td>- <td><a href="#int32">int32</a></td>+ <td>semantic_type</td>+ <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td><td></td>- <td><p>start is the start index of the original value, start from 0 and should be less than stop. </p></td>+ <td><p> </p></td></tr><tr>- <td>end</td>- <td><a href="#int32">int32</a></td>+ <td>ai</td>+ <td><a href="#bytebase.v1.AISetting">AISetting</a></td><td></td>- <td><p>stop is the stop index of the original value, should be less than the length of the original value. </p></td>+ <td><p> </p></td></tr><tr>- <td>substitution</td>- <td><a href="#string">string</a></td>+ <td>environment</td>+ <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td><td></td>- <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>+ <td><p> </p></td></tr></tbody>@@ -7097,8 +6344,8 @@ But frontend can be started with a single rule easily. </p></td>- <h3 id="bytebase.v1.Announcement">Announcement</h3>- <p></p>+ <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>+ <p>The request message for updating or creating a setting.</p><table class="field-table">@@ -7108,24 +6355,32 @@ But frontend can be started with a single rule easily. </p></td><tbody><tr>- <td>level</td>- <td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td>+ <td>setting</td>+ <td><a href="#bytebase.v1.Setting">Setting</a></td><td></td>- <td><p>The alert level of announcement </p></td>+ <td><p>The setting to update. </p></td></tr><tr>- <td>text</td>- <td><a href="#string">string</a></td>+ <td>validate_only</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>The text of announcement </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>link</td>- <td><a href="#string">string</a></td>+ <td>allow_missing</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>The optional link, user can follow the link to check extra details </p></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>@@ -7135,7 +6390,7 @@ But frontend can be started with a single rule easily. </p></td>- <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>+ <h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3><p></p>@@ -7146,8 +6401,8 @@ But frontend can be started with a single rule easily. </p></td><tbody><tr>- <td>settings</td>- <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td>+ <td>rules</td>+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td><td>repeated</td><td><p> </p></td></tr>@@ -7159,7 +6414,7 @@ But frontend can be started with a single rule easily. </p></td>- <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>+ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3><p></p>@@ -7170,22 +6425,48 @@ But frontend can be started with a single rule easily. </p></td><tbody><tr>- <td>client_id</td>- <td><a href="#string">string</a></td>+ <td>template</td>+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td><td></td><td><p> </p></td></tr><tr>- <td>client_secret</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 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 "==", "!=", "<", "<=", ">", ">=" operations.+statement.table_rows: table row count number, support "==", "!=", "<", "<=", ">", ">=" operations.+resource.environment_id: the environment resource id, support "==", "!=", "in [xx]", "!(in [xx])" operations.+resource.project_id: the project resource id, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.+resource.db_engine: the database engine type, support "==", "!=", "in [xx]", "!(in [xx])" operations. Check the Engine enum for values.+statement.sql_type: the SQL type, support "==", "!=", "in [xx]", "!(in [xx])" operations.+resource.database_name: the database name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.+resource.schema_name: the schema name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.+resource.table_name: the table name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.+statement.text: the SQL statement, support "contains()", "matches()", "startsWith()", "endsWith()" operations.+request.expiration_days: the role expiration days for the request, support "==", "!=", "<", "<=", ">", ">=" operations.+request.role: the request role full name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" 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 == "prod" && statement.affected_rows >= 100+resource.table_name.matches("sensitive_.*") && resource.db_engine == "MYSQL" </p></td></tr><tr>- <td>robot_code</td>- <td><a href="#string">string</a></td>+ <td>source</td>+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td><td></td><td><p> </p></td></tr>@@ -7197,7 +6478,7 @@ But frontend can be started with a single rule easily. </p></td>- <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>+ <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3><p></p>@@ -7208,176 +6489,124 @@ But frontend can be started with a single rule easily. </p></td><tbody><tr>- <td>app_id</td>+ <td>external_url</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The external URL is used for sso authentication callback. </p></td></tr><tr>- <td>app_secret</td>- <td><a href="#string">string</a></td>+ <td>disallow_signup</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Disallow self-service signup, users can only be invited by the owner. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</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>require_2fa</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Require 2FA for all users. </p></td>+ </tr><tr>- <td>type</td>- <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>+ <td>token_duration</td>+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p> </p></td>+ <td><p>The duration for token. </p></td></tr><tr>- <td>slack</td>- <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td>+ <td>announcement</td>+ <td><a href="#bytebase.v1.Announcement">Announcement</a></td><td></td>- <td><p> </p></td>+ <td><p>The setting of custom announcement </p></td></tr><tr>- <td>feishu</td>- <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>+ <td>maximum_role_expiration</td>+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p> </p></td>+ <td><p>The max duration for role expired. </p></td></tr><tr>- <td>wecom</td>- <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>+ <td>domains</td>+ <td><a href="#string">string</a></td>+ <td>repeated</td>+ <td><p>The workspace domain, e.g., bytebase.com. </p></td>+ </tr>++ <tr>+ <td>enforce_identity_domain</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Only user and group from the domains can be created and login. </p></td></tr><tr>- <td>lark</td>- <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>+ <td>database_change_mode</td>+ <td><a href="#bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</a></td><td></td>- <td><p> </p></td>+ <td><p>The workspace database change mode. </p></td></tr><tr>- <td>dingtalk</td>- <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>+ <td>disallow_password_signin</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to disallow password signin. (Except workspace admins) </p></td></tr><tr>- <td>teams</td>- <td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td>+ <td>enable_metric_collection</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to enable metric collection for the workspace. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</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>app_id</td>- <td><a href="#string">string</a></td>+ <td>inactive_session_timeout</td>+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p> </p></td>+ <td><p>The session expiration time if not activity detected for the user. Value <= 0 means no limit. </p></td></tr><tr>- <td>app_secret</td>- <td><a href="#string">string</a></td>+ <td>enable_audit_log_stdout</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to enable audit logging to stdout in structured JSON format.+Requires TEAM or ENTERPRISE license. </p></td></tr>- </tbody>- </table>------ <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>watermark</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to display watermark on pages.+Requires ENTERPRISE license. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</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>directory_sync_token</td><td><a href="#string">string</a></td><td></td>- <td><p>Azure AD tenant ID (Directory ID). </p></td>+ <td><p>The token for directory sync authentication. </p></td></tr><tr>- <td>client_id</td>+ <td>branding_logo</td><td><a href="#string">string</a></td><td></td>- <td><p>Azure AD application (client) ID. </p></td>+ <td><p>The branding logo as a data URI (e.g. data:image/png;base64,...). </p></td></tr><tr>- <td>client_secret</td>- <td><a href="#string">string</a></td>+ <td>password_restriction</td>+ <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td><td></td>- <td><p>Azure AD client secret. </p></td>+ <td><p>Password restriction settings. </p></td></tr></tbody>@@ -7387,7 +6616,7 @@ But frontend can be started with a single rule easily. </p></td>- <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>+ <h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3><p></p>@@ -7398,126 +6627,52 @@ But frontend can be started with a single rule easily. </p></td><tbody><tr>- <td>corp_id</td>- <td><a href="#string">string</a></td>+ <td>min_length</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>min_length is the minimum length for password, should no less than 8. </p></td></tr><tr>- <td>agent_id</td>- <td><a href="#string">string</a></td>+ <td>require_number</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>require_number requires the password must contains at least one number. </p></td></tr><tr>- <td>secret</td>- <td><a href="#string">string</a></td>+ <td>require_letter</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>- </tr>-- </tbody>- </table>------ <h3 id="bytebase.v1.DataClassificationSetting">DataClassificationSetting</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>configs</td>- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td>- <td>repeated</td>- <td><p> </p></td>+ <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</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>id</td>- <td><a href="#string">string</a></td>+ <td>require_uppercase_letter</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td>+ <td><p>require_uppercase_letter requires the password must contains at least one upper case letter. </p></td></tr><tr>- <td>title</td>- <td><a href="#string">string</a></td>+ <td>require_special_character</td>+ <td><a href="#bool">bool</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]+-[0-9]+-[0-9]+ format. </p></td>+ <td><p>require_special_character requires the password must contains at least one special character. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</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>require_reset_password_for_first_login</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td></tr><tr>- <td>value</td>- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>+ <td>password_rotation</td>+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p> </p></td>+ <td><p>password_rotation requires users to reset their password after the duration. </p></td></tr></tbody>@@ -7527,204 +6682,343 @@ The id should in [0-9]+-[0-9]+-[0-9]+ format. </p></td>- <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>id</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>id is the classification id in [0-9]+-[0-9]+-[0-9]+ format. </p></td>- </tr>-- <tr>- <td>title</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>description</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>level_id</td>- <td><a href="#string">string</a></td>- <td>optional</td>- <td><p> </p></td>- </tr>-- </tbody>- </table>---- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3>+ <h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</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>id</td>- <td><a href="#string">string</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>description</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>PROVIDER_UNSPECIFIED</td>+ <td>0</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>OPEN_AI</td>+ <td>1</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>CLAUDE</td>+ <td>2</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>GEMINI</td>+ <td>3</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>AZURE_OPENAI</td>+ <td>4</td>+ <td><p></p></td>+ </tr>++ </tbody>+ </table>- <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>+ <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</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>environments</td>- <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>- <td>repeated</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>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.EnvironmentSetting.Environment">EnvironmentSetting.Environment</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 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><a href="#string">string</a></td>- <td></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.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>+ <h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</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>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.GetSettingRequest">GetSettingRequest</h3>- <p>The request message for getting a setting.</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>+ </thead>+ <tbody>++ <tr>+ <td>SETTING_NAME_UNSPECIFIED</td>+ <td>0</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>WORKSPACE_PROFILE</td>+ <td>4</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>WORKSPACE_APPROVAL</td>+ <td>5</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>APP_IM</td>+ <td>8</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>AI</td>+ <td>10</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>DATA_CLASSIFICATION</td>+ <td>14</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>SEMANTIC_TYPES</td>+ <td>15</td>+ <td><p></p></td>+ </tr>++ <tr>+ <td>ENVIRONMENT</td>+ <td>19</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>+ </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>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>+ </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>+ </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>ListSettings</td>+ <td>GET</td>+ <td>/v1/settings</td>+ <td></td>+ </tr>+++++ <tr>+ <td>GetSetting</td>+ <td>GET</td>+ <td>/v1/{name=settings/*}</td>+ <td></td>+ </tr>+++++ <tr>+ <td>UpdateSetting</td>+ <td>PATCH</td>+ <td>/v1/{setting.name=settings/*}</td>+ <td>setting</td>+ </tr>+++ </tbody>+ </table>+++++ <div class="file-heading">+ <h2 id="v1/user_service.proto">v1/user_service.proto</h2><a href="#title">Top</a>+ </div>+ <p></p>+++ <h3 id="bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</h3>+ <p></p>++<table class="field-table"><thead><tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>@@ -7732,10 +7026,11 @@ are /[a-z][0-9]-/. </p></td><tbody><tr>- <td>name</td>+ <td>names</td><td><a href="#string">string</a></td>- <td></td>- <td><p>The resource name of the setting. </p></td>+ <td>repeated</td>+ <td><p>The user names to retrieve.+Format: users/{user uid or user email} </p></td></tr></tbody>@@ -7745,8 +7040,8 @@ are /[a-z][0-9]-/. </p></td>- <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>- <p>The response message for getting a setting.</p>+ <h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</h3>+ <p></p><table class="field-table">@@ -7756,10 +7051,10 @@ are /[a-z][0-9]-/. </p></td><tbody><tr>- <td>setting</td>- <td><a href="#bytebase.v1.Setting">Setting</a></td>- <td></td>- <td><p> </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>@@ -7769,14 +7064,7 @@ are /[a-z][0-9]-/. </p></td>- <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3>- <p></p>------ <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3>+ <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</h3><p></p>@@ -7787,10 +7075,10 @@ are /[a-z][0-9]-/. </p></td><tbody><tr>- <td>settings</td>- <td><a href="#bytebase.v1.Setting">Setting</a></td>- <td>repeated</td>- <td><p>The settings from the specified request. </p></td>+ <td>user</td>+ <td><a href="#bytebase.v1.User">User</a></td>+ <td></td>+ <td><p>The user to create. </p></td></tr></tbody>@@ -7800,7 +7088,7 @@ are /[a-z][0-9]-/. </p></td>- <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>+ <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3><p></p>@@ -7811,10 +7099,11 @@ are /[a-z][0-9]-/. </p></td><tbody><tr>- <td>types</td>- <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</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 of the user to delete.+Format: users/{user} </p></td></tr></tbody>@@ -7824,7 +7113,7 @@ are /[a-z][0-9]-/. </p></td>- <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>+ <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3><p></p>@@ -7835,38 +7124,85 @@ 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>id is the uuid for semantic type. </p></td>+ <td><p>The name of the user to retrieve.+Format: users/{user uid or user email} </p></td></tr>- <tr>- <td>title</td>- <td><a href="#string">string</a></td>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.ListUsersRequest">ListUsersRequest</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_size</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>the title of the semantic type, it should not be empty. </p></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>description</td>+ <td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>the description of the semantic type, it can be empty. </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>algorithm</td>- <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>+ <td>show_deleted</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Show deleted users if specified. </p></td></tr><tr>- <td>icon</td>+ <td>filter</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><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 "==" and ".matches()" operator.+- email: the user email, support "==" and ".matches()" operator.+- user_type: the type, check UserType enum for values, support "==", "in [xx]", "!(in [xx])" operator.+- state: check State enum for values, support "==" operator.+- project: the project full name in "projects/{id}" format, support "==" operator.++For example:+name == "ed"+name.matches("ed")+email == "[email protected]"+email.matches("ed")+user_type == "SERVICE_ACCOUNT"+user_type in ["SERVICE_ACCOUNT", "USER"]+!(user_type in ["SERVICE_ACCOUNT", "USER"])+state == "DELETED"+project == "projects/sample-project"+You can combine filter conditions like:+name.matches("ed") && project == "projects/sample-project"+(name == "ed" || email == "[email protected]") && project == "projects/sample-project" </p></td></tr></tbody>@@ -7876,8 +7212,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.ListUsersResponse">ListUsersResponse</h3>+ <p></p><table class="field-table">@@ -7887,19 +7223,18 @@ 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: "settings/SEMANTIC_TYPES" </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><tr>- <td>value</td>- <td><a href="#bytebase.v1.SettingValue">SettingValue</a></td>+ <td>next_page_token</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The configuration value of the setting. </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>@@ -7909,8 +7244,8 @@ Example: "settings/SEMANTIC_TYPES" </p></td>- <h3 id="bytebase.v1.SettingValue">SettingValue</h3>- <p>The data in setting value.</p>+ <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>+ <p></p><table class="field-table">@@ -7920,52 +7255,75 @@ Example: "settings/SEMANTIC_TYPES" </p></td><tbody><tr>- <td>app_im</td>- <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</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 user.+Format: users/{user} </p></td></tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</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>workspace_profile</td>- <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>+ <td>user</td>+ <td><a href="#bytebase.v1.User">User</a></td><td></td>- <td><p> </p></td>+ <td><p>The user to update.++The user's `name` field is used to identify the user to update.+Format: users/{user} </p></td></tr><tr>- <td>workspace_approval</td>- <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</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>data_classification</td>- <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td>- <td></td>- <td><p> </p></td>+ <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's identity by MFA. </p></td></tr><tr>- <td>semantic_type</td>- <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>+ <td>regenerate_temp_mfa_secret</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </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>ai</td>- <td><a href="#bytebase.v1.AISetting">AISetting</a></td>+ <td>regenerate_recovery_codes</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td></tr><tr>- <td>environment</td>- <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>+ <td>allow_missing</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </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>@@ -7975,8 +7333,8 @@ Example: "settings/SEMANTIC_TYPES" </p></td>- <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>- <p>The request message for updating or creating a setting.</p>+ <h3 id="bytebase.v1.User">User</h3>+ <p></p><table class="field-table">@@ -7986,258 +7344,104 @@ Example: "settings/SEMANTIC_TYPES" </p></td><tbody><tr>- <td>setting</td>- <td><a href="#bytebase.v1.Setting">Setting</a></td>+ <td>name</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The setting to update. </p></td>+ <td><p>The name of the user.+Format: users/{user}. {user} is a system-generated unique ID. </p></td></tr><tr>- <td>validate_only</td>- <td><a href="#bool">bool</a></td>+ <td>state</td>+ <td><a href="#bytebase.v1.State">State</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>+ <td><p>The lifecycle state of the user account. </p></td></tr><tr>- <td>allow_missing</td>- <td><a href="#bool">bool</a></td>+ <td>email</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The email address of the user, used for login and notifications. </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> </p></td>+ <td><p>The display title or full name of the user. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</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>user_type</td>+ <td><a href="#bytebase.v1.UserType">UserType</a></td>+ <td></td>+ <td><p>The type of user account. </p></td>+ </tr><tr>- <td>rules</td>- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td>- <td>repeated</td>- <td><p> </p></td>+ <td>password</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></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</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><a href="#string">string</a></td>+ <td></td>+ <td><p>The service key for service account authentication. Only used for service accounts. </p></td>+ </tr><tr>- <td>template</td>- <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</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>condition</td>- <td><a href="#google.type.Expr">google.type.Expr</a></td>+ <td>temp_otp_secret</td>+ <td><a href="#string">string</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 "==", "!=", "<", "<=", ">", ">=" operations.-statement.table_rows: table row count number, support "==", "!=", "<", "<=", ">", ">=" operations.-resource.environment_id: the environment resource id, support "==", "!=", "in [xx]", "!(in [xx])" operations.-resource.project_id: the project resource id, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.-resource.db_engine: the database engine type, support "==", "!=", "in [xx]", "!(in [xx])" operations. Check the Engine enum for values.-statement.sql_type: the SQL type, support "==", "!=", "in [xx]", "!(in [xx])" operations.-resource.database_name: the database name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.-resource.schema_name: the schema name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.-resource.table_name: the table name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" operations.-statement.text: the SQL statement, support "contains()", "matches()", "startsWith()", "endsWith()" operations.-request.expiration_days: the role expiration days for the request, support "==", "!=", "<", "<=", ">", ">=" operations.-request.role: the request role full name, support "==", "!=", "in [xx]", "!(in [xx])", "contains()", "matches()", "startsWith()", "endsWith()" 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 == "prod" && statement.affected_rows >= 100-resource.table_name.matches("sensitive_.*") && resource.db_engine == "MYSQL" </p></td>- </tr>-- <tr>- <td>source</td>- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>- <td></td>- <td><p> </p></td>- </tr>-- </tbody>- </table>------ <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</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>external_url</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The external URL is used for sso authentication callback. </p></td>- </tr>-- <tr>- <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>token_duration</td>- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>- <td></td>- <td><p>The duration for token. </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>+ <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td></tr><tr>- <td>domains</td>+ <td>temp_recovery_codes</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p>The workspace domain, e.g., bytebase.com. </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>-- <tr>- <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 <= 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>+ <td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td></tr><tr>- <td>watermark</td>- <td><a href="#bool">bool</a></td>+ <td>temp_otp_secret_created_time</td>+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p>Whether to display watermark on pages.-Requires ENTERPRISE license. </p></td>+ <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td></tr><tr>- <td>directory_sync_token</td>+ <td>phone</td><td><a href="#string">string</a></td><td></td>- <td><p>The token for directory sync authentication. </p></td>+ <td><p>Should be a valid E.164 compliant phone number.+Could be empty. </p></td></tr><tr>- <td>branding_logo</td>- <td><a href="#string">string</a></td>+ <td>profile</td>+ <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td><td></td>- <td><p>The branding logo as a data URI (e.g. data:image/png;base64,...). </p></td>+ <td><p>User profile metadata. </p></td></tr><tr>- <td>password_restriction</td>- <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>- <td></td>- <td><p>Password restriction settings. </p></td>+ <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></tr></tbody>@@ -8247,7 +7451,7 @@ Requires ENTERPRISE license. </p></td>- <h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3>+ <h3 id="bytebase.v1.User.Profile">User.Profile</h3><p></p>@@ -8258,52 +7462,24 @@ 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>- </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>-- <tr>- <td>require_special_character</td>- <td><a href="#bool">bool</a></td>+ <td>last_login_time</td>+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p>require_special_character requires the password must contains at least one special character. </p></td>+ <td><p>The last time the user successfully logged in. </p></td></tr><tr>- <td>require_reset_password_for_first_login</td>- <td><a href="#bool">bool</a></td>+ <td>last_change_password_time</td>+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td>+ <td><p>The last time the user changed their password. </p></td></tr><tr>- <td>password_rotation</td>- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>+ <td>source</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>password_rotation requires users to reset their password after the duration. </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>@@ -8315,7 +7491,7 @@ Requires ENTERPRISE license. </p></td>- <h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</h3>+ <h3 id="bytebase.v1.UserType">UserType</h3><p></p><table class="enum-table"><thead>@@ -8324,266 +7500,109 @@ Requires ENTERPRISE license. </p></td><tbody><tr>- <td>PROVIDER_UNSPECIFIED</td>+ <td>USER_TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified user type.</p></td></tr><tr>- <td>OPEN_AI</td>+ <td>USER</td><td>1</td>- <td><p></p></td>+ <td><p>Regular human user account.</p></td></tr><tr>- <td>CLAUDE</td>+ <td>SYSTEM_BOT</td><td>2</td>- <td><p></p></td>+ <td><p>System-managed bot account for automated operations.</p></td></tr><tr>- <td>GEMINI</td>+ <td>SERVICE_ACCOUNT</td><td>3</td>- <td><p></p></td>- </tr>-- <tr>- <td>AZURE_OPENAI</td>- <td>4</td>- <td><p></p></td>+ <td><p>Service account for API integrations.</p></td></tr></tbody></table>- <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</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>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>MASK_TYPE_UNSPECIFIED</td>- <td>0</td>- <td><p></p></td>+ <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>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>4</td>- <td><p></p></td>- </tr>-- <tr>- <td>WORKSPACE_APPROVAL</td>- <td>5</td>- <td><p></p></td>- </tr>-- <tr>- <td>APP_IM</td>- <td>8</td>- <td><p></p></td>- </tr>-- <tr>- <td>AI</td>- <td>10</td>- <td><p></p></td>- </tr>-- <tr>- <td>DATA_CLASSIFICATION</td>- <td>14</td>- <td><p></p></td>- </tr>-- <tr>- <td>SEMANTIC_TYPES</td>- <td>15</td>- <td><p></p></td>- </tr>-- <tr>- <td>ENVIRONMENT</td>- <td>19</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>+ <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>CREATE_DATABASE</td>- <td>2</td>- <td><p></p></td>+ <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>EXPORT_DATA</td>- <td>3</td>- <td><p></p></td>+ <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>REQUEST_ROLE</td>- <td>4</td>- <td><p></p></td>+ <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>- </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>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>+ <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.+Permissions required: bb.users.update (or self)</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>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>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>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></tbody>@@ -8607,9 +7626,9 @@ Permissions required: bb.settings.set</p></td><tr>- <td>ListSettings</td>+ <td>GetUser</td><td>GET</td>- <td>/v1/settings</td>+ <td>/v1/{name=users/*}</td><td></td></tr>@@ -8617,9 +7636,9 @@ Permissions required: bb.settings.set</p></td><tr>- <td>GetSetting</td>+ <td>BatchGetUsers</td><td>GET</td>- <td>/v1/{name=settings/*}</td>+ <td>/v1/users:batchGet</td><td></td></tr>@@ -8627,76 +7646,77 @@ Permissions required: bb.settings.set</p></td><tr>- <td>UpdateSetting</td>- <td>PATCH</td>- <td>/v1/{setting.name=settings/*}</td>- <td>setting</td>+ <td>GetCurrentUser</td>+ <td>GET</td>+ <td>/v1/users/me</td>+ <td></td></tr>- </tbody>- </table>----- <div class="file-heading">- <h2 id="v1/user_service.proto">v1/user_service.proto</h2><a href="#title">Top</a>- </div>- <p></p>--- <h3 id="bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</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><a href="#string">string</a></td>- <td>repeated</td>- <td><p>The user names to retrieve.-Format: users/{user uid or user email} </p></td>- </tr>- </tbody>- </table>------ <h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</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>ListUsers</td>+ <td>GET</td>+ <td>/v1/users</td>+ <td></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>- </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>++</tbody></table>--+- <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</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">@@ -8706,373 +7726,202 @@ Format: users/{user uid or user email} </p></td><tbody><tr>- <td>user</td>- <td><a href="#bytebase.v1.User">User</a></td>+ <td>version</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The user to create. </p></td>+ <td><p>The Bytebase server version. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</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>git_commit</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of the user to delete.-Format: users/{user} </p></td>+ <td><p>The git commit hash of the build. </p></td></tr>- </tbody>- </table>------ <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>readonly</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>The name of the user to retrieve.-Format: users/{user uid or user email} </p></td>+ <td><p>Whether the Bytebase instance is running in read-only mode. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.ListUsersRequest">ListUsersRequest</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>saas</td>+ <td><a href="#bool">bool</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>+ </tr><tr>- <td>page_size</td>- <td><a href="#int32">int32</a></td>+ <td>demo</td>+ <td><a href="#bool">bool</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>+ <td><p>Whether the Bytebase instance is running in demo mode. </p></td></tr><tr>- <td>page_token</td>+ <td>host</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>+ <td><p>The host address of the Bytebase instance. </p></td></tr><tr>- <td>show_deleted</td>- <td><a href="#bool">bool</a></td>+ <td>port</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Show deleted users if specified. </p></td>+ <td><p>The port number of the Bytebase instance. </p></td></tr><tr>- <td>filter</td>+ <td>external_url</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 "==" and ".matches()" operator.-- email: the user email, support "==" and ".matches()" operator.-- user_type: the type, check UserType enum for values, support "==", "in [xx]", "!(in [xx])" operator.-- state: check State enum for values, support "==" operator.-- project: the project full name in "projects/{id}" format, support "==" operator.--For example:-name == "ed"-name.matches("ed")-email == "[email protected]"-email.matches("ed")-user_type == "SERVICE_ACCOUNT"-user_type in ["SERVICE_ACCOUNT", "USER"]-!(user_type in ["SERVICE_ACCOUNT", "USER"])-state == "DELETED"-project == "projects/sample-project"-You can combine filter conditions like:-name.matches("ed") && project == "projects/sample-project"-(name == "ed" || email == "[email protected]") && project == "projects/sample-project" </p></td>+ <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</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>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>need_admin_setup</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether the Bytebase instance requires initial admin setup. </p></td></tr><tr>- <td>next_page_token</td>- <td><a href="#string">string</a></td>+ <td>disallow_signup</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>- </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></td>- <td><p>The name of the deleted user.-Format: users/{user} </p></td>- </tr>-- </tbody>- </table>------ <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</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>user</td>- <td><a href="#bytebase.v1.User">User</a></td>- <td></td>- <td><p>The user to update.--The user's `name` field is used to identify the user to update.-Format: users/{user} </p></td>+ <td><p>Whether self-service user signup is disabled. </p></td></tr><tr>- <td>update_mask</td>- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>+ <td>last_active_time</td>+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</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's identity by MFA. </p></td>+ <td><p>The last time any API call was made, refreshed on each request. </p></td></tr><tr>- <td>regenerate_temp_mfa_secret</td>+ <td>require_2fa</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>+ <td><p>Whether two-factor authentication is required for all users. </p></td></tr><tr>- <td>regenerate_recovery_codes</td>- <td><a href="#bool">bool</a></td>+ <td>workspace_id</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>+ <td><p>The unique identifier for the workspace. </p></td></tr><tr>- <td>allow_missing</td>+ <td>debug</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>Whether debug mode is enabled. </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.User">User</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>unlicensed_features</td><td><a href="#string">string</a></td>- <td></td>- <td><p>The name of the user.-Format: users/{user}. {user} is a system-generated unique ID. </p></td>+ <td>repeated</td>+ <td><p>List of features that are not licensed. </p></td></tr><tr>- <td>state</td>- <td><a href="#bytebase.v1.State">State</a></td>+ <td>disallow_password_signin</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>The lifecycle state of the user account. </p></td>+ <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td></tr><tr>- <td>email</td>- <td><a href="#string">string</a></td>+ <td>password_restriction</td>+ <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td><td></td>- <td><p>The email address of the user, used for login and notifications. </p></td>+ <td><p>Password complexity and restriction requirements. </p></td></tr><tr>- <td>title</td>- <td><a href="#string">string</a></td>+ <td>docker</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>The display title or full name of the user. </p></td>+ <td><p>Whether the Bytebase instance is running in Docker. </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>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>password</td>- <td><a href="#string">string</a></td>+ <td>activated_instance_count</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>The password for authentication. Only used during user creation or password updates. </p></td>+ <td><p>The number of activated database instances. </p></td></tr><tr>- <td>service_key</td>- <td><a href="#string">string</a></td>+ <td>total_instance_count</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>The service key for service account authentication. Only used for service accounts. </p></td>+ <td><p>The total number of database instances. </p></td></tr><tr>- <td>mfa_enabled</td>+ <td>enable_sample</td><td><a href="#bool">bool</a></td><td></td>- <td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td>+ <td><p>Whether sample data setup is enabled. </p></td></tr><tr>- <td>temp_otp_secret</td>- <td><a href="#string">string</a></td>+ <td>external_url_from_flag</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td>+ <td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </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>- </tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>+ <p>User statistics by type and state.</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>user_type</td>+ <td><a href="#bytebase.v1.UserType">UserType</a></td><td></td>- <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td>+ <td><p>The type of user. </p></td></tr><tr>- <td>phone</td>- <td><a href="#string">string</a></td>+ <td>state</td>+ <td><a href="#bytebase.v1.State">State</a></td><td></td>- <td><p>Should be a valid E.164 compliant phone number.-Could be empty. </p></td>+ <td><p>The state of the user. </p></td></tr><tr>- <td>profile</td>- <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td>+ <td>count</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>User profile metadata. </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><p>The count of users matching this type and state. </p></td></tr></tbody>@@ -9082,8 +7931,29 @@ Format: groups/{email} </p></td>- <h3 id="bytebase.v1.User.Profile">User.Profile</h3>- <p></p>+ <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">@@ -9093,24 +7963,10 @@ 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>- </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>-- <tr>- <td>source</td>- <td><a href="#string">string</a></td>+ <td>logo</td>+ <td><a href="#bytes">bytes</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><p>The branding logo. </p></td></tr></tbody>@@ -9120,49 +7976,60 @@ Format: groups/{email} </p></td>+ <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>+ <p>Request message for setting up sample data.</p>+++- <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>-- </tbody>- </table>+ <h3 id="bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</h3>+ <p>Request message for updating actuator 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>actuator</td>+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>+ <td></td>+ <td><p>The actuator 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 actuator is not found, a new actuator will be created.+In this situation, `update_mask` is ignored. </p></td>+ </tr>++ </tbody>+ </table>++++- <h3 id="bytebase.v1.UserService">UserService</h3>- <p>UserService manages user accounts and authentication.</p>+++ <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>@@ -9170,70 +8037,43 @@ Format: groups/{email} </p></td><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.+ <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>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>+ <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>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.-Permissions required: bb.users.update (or self)</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>DeleteUser</td>- <td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></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>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>+ <td><p>Clears the system cache to force data refresh.+Permissions required: None</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>+ <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>@@ -9257,29 +8097,9 @@ Permissions required: bb.users.undelete</p></td><tr>- <td>GetUser</td>- <td>GET</td>- <td>/v1/{name=users/*}</td>- <td></td>- </tr>----- <tr>- <td>BatchGetUsers</td>- <td>GET</td>- <td>/v1/users:batchGet</td>- <td></td>- </tr>----- <tr>- <td>GetCurrentUser</td>+ <td>GetActuatorInfo</td><td>GET</td>- <td>/v1/users/me</td>+ <td>/v1/actuator/info</td><td></td></tr>@@ -9287,39 +8107,29 @@ Permissions required: bb.users.undelete</p></td><tr>- <td>ListUsers</td>- <td>GET</td>- <td>/v1/users</td>- <td></td>+ <td>UpdateActuatorInfo</td>+ <td>PATCH</td>+ <td>/v1/actuator/info</td>+ <td>actuator</td></tr><tr>- <td>CreateUser</td>+ <td>SetupSample</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>+ <td>/v1/actuator:setupSample</td>+ <td></td></tr><tr>- <td>DeleteUser</td>+ <td>DeleteCache</td><td>DELETE</td>- <td>/v1/{name=users/*}</td>+ <td>/v1/actuator/cache</td><td></td></tr>@@ -9327,10 +8137,10 @@ Permissions required: bb.users.undelete</p></td><tr>- <td>UndeleteUser</td>- <td>POST</td>- <td>/v1/{name=users/*}:undelete</td>- <td>*</td>+ <td>GetResourcePackage</td>+ <td>GET</td>+ <td>/v1/actuator/resources</td>+ <td></td></tr>@@ -9341,13 +8151,13 @@ Permissions required: bb.users.undelete</p></td><div class="file-heading">- <h2 id="v1/actuator_service.proto">v1/actuator_service.proto</h2><a href="#title">Top</a>+ <h2 id="v1/iam_policy.proto">v1/iam_policy.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>+ <h3 id="bytebase.v1.Binding">Binding</h3>+ <p>Binding associates members with a role and optional conditions.</p><table class="field-table">@@ -9357,164 +8167,120 @@ Permissions required: bb.users.undelete</p></td><tbody><tr>- <td>version</td>+ <td>role</td><td><a href="#string">string</a></td><td></td>- <td><p>The Bytebase server version. </p></td>+ <td><p>The role that is assigned to the members.+Format: roles/{role} </p></td></tr><tr>- <td>git_commit</td>+ <td>members</td><td><a href="#string">string</a></td>- <td></td>- <td><p>The git commit hash of the build. </p></td>- </tr>-- <tr>- <td>readonly</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Whether the Bytebase instance is running in read-only mode. </p></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>saas</td>- <td><a href="#bool">bool</a></td>+ <td>condition</td>+ <td><a href="#google.type.Expr">google.type.Expr</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 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 "instances/{instance}/databases/{database}" format, used by the "roles/sqlEditorUser" role, support "==" operator.+resource.schema_name: the schema name, used by the "roles/sqlEditorUser" role, support "==" operator.+resource.table_name: the table name, used by the "roles/sqlEditorUser" role, support "==" operator.+request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")`.++For example:+resource.database == "instances/local-pg/databases/postgres" && resource.schema_name in ["public","another_schema"]+resource.database == "instances/local-pg/databases/bytebase" && resource.schema_name == "public" && resource.table_name in ["audit_log"]+request.time < timestamp("2025-04-26T11:24:48.655Z") </p></td></tr><tr>- <td>demo</td>- <td><a href="#bool">bool</a></td>+ <td>parsed_expr</td>+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td><td></td>- <td><p>Whether the Bytebase instance is running in demo mode. </p></td>+ <td><p>The parsed expression of the condition. </p></td></tr>- <tr>- <td>host</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The host address of the Bytebase instance. </p></td>- </tr>-- <tr>- <td>port</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The port number of the Bytebase instance. </p></td>- </tr>-- <tr>- <td>external_url</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td>- </tr>-- <tr>- <td>need_admin_setup</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>- </tr>-- <tr>- <td>disallow_signup</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Whether self-service user signup is disabled. </p></td>- </tr>-- <tr>- <td>last_active_time</td>- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>- <td></td>- <td><p>The last time any API call was made, refreshed on each request. </p></td>- </tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.BindingDelta">BindingDelta</h3>+ <p>A single change to a binding.</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_2fa</td>- <td><a href="#bool">bool</a></td>+ <td>action</td>+ <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td><td></td>- <td><p>Whether two-factor authentication is required for all users. </p></td>+ <td><p>The action that was performed on a Binding. </p></td></tr><tr>- <td>workspace_id</td>+ <td>role</td><td><a href="#string">string</a></td><td></td>- <td><p>The unique identifier for the workspace. </p></td>- </tr>-- <tr>- <td>debug</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Whether debug mode is enabled. </p></td>+ <td><p>Role that is assigned to `members`.+For example, `roles/projectOwner`. </p></td></tr><tr>- <td>unlicensed_features</td>+ <td>member</td><td><a href="#string">string</a></td>- <td>repeated</td>- <td><p>List of features that are not licensed. </p></td>- </tr>-- <tr>- <td>disallow_password_signin</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td>- </tr>-- <tr>- <td>password_restriction</td>- <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>- <td></td>- <td><p>Password complexity and restriction requirements. </p></td>- </tr>-- <tr>- <td>docker</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>Whether the Bytebase instance is running in Docker. </p></td>- </tr>-- <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>+ <td><p>Follows the same format of Binding.members. </p></td></tr><tr>- <td>total_instance_count</td>- <td><a href="#int32">int32</a></td>+ <td>condition</td>+ <td><a href="#google.type.Expr">google.type.Expr</a></td><td></td>- <td><p>The total number of database instances. </p></td>+ <td><p>The condition that is associated with this binding. </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>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3>+ <p>Request message for getting 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>external_url_from_flag</td>- <td><a href="#bool">bool</a></td>+ <td>resource</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>The name of the resource to get the IAM policy.+Format: projects/{project}+Format: workspaces/{workspace} </p></td></tr></tbody>@@ -9524,8 +8290,8 @@ Permissions required: bb.users.undelete</p></td>- <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>- <p>User statistics by type and state.</p>+ <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>+ <p>IAM policy that binds members to roles.</p><table class="field-table">@@ -9535,24 +8301,20 @@ Permissions required: bb.users.undelete</p></td><tbody><tr>- <td>user_type</td>- <td><a href="#bytebase.v1.UserType">UserType</a></td>- <td></td>- <td><p>The type of user. </p></td>- </tr>-- <tr>- <td>state</td>- <td><a href="#bytebase.v1.State">State</a></td>- <td></td>- <td><p>The state of the user. </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>count</td>- <td><a href="#int32">int32</a></td>+ <td>etag</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>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>@@ -9562,29 +8324,8 @@ Permissions required: bb.users.undelete</p></td>- <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>+ <h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>+ <p>Describes changes between two IAM policies.</p><table class="field-table">@@ -9594,10 +8335,10 @@ Permissions required: bb.users.undelete</p></td><tbody><tr>- <td>logo</td>- <td><a href="#bytes">bytes</a></td>- <td></td>- <td><p>The branding logo. </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>@@ -9607,15 +8348,8 @@ Permissions required: bb.users.undelete</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.SetIamPolicyRequest">SetIamPolicyRequest</h3>+ <p>Request message for setting an IAM policy.</p><table class="field-table">@@ -9625,25 +8359,26 @@ Permissions required: bb.users.undelete</p></td><tbody><tr>- <td>actuator</td>- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>+ <td>resource</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The actuator to update. </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>update_mask</td>- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>+ <td>policy</td>+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td><td></td>- <td><p>The list of fields to update. </p></td>+ <td><p> </p></td></tr><tr>- <td>allow_missing</td>- <td><a href="#bool">bool</a></td>+ <td>etag</td>+ <td><a href="#string">string</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 current etag of the policy. </p></td></tr></tbody>@@ -9655,130 +8390,39 @@ 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>+ <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>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>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>+ <td>ACTION_UNSPECIFIED</td>+ <td>0</td>+ <td><p>Unspecified action.</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>+ <td>ADD</td>+ <td>1</td>+ <td><p>Add a binding.</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>+ <td>REMOVE</td>+ <td>2</td>+ <td><p>Remove a binding.</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">@@ -14611,14 +13255,6 @@ Or present but not found if deleted </p></td><td><p> </p></td></tr>- <tr>- <td>dump_version_mismatch</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>True if this changelog's dump version differs from current engine dump version.-When true and drift is detected, the drift may be a false positive from Bytebase upgrade. </p></td>- </tr>-</tbody></table>@@ -17881,131 +16517,842 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p></tbody></table>- <h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</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>+ <h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</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>++ <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.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>+ <thead>+ <tr>+ <td>Method Name</td>+ <td>Method</td>+ <td>Pattern</td>+ <td>Body</td>+ </tr>+ </thead>+ <tbody>++++ <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>GetSchemaString</td>+ <td>GET</td>+ <td>/v1/{name=instances/*/databases/*/schemaString}</td>+ <td></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>+++ <h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>+ <p>Request message for batch getting 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>names</td>+ <td><a href="#string">string</a></td>+ <td>repeated</td>+ <td><p>The group names to retrieve.+Format: groups/{email} </p></td>+ </tr>++ </tbody>+ </table>++++++ <h3 id="bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</h3>+ <p>Response message for batch getting 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>+ </tr>++ </tbody>+ </table>++++++ <h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3>+ <p>Request message for creating 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>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 email to use for the group, which will become the final component+of the group's resource name. </p></td>+ </tr>++ </tbody>+ </table>++++++ <h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>+ <p>Request message for deleting 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><a href="#string">string</a></td>+ <td></td>+ <td><p>The name of the group to delete.+Format: groups/{email} </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><a href="#string">string</a></td>+ <td></td>+ <td><p>The name of the group to retrieve.+Format: groups/{email} </p></td>+ </tr>++ </tbody>+ </table>++++++ <h3 id="bytebase.v1.Group">Group</h3>+ <p>A group of users within the workspace.</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 group to retrieve.+Format: groups/{group}, the group should be email or uuid. </p></td>+ </tr>++ <tr>+ <td>title</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The display title of the group. </p></td>+ </tr>++ <tr>+ <td>description</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>+ </tr>++ <tr>+ <td>source</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>+ </tr>++ <tr>+ <td>email</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The unique email for the group. </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>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>+ </tr>++ <tr>+ <td>role</td>+ <td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td>+ <td></td>+ <td><p>The member's role in the group. </p></td>+ </tr>++ </tbody>+ </table>++++++ <h3 id="bytebase.v1.ListGroupsRequest">ListGroupsRequest</h3>+ <p>Request 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>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><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>+ </tr>++ <tr>+ <td>filter</td>+ <td><a href="#string">string</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 "==" and ".matches()" operator.+- email: the group email, support "==" and ".matches()" operator.+- project: the project full name in "projects/{id}" format, support "==" operator.++For example:+title == "dba"+email == "[email protected]"+title.matches("dba")+email.matches("dba")+project == "projects/sample-project"+You can combine filter conditions like:+title.matches("dba") || email.matches("dba") </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>+ </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>- <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.UpdateGroupRequest">UpdateGroupRequest</h3>+ <p>Request message for updating 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>group</td>+ <td><a href="#bytebase.v1.Group">Group</a></td>+ <td></td>+ <td><p>The group to update.++The group's `name` field is used to identify the group to update.+Format: groups/{email} </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 group is not found, a new group will be created.+In this situation, `update_mask` is ignored. </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>+ <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>@@ -18013,21 +17360,21 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><tbody><tr>- <td>STATE_UNSPECIFIED</td>+ <td>ROLE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified role.</p></td></tr><tr>- <td>STARTED</td>+ <td>OWNER</td><td>1</td>- <td><p></p></td>+ <td><p>Group owner.</p></td></tr><tr>- <td>SUSPENDED</td>+ <td>MEMBER</td><td>2</td>- <td><p></p></td>+ <td><p>Group member.</p></td></tr></tbody>@@ -18037,8 +17384,8 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p>- <h3 id="bytebase.v1.DatabaseService">DatabaseService</h3>- <p>DatabaseService manages databases and their schemas.</p>+ <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>@@ -18046,115 +17393,52 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p><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>+ <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>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>+ <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>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>+ <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>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>+ <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>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>+ <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>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>+ <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>@@ -18178,9 +17462,9 @@ Permissions required: bb.databases.getSchema</p></td><tr>- <td>GetDatabase</td>+ <td>GetGroup</td><td>GET</td>- <td>/v1/{name=instances/*/databases/*}</td>+ <td>/v1/{name=groups/*}</td><td></td></tr>@@ -18188,16 +17472,9 @@ Permissions required: bb.databases.getSchema</p></td><tr>- <td>BatchGetDatabases</td>- <td>GET</td>- <td>/v1/{parent=projects/*}/databases:batchGet</td>- <td></td>- </tr>-- <tr>- <td>BatchGetDatabases</td>+ <td>BatchGetGroups</td><td>GET</td>- <td>/v1/{parent=instances/*}/databases:batchGet</td>+ <td>/v1/groups:batchGet</td><td></td></tr>@@ -18205,158 +17482,379 @@ Permissions required: bb.databases.getSchema</p></td><tr>- <td>ListDatabases</td>+ <td>ListGroups</td><td>GET</td>- <td>/v1/{parent=projects/*}/databases</td>+ <td>/v1/groups</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>+ <td>CreateGroup</td>+ <td>POST</td>+ <td>/v1/groups</td>+ <td>group</td></tr><tr>- <td>UpdateDatabase</td>+ <td>UpdateGroup</td><td>PATCH</td>- <td>/v1/{database.name=instances/*/databases/*}</td>- <td>database</td>+ <td>/v1/{group.name=groups/*}</td>+ <td>group</td></tr><tr>- <td>BatchUpdateDatabases</td>- <td>POST</td>- <td>/v1/{parent=instances/*}/databases:batchUpdate</td>- <td>*</td>+ <td>DeleteGroup</td>+ <td>DELETE</td>+ <td>/v1/{name=groups/*}</td>+ <td></td></tr>+ </tbody>+ </table>+++++ <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>+++ <table class="field-table">+ <thead>+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>+ </thead>+ <tbody>++ <tr>+ <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>identity_provider_id</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The ID to use for the identity provider, which will become the final component of+the identity provider'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>+ </table>++++++ <h3 id="bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</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 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>SyncDatabase</td>- <td>POST</td>- <td>/v1/{name=instances/*/databases/*}:sync</td>- <td>*</td>- </tr>+ <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>BatchSyncDatabases</td>- <td>POST</td>- <td>/v1/{parent=instances/*}/databases:batchSync</td>- <td>*</td>- </tr>+ <tr>+ <td>groups</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>+ </tr>-+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</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 identity provider to retrieve.+Format: idps/{idp} </p></td>+ </tr>- <tr>- <td>GetDatabaseMetadata</td>- <td>GET</td>- <td>/v1/{name=instances/*/databases/*/metadata}</td>- <td></td>- </tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.IdentityProvider">IdentityProvider</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 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>GetDatabaseSchema</td>- <td>GET</td>- <td>/v1/{name=instances/*/databases/*/schema}</td>- <td></td>- </tr>+ <tr>+ <td>domain</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The domain for email matching when using this identity provider. </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>+ </tr>+ <tr>+ <td>config</td>+ <td><a href="#bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</a></td>+ <td></td>+ <td><p>The configuration details for the identity provider. </p></td>+ </tr>- <tr>- <td>GetDatabaseSDLSchema</td>- <td>GET</td>- <td>/v1/{name=instances/*/databases/*/sdlSchema}</td>- <td></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>oauth2_config</td>+ <td><a href="#bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td>+ <td></td>+ <td><p>OAuth2 protocol configuration. </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>- <tr>- <td>DiffSchema</td>- <td>POST</td>- <td>/v1/{name=instances/*/databases/*}:diffSchema</td>- <td>*</td>- </tr>+ <tr>+ <td>ldap_config</td>+ <td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td>+ <td></td>+ <td><p>LDAP protocol configuration. </p></td>+ </tr>- <tr>- <td>DiffSchema</td>- <td>POST</td>- <td>/v1/{name=instances/*/databases/*/changelogs/*}:diffSchema</td>- <td>*</td>- </tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</h3>+ <p>LDAPIdentityProviderConfig is the structure for LDAP identity provider config.</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>Host is the hostname or IP address of the LDAP server, e.g.,+"ldap.example.com". </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>ListChangelogs</td>- <td>GET</td>- <td>/v1/{parent=instances/*/databases/*}/changelogs</td>- <td></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>GetChangelog</td>- <td>GET</td>- <td>/v1/{name=instances/*/databases/*/changelogs/*}</td>- <td></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., "ou=users,dc=example,dc=com". </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., "(uid=%s)". </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>+ </tr>- <tr>- <td>GetSchemaString</td>- <td>GET</td>- <td>/v1/{name=instances/*/databases/*/schemaString}</td>- <td></td>- </tr>+ <tr>+ <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>++-- <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.ListIdentityProvidersRequest">ListIdentityProvidersRequest</h3>+ <p></p>+++- <h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>- <p>Request message for batch getting groups.</p>+ <h3 id="bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</h3>+ <p></p><table class="field-table">@@ -18366,11 +17864,10 @@ Permissions required: bb.databases.getSchema</p></td><tbody><tr>- <td>names</td>- <td><a href="#string">string</a></td>+ <td>identity_providers</td>+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td><td>repeated</td>- <td><p>The group names to retrieve.-Format: groups/{email} </p></td>+ <td><p>The identity providers from the specified request. </p></td></tr></tbody>@@ -18380,8 +17877,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.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</h3>+ <p>OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.</p><table class="field-table">@@ -18391,10 +17888,66 @@ Format: groups/{email} </p></td><tbody><tr>- <td>groups</td>- <td><a href="#bytebase.v1.Group">Group</a></td>+ <td>auth_url</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The authorization endpoint URL for OAuth2 flow. </p></td>+ </tr>++ <tr>+ <td>token_url</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The token endpoint URL for exchanging authorization code. </p></td>+ </tr>++ <tr>+ <td>user_info_url</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The user information endpoint URL. </p></td>+ </tr>++ <tr>+ <td>client_id</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The OAuth2 client identifier. </p></td>+ </tr>++ <tr>+ <td>client_secret</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The OAuth2 client secret for authentication. </p></td>+ </tr>++ <tr>+ <td>scopes</td>+ <td><a href="#string">string</a></td><td>repeated</td>- <td><p>The groups from the specified request. </p></td>+ <td><p>The list of OAuth2 scopes to request. </p></td>+ </tr>++ <tr>+ <td>field_mapping</td>+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>+ <td></td>+ <td><p>Mapping configuration for user attributes from OAuth2 response. </p></td>+ </tr>++ <tr>+ <td>skip_tls_verify</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></tbody>@@ -18404,8 +17957,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.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</h3>+ <p></p><table class="field-table">@@ -18415,18 +17968,10 @@ Format: groups/{email} </p></td><tbody><tr>- <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>code</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's resource name. </p></td>+ <td><p>Authorize code from website. </p></td></tr></tbody>@@ -18436,8 +17981,8 @@ of the group's resource name. </p></td>- <h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>- <p>Request message for deleting a group.</p>+ <h3 id="bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3>+ <p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p><table class="field-table">@@ -18447,11 +17992,61 @@ of the group's resource name. </p></td><tbody><tr>- <td>name</td>+ <td>issuer</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 OIDC issuer URL for the identity provider. </p></td>+ </tr>++ <tr>+ <td>client_id</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p>The OIDC client identifier. </p></td>+ </tr>++ <tr>+ <td>client_secret</td>+ <td><a href="#string">string</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>+ </tr>++ <tr>+ <td>field_mapping</td>+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>+ <td></td>+ <td><p>Mapping configuration for user attributes from OIDC claims. </p></td>+ </tr>++ <tr>+ <td>skip_tls_verify</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>@@ -18461,8 +18056,8 @@ Format: groups/{email} </p></td>- <h3 id="bytebase.v1.GetGroupRequest">GetGroupRequest</h3>- <p>Request message for getting a group.</p>+ <h3 id="bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</h3>+ <p></p><table class="field-table">@@ -18472,11 +18067,10 @@ Format: groups/{email} </p></td><tbody><tr>- <td>name</td>+ <td>code</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>Authorize code from OIDC provider. </p></td></tr></tbody>@@ -18486,8 +18080,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.TestIdentityProviderRequest">TestIdentityProviderRequest</h3>+ <p></p><table class="field-table">@@ -18497,46 +18091,24 @@ Format: groups/{email} </p></td><tbody><tr>- <td>name</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>- </tr>-- <tr>- <td>title</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The display title of the group. </p></td>- </tr>-- <tr>- <td>description</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 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>The identity provider to test connection including uncreated. </p></td></tr><tr>- <td>source</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 source system where the group originated (e.g., Entra ID for SCIM sync). </p></td>+ <td><p> </p></td></tr><tr>- <td>email</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 unique email for the group. </p></td>+ <td><p>OIDC authentication context for test connection. </p></td></tr></tbody>@@ -18546,8 +18118,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.TestIdentityProviderResponse">TestIdentityProviderResponse</h3>+ <p></p><table class="field-table">@@ -18557,19 +18129,17 @@ 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>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>role</td>- <td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td>- <td></td>- <td><p>The member's role in the group. </p></td>+ <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>@@ -18579,8 +18149,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.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</h3>+ <p></p><table class="field-table">@@ -18590,46 +18160,17 @@ 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>key</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> </p></td></tr><tr>- <td>filter</td>+ <td>value</td><td><a href="#string">string</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 "==" and ".matches()" operator.-- email: the group email, support "==" and ".matches()" operator.-- project: the project full name in "projects/{id}" format, support "==" operator.--For example:-title == "dba"-email == "[email protected]"-title.matches("dba")-email.matches("dba")-project == "projects/sample-project"-You can combine filter conditions like:-title.matches("dba") || email.matches("dba") </p></td>+ <td><p> </p></td></tr></tbody>@@ -18639,8 +18180,8 @@ title.matches("dba") || email.matches("dba") </p></td>- <h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3>- <p>Response message for listing groups.</p>+ <h3 id="bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</h3>+ <p></p><table class="field-table">@@ -18650,18 +18191,17 @@ title.matches("dba") || email.matches("dba") </p></td><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>key</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr><tr>- <td>next_page_token</td>+ <td>value</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>@@ -18671,8 +18211,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.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</h3>+ <p></p><table class="field-table">@@ -18682,13 +18222,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>identity_provider</td>+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td><td></td>- <td><p>The group to update.+ <td><p>The identity provider to update.-The group's `name` field is used to identify the group to update.-Format: groups/{email} </p></td>+The identity provider's `name` field is used to identify the identity provider to update.+Format: idps/{identity_provider} </p></td></tr><tr>@@ -18702,7 +18242,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 identity provider is not found, a new identity provider will be created.In this situation, `update_mask` is ignored. </p></td></tr>@@ -18715,8 +18255,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.IdentityProviderType">IdentityProviderType</h3>+ <p></p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -18724,21 +18264,87 @@ In this situation, `update_mask` is ignored. </p></td><tbody><tr>- <td>ROLE_UNSPECIFIED</td>+ <td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td><td>0</td>- <td><p>Unspecified role.</p></td>+ <td><p>Unspecified identity provider type.</p></td></tr><tr>- <td>OWNER</td>+ <td>OAUTH2</td><td>1</td>- <td><p>Group owner.</p></td>+ <td><p>OAuth 2.0 authentication protocol.</p></td></tr><tr>- <td>MEMBER</td>+ <td>OIDC</td><td>2</td>- <td><p>Group member.</p></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 "client_id" and "client_secret" 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>@@ -18748,8 +18354,8 @@ In this situation, `update_mask` is ignored. </p></td>- <h3 id="bytebase.v1.GroupService">GroupService</h3>- <p>GroupService manages user groups for organizing users and permissions.</p>+ <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>@@ -18757,52 +18363,52 @@ In this situation, `update_mask` is ignored. </p></td><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>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>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>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>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>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>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>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>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>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>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>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>@@ -18826,19 +18432,9 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td><tr>- <td>GetGroup</td>- <td>GET</td>- <td>/v1/{name=groups/*}</td>- <td></td>- </tr>----- <tr>- <td>BatchGetGroups</td>+ <td>GetIdentityProvider</td><td>GET</td>- <td>/v1/groups:batchGet</td>+ <td>/v1/{name=idps/*}</td><td></td></tr>@@ -18846,9 +18442,9 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td><tr>- <td>ListGroups</td>+ <td>ListIdentityProviders</td><td>GET</td>- <td>/v1/groups</td>+ <td>/v1/idps</td><td></td></tr>@@ -18856,33 +18452,43 @@ Permissions required: bb.groups.delete OR caller is group owner</p></td><tr>- <td>CreateGroup</td>+ <td>CreateIdentityProvider</td><td>POST</td>- <td>/v1/groups</td>- <td>group</td>+ <td>/v1/idps</td>+ <td>identity_provider</td></tr><tr>- <td>UpdateGroup</td>+ <td>UpdateIdentityProvider</td><td>PATCH</td>- <td>/v1/{group.name=groups/*}</td>- <td>group</td>+ <td>/v1/{identity_provider.name=idps/*}</td>+ <td>identity_provider</td></tr><tr>- <td>DeleteGroup</td>+ <td>DeleteIdentityProvider</td><td>DELETE</td>- <td>/v1/{name=groups/*}</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>@@ -18890,12 +18496,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>@@ -18906,28 +18512,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: "".+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'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>@@ -18937,8 +18543,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">@@ -18948,11 +18554,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>@@ -18962,8 +18581,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">@@ -18973,32 +18592,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's `name` field is used to identify the instance to update.+Format: {resource name}/policies/{policy type}+Workspace resource name: "".+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>@@ -19008,7 +18610,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>@@ -19022,8 +18624,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>@@ -19033,7 +18635,7 @@ Format: idps/{idp} </p></td>- <h3 id="bytebase.v1.IdentityProvider">IdentityProvider</h3>+ <h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3><p></p>@@ -19044,39 +18646,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>@@ -19086,7 +18674,7 @@ Format: idps/{idp} </p></td>- <h3 id="bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</h3>+ <h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3><p></p>@@ -19097,24 +18685,10 @@ 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>- </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>-- <tr>- <td>ldap_config</td>- <td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td>- <td></td>- <td><p>LDAP 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></tbody>@@ -19124,8 +18698,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.MaskingExceptionPolicy">MaskingExceptionPolicy</h3>+ <p>MaskingExceptionPolicy is the allowlist of users who can access sensitive data.</p><table class="field-table">@@ -19135,72 +18709,66 @@ Format: idps/{idp} </p></td><tbody><tr>- <td>host</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.,-"ldap.example.com". </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>+ <td>masking_exceptions</td>+ <td><a href="#bytebase.v1.MaskingExceptionPolicy.MaskingException">MaskingExceptionPolicy.MaskingException</a></td>+ <td>repeated</td>+ <td><p>The list of masking exceptions. </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>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.MaskingExceptionPolicy.MaskingException">MaskingExceptionPolicy.MaskingException</h3>+ <p>An exception allowing specific users to access masked 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>base_dn</td>- <td><a href="#string">string</a></td>+ <td>action</td>+ <td><a href="#bytebase.v1.MaskingExceptionPolicy.MaskingException.Action">MaskingExceptionPolicy.MaskingException.Action</a></td><td></td>- <td><p>BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com". </p></td>+ <td><p>The action that the user can perform on sensitive data. </p></td></tr><tr>- <td>user_filter</td>+ <td>member</td><td><a href="#string">string</a></td><td></td>- <td><p>UserFilter is the filter to search for users, e.g., "(uid=%s)". </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><p>Member is the principal who bind to this exception policy instance.++- `user:{email}`: An email address that represents a specific Bytebase account. For example, `[email protected]`.+- `group:{email}`: An email address for group. </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 "==" operation.+resource.database_name: the database name. Only support "==" operation.+resource.schema_name: the schema name. Only support "==" operation.+resource.table_name: the table name. Only support "==" operation.+resource.column_name: the column name. Only support "==" operation.+request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")`+All variables should join with "&&" condition.++For example:+resource.instance_id == "local" && resource.database_name == "employee" && request.time < timestamp("2025-04-30T11:10:39.000Z")+resource.instance_id == "local" && resource.database_name == "employee" </p></td></tr></tbody>@@ -19210,15 +18778,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">@@ -19228,10 +18813,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 == "test" && resource.project_id == "sample-project"+resource.instance_id == "sample-instance" && resource.database_name == "employee" && resource.table_name in ["table1", "table2"]+resource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"])+resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2") </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., "SSN", "EMAIL"). </p></td></tr></tbody>@@ -19241,8 +18862,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">@@ -19252,90 +18873,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: "".+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_exception_policy</td>+ <td><a href="#bytebase.v1.MaskingExceptionPolicy">MaskingExceptionPolicy</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>@@ -19345,8 +18961,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">@@ -19356,61 +18972,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 <= 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>+ <td><p>Disable copying query results. </p></td></tr></tbody>@@ -19420,8 +19015,8 @@ Should be fetched from the well-known configuration file of the OIDC provider. <- <h3 id="bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</h3>- <p></p>+ <h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3>+ <p>Rollout policy configuration.</p><table class="field-table">@@ -19431,10 +19026,25 @@ Should be fetched from the well-known configuration file of the OIDC provider. <<tbody><tr>- <td>code</td>- <td><a href="#string">string</a></td>+ <td>automatic</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p>Whether rollout is automatic without manual approval. </p></td>+ </tr>++ <tr>+ <td>roles</td>+ <td><a href="#string">string</a></td>+ <td>repeated</td>+ <td><p>The roles that can approve rollout execution. </p></td>+ </tr>++ <tr>+ <td>checkers</td>+ <td><a href="#bytebase.v1.RolloutPolicy.Checkers">RolloutPolicy.Checkers</a></td><td></td>- <td><p>Authorize code from OIDC provider. </p></td>+ <td><p>Checkers that must pass before rollout execution.+These checks are performed in UI workflows only. </p></td></tr></tbody>@@ -19444,7 +19054,7 @@ Should be fetched from the well-known configuration file of the OIDC provider. <- <h3 id="bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</h3>+ <h3 id="bytebase.v1.RolloutPolicy.Checkers">RolloutPolicy.Checkers</h3><p></p>@@ -19455,24 +19065,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>required_issue_approval</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether issue approval is required before proceeding with rollout. </p></td></tr><tr>- <td>oidc_context</td>- <td><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</a></td>+ <td>required_status_checks</td>+ <td><a href="#bytebase.v1.RolloutPolicy.Checkers.RequiredStatusChecks">RolloutPolicy.Checkers.RequiredStatusChecks</a></td><td></td>- <td><p>OIDC authentication context for test connection. </p></td>+ <td><p>Status checks that must pass before rollout can be executed. </p></td></tr></tbody>@@ -19482,7 +19085,7 @@ Should be fetched from the well-known configuration file of the OIDC provider. <- <h3 id="bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</h3>+ <h3 id="bytebase.v1.RolloutPolicy.Checkers.RequiredStatusChecks">RolloutPolicy.Checkers.RequiredStatusChecks</h3><p></p>@@ -19493,17 +19096,10 @@ Should be fetched from the well-known configuration file of the OIDC provider. <<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>- </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>+ <td>plan_check_enforcement</td>+ <td><a href="#bytebase.v1.RolloutPolicy.Checkers.PlanCheckEnforcement">RolloutPolicy.Checkers.PlanCheckEnforcement</a></td>+ <td></td>+ <td><p>Enforcement level for plan check results during rollout validation. </p></td></tr></tbody>@@ -19513,8 +19109,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">@@ -19524,17 +19120,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 "bb.tag.review_config": "reviewConfigs/{review config resource id}" </p></td></tr></tbody>@@ -19544,7 +19134,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>@@ -19575,7 +19165,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>@@ -19586,13 +19176,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's `name` field is used to identify the identity provider to update.-Format: idps/{identity_provider} </p></td>+The policy's `name` field is used to identify the instance to update.+Format: {resource name}/policies/{policy type}+Workspace resource name: "".+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>@@ -19606,7 +19200,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>@@ -19619,8 +19213,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>@@ -19628,34 +19222,57 @@ 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>+ <td><p>Disallow querying admin data sources.</p></td>+ </tr>++ </tbody>+ </table>++ <h3 id="bytebase.v1.MaskingExceptionPolicy.MaskingException.Action">MaskingExceptionPolicy.MaskingException.Action</h3>+ <p>The action that the exception permits.</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>LDAP</td>- <td>3</td>- <td><p>LDAP directory service authentication.</p></td>+ <td>QUERY</td>+ <td>1</td>+ <td><p>Allow querying sensitive data.</p></td>+ </tr>++ <tr>+ <td>EXPORT</td>+ <td>2</td>+ <td><p>Allow exporting sensitive data.</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>@@ -19663,27 +19280,86 @@ 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>+ <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>ROLLOUT_POLICY</td>+ <td>11</td>+ <td><p>Rollout deployment policy.</p></td>+ </tr>++ <tr>+ <td>MASKING_RULE</td>+ <td>9</td>+ <td><p>Data masking rule policy.</p></td>+ </tr>++ <tr>+ <td>MASKING_EXCEPTION</td>+ <td>10</td>+ <td><p>Data masking exception policy.</p></td>+ </tr>++ <tr>+ <td>TAG</td>+ <td>13</td>+ <td><p>Resource tag policy.</p></td>+ </tr>++ <tr>+ <td>DATA_SOURCE_QUERY</td>+ <td>14</td>+ <td><p>Data source query restrictions policy.</p></td>+ </tr>++ <tr>+ <td>DATA_QUERY</td>+ <td>16</td>+ <td><p>Query data access policy.</p></td>+ </tr>++ </tbody>+ </table>++ <h3 id="bytebase.v1.RolloutPolicy.Checkers.PlanCheckEnforcement">RolloutPolicy.Checkers.PlanCheckEnforcement</h3><p></p><table class="enum-table"><thead>@@ -19692,23 +19368,21 @@ In this situation, `update_mask` is ignored. </p></td><tbody><tr>- <td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td>+ <td>PLAN_CHECK_ENFORCEMENT_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Allow rollout regardless of plan check results (no enforcement).</p></td></tr><tr>- <td>IN_PARAMS</td>+ <td>ERROR_ONLY</td><td>1</td>- <td><p>IN_PARAMS sends the "client_id" and "client_secret" in the POST body-as application/x-www-form-urlencoded parameters.</p></td>+ <td><p>Block rollout only when plan check finds errors.</p></td></tr><tr>- <td>IN_HEADER</td>+ <td>STRICT</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>Block rollout when plan check finds errors or warnings.</p></td></tr></tbody>@@ -19718,8 +19392,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>@@ -19727,52 +19401,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>+ <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>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>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>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>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>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>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>DeleteIdentityProvider</td>- <td><a href="#bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</a></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 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>+ <td><p>Deletes an organizational policy.+Permissions required: bb.policies.delete</p></td></tr></tbody>@@ -19796,9 +19461,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>@@ -19806,9 +19499,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>@@ -19816,40 +19537,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>DeletePolicy</td>+ <td>DELETE</td>+ <td>/v1/{name=instances/*/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/*/databases/*/policies/*}</td>+ <td></td></tr>@@ -19860,82 +19655,26 @@ 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><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 where this instance will be created.-Workspace resource name: "".-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>- </tr>-- </tbody>- </table>------ <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">- <thead>- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>- </thead>- <tbody>-- <tr>- <td>admin_data_source_restriction</td>- <td><a href="#bytebase.v1.DataSourceQueryPolicy.Restriction">DataSourceQueryPolicy.Restriction</a></td>- <td></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>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>+ </thead>+ <tbody><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>+ <td>messages</td>+ <td><a href="#bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</a></td>+ <td>repeated</td>+ <td><p> </p></td></tr></tbody>@@ -19945,7 +19684,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>- <h3 id="bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</h3>+ <h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</h3><p></p>@@ -19956,15 +19695,17 @@ Database resource name: instances/instance-id/databases/database-name. </p></td><tbody><tr>- <td>name</td>+ <td>role</td><td><a href="#string">string</a></td><td></td>- <td><p>The policy's `name` field is used to identify the instance to update.-Format: {resource name}/policies/{policy type}-Workspace resource name: "".-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> </p></td>+ </tr>++ <tr>+ <td>content</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -19974,7 +19715,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>- <h3 id="bytebase.v1.GetPolicyRequest">GetPolicyRequest</h3>+ <h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3><p></p>@@ -19985,11 +19726,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 name of the policy to retrieve.-Format: {resource type}/{resource id}/policies/{policy type} </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>@@ -19999,7 +19740,7 @@ Format: {resource type}/{resource id}/policies/{policy type} </p></td>- <h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3>+ <h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</h3><p></p>@@ -20010,25 +19751,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>content</td>+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</a></td><td></td>- <td><p>Show deleted policies if specified. </p></td>+ <td><p> </p></td></tr></tbody>@@ -20038,7 +19764,7 @@ Format: {resource type}/{resource id} </p></td>- <h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3>+ <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3><p></p>@@ -20049,10 +19775,10 @@ Format: {resource type}/{resource id} </p></td><tbody><tr>- <td>policies</td>- <td><a href="#bytebase.v1.Policy">Policy</a></td>+ <td>parts</td>+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</a></td><td>repeated</td>- <td><p>The policies from the specified request. </p></td>+ <td><p>parts is used for a result content with multiple parts. </p></td></tr></tbody>@@ -20062,8 +19788,8 @@ Format: {resource type}/{resource id} </p></td>- <h3 id="bytebase.v1.MaskingExceptionPolicy">MaskingExceptionPolicy</h3>- <p>MaskingExceptionPolicy is the allowlist of users who can access sensitive data.</p>+ <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</h3>+ <p></p><table class="field-table">@@ -20073,10 +19799,10 @@ Format: {resource type}/{resource id} </p></td><tbody><tr>- <td>masking_exceptions</td>- <td><a href="#bytebase.v1.MaskingExceptionPolicy.MaskingException">MaskingExceptionPolicy.MaskingException</a></td>- <td>repeated</td>- <td><p>The list of masking exceptions. </p></td>+ <td>text</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -20086,8 +19812,8 @@ Format: {resource type}/{resource id} </p></td>- <h3 id="bytebase.v1.MaskingExceptionPolicy.MaskingException">MaskingExceptionPolicy.MaskingException</h3>- <p>An exception allowing specific users to access masked data.</p>+ <h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3>+ <p></p><table class="field-table">@@ -20097,42 +19823,41 @@ Format: {resource type}/{resource id} </p></td><tbody><tr>- <td>action</td>- <td><a href="#bytebase.v1.MaskingExceptionPolicy.MaskingException.Action">MaskingExceptionPolicy.MaskingException.Action</a></td>+ <td>name</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The action that the user can perform on sensitive data. </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>member</td>+ <td>statement</td><td><a href="#string">string</a></td><td></td>- <td><p>Member is the principal who bind to this exception policy instance.--- `user:{email}`: An email address that represents a specific Bytebase account. For example, `[email protected]`.-- `group:{email}`: An email address for group. </p></td>+ <td><p>The SQL statement to execute. </p></td></tr><tr>- <td>condition</td>- <td><a href="#google.type.Expr">google.type.Expr</a></td>+ <td>limit</td>+ <td><a href="#int32">int32</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 "==" operation.-resource.database_name: the database name. Only support "==" operation.-resource.schema_name: the schema name. Only support "==" operation.-resource.table_name: the table name. Only support "==" operation.-resource.column_name: the column name. Only support "==" operation.-request.time: the expiration. Only support "<" operation in `request.time < timestamp("{ISO datetime string format}")`-All variables should join with "&&" condition.--For example:-resource.instance_id == "local" && resource.database_name == "employee" && request.time < timestamp("2025-04-30T11:10:39.000Z")-resource.instance_id == "local" && resource.database_name == "employee" </p></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>@@ -20142,8 +19867,8 @@ resource.instance_id == "local" && resource.database_name == - <h3 id="bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</h3>- <p>Policy for configuring data masking rules.</p>+ <h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3>+ <p></p><table class="field-table">@@ -20153,10 +19878,10 @@ resource.instance_id == "local" && resource.database_name == <tbody><tr>- <td>rules</td>- <td><a href="#bytebase.v1.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</a></td>+ <td>results</td>+ <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td><td>repeated</td>- <td><p>The list of masking rules. </p></td>+ <td><p>The query results. </p></td></tr></tbody>@@ -20166,8 +19891,8 @@ resource.instance_id == "local" && resource.database_name == - <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.Advice">Advice</h3>+ <p></p><table class="field-table">@@ -20177,46 +19902,105 @@ resource.instance_id == "local" && resource.database_name == <tbody><tr>- <td>id</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>A unique identifier for the rule in UUID format. </p></td>+ <td><p>The advice title. </p></td></tr><tr>- <td>condition</td>- <td><a href="#google.type.Expr">google.type.Expr</a></td>+ <td>content</td>+ <td><a href="#string">string</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+ <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>+ </table>-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.+++ <h3 id="bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</h3>+ <p></p>-For example:-resource.environment_id == "test" && resource.project_id == "sample-project"-resource.instance_id == "sample-instance" && resource.database_name == "employee" && resource.table_name in ["table1", "table2"]-resource.environment_id != "test" || !(resource.project_id in ["poject1", "prject2"])-resource.instance_id == "sample-instance" && (resource.database_name == "db1" || resource.database_name == "db2") </p></td>++ <table class="field-table">+ <thead>+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>+ </thead>+ <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></td>+ <td><p>The metadata of the target schema. </p></td>+ </tr>++ <tr>+ <td>source_catalog</td>+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>target_catalog</td>+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>+ <td></td>+ <td><p> </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., "SSN", "EMAIL"). </p></td>+ <td><p>The database engine of the schema. </p></td></tr></tbody>@@ -20226,7 +20010,7 @@ resource.instance_id == "sample-instance" && (resource.database_- <h3 id="bytebase.v1.Policy">Policy</h3>+ <h3 id="bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</h3><p></p>@@ -20237,85 +20021,116 @@ resource.instance_id == "sample-instance" && (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: "".-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_exception_policy</td>- <td><a href="#bytebase.v1.MaskingExceptionPolicy">MaskingExceptionPolicy</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>@@ -20325,8 +20140,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">@@ -20336,40 +20151,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., "SSN", "email", "phone"). </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 <= 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., "Matched global rule: PII Protection"). </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>@@ -20379,8 +20206,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">@@ -20390,80 +20217,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><tr>- <td>checkers</td>- <td><a href="#bytebase.v1.RolloutPolicy.Checkers">RolloutPolicy.Checkers</a></td>+ <td>creator</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Checkers that must pass before rollout execution.-These checks are performed in UI workflows only. </p></td>+ <td><p> </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.RolloutPolicy.Checkers">RolloutPolicy.Checkers</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_issue_approval</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 issue approval is required before proceeding with rollout. </p></td>+ <td><p> </p></td></tr><tr>- <td>required_status_checks</td>- <td><a href="#bytebase.v1.RolloutPolicy.Checkers.RequiredStatusChecks">RolloutPolicy.Checkers.RequiredStatusChecks</a></td>+ <td>statement</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Status checks that must pass before rollout can be executed. </p></td>+ <td><p> </p></td></tr>- </tbody>- </table>------ <h3 id="bytebase.v1.RolloutPolicy.Checkers.RequiredStatusChecks">RolloutPolicy.Checkers.RequiredStatusChecks</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>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>plan_check_enforcement</td>- <td><a href="#bytebase.v1.RolloutPolicy.Checkers.PlanCheckEnforcement">RolloutPolicy.Checkers.PlanCheckEnforcement</a></td>+ <td>type</td>+ <td><a href="#bytebase.v1.QueryHistory.Type">QueryHistory.Type</a></td><td></td>- <td><p>Enforcement level for plan check results during rollout validation. </p></td>+ <td><p> </p></td></tr></tbody>@@ -20473,8 +20281,8 @@ These checks are performed in UI workflows only. </p></td>- <h3 id="bytebase.v1.TagPolicy">TagPolicy</h3>- <p>Policy for tagging resources with metadata.</p>+ <h3 id="bytebase.v1.QueryOption">QueryOption</h3>+ <p></p><table class="field-table">@@ -20484,11 +20292,17 @@ These checks are performed in UI workflows only. </p></td><tbody><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 "bb.tag.review_config": "reviewConfigs/{review config resource id}" </p></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>mssql_explain_format</td>+ <td><a href="#bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -20498,7 +20312,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.QueryRequest">QueryRequest</h3><p></p>@@ -20509,535 +20323,394 @@ for example, the environment resource can have the sql review config tag, like &<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 is the instance name to execute the query against.+Format: instances/{instance}/databases/{databaseName} </p></td></tr><tr>- <td>value</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>- </tbody>- </table>------ <h3 id="bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</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>policy</td>- <td><a href="#bytebase.v1.Policy">Policy</a></td>+ <td>limit</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>The policy to update.--The policy's `name` field is used to identify the instance to update.-Format: {resource name}/policies/{policy type}-Workspace resource name: "".-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 maximum number of rows to return. </p></td></tr><tr>- <td>update_mask</td>- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>+ <td>data_source_id</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The list of fields to update. </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>allow_missing</td>+ <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>- </tbody>- </table>-------- <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.MaskingExceptionPolicy.MaskingException.Action">MaskingExceptionPolicy.MaskingException.Action</h3>- <p>The action that the exception permits.</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>QUERY</td>- <td>1</td>- <td><p>Allow querying sensitive data.</p></td>- </tr>-- <tr>- <td>EXPORT</td>- <td>2</td>- <td><p>Allow exporting sensitive data.</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>ROLLOUT_POLICY</td>- <td>11</td>- <td><p>Rollout deployment policy.</p></td>- </tr>-- <tr>- <td>MASKING_RULE</td>- <td>9</td>- <td><p>Data masking rule policy.</p></td>- </tr>-- <tr>- <td>MASKING_EXCEPTION</td>- <td>10</td>- <td><p>Data masking exception policy.</p></td>- </tr>-- <tr>- <td>TAG</td>- <td>13</td>- <td><p>Resource tag policy.</p></td>- </tr>-- <tr>- <td>DATA_SOURCE_QUERY</td>- <td>14</td>- <td><p>Data source query restrictions policy.</p></td>- </tr>-- <tr>- <td>DATA_QUERY</td>- <td>16</td>- <td><p>Query data access policy.</p></td>- </tr>-- </tbody>- </table>+ <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>++++- <h3 id="bytebase.v1.RolloutPolicy.Checkers.PlanCheckEnforcement">RolloutPolicy.Checkers.PlanCheckEnforcement</h3>+ <h3 id="bytebase.v1.QueryResponse">QueryResponse</h3><p></p>- <table class="enum-table">- <thead>- <tr><td>Name</td><td>Number</td><td>Description</td></tr>- </thead>- <tbody>-- <tr>- <td>PLAN_CHECK_ENFORCEMENT_UNSPECIFIED</td>- <td>0</td>- <td><p>Allow rollout regardless of plan check results (no enforcement).</p></td>- </tr>-- <tr>- <td>ERROR_ONLY</td>- <td>1</td>- <td><p>Block rollout only when plan check finds errors.</p></td>- </tr>-- <tr>- <td>STRICT</td>- <td>2</td>- <td><p>Block rollout when plan check finds errors or warnings.</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>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=policies/*}</td>- <td></td>- </tr>-- <tr>- <td>GetPolicy</td>- <td>GET</td>- <td>/v1/{name=projects/*/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=environments/*/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/*/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>GetPolicy</td>- <td>GET</td>- <td>/v1/{name=instances/*/databases/*/policies/*}</td>- <td></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>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/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=projects/*}/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=environments/*}/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/*}/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's RAISE NOTICE, MSSQL's PRINT, or Oracle's DBMS_OUTPUT.PUT_LINE. </p></td>+ </tr>- <tr>- <td>ListPolicies</td>- <td>GET</td>- <td>/v1/{parent=instances/*/databases/*}/policies</td>- <td></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>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/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=projects/*}/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=environments/*}/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/*}/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>- <tr>- <td>CreatePolicy</td>- <td>POST</td>- <td>/v1/{parent=instances/*/databases/*}/policies</td>- <td>policy</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>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=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>UpdatePolicy</td>- <td>PATCH</td>- <td>/v1/{policy.name=projects/*/policies/*}</td>- <td>policy</td>- </tr>+ <tr>+ <td>detail</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=environments/*/policies/*}</td>- <td>policy</td>- </tr>+ <tr>+ <td>hint</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/*/policies/*}</td>- <td>policy</td>- </tr>+ <tr>+ <td>position</td>+ <td><a href="#int32">int32</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>internal_position</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>-+ <tr>+ <td>internal_query</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></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=policies/*}</td>- <td></td>- </tr>+ <tr>+ <td>schema_name</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=projects/*/policies/*}</td>- <td></td>- </tr>+ <tr>+ <td>table_name</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=environments/*/policies/*}</td>- <td></td>- </tr>+ <tr>+ <td>column_name</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>data_type_name</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>constraint_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>file</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>line</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>routine</td>+ <td><a href="#string">string</a></td>+ <td></td><td><p> </p></td></tr>@@ -21048,8 +20721,8 @@ Permissions required: bb.policies.delete</p></td>- <h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</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">@@ -21059,17 +20732,10 @@ Permissions required: bb.policies.delete</p></td><tbody><tr>- <td>role</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>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>@@ -21079,7 +20745,7 @@ Permissions required: bb.policies.delete</p></td>- <h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3>+ <h3 id="bytebase.v1.QueryRow">QueryRow</h3><p></p>@@ -21090,11 +20756,10 @@ Permissions required: bb.policies.delete</p></td><tbody><tr>- <td>candidates</td>- <td><a href="#bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</a></td>+ <td>values</td>+ <td><a href="#bytebase.v1.RowValue">RowValue</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><p>Row values of the query result. </p></td></tr></tbody>@@ -21104,7 +20769,7 @@ for OpenAI and Gemini. </p></td>- <h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</h3>+ <h3 id="bytebase.v1.RowValue">RowValue</h3><p></p>@@ -21115,12 +20780,100 @@ 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>null_value</td>+ <td><a href="#google.protobuf.NullValue">google.protobuf.NullValue</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>bool_value</td>+ <td><a href="#bool">bool</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>bytes_value</td>+ <td><a href="#bytes">bytes</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>double_value</td>+ <td><a href="#double">double</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>float_value</td>+ <td><a href="#float">float</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>int32_value</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>int64_value</td>+ <td><a href="#int64">int64</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>string_value</td>+ <td><a href="#string">string</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>uint32_value</td>+ <td><a href="#uint32">uint32</a></td>+ <td></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>uint64_value</td>+ <td><a href="#uint64">uint64</a></td><td></td><td><p> </p></td></tr>+ <tr>+ <td>value_value</td>+ <td><a href="#google.protobuf.Value">google.protobuf.Value</a></td>+ <td></td>+ <td><p>value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. </p></td>+ </tr>++ <tr>+ <td>timestamp_value</td>+ <td><a href="#bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</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>+ </tr>++ <tr>+ <td>timestamp_tz_value</td>+ <td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</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>+ </tr>+</tbody></table>@@ -21128,7 +20881,7 @@ for OpenAI and Gemini. </p></td>- <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3>+ <h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3><p></p>@@ -21139,10 +20892,17 @@ 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>repeated</td>- <td><p>parts is used for a result content with multiple parts. </p></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>accuracy</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p>The accuracy is the number of digits after the decimal point. </p></td></tr></tbody>@@ -21152,7 +20912,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.TimestampTZ">RowValue.TimestampTZ</h3><p></p>@@ -21163,9 +20923,35 @@ for OpenAI and Gemini. </p></td><tbody><tr>- <td>text</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>Zone is the time zone abbreviations in timezone database such as "PDT",+"PST". 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>@@ -21176,7 +20962,7 @@ for OpenAI and Gemini. </p></td>- <h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3>+ <h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3><p></p>@@ -21187,218 +20973,495 @@ for OpenAI and Gemini. </p></td><tbody><tr>- <td>name</td>- <td><a href="#string">string</a></td>+ <td>page_size</td>+ <td><a href="#int32">int32</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>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>statement</td>+ <td>page_token</td><td><a href="#string">string</a></td><td></td>- <td><p>The SQL statement to execute. </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>limit</td>- <td><a href="#int32">int32</a></td>+ <td>filter</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The maximum number of rows to return. </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 "projects/{id}" format, support "==" operator.+- database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.+- instance: the instance full name in "instances/{id}" format, support "==" operator.+- type: the type, should be "QUERY" or "EXPORT", support "==" operator.+- statement: the SQL statement, support ".matches()" operator.++For example:+project == "projects/{project}"+database == "instances/{instance}/databases/{database}"+instance == "instances/{instance}"+type == "QUERY"+type == "EXPORT"+statement.matches("select")+type == "QUERY" && statement.matches("select") </p></td></tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</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>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>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>container</td>+ <td>next_page_token</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></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></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.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="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.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</h3>+ <p></p>+ <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.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>+++-- <h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3>- <p></p>+ <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'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>- <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>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.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>Query</td>+ <td>POST</td>+ <td>/v1/{name=instances/*/databases/*}:query</td>+ <td>*</td>+ </tr>- <tr>- <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>AdminExecute</td>+ <td>GET</td>+ <td>/v1:adminExecute</td>+ <td></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>SearchQueryHistories</td>+ <td>POST</td>+ <td>/v1/queryHistories:search</td>+ <td>*</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>- </table>------ <h3 id="bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</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_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>Export</td>+ <td>POST</td>+ <td>/v1/{name=instances/*/databases/*}:export</td>+ <td>*</td>+ </tr>- <tr>- <td>target_metadata</td>- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>- <td></td>- <td><p>The metadata of the target schema. </p></td>- </tr>+ <tr>+ <td>Export</td>+ <td>POST</td>+ <td>/v1/{name=projects/*/rollouts/*}:export</td>+ <td>*</td>+ </tr>- <tr>- <td>source_catalog</td>- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>- <td></td>- <td><p> </p></td>- </tr>+ <tr>+ <td>Export</td>+ <td>POST</td>+ <td>/v1/{name=projects/*/rollouts/*/stages/*}:export</td>+ <td>*</td>+ </tr>- <tr>- <td>target_catalog</td>- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</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 of the schema. </p></td>- </tr>- </tbody>- </table>------ <h3 id="bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</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>DiffMetadata</td>+ <td>POST</td>+ <td>/v1/schemaDesign:diffMetadata</td>+ <td>*</td>+ </tr>+++- <tr>- <td>diff</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The diff of the metadata. </p></td>- </tr>+ <tr>+ <td>AICompletion</td>+ <td>POST</td>+ <td>/v1/sql/aiCompletion</td>+ <td>*</td>+ </tr>+</tbody></table>--+- <h3 id="bytebase.v1.ExportRequest">ExportRequest</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.BatchCancelPlanCheckRunsRequest">BatchCancelPlanCheckRunsRequest</h3><p></p>@@ -21409,68 +21472,20 @@ 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><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>- </tr>-- <tr>- <td>password</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The zip password provide by users. </p></td>- </tr>-- <tr>- <td>data_source_id</td>+ <td>parent</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>+ <td><p>The name of the parent of the planChecks.+Format: projects/{project}/plans/{plan} </p></td></tr><tr>- <td>schema</td>+ <td>plan_check_runs</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>repeated</td>+ <td><p>TODO(d): update this API.+The planCheckRuns to cancel.+Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} </p></td></tr></tbody>@@ -21480,7 +21495,14 @@ Oracle and search path in Postgres. </p></td>- <h3 id="bytebase.v1.ExportResponse">ExportResponse</h3>+ <h3 id="bytebase.v1.BatchCancelPlanCheckRunsResponse">BatchCancelPlanCheckRunsResponse</h3>+ <p></p>++++++ <h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</h3><p></p>@@ -21491,10 +21513,18 @@ Oracle and search path in Postgres. </p></td><tbody><tr>- <td>content</td>- <td><a href="#bytes">bytes</a></td>+ <td>parent</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The export file content. </p></td>+ <td><p>The parent project where this plan will be created.+Format: projects/{project} </p></td>+ </tr>++ <tr>+ <td>plan</td>+ <td><a href="#bytebase.v1.Plan">Plan</a></td>+ <td></td>+ <td><p>The plan to create. </p></td></tr></tbody>@@ -21504,7 +21534,7 @@ Oracle and search path in Postgres. </p></td>- <h3 id="bytebase.v1.MaskingReason">MaskingReason</h3>+ <h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3><p></p>@@ -21515,52 +21545,11 @@ Oracle and search path in Postgres. </p></td><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., "SSN", "email", "phone"). </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., "Matched global rule: PII Protection"). </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>name</td><td><a href="#string">string</a></td><td></td>- <td><p>Icon associated with the semantic type (if any). </p></td>+ <td><p>The name of the plan to retrieve.+Format: projects/{project}/plans/{plan} </p></td></tr></tbody>@@ -21570,7 +21559,7 @@ Oracle and search path in Postgres. </p></td>- <h3 id="bytebase.v1.QueryHistory">QueryHistory</h3>+ <h3 id="bytebase.v1.ListPlanCheckRunsRequest">ListPlanCheckRunsRequest</h3><p></p>@@ -21581,61 +21570,36 @@ Oracle and search path in Postgres. </p></td><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>parent</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>+ <td><p>The parent, which owns this collection of plan check runs.+Format: projects/{project}/plans/{plan} </p></td></tr><tr>- <td>statement</td>- <td><a href="#string">string</a></td>+ <td>latest_only</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>If set to true, only the latest plan check run will be returned. </p></td></tr><tr>- <td>error</td>+ <td>filter</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>+ <td><p>Filter is used to filter plan check runs returned in the list.+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec++Supported filters:+- status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values.+- result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.++For example:+status in ["DONE", "FAILED"]+status == "RUNNING"+result_status in ["SUCCESS", "ERROR"]+result_status == "WARNING" </p></td></tr></tbody>@@ -21645,7 +21609,7 @@ Format: instances/{instance}/databases/{databaseName} </p></td>- <h3 id="bytebase.v1.QueryOption">QueryOption</h3>+ <h3 id="bytebase.v1.ListPlanCheckRunsResponse">ListPlanCheckRunsResponse</h3><p></p>@@ -21656,17 +21620,10 @@ Format: instances/{instance}/databases/{databaseName} </p></td><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>+ <td>plan_check_runs</td>+ <td><a href="#bytebase.v1.PlanCheckRun">PlanCheckRun</a></td>+ <td>repeated</td>+ <td><p>The plan check runs from the specified request. </p></td></tr></tbody>@@ -21676,7 +21633,7 @@ Format: instances/{instance}/databases/{databaseName} </p></td>- <h3 id="bytebase.v1.QueryRequest">QueryRequest</h3>+ <h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3><p></p>@@ -21687,65 +21644,33 @@ Format: instances/{instance}/databases/{databaseName} </p></td><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>parent</td><td><a href="#string">string</a></td><td></td>- <td><p>The SQL statement to execute. </p></td>+ <td><p>The parent, which owns this collection of plans.+Format: projects/{project}+Use "projects/-" to list all plans from all projects. </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>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>+ <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>schema</td>+ <td>page_token</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>+ <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></tbody>@@ -21755,7 +21680,7 @@ CosmosDB only. </p></td>- <h3 id="bytebase.v1.QueryResponse">QueryResponse</h3>+ <h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3><p></p>@@ -21766,10 +21691,18 @@ CosmosDB only. </p></td><tbody><tr>- <td>results</td>- <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>+ <td>plans</td>+ <td><a href="#bytebase.v1.Plan">Plan</a></td><td>repeated</td>- <td><p>The query results. </p></td>+ <td><p>The plans 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>@@ -21779,7 +21712,7 @@ CosmosDB only. </p></td>- <h3 id="bytebase.v1.QueryResult">QueryResult</h3>+ <h3 id="bytebase.v1.Plan">Plan</h3><p></p>@@ -21790,89 +21723,98 @@ CosmosDB only. </p></td><tbody><tr>- <td>column_names</td>+ <td>name</td><td><a href="#string">string</a></td>- <td>repeated</td>- <td><p>Column names of the query result. </p></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>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>+ <td>state</td>+ <td><a href="#bytebase.v1.State">State</a></td>+ <td></td>+ <td><p>The state of the plan. </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>+ <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><tr>- <td>rows_count</td>- <td><a href="#int64">int64</a></td>+ <td>rollout</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The rollout associated with the plan.+Can be empty.+Format: projects/{project}/rollouts/{rollout} </p></td></tr><tr>- <td>error</td>+ <td>title</td><td><a href="#string">string</a></td><td></td>- <td><p>The error message if the query failed. </p></td>+ <td><p>The title of the plan. </p></td></tr><tr>- <td>latency</td>- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>+ <td>description</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The time it takes to execute the query. </p></td>+ <td><p>The description of the plan. </p></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>+ <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>postgres_error</td>- <td><a href="#bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</a></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>syntax_error</td>- <td><a href="#bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</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>permission_denied</td>- <td><a href="#bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</a></td>+ <td>update_time</td>+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</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>plan_check_run_status_count</td>+ <td><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</a></td><td>repeated</td>- <td><p>Informational or debug messages returned by the database engine during query execution.-Examples include PostgreSQL's RAISE NOTICE, MSSQL's PRINT, or Oracle's DBMS_OUTPUT.PUT_LINE. </p></td>+ <td><p>The status count of the latest plan check runs.+Keys are:+- SUCCESS+- WARNING+- ERROR+- RUNNING </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>+ <td>deployment</td>+ <td><a href="#bytebase.v1.Plan.Deployment">Plan.Deployment</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -21882,7 +21824,7 @@ Examples include PostgreSQL's RAISE NOTICE, MSSQL's PRINT, or Oracle'- <h3 id="bytebase.v1.QueryResult.Message">QueryResult.Message</h3>+ <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3><p></p>@@ -21893,19 +21835,58 @@ Examples include PostgreSQL's RAISE NOTICE, MSSQL's PRINT, or Oracle'<tbody><tr>- <td>level</td>- <td><a href="#bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</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>content</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>type</td>+ <td><a href="#bytebase.v1.DatabaseChangeType">DatabaseChangeType</a></td>+ <td></td>+ <td><p>Type is the database change type. </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>enable_prior_backup</td>+ <td><a href="#bool">bool</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>+ </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>+</tbody></table>@@ -21913,8 +21894,8 @@ Examples include PostgreSQL's RAISE NOTICE, MSSQL's PRINT, or Oracle'- <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.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</h3>+ <p></p><table class="field-table">@@ -21924,22 +21905,17 @@ Examples include PostgreSQL's RAISE NOTICE, MSSQL's PRINT, or Oracle'<tbody><tr>- <td>resources</td>+ <td>key</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> </p></td></tr><tr>- <td>command_type</td>- <td><a href="#bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</a></td>+ <td>value</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Disallowed command_type. </p></td>+ <td><p> </p></td></tr></tbody>@@ -21949,8 +21925,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.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</h3>+ <p></p><table class="field-table">@@ -21960,122 +21936,173 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></<tbody><tr>- <td>severity</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>code</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>message</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>detail</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>hint</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>position</td>- <td><a href="#int32">int32</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>internal_position</td>- <td><a href="#int32">int32</a></td>+ <td>cluster</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for "ON CLUSTER <<cluster>>". </p></td></tr><tr>- <td>internal_query</td>+ <td>owner</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>owner is the owner of the database. This is only applicable to Postgres for "WITH OWNER <<owner>>". </p></td></tr><tr>- <td>where</td>+ <td>environment</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The environment resource.+Format: environments/prod where prod is the environment resource ID. </p></td></tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.Plan.Deployment">Plan.Deployment</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_name</td>+ <td>environments</td><td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>+ <td>repeated</td>+ <td><p>The environments deploy order. </p></td></tr><tr>- <td>table_name</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>+ <td>database_group_mappings</td>+ <td><a href="#bytebase.v1.Plan.Deployment.DatabaseGroupMapping">Plan.Deployment.DatabaseGroupMapping</a></td>+ <td>repeated</td>+ <td><p>The database group mapping. </p></td></tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.Plan.Deployment.DatabaseGroupMapping">Plan.Deployment.DatabaseGroupMapping</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>column_name</td>+ <td>database_group</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Format: projects/{project}/databaseGroups/{databaseGroup}. </p></td></tr><tr>- <td>data_type_name</td>+ <td>databases</td><td><a href="#string">string</a></td>- <td></td>- <td><p> </p></td>+ <td>repeated</td>+ <td><p>Format: instances/{instance-id}/databases/{database-name}. </p></td></tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.Plan.ExportDataConfig">Plan.ExportDataConfig</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>constraint_name</td>+ <td>targets</td><td><a href="#string">string</a></td>- <td></td>- <td><p> </p></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>file</td>+ <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>line</td>- <td><a href="#int32">int32</a></td>+ <td>format</td>+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td><td></td>- <td><p> </p></td>+ <td><p>The format of the exported file. </p></td></tr><tr>- <td>routine</td>+ <td>password</td><td><a href="#string">string</a></td>- <td></td>- <td><p> </p></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>@@ -22085,8 +22112,8 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></- <h3 id="bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</h3>- <p>Syntax error with position information for editor highlighting</p>+ <h3 id="bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</h3>+ <p></p><table class="field-table">@@ -22096,10 +22123,17 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></<tbody><tr>- <td>start_position</td>- <td><a href="#bytebase.v1.Position">Position</a></td>+ <td>key</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Position information for highlighting in editor </p></td>+ <td><p> </p></td>+ </tr>++ <tr>+ <td>value</td>+ <td><a href="#int32">int32</a></td>+ <td></td>+ <td><p> </p></td></tr></tbody>@@ -22109,7 +22143,7 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></- <h3 id="bytebase.v1.QueryRow">QueryRow</h3>+ <h3 id="bytebase.v1.Plan.Spec">Plan.Spec</h3><p></p>@@ -22120,10 +22154,31 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></<tbody><tr>- <td>values</td>- <td><a href="#bytebase.v1.RowValue">RowValue</a></td>- <td>repeated</td>- <td><p>Row values of the query result. </p></td>+ <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></td>+ <td><p> </p></td></tr></tbody>@@ -22133,7 +22188,7 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></- <h3 id="bytebase.v1.RowValue">RowValue</h3>+ <h3 id="bytebase.v1.PlanCheckRun">PlanCheckRun</h3><p></p>@@ -22144,98 +22199,118 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></<tbody><tr>- <td>null_value</td>- <td><a href="#google.protobuf.NullValue">google.protobuf.NullValue</a></td>+ <td>name</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} </p></td></tr><tr>- <td>bool_value</td>- <td><a href="#bool">bool</a></td>+ <td>type</td>+ <td><a href="#bytebase.v1.PlanCheckRun.Type">PlanCheckRun.Type</a></td><td></td><td><p> </p></td></tr><tr>- <td>bytes_value</td>- <td><a href="#bytes">bytes</a></td>+ <td>status</td>+ <td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td><td></td><td><p> </p></td></tr><tr>- <td>double_value</td>- <td><a href="#double">double</a></td>+ <td>target</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Format: instances/{instance}/databases/{database} </p></td></tr><tr>- <td>float_value</td>- <td><a href="#float">float</a></td>+ <td>sheet</td>+ <td><a href="#string">string</a></td><td></td>+ <td><p>Format: project/{project}/sheets/{sheet} </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></tr><tr>- <td>int32_value</td>- <td><a href="#int32">int32</a></td>+ <td>error</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>error is set if the Status is FAILED. </p></td></tr><tr>- <td>int64_value</td>- <td><a href="#int64">int64</a></td>+ <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.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>string_value</td>- <td><a href="#string">string</a></td>+ <td>status</td>+ <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td><td></td><td><p> </p></td></tr><tr>- <td>uint32_value</td>- <td><a href="#uint32">uint32</a></td>+ <td>title</td>+ <td><a href="#string">string</a></td><td></td><td><p> </p></td></tr><tr>- <td>uint64_value</td>- <td><a href="#uint64">uint64</a></td>+ <td>content</td>+ <td><a href="#string">string</a></td><td></td><td><p> </p></td></tr><tr>- <td>value_value</td>- <td><a href="#google.protobuf.Value">google.protobuf.Value</a></td>+ <td>code</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. </p></td>+ <td><p> </p></td></tr><tr>- <td>timestamp_value</td>- <td><a href="#bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</a></td>+ <td>sql_summary_report</td>+ <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</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> </p></td></tr><tr>- <td>timestamp_tz_value</td>- <td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</a></td>+ <td>sql_review_report</td>+ <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</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> </p></td></tr></tbody>@@ -22245,7 +22320,7 @@ accurately represents the timestamp with location information. </p></td>- <h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3>+ <h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3><p></p>@@ -22256,17 +22331,17 @@ 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>start_position</td>+ <td><a href="#bytebase.v1.Position">Position</a></td><td></td>- <td><p> </p></td>+ <td><p>Position of the SQL statement. </p></td></tr><tr>- <td>accuracy</td>- <td><a href="#int32">int32</a></td>+ <td>end_position</td>+ <td><a href="#bytebase.v1.Position">Position</a></td><td></td>- <td><p>The accuracy is the number of digits after the decimal point. </p></td>+ <td><p> </p></td></tr></tbody>@@ -22276,7 +22351,7 @@ accurately represents the timestamp with location information. </p></td>- <h3 id="bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</h3>+ <h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3><p></p>@@ -22287,36 +22362,58 @@ 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>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><tr>- <td>zone</td>- <td><a href="#string">string</a></td>+ <td>changed_resources</td>+ <td><a href="#bytebase.v1.ChangedResources">ChangedResources</a></td><td></td>- <td><p>Zone is the time zone abbreviations in timezone database such as "PDT",-"PST". 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>+ <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>offset</td>- <td><a href="#int32">int32</a></td>+ <td>name</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The offset is in seconds east of UTC </p></td>+ <td><p>The plan to run plan checks.+Format: projects/{project}/plans/{plan} </p></td></tr><tr>- <td>accuracy</td>- <td><a href="#int32">int32</a></td>- <td></td>- <td><p> </p></td>+ <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>@@ -22326,7 +22423,14 @@ time.Time.Zone() </p></td>- <h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3>+ <h3 id="bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</h3>+ <p></p>++++++ <h3 id="bytebase.v1.SearchPlansRequest">SearchPlansRequest</h3><p></p>@@ -22336,13 +22440,22 @@ time.Time.Zone() </p></td></thead><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 "projects/-" to list all plans 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 histories to return.-The service may return fewer than this value.-If unspecified, at most 10 history entries will be returned.+ <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>@@ -22350,32 +22463,36 @@ 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 `ListQueryHistory` call.-Provide this to retrieve the subsequent page. </p></td>+ <td><p>A page token, received from a previous `SearchPlans` call.+Provide this to retrieve the subsequent page.++When paginating, all other parameters provided to `SearchPlans` 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 the filter to apply on the search query history+ <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 filter:-- project: the project full name in "projects/{id}" format, support "==" operator.-- database: the database full name in "instances/{id}/databases/{name}" format, support "==" operator.-- instance: the instance full name in "instances/{id}" format, support "==" operator.-- type: the type, should be "QUERY" or "EXPORT", support "==" operator.-- statement: the SQL statement, support ".matches()" operator.+Supported filters:+- creator: the plan creator full name in "users/{email or id}" format, support "==" operator.+- create_time: the plan create time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator.+- has_pipeline: the plan has pipeline or not, support "==" operator, the value should be "true" or "false".+- has_issue: the plan has issue or not, support "==" operator, the value should be "true" or "false".+- title: the plan title, support "==" operator for exact match and ".matches()" operator for case-insensitive substring match.+- spec_type: the plan spec config type, support "==" operator, the value should be "create_database_config", "change_database_config", or "export_data_config".+- state: the plan state, support "==" operator, the value should be "ACTIVE" or "DELETED".For example:-project == "projects/{project}"-database == "instances/{instance}/databases/{database}"-instance == "instances/{instance}"-type == "QUERY"-type == "EXPORT"-statement.matches("select")-type == "QUERY" && statement.matches("select") </p></td>+creator == "users/[email protected]" && create_time >= "2025-01-02T15:04:05Z07:00"+has_pipeline == false && has_issue == true+title == "My Plan"+title.matches("database migration")+spec_type == "change_database_config"+state == "ACTIVE" </p></td></tr></tbody>@@ -22385,7 +22502,7 @@ type == "QUERY" && statement.matches("select") </p></td>- <h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</h3>+ <h3 id="bytebase.v1.SearchPlansResponse">SearchPlansResponse</h3><p></p>@@ -22396,19 +22513,18 @@ type == "QUERY" && statement.matches("select") </p></td><tbody><tr>- <td>query_histories</td>- <td><a href="#bytebase.v1.QueryHistory">QueryHistory</a></td>+ <td>plans</td>+ <td><a href="#bytebase.v1.Plan">Plan</a></td><td>repeated</td>- <td><p>The list of history. </p></td>+ <td><p>The plans 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 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>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>@@ -22418,104 +22534,51 @@ Pass this value in the page_token field in the subsequent call to+ <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'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.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.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="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.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</h3>+ <h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</h3><p></p><table class="enum-table"><thead>@@ -22524,56 +22587,39 @@ These are custom, flexible checks powered by AI models.</p></td><tbody><tr>- <td>MSSQL_EXPLAIN_FORMAT_UNSPECIFIED</td>+ <td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p>defaults to SHOWPLAN_ALL</p></td>+ <td><p></p></td></tr><tr>- <td>MSSQL_EXPLAIN_FORMAT_ALL</td>+ <td>RUNNING</td><td>1</td>- <td><p>SHOWPLAN_ALL</p></td>+ <td><p></p></td></tr><tr>- <td>MSSQL_EXPLAIN_FORMAT_XML</td>+ <td>DONE</td><td>2</td>- <td><p>SHOWPLAN_XML</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><p></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>FAILED</td>+ <td>3</td>+ <td><p></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>CANCELED</td>+ <td>4</td>+ <td><p></p></td></tr></tbody></table>- <h3 id="bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</h3>+ <h3 id="bytebase.v1.PlanCheckRun.Type">PlanCheckRun.Type</h3><p></p><table class="enum-table"><thead>@@ -22582,80 +22628,39 @@ These are custom, flexible checks powered by AI models.</p></td><tbody><tr>- <td>LEVEL_UNSPECIFIED</td>+ <td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p>Unspecified message level.</p></td>+ <td><p>Unspecified check type.</p></td></tr><tr>- <td>INFO</td>+ <td>DATABASE_STATEMENT_FAKE_ADVISE</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>+ <td><p>Fake advise check for testing purposes without executing against database.</p></td></tr><tr>- <td>DEBUG</td>+ <td>DATABASE_STATEMENT_ADVISE</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>+ <td><p>SQL review check that analyzes statements against configured SQL review rules.</p></td></tr><tr>- <td>NOTICE</td>+ <td>DATABASE_STATEMENT_SUMMARY_REPORT</td><td>5</td>- <td><p>Notice message for important information.</p></td>+ <td><p>Summary report check that generates impact analysis for the statements.</p></td></tr><tr>- <td>EXCEPTION</td>+ <td>DATABASE_CONNECT</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>+ <td><p>Connection check that verifies database connectivity.</p></td></tr><tr>- <td>NON_READ_ONLY</td>- <td>3</td>- <td><p></p></td>+ <td>DATABASE_GHOST_SYNC</td>+ <td>7</td>+ <td><p>Ghost sync check that validates gh-ost online schema change compatibility.</p></td></tr></tbody>@@ -22665,8 +22670,8 @@ These are custom, flexible checks powered by AI models.</p></td>- <h3 id="bytebase.v1.SQLService">SQLService</h3>- <p>SQLService executes SQL queries and manages query operations.</p>+ <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>@@ -22674,51 +22679,68 @@ These are custom, flexible checks powered by AI models.</p></td><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>+ <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>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>+ <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><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's own query histories)</p></td>+ <td>SearchPlans</td>+ <td><a href="#bytebase.v1.SearchPlansRequest">SearchPlansRequest</a></td>+ <td><a href="#bytebase.v1.SearchPlansResponse">SearchPlansResponse</a></td>+ <td><p>Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query.+Permissions required: bb.plans.get</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>+ <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>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>+ <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>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>+ <td>ListPlanCheckRuns</td>+ <td><a href="#bytebase.v1.ListPlanCheckRunsRequest">ListPlanCheckRunsRequest</a></td>+ <td><a href="#bytebase.v1.ListPlanCheckRunsResponse">ListPlanCheckRunsResponse</a></td>+ <td><p>Lists plan check runs for a deployment plan.+Permissions required: bb.planCheckRuns.list</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>+ </tr>++ <tr>+ <td>BatchCancelPlanCheckRuns</td>+ <td><a href="#bytebase.v1.BatchCancelPlanCheckRunsRequest">BatchCancelPlanCheckRunsRequest</a></td>+ <td><a href="#bytebase.v1.BatchCancelPlanCheckRunsResponse">BatchCancelPlanCheckRunsResponse</a></td>+ <td><p>Cancels multiple plan check runs.+Permissions required: bb.planCheckRuns.run</p></td></tr></tbody>@@ -22742,19 +22764,19 @@ Permissions required: None (authenticated users only, requires AI to be enabled)<tr>- <td>Query</td>- <td>POST</td>- <td>/v1/{name=instances/*/databases/*}:query</td>- <td>*</td>+ <td>GetPlan</td>+ <td>GET</td>+ <td>/v1/{name=projects/*/plans/*}</td>+ <td></td></tr><tr>- <td>AdminExecute</td>+ <td>ListPlans</td><td>GET</td>- <td>/v1:adminExecute</td>+ <td>/v1/{parent=projects/*}/plans</td><td></td></tr>@@ -22762,9 +22784,9 @@ Permissions required: None (authenticated users only, requires AI to be enabled)<tr>- <td>SearchQueryHistories</td>+ <td>SearchPlans</td><td>POST</td>- <td>/v1/queryHistories:search</td>+ <td>/v1/{parent=projects/*}/plans:search</td><td>*</td></tr>@@ -22772,33 +22794,39 @@ Permissions required: None (authenticated users only, requires AI to be enabled)<tr>- <td>Export</td>+ <td>CreatePlan</td><td>POST</td>- <td>/v1/{name=instances/*/databases/*}:export</td>- <td>*</td>+ <td>/v1/{parent=projects/*}/plans</td>+ <td>plan</td></tr>+++<tr>- <td>Export</td>- <td>POST</td>- <td>/v1/{name=projects/*/rollouts/*}:export</td>- <td>*</td>+ <td>UpdatePlan</td>+ <td>PATCH</td>+ <td>/v1/{plan.name=projects/*/plans/*}</td>+ <td>plan</td></tr>+++<tr>- <td>Export</td>- <td>POST</td>- <td>/v1/{name=projects/*/rollouts/*/stages/*}:export</td>- <td>*</td>+ <td>ListPlanCheckRuns</td>+ <td>GET</td>+ <td>/v1/{parent=projects/*/plans/*}/planCheckRuns</td>+ <td></td></tr><tr>- <td>DiffMetadata</td>+ <td>RunPlanChecks</td><td>POST</td>- <td>/v1/schemaDesign:diffMetadata</td>+ <td>/v1/{name=projects/*/plans/*}:runPlanChecks</td><td>*</td></tr>@@ -22806,9 +22834,9 @@ Permissions required: None (authenticated users only, requires AI to be enabled)<tr>- <td>AICompletion</td>+ <td>BatchCancelPlanCheckRuns</td><td>POST</td>- <td>/v1/sql/aiCompletion</td>+ <td>/v1/{parent=projects/*/plans/*}/planCheckRuns:batchCancel</td><td>*</td></tr>@@ -22820,53 +22848,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.BatchCancelPlanCheckRunsRequest">BatchCancelPlanCheckRunsRequest</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 name of the parent of the planChecks.-Format: projects/{project}/plans/{plan} </p></td>- </tr>-- <tr>- <td>plan_check_runs</td>- <td><a href="#string">string</a></td>- <td>repeated</td>- <td><p>TODO(d): update this API.-The planCheckRuns to cancel.-Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} </p></td>- </tr>-- </tbody>- </table>------ <h3 id="bytebase.v1.BatchCancelPlanCheckRunsResponse">BatchCancelPlanCheckRunsResponse</h3>- <p></p>+ <h3 id="bytebase.v1.Activity">Activity</h3>+ <p>Activity types for webhook notifications.</p>- <h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</h3>+ <h3 id="bytebase.v1.AddWebhookRequest">AddWebhookRequest</h3><p></p>@@ -22877,18 +22871,18 @@ Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} </p></td><tbody><tr>- <td>parent</td>+ <td>project</td><td><a href="#string">string</a></td><td></td>- <td><p>The parent project where this plan will be created.+ <td><p>The name of the project to add the webhook to.Format: projects/{project} </p></td></tr><tr>- <td>plan</td>- <td><a href="#bytebase.v1.Plan">Plan</a></td>+ <td>webhook</td>+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td><td></td>- <td><p>The plan to create. </p></td>+ <td><p>The webhook to add. </p></td></tr></tbody>@@ -22898,7 +22892,7 @@ Format: projects/{project} </p></td>- <h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3>+ <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3><p></p>@@ -22909,11 +22903,21 @@ Format: projects/{project} </p></td><tbody><tr>- <td>name</td>+ <td>names</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>+ </tr>++ <tr>+ <td>force</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>The name of the plan to retrieve.-Format: projects/{project}/plans/{plan} </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>@@ -22923,7 +22927,7 @@ Format: projects/{project}/plans/{plan} </p></td>- <h3 id="bytebase.v1.ListPlanCheckRunsRequest">ListPlanCheckRunsRequest</h3>+ <h3 id="bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</h3><p></p>@@ -22934,36 +22938,17 @@ Format: projects/{project}/plans/{plan} </p></td><tbody><tr>- <td>parent</td>+ <td>scope</td><td><a href="#string">string</a></td><td></td>- <td><p>The parent, which owns this collection of plan check runs.-Format: projects/{project}/plans/{plan} </p></td>- </tr>-- <tr>- <td>latest_only</td>- <td><a href="#bool">bool</a></td>- <td></td>- <td><p>If set to true, only the latest plan check run will be returned. </p></td>+ <td><p>The scope of the batch get. Typically it's "projects/-". </p></td></tr><tr>- <td>filter</td>+ <td>names</td><td><a href="#string">string</a></td>- <td></td>- <td><p>Filter is used to filter plan check runs returned in the list.-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec--Supported filters:-- status: the plan check run status, support "==" and "in" operator, check the Status enum in the PlanCheckRun message for the values.-- result_status: the plan check run result status, support "==" and "in" operator, check the Result.Status enum in the PlanCheckRun message for the values.--For example:-status in ["DONE", "FAILED"]-status == "RUNNING"-result_status in ["SUCCESS", "ERROR"]-result_status == "WARNING" </p></td>+ <td>repeated</td>+ <td><p> </p></td></tr></tbody>@@ -22973,7 +22958,7 @@ result_status == "WARNING" </p></td>- <h3 id="bytebase.v1.ListPlanCheckRunsResponse">ListPlanCheckRunsResponse</h3>+ <h3 id="bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</h3><p></p>@@ -22984,10 +22969,10 @@ result_status == "WARNING" </p></td><tbody><tr>- <td>plan_check_runs</td>- <td><a href="#bytebase.v1.PlanCheckRun">PlanCheckRun</a></td>+ <td>policy_results</td>+ <td><a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</a></td><td>repeated</td>- <td><p>The plan check runs from the specified request. </p></td>+ <td><p>The policy results for each requested project. </p></td></tr></tbody>@@ -22997,8 +22982,8 @@ result_status == "WARNING" </p></td>- <h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3>- <p></p>+ <h3 id="bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</h3>+ <p>Result for a single project's IAM policy.</p><table class="field-table">@@ -23008,33 +22993,17 @@ result_status == "WARNING" </p></td><tbody><tr>- <td>parent</td>+ <td>project</td><td><a href="#string">string</a></td><td></td>- <td><p>The parent, which owns this collection of plans.-Format: projects/{project}-Use "projects/-" to list all plans 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 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 resource name. </p></td></tr><tr>- <td>page_token</td>- <td><a href="#string">string</a></td>+ <td>policy</td>+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td><td></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>+ <td><p>The IAM policy for the project. </p></td></tr></tbody>@@ -23044,7 +23013,7 @@ the call that provided the page token. </p></td>- <h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3>+ <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3><p></p>@@ -23055,18 +23024,21 @@ the call that provided the page token. </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>project</td>+ <td><a href="#bytebase.v1.Project">Project</a></td>+ <td></td>+ <td><p>The project to create. </p></td></tr><tr>- <td>next_page_token</td>+ <td>project_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 project, which will become the final component of+the project's resource name.++This value should be 4-63 characters, and valid characters+are /[a-z][0-9]-/. </p></td></tr></tbody>@@ -23076,109 +23048,67 @@ If this field is omitted, there are no subsequent pages. </p></td>- <h3 id="bytebase.v1.Plan">Plan</h3>+ <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</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 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>- </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>-- <tr>- <td>rollout</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The rollout associated with the plan.-Can be empty.-Format: projects/{project}/rollouts/{rollout} </p></td>- </tr>-- <tr>- <td>title</td>- <td><a href="#string">string</a></td>- <td></td>- <td><p>The title of the plan. </p></td>- </tr>-- <tr>- <td>description</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>- </tr>+ <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>name</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: users/[email protected] </p></td>+ <td><p>The name of the project to delete.+Format: projects/{project} </p></td></tr><tr>- <td>create_time</td>- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>+ <td>force</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </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>update_time</td>- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>+ <td>purge</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></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>- <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>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</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>deployment</td>- <td><a href="#bytebase.v1.Plan.Deployment">Plan.Deployment</a></td>+ <td>name</td>+ <td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The name of the project to retrieve.+Format: projects/{project} </p></td></tr></tbody>@@ -23188,8 +23118,8 @@ Keys are:- <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3>- <p></p>+ <h3 id="bytebase.v1.Label">Label</h3>+ <p>A label for categorizing and organizing issues.</p><table class="field-table">@@ -23199,56 +23129,78 @@ Keys are:<tbody><tr>- <td>targets</td>+ <td>value</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>+ <td></td>+ <td><p>The label value/name. </p></td></tr><tr>- <td>sheet</td>+ <td>color</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>The color code for the label (e.g., hex color). </p></td></tr><tr>- <td>release</td>+ <td>group</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>The group this label belongs to. </p></td></tr>+ </tbody>+ </table>++++++ <h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</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.DatabaseChangeType">DatabaseChangeType</a></td>+ <td>page_size</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>Type is the database change type. </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>ghost_flags</td>- <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</a></td>- <td>repeated</td>- <td><p> </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.+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>enable_prior_backup</td>+ <td>show_deleted</td><td><a href="#bool">bool</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>Show deleted projects if specified. </p></td></tr><tr>- <td>enable_ghost</td>- <td><a href="#bool">bool</a></td>+ <td>filter</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>Filter the project.+Check filter for SearchProjectsRequest for details.+Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == "production"). </p></td></tr></tbody>@@ -23258,7 +23210,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>@@ -23269,17 +23221,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>@@ -23289,7 +23242,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>@@ -23300,124 +23253,141 @@ Format: projects/{project}/releases/{release} </p></td><tbody><tr>- <td>target</td>+ <td>name</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>+ <td><p>The name of the project.+Format: projects/{project} </p></td></tr><tr>- <td>database</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 name of the database to create. </p></td>+ <td><p>The lifecycle state of the project. </p></td></tr><tr>- <td>table</td>+ <td>title</td><td><a href="#string">string</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 title or name of a project. It's not unique within the workspace. </p></td></tr><tr>- <td>character_set</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>data_classification_config_id</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 data classification configuration ID for the project. </p></td></tr><tr>- <td>collation</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>collation is the collation of the database. </p></td>+ <td><p>Force issue labels to be used when creating an issue. </p></td></tr><tr>- <td>cluster</td>- <td><a href="#string">string</a></td>+ <td>allow_modify_statement</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for "ON CLUSTER <<cluster>>". </p></td>+ <td><p>Allow modifying SQL statements after issue is created. </p></td></tr><tr>- <td>owner</td>- <td><a href="#string">string</a></td>+ <td>auto_resolve_issue</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 "WITH OWNER <<owner>>". </p></td>+ <td><p>Enable automatic issue resolution when tasks complete. </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>- </tbody>- </table>------ <h3 id="bytebase.v1.Plan.Deployment">Plan.Deployment</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>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>environments</td>- <td><a href="#string">string</a></td>- <td>repeated</td>- <td><p>The environments deploy order. </p></td>+ <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 "set role <db_owner>" 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>database_group_mappings</td>- <td><a href="#bytebase.v1.Plan.Deployment.DatabaseGroupMapping">Plan.Deployment.DatabaseGroupMapping</a></td>- <td>repeated</td>- <td><p>The database group mapping. </p></td>+ <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.Plan.Deployment.DatabaseGroupMapping">Plan.Deployment.DatabaseGroupMapping</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>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>database_group</td>- <td><a href="#string">string</a></td>+ <td>parallel_tasks_per_rollout</td>+ <td><a href="#int32">int32</a></td><td></td>- <td><p>Format: projects/{project}/databaseGroups/{databaseGroup}. </p></td>+ <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td></tr><tr>- <td>databases</td>- <td><a href="#string">string</a></td>+ <td>labels</td>+ <td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td><td>repeated</td>- <td><p>Format: instances/{instance-id}/databases/{database-name}. </p></td>+ <td><p>Labels are key-value pairs that can be attached to the project.+For example, { "environment": "production", "team": "backend" } </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></tbody>@@ -23427,8 +23397,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">@@ -23438,35 +23408,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>@@ -23476,7 +23421,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>@@ -23495,7 +23440,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>@@ -23507,7 +23452,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>@@ -23518,31 +23463,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>@@ -23552,7 +23476,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>@@ -23563,59 +23487,61 @@ 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></td>- <td><p>Format: projects/{project}/plans/{plan}/planCheckRuns/{planCheckRun} </p></td>- </tr>-- <tr>- <td>type</td>- <td><a href="#bytebase.v1.PlanCheckRun.Type">PlanCheckRun.Type</a></td>- <td></td>- <td><p> </p></td>- </tr>-- <tr>- <td>status</td>- <td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td>+ <td>show_deleted</td>+ <td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Show deleted projects if specified. </p></td></tr><tr>- <td>target</td>+ <td>filter</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: instances/{instance}/databases/{database} </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 "==" and ".matches()" operator.+- resource_id: the project id, support "==" and ".matches()" operator.+- exclude_default: if not include the default project, should be "true" or "false", support "==" operator.+- state: check the State enum for the values, support "==" operator.+- labels.{key}: the project label, support "==" and "in" operators.++For example:+name == "project name"+name.matches("project name")+resource_id == "project id"+resource_id.matches("project id")+exclude_default == true+state == "DELETED"+labels.environment == "production"+labels.tier == "critical"+labels.environment in ["staging", "prod"]+You can combine filter conditions like:+name == "project name" && resource_id.matches("project id")+name.matches("project name") || resource_id == "project id"+labels.environment == "production" && labels.tier == "critical" </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>Format: project/{project}/sheets/{sheet} </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><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>- </tr>-- <tr>- <td>create_time</td>- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>- <td></td>- <td><p> </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></tbody>@@ -23625,7 +23551,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>@@ -23636,45 +23562,18 @@ 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>- </tr>-- <tr>- <td>title</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>content</td>+ <td>next_page_token</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>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>+ <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>@@ -23684,7 +23583,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>- <h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3>+ <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3><p></p>@@ -23695,17 +23594,18 @@ Leave it empty if no needs to encrypt the zip file. </p></td><tbody><tr>- <td>start_position</td>- <td><a href="#bytebase.v1.Position">Position</a></td>+ <td>project</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>Position of the SQL statement. </p></td>+ <td><p>The name of the project which owns the webhook to test.+Format: projects/{project} </p></td></tr><tr>- <td>end_position</td>- <td><a href="#bytebase.v1.Position">Position</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></tbody>@@ -23715,7 +23615,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>- <h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3>+ <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3><p></p>@@ -23726,24 +23626,10 @@ Leave it empty if no needs to encrypt the zip file. </p></td><tbody><tr>- <td>statement_types</td>+ <td>error</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>-- <tr>- <td>changed_resources</td>- <td><a href="#bytebase.v1.ChangedResources">ChangedResources</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>@@ -23753,7 +23639,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td>- <h3 id="bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</h3>+ <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3><p></p>@@ -23767,17 +23653,8 @@ Leave it empty if no needs to encrypt the zip file. </p></td><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>+ <td><p>The name of the deleted project.+Format: projects/{project} </p></td></tr></tbody>@@ -23787,14 +23664,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.SearchPlansRequest">SearchPlansRequest</h3>+ <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3><p></p>@@ -23805,58 +23675,28 @@ If not set, all specs in the plan will be used. </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 "projects/-" 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 update.++The project's `name` field is used to identify the project to update.+Format: projects/{project} </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 `SearchPlans` call.-Provide this to retrieve the subsequent page.--When paginating, all other parameters provided to `SearchPlans` must match-the call that provided the page token. </p></td>+ <td><p>The list of fields to update. </p></td></tr><tr>- <td>filter</td>- <td><a href="#string">string</a></td>+ <td>allow_missing</td>+ <td><a href="#bool">bool</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 "users/{email or id}" format, support "==" operator.-- create_time: the plan create time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator.-- has_pipeline: the plan has pipeline or not, support "==" operator, the value should be "true" or "false".-- has_issue: the plan has issue or not, support "==" operator, the value should be "true" or "false".-- title: the plan title, support "==" operator for exact match and ".matches()" operator for case-insensitive substring match.-- spec_type: the plan spec config type, support "==" operator, the value should be "create_database_config", "change_database_config", or "export_data_config".-- state: the plan state, support "==" operator, the value should be "ACTIVE" or "DELETED".--For example:-creator == "users/[email protected]" && create_time >= "2025-01-02T15:04:05Z07:00"-has_pipeline == false && has_issue == true-title == "My Plan"-title.matches("database migration")-spec_type == "change_database_config"-state == "ACTIVE" </p></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>@@ -23866,7 +23706,7 @@ state == "ACTIVE" </p></td>- <h3 id="bytebase.v1.SearchPlansResponse">SearchPlansResponse</h3>+ <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3><p></p>@@ -23877,18 +23717,25 @@ state == "ACTIVE" </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>webhook</td>+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>+ <td></td>+ <td><p>The webhook to modify. </p></td></tr><tr>- <td>next_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 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 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>@@ -23898,7 +23745,7 @@ If this field is omitted, there are no subsequent pages. </p></td>- <h3 id="bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</h3>+ <h3 id="bytebase.v1.Webhook">Webhook</h3><p></p>@@ -23909,28 +23756,60 @@ If this field is omitted, there are no subsequent pages. </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'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_CREATE+- ISSUE_COMMENT_CREATE+- ISSUE_FIELD_UPDATE+- ISSUE_STATUS_UPDATE+- ISSUE_APPROVAL_NOTIFY+- ISSUE_PIPELINE_STAGE_STATUS_UPDATE+- ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE+- NOTIFY_ISSUE_APPROVED+- NOTIFY_PIPELINE_ROLLOUT </p></td></tr></tbody>@@ -23942,8 +23821,8 @@ In this situation, `update_mask` is ignored. </p></td>- <h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</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>@@ -23951,160 +23830,203 @@ In this situation, `update_mask` is ignored. </p></td><tbody><tr>- <td>STATUS_UNSPECIFIED</td>+ <td>TYPE_UNSPECIFIED</td><td>0</td>- <td><p></p></td>+ <td><p>Unspecified type.</p></td></tr><tr>- <td>RUNNING</td>+ <td>NOTIFY_ISSUE_APPROVED</td>+ <td>23</td>+ <td><p>Notifications via webhooks.++NOTIFY_ISSUE_APPROVED represents the issue approved notification.</p></td>+ </tr>++ <tr>+ <td>NOTIFY_PIPELINE_ROLLOUT</td>+ <td>24</td>+ <td><p>NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification.</p></td>+ </tr>++ <tr>+ <td>ISSUE_CREATE</td><td>1</td>- <td><p></p></td>+ <td><p>Issue related activity types.++ISSUE_CREATE represents creating an issue.</p></td></tr><tr>- <td>DONE</td>+ <td>ISSUE_COMMENT_CREATE</td><td>2</td>- <td><p></p></td>+ <td><p>ISSUE_COMMENT_CREATE represents commenting on an issue.</p></td></tr><tr>- <td>FAILED</td>+ <td>ISSUE_FIELD_UPDATE</td><td>3</td>- <td><p></p></td>+ <td><p>ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc.</p></td></tr><tr>- <td>CANCELED</td>+ <td>ISSUE_STATUS_UPDATE</td><td>4</td>- <td><p></p></td>+ <td><p>ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now.</p></td>+ </tr>++ <tr>+ <td>ISSUE_APPROVAL_NOTIFY</td>+ <td>21</td>+ <td><p>ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval.</p></td>+ </tr>++ <tr>+ <td>ISSUE_PIPELINE_STAGE_STATUS_UPDATE</td>+ <td>5</td>+ <td><p>ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now.</p></td>+ </tr>++ <tr>+ <td>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE</td>+ <td>22</td>+ <td><p>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED.</p></td></tr></tbody></table>- <h3 id="bytebase.v1.PlanCheckRun.Type">PlanCheckRun.Type</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>TYPE_UNSPECIFIED</td>- <td>0</td>- <td><p>Unspecified check type.</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 "bb.projects.get" permission on the workspace or the project owner can access this method.+Permissions required: bb.projects.get</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></tr><tr>- <td>DATABASE_STATEMENT_FAKE_ADVISE</td>- <td>1</td>- <td><p>Fake advise check for testing purposes without executing against database.</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><tr>- <td>DATABASE_STATEMENT_ADVISE</td>- <td>3</td>- <td><p>SQL review check that analyzes statements against configured SQL review rules.</p></td>+ <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>DATABASE_STATEMENT_SUMMARY_REPORT</td>- <td>5</td>- <td><p>Summary report check that generates impact analysis for the statements.</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's properties.+Permissions required: bb.projects.update</p></td></tr><tr>- <td>DATABASE_CONNECT</td>- <td>6</td>- <td><p>Connection check that verifies database connectivity.</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>DATABASE_GHOST_SYNC</td>- <td>7</td>- <td><p>Ghost sync check that validates gh-ost online schema change compatibility.</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>- </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>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>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>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>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>SearchPlans</td>- <td><a href="#bytebase.v1.SearchPlansRequest">SearchPlansRequest</a></td>- <td><a href="#bytebase.v1.SearchPlansResponse">SearchPlansResponse</a></td>- <td><p>Search for plans that the caller has the bb.plans.get permission on and also satisfy the specified filter & query.-Permissions required: bb.plans.get</p></td>+ <td>BatchGetIamPolicy</td>+ <td><a href="#bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</a></td>+ <td><a href="#bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</a></td>+ <td><p>Deprecated. No permission check implemented.+Permissions required: None</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>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>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>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>ListPlanCheckRuns</td>- <td><a href="#bytebase.v1.ListPlanCheckRunsRequest">ListPlanCheckRunsRequest</a></td>- <td><a href="#bytebase.v1.ListPlanCheckRunsResponse">ListPlanCheckRunsResponse</a></td>- <td><p>Lists plan check runs for a deployment plan.-Permissions required: bb.planCheckRuns.list</p></td>+ <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>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>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>BatchCancelPlanCheckRuns</td>- <td><a href="#bytebase.v1.BatchCancelPlanCheckRunsRequest">BatchCancelPlanCheckRunsRequest</a></td>- <td><a href="#bytebase.v1.BatchCancelPlanCheckRunsResponse">BatchCancelPlanCheckRunsResponse</a></td>- <td><p>Cancels multiple plan check runs.-Permissions required: bb.planCheckRuns.run</p></td>+ <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>@@ -24128,9 +24050,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>@@ -24138,9 +24060,9 @@ Permissions required: bb.planCheckRuns.run</p></td><tr>- <td>ListPlans</td>+ <td>ListProjects</td><td>GET</td>- <td>/v1/{parent=projects/*}/plans</td>+ <td>/v1/projects</td><td></td></tr>@@ -24148,9 +24070,9 @@ Permissions required: bb.planCheckRuns.run</p></td><tr>- <td>SearchPlans</td>+ <td>SearchProjects</td><td>POST</td>- <td>/v1/{parent=projects/*}/plans:search</td>+ <td>/v1/projects:search</td><td>*</td></tr>@@ -24158,29 +24080,59 @@ Permissions required: bb.planCheckRuns.run</p></td><tr>- <td>CreatePlan</td>+ <td>CreateProject</td><td>POST</td>- <td>/v1/{parent=projects/*}/plans</td>- <td>plan</td>+ <td>/v1/projects</td>+ <td>project</td></tr><tr>- <td>UpdatePlan</td>+ <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>ListPlanCheckRuns</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/{parent=projects/*/plans/*}/planCheckRuns</td>+ <td>/v1/{resource=projects/*}:getIamPolicy</td><td></td></tr>@@ -24188,9 +24140,19 @@ Permissions required: bb.planCheckRuns.run</p></td><tr>- <td>RunPlanChecks</td>+ <td>BatchGetIamPolicy</td>+ <td>GET</td>+ <td>/v1/{scope=*/*}/iamPolicies:batchGet</td>+ <td></td>+ </tr>+++++ <tr>+ <td>SetIamPolicy</td><td>POST</td>- <td>/v1/{name=projects/*/plans/*}:runPlanChecks</td>+ <td>/v1/{resource=projects/*}:setIamPolicy</td><td>*</td></tr>@@ -24198,9 +24160,39 @@ Permissions required: bb.planCheckRuns.run</p></td><tr>- <td>BatchCancelPlanCheckRuns</td>+ <td>AddWebhook</td><td>POST</td>- <td>/v1/{parent=projects/*/plans/*}/planCheckRuns:batchCancel</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>diff --git a/proto/v1/v1/database_service.proto b/proto/v1/v1/database_service.protoindex c7083531eb..09cc2630b8 100644--- a/proto/v1/v1/database_service.proto+++ b/proto/v1/v1/database_service.proto@@ -1526,10 +1526,6 @@ message Changelog {SDL = 3;}Type type = 17;-- // True if this changelog's dump version differs from current engine dump version.- // When true and drift is detected, the drift may be a false positive from Bytebase upgrade.- bool dump_version_mismatch = 18;}message GetSchemaStringRequest {