Skip to content

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

fix: move necessary setup info to the actuator api (#18953)

ecmadaoc8c0bc58d90e
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index ea503f27fc..8671b28887 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -6383,6 +6383,9 @@ components:
title: replica_count
format: int32
description: The number of active replicas (servers sharing the same database).
+ restriction:
+ title: restriction
+ $ref: '#/components/schemas/bytebase.v1.Restriction'
title: ActuatorInfo
additionalProperties: false
description: |-
@@ -13869,6 +13872,23 @@ components:
title: ResourcePackage
additionalProperties: false
description: Custom branding resources for the Bytebase instance.
+ bytebase.v1.Restriction:
+ type: object
+ properties:
+ disallowSignup:
+ type: boolean
+ title: disallow_signup
+ description: Whether self-service user signup is disabled.
+ disallowPasswordSignin:
+ type: boolean
+ title: disallow_password_signin
+ description: Whether password-based signin is disabled (except for workspace admins).
+ passwordRestriction:
+ title: password_restriction
+ description: Password complexity and restriction requirements.
+ $ref: '#/components/schemas/bytebase.v1.WorkspaceProfileSetting.PasswordRestriction'
+ title: Restriction
+ additionalProperties: false
bytebase.v1.ReviewConfig:
type: object
properties:
@@ -18761,6 +18781,10 @@ components:
documentation for additional information.
security: []
tags:
+ - name: bytebase.v1.IssueService
+ description: IssueService manages issues for tracking database changes and tasks.
+ - name: bytebase.v1.SettingService
+ description: SettingService manages workspace-level settings and configurations.
- name: bytebase.v1.UserService
description: UserService manages user accounts and authentication.
- name: bytebase.v1.ActuatorService
@@ -18785,8 +18809,6 @@ tags:
description: GroupService manages user groups for organizing users and permissions.
- name: bytebase.v1.IdentityProviderService
description: IdentityProviderService manages external identity providers for SSO authentication.
- - name: bytebase.v1.IssueService
- description: IssueService manages issues for tracking database changes and tasks.
- name: bytebase.v1.OrgPolicyService
description: OrgPolicyService manages organizational policies at various resource levels.
- name: bytebase.v1.SQLService
@@ -18805,8 +18827,6 @@ tags:
description: RoleService manages workspace roles and permissions.
- name: bytebase.v1.RolloutService
description: RolloutService manages the execution of deployment plans.
- - name: bytebase.v1.SettingService
- description: SettingService manages workspace-level settings and configurations.
- name: bytebase.v1.SheetService
description: SheetService manages SQL scripts and saved queries.
- name: bytebase.v1.SubscriptionService
diff --git a/backend/api/v1/actuator_service.go b/backend/api/v1/actuator_service.go
index a363ebf42a..e80d439714 100644
--- a/backend/api/v1/actuator_service.go
+++ b/backend/api/v1/actuator_service.go
@@ -154,6 +154,11 @@ func (s *ActuatorService) getServerInfo(ctx context.Context) (*v1pb.ActuatorInfo
EnableSample: hasSampleInstances,
ExternalUrlFromFlag: s.profile.ExternalURL != "",
ReplicaCount: int32(s.licenseService.CountActiveReplicas(ctx)),
+ Restriction: &v1pb.Restriction{
+ PasswordRestriction: convertToPasswordRestrictionSetting(setting.GetPasswordRestriction()),
+ DisallowSignup: setting.DisallowSignup || s.profile.SaaS,
+ DisallowPasswordSignin: setting.DisallowPasswordSignin,
+ },
}
stats, err := s.store.StatUsers(ctx)
diff --git a/backend/generated-go/v1/actuator_service.pb.go b/backend/generated-go/v1/actuator_service.pb.go
index c17ced1477..608d4ad182 100644
--- a/backend/generated-go/v1/actuator_service.pb.go
+++ b/backend/generated-go/v1/actuator_service.pb.go
@@ -218,6 +218,69 @@ func (*DeleteCacheRequest) Descriptor() ([]byte, []int) {
return file_v1_actuator_service_proto_rawDescGZIP(), []int{4}
}
+type Restriction struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // Whether self-service user signup is disabled.
+ DisallowSignup bool `protobuf:"varint,1,opt,name=disallow_signup,json=disallowSignup,proto3" json:"disallow_signup,omitempty"`
+ // Whether password-based signin is disabled (except for workspace admins).
+ DisallowPasswordSignin bool `protobuf:"varint,2,opt,name=disallow_password_signin,json=disallowPasswordSignin,proto3" json:"disallow_password_signin,omitempty"`
+ // Password complexity and restriction requirements.
+ PasswordRestriction *WorkspaceProfileSetting_PasswordRestriction `protobuf:"bytes,3,opt,name=password_restriction,json=passwordRestriction,proto3" json:"password_restriction,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *Restriction) Reset() {
+ *x = Restriction{}
+ mi := &file_v1_actuator_service_proto_msgTypes[5]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *Restriction) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*Restriction) ProtoMessage() {}
+
+func (x *Restriction) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_actuator_service_proto_msgTypes[5]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use Restriction.ProtoReflect.Descriptor instead.
+func (*Restriction) Descriptor() ([]byte, []int) {
+ return file_v1_actuator_service_proto_rawDescGZIP(), []int{5}
+}
+
+func (x *Restriction) GetDisallowSignup() bool {
+ if x != nil {
+ return x.DisallowSignup
+ }
+ return false
+}
+
+func (x *Restriction) GetDisallowPasswordSignin() bool {
+ if x != nil {
+ return x.DisallowPasswordSignin
+ }
+ return false
+}
+
+func (x *Restriction) GetPasswordRestriction() *WorkspaceProfileSetting_PasswordRestriction {
+ if x != nil {
+ return x.PasswordRestriction
+ }
+ return nil
+}
+
// System information and configuration for the Bytebase instance.
// Actuator concept is similar to the Spring Boot Actuator.
type ActuatorInfo struct {
@@ -259,14 +322,15 @@ type ActuatorInfo struct {
// Whether the external URL is set via command-line flag (and thus cannot be changed via UI).
ExternalUrlFromFlag bool `protobuf:"varint,23,opt,name=external_url_from_flag,json=externalUrlFromFlag,proto3" json:"external_url_from_flag,omitempty"`
// The number of active replicas (servers sharing the same database).
- ReplicaCount int32 `protobuf:"varint,24,opt,name=replica_count,json=replicaCount,proto3" json:"replica_count,omitempty"`
+ ReplicaCount int32 `protobuf:"varint,24,opt,name=replica_count,json=replicaCount,proto3" json:"replica_count,omitempty"`
+ Restriction *Restriction `protobuf:"bytes,25,opt,name=restriction,proto3" json:"restriction,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
func (x *ActuatorInfo) Reset() {
*x = ActuatorInfo{}
- mi := &file_v1_actuator_service_proto_msgTypes[5]
+ mi := &file_v1_actuator_service_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -278,7 +342,7 @@ func (x *ActuatorInfo) String() string {
func (*ActuatorInfo) ProtoMessage() {}
func (x *ActuatorInfo) ProtoReflect() protoreflect.Message {
- mi := &file_v1_actuator_service_proto_msgTypes[5]
+ mi := &file_v1_actuator_service_proto_msgTypes[6]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -291,7 +355,7 @@ func (x *ActuatorInfo) ProtoReflect() protoreflect.Message {
// Deprecated: Use ActuatorInfo.ProtoReflect.Descriptor instead.
func (*ActuatorInfo) Descriptor() ([]byte, []int) {
- return file_v1_actuator_service_proto_rawDescGZIP(), []int{5}
+ return file_v1_actuator_service_proto_rawDescGZIP(), []int{6}
}
func (x *ActuatorInfo) GetVersion() string {
@@ -427,6 +491,13 @@ func (x *ActuatorInfo) GetReplicaCount() int32 {
return 0
}
+func (x *ActuatorInfo) GetRestriction() *Restriction {
+ if x != nil {
+ return x.Restriction
+ }
+ return nil
+}
+
// User statistics by type and state.
type ActuatorInfo_StatUser struct {
state protoimpl.MessageState `protogen:"open.v1"`
@@ -442,7 +513,7 @@ type ActuatorInfo_StatUser struct {
func (x *ActuatorInfo_StatUser) Reset() {
*x = ActuatorInfo_StatUser{}
- mi := &file_v1_actuator_service_proto_msgTypes[6]
+ mi := &file_v1_actuator_service_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -454,7 +525,7 @@ func (x *ActuatorInfo_StatUser) String() string {
func (*ActuatorInfo_StatUser) ProtoMessage() {}
func (x *ActuatorInfo_StatUser) ProtoReflect() protoreflect.Message {
- mi := &file_v1_actuator_service_proto_msgTypes[6]
+ mi := &file_v1_actuator_service_proto_msgTypes[7]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -467,7 +538,7 @@ func (x *ActuatorInfo_StatUser) ProtoReflect() protoreflect.Message {
// Deprecated: Use ActuatorInfo_StatUser.ProtoReflect.Descriptor instead.
func (*ActuatorInfo_StatUser) Descriptor() ([]byte, []int) {
- return file_v1_actuator_service_proto_rawDescGZIP(), []int{5, 0}
+ return file_v1_actuator_service_proto_rawDescGZIP(), []int{6, 0}
}
func (x *ActuatorInfo_StatUser) GetUserType() UserType {
@@ -495,13 +566,17 @@ var File_v1_actuator_service_proto protoreflect.FileDescriptor
const file_v1_actuator_service_proto_rawDesc = "" +
"\n" +
- "\x19v1/actuator_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a\x15v1/user_service.proto\"\x1b\n" +
+ "\x19v1/actuator_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a\x18v1/setting_service.proto\x1a\x15v1/user_service.proto\"\x1b\n" +
"\x19GetResourcePackageRequest\"%\n" +
"\x0fResourcePackage\x12\x12\n" +
"\x04logo\x18\x01 \x01(\fR\x04logo\"\x14\n" +
"\x12SetupSampleRequest\"\x18\n" +
"\x16GetActuatorInfoRequest\"\x14\n" +
- "\x12DeleteCacheRequest\"\xdd\a\n" +
+ "\x12DeleteCacheRequest\"\xec\x01\n" +
+ "\vRestriction\x12,\n" +
+ "\x0fdisallow_signup\x18\x01 \x01(\bB\x03\xe0A\x03R\x0edisallowSignup\x12=\n" +
+ "\x18disallow_password_signin\x18\x02 \x01(\bB\x03\xe0A\x03R\x16disallowPasswordSignin\x12p\n" +
+ "\x14password_restriction\x18\x03 \x01(\v28.bytebase.v1.WorkspaceProfileSetting.PasswordRestrictionB\x03\xe0A\x03R\x13passwordRestriction\"\x9e\b\n" +
"\fActuatorInfo\x12\x1d\n" +
"\aversion\x18\x01 \x01(\tB\x03\xe0A\x03R\aversion\x12\"\n" +
"\n" +
@@ -523,7 +598,8 @@ const file_v1_actuator_service_proto_rawDesc = "" +
"\x14total_instance_count\x18\x15 \x01(\x05B\x03\xe0A\x03R\x12totalInstanceCount\x12(\n" +
"\renable_sample\x18\x16 \x01(\bB\x03\xe0A\x03R\fenableSample\x128\n" +
"\x16external_url_from_flag\x18\x17 \x01(\bB\x03\xe0A\x03R\x13externalUrlFromFlag\x12(\n" +
- "\rreplica_count\x18\x18 \x01(\x05B\x03\xe0A\x03R\freplicaCount\x1a~\n" +
+ "\rreplica_count\x18\x18 \x01(\x05B\x03\xe0A\x03R\freplicaCount\x12?\n" +
+ "\vrestriction\x18\x19 \x01(\v2\x18.bytebase.v1.RestrictionB\x03\xe0A\x03R\vrestriction\x1a~\n" +
"\bStatUser\x122\n" +
"\tuser_type\x18\x01 \x01(\x0e2\x15.bytebase.v1.UserTypeR\buserType\x12(\n" +
"\x05state\x18\x02 \x01(\x0e2\x12.bytebase.v1.StateR\x05state\x12\x14\n" +
@@ -548,38 +624,42 @@ func file_v1_actuator_service_proto_rawDescGZIP() []byte {
return file_v1_actuator_service_proto_rawDescData
}
-var file_v1_actuator_service_proto_msgTypes = make([]protoimpl.MessageInfo, 7)
+var file_v1_actuator_service_proto_msgTypes = make([]protoimpl.MessageInfo, 8)
var file_v1_actuator_service_proto_goTypes = []any{
- (*GetResourcePackageRequest)(nil), // 0: bytebase.v1.GetResourcePackageRequest
- (*ResourcePackage)(nil), // 1: bytebase.v1.ResourcePackage
- (*SetupSampleRequest)(nil), // 2: bytebase.v1.SetupSampleRequest
- (*GetActuatorInfoRequest)(nil), // 3: bytebase.v1.GetActuatorInfoRequest
- (*DeleteCacheRequest)(nil), // 4: bytebase.v1.DeleteCacheRequest
- (*ActuatorInfo)(nil), // 5: bytebase.v1.ActuatorInfo
- (*ActuatorInfo_StatUser)(nil), // 6: bytebase.v1.ActuatorInfo.StatUser
- (*timestamppb.Timestamp)(nil), // 7: google.protobuf.Timestamp
- (UserType)(0), // 8: bytebase.v1.UserType
- (State)(0), // 9: bytebase.v1.State
- (*emptypb.Empty)(nil), // 10: google.protobuf.Empty
+ (*GetResourcePackageRequest)(nil), // 0: bytebase.v1.GetResourcePackageRequest
+ (*ResourcePackage)(nil), // 1: bytebase.v1.ResourcePackage
+ (*SetupSampleRequest)(nil), // 2: bytebase.v1.SetupSampleRequest
+ (*GetActuatorInfoRequest)(nil), // 3: bytebase.v1.GetActuatorInfoRequest
+ (*DeleteCacheRequest)(nil), // 4: bytebase.v1.DeleteCacheRequest
+ (*Restriction)(nil), // 5: bytebase.v1.Restriction
+ (*ActuatorInfo)(nil), // 6: bytebase.v1.ActuatorInfo
+ (*ActuatorInfo_StatUser)(nil), // 7: bytebase.v1.ActuatorInfo.StatUser
+ (*WorkspaceProfileSetting_PasswordRestriction)(nil), // 8: bytebase.v1.WorkspaceProfileSetting.PasswordRestriction
+ (*timestamppb.Timestamp)(nil), // 9: google.protobuf.Timestamp
+ (UserType)(0), // 10: bytebase.v1.UserType
+ (State)(0), // 11: bytebase.v1.State
+ (*emptypb.Empty)(nil), // 12: google.protobuf.Empty
}
var file_v1_actuator_service_proto_depIdxs = []int32{
- 7, // 0: bytebase.v1.ActuatorInfo.last_active_time:type_name -> google.protobuf.Timestamp
- 6, // 1: bytebase.v1.ActuatorInfo.user_stats:type_name -> bytebase.v1.ActuatorInfo.StatUser
- 8, // 2: bytebase.v1.ActuatorInfo.StatUser.user_type:type_name -> bytebase.v1.UserType
- 9, // 3: bytebase.v1.ActuatorInfo.StatUser.state:type_name -> bytebase.v1.State
- 3, // 4: bytebase.v1.ActuatorService.GetActuatorInfo:input_type -> bytebase.v1.GetActuatorInfoRequest
- 2, // 5: bytebase.v1.ActuatorService.SetupSample:input_type -> bytebase.v1.SetupSampleRequest
- 4, // 6: bytebase.v1.ActuatorService.DeleteCache:input_type -> bytebase.v1.DeleteCacheRequest
- 0, // 7: bytebase.v1.ActuatorService.GetResourcePackage:input_type -> bytebase.v1.GetResourcePackageRequest
- 5, // 8: bytebase.v1.ActuatorService.GetActuatorInfo:output_type -> bytebase.v1.ActuatorInfo
- 10, // 9: bytebase.v1.ActuatorService.SetupSample:output_type -> google.protobuf.Empty
- 10, // 10: bytebase.v1.ActuatorService.DeleteCache:output_type -> google.protobuf.Empty
- 1, // 11: bytebase.v1.ActuatorService.GetResourcePackage:output_type -> bytebase.v1.ResourcePackage
- 8, // [8:12] is the sub-list for method output_type
- 4, // [4:8] is the sub-list for method input_type
- 4, // [4:4] is the sub-list for extension type_name
- 4, // [4:4] is the sub-list for extension extendee
- 0, // [0:4] is the sub-list for field type_name
+ 8, // 0: bytebase.v1.Restriction.password_restriction:type_name -> bytebase.v1.WorkspaceProfileSetting.PasswordRestriction
+ 9, // 1: bytebase.v1.ActuatorInfo.last_active_time:type_name -> google.protobuf.Timestamp
+ 7, // 2: bytebase.v1.ActuatorInfo.user_stats:type_name -> bytebase.v1.ActuatorInfo.StatUser
+ 5, // 3: bytebase.v1.ActuatorInfo.restriction:type_name -> bytebase.v1.Restriction
+ 10, // 4: bytebase.v1.ActuatorInfo.StatUser.user_type:type_name -> bytebase.v1.UserType
+ 11, // 5: bytebase.v1.ActuatorInfo.StatUser.state:type_name -> bytebase.v1.State
+ 3, // 6: bytebase.v1.ActuatorService.GetActuatorInfo:input_type -> bytebase.v1.GetActuatorInfoRequest
+ 2, // 7: bytebase.v1.ActuatorService.SetupSample:input_type -> bytebase.v1.SetupSampleRequest
+ 4, // 8: bytebase.v1.ActuatorService.DeleteCache:input_type -> bytebase.v1.DeleteCacheRequest
+ 0, // 9: bytebase.v1.ActuatorService.GetResourcePackage:input_type -> bytebase.v1.GetResourcePackageRequest
+ 6, // 10: bytebase.v1.ActuatorService.GetActuatorInfo:output_type -> bytebase.v1.ActuatorInfo
+ 12, // 11: bytebase.v1.ActuatorService.SetupSample:output_type -> google.protobuf.Empty
+ 12, // 12: bytebase.v1.ActuatorService.DeleteCache:output_type -> google.protobuf.Empty
+ 1, // 13: bytebase.v1.ActuatorService.GetResourcePackage:output_type -> bytebase.v1.ResourcePackage
+ 10, // [10:14] is the sub-list for method output_type
+ 6, // [6:10] is the sub-list for method input_type
+ 6, // [6:6] is the sub-list for extension type_name
+ 6, // [6:6] is the sub-list for extension extendee
+ 0, // [0:6] is the sub-list for field type_name
}
func init() { file_v1_actuator_service_proto_init() }
@@ -589,6 +669,7 @@ func file_v1_actuator_service_proto_init() {
}
file_v1_annotation_proto_init()
file_v1_common_proto_init()
+ file_v1_setting_service_proto_init()
file_v1_user_service_proto_init()
type x struct{}
out := protoimpl.TypeBuilder{
@@ -596,7 +677,7 @@ func file_v1_actuator_service_proto_init() {
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_actuator_service_proto_rawDesc), len(file_v1_actuator_service_proto_rawDesc)),
NumEnums: 0,
- NumMessages: 7,
+ NumMessages: 8,
NumExtensions: 0,
NumServices: 1,
},
diff --git a/backend/generated-go/v1/actuator_service_equal.pb.go b/backend/generated-go/v1/actuator_service_equal.pb.go
index 797fc3cfb6..db74aaf109 100644
--- a/backend/generated-go/v1/actuator_service_equal.pb.go
+++ b/backend/generated-go/v1/actuator_service_equal.pb.go
@@ -56,6 +56,25 @@ func (x *DeleteCacheRequest) Equal(y *DeleteCacheRequest) bool {
return true
}
+func (x *Restriction) Equal(y *Restriction) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.DisallowSignup != y.DisallowSignup {
+ return false
+ }
+ if x.DisallowPasswordSignin != y.DisallowPasswordSignin {
+ return false
+ }
+ if !x.PasswordRestriction.Equal(y.PasswordRestriction) {
+ return false
+ }
+ return true
+}
+
func (x *ActuatorInfo_StatUser) Equal(y *ActuatorInfo_StatUser) bool {
if x == y {
return true
@@ -149,5 +168,8 @@ func (x *ActuatorInfo) Equal(y *ActuatorInfo) bool {
if x.ReplicaCount != y.ReplicaCount {
return false
}
+ if !x.Restriction.Equal(y.Restriction) {
+ return false
+ }
return true
}
diff --git a/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts b/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts
index cb49a818af..4004227dde 100644
--- a/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/actuator_service_pb.d.ts
@@ -4,6 +4,7 @@
import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
import type { Message } from "@bufbuild/protobuf";
+import type { WorkspaceProfileSetting_PasswordRestriction } from "./setting_service_pb";
import type { EmptySchema, Timestamp } from "@bufbuild/protobuf/wkt";
import type { UserType } from "./user_service_pb";
import type { State } from "./common_pb";
@@ -89,6 +90,38 @@ export declare type DeleteCacheRequest = Message<"bytebase.v1.DeleteCacheRequest
*/
export declare const DeleteCacheRequestSchema: GenMessage<DeleteCacheRequest>;
+/**
+ * @generated from message bytebase.v1.Restriction
+ */
+export declare type Restriction = Message<"bytebase.v1.Restriction"> & {
+ /**
+ * Whether self-service user signup is disabled.
+ *
+ * @generated from field: bool disallow_signup = 1;
+ */
+ disallowSignup: boolean;
+
+ /**
+ * Whether password-based signin is disabled (except for workspace admins).
+ *
+ * @generated from field: bool disallow_password_signin = 2;
+ */
+ disallowPasswordSignin: boolean;
+
+ /**
+ * Password complexity and restriction requirements.
+ *
+ * @generated from field: bytebase.v1.WorkspaceProfileSetting.PasswordRestriction password_restriction = 3;
+ */
+ passwordRestriction?: WorkspaceProfileSetting_PasswordRestriction;
+};
+
+/**
+ * Describes the message bytebase.v1.Restriction.
+ * Use `create(RestrictionSchema)` to create a new message.
+ */
+export declare const RestrictionSchema: GenMessage<Restriction>;
+
/**
* System information and configuration for the Bytebase instance.
* Actuator concept is similar to the Spring Boot Actuator.
@@ -228,6 +261,11 @@ export declare type ActuatorInfo = Message<"bytebase.v1.ActuatorInfo"> & {
* @generated from field: int32 replica_count = 24;
*/
replicaCount: number;
+
+ /**
+ * @generated from field: bytebase.v1.Restriction restriction = 25;
+ */
+ restriction?: Restriction;
};
/**
diff --git a/frontend/src/types/proto-es/v1/actuator_service_pb.js b/frontend/src/types/proto-es/v1/actuator_service_pb.js
index 65c04ab90b..484689bbea 100644
--- a/frontend/src/types/proto-es/v1/actuator_service_pb.js
+++ b/frontend/src/types/proto-es/v1/actuator_service_pb.js
@@ -9,13 +9,14 @@ import { file_google_api_field_behavior } from "../google/api/field_behavior_pb"
import { file_google_protobuf_empty, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
import { file_v1_annotation } from "./annotation_pb";
import { file_v1_common } from "./common_pb";
+import { file_v1_setting_service } from "./setting_service_pb";
import { file_v1_user_service } from "./user_service_pb";
/**
* Describes the file v1/actuator_service.proto.
*/
export const file_v1_actuator_service = /*@__PURE__*/
- fileDesc("Chl2MS9hY3R1YXRvcl9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSIbChlHZXRSZXNvdXJjZVBhY2thZ2VSZXF1ZXN0Ih8KD1Jlc291cmNlUGFja2FnZRIMCgRsb2dvGAEgASgMIhQKElNldHVwU2FtcGxlUmVxdWVzdCIYChZHZXRBY3R1YXRvckluZm9SZXF1ZXN0IhQKEkRlbGV0ZUNhY2hlUmVxdWVzdCLRBQoMQWN0dWF0b3JJbmZvEhQKB3ZlcnNpb24YASABKAlCA+BBAxIXCgpnaXRfY29tbWl0GAIgASgJQgPgQQMSFQoIcmVhZG9ubHkYAyABKAhCA+BBAxIRCgRzYWFzGAQgASgIQgPgQQMSEQoEZGVtbxgFIAEoCEID4EEDEhEKBGhvc3QYBiABKAlCA+BBAxIRCgRwb3J0GAcgASgJQgPgQQMSGQoMZXh0ZXJuYWxfdXJsGAggASgJQgPgQQMSHQoQbmVlZF9hZG1pbl9zZXR1cBgJIAEoCEID4EEDEjkKEGxhc3RfYWN0aXZlX3RpbWUYCyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSGQoMd29ya3NwYWNlX2lkGA0gASgJQgPgQQMSIAoTdW5saWNlbnNlZF9mZWF0dXJlcxgPIAMoCUID4EEDEhMKBmRvY2tlchgSIAEoCEID4EEDEjsKCnVzZXJfc3RhdHMYEyADKAsyIi5ieXRlYmFzZS52MS5BY3R1YXRvckluZm8uU3RhdFVzZXJCA+BBAxIlChhhY3RpdmF0ZWRfaW5zdGFuY2VfY291bnQYFCABKAVCA+BBAxIhChR0b3RhbF9pbnN0YW5jZV9jb3VudBgVIAEoBUID4EEDEhoKDWVuYWJsZV9zYW1wbGUYFiABKAhCA+BBAxIjChZleHRlcm5hbF91cmxfZnJvbV9mbGFnGBcgASgIQgPgQQMSGgoNcmVwbGljYV9jb3VudBgYIAEoBUID4EEDGmYKCFN0YXRVc2VyEigKCXVzZXJfdHlwZRgBIAEoDjIVLmJ5dGViYXNlLnYxLlVzZXJUeXBlEiEKBXN0YXRlGAIgASgOMhIuYnl0ZWJhc2UudjEuU3RhdGUSDQoFY291bnQYAyABKAVKBAgKEAtKBAgMEA1KBAgQEBFKBAgREBJKBAgOEA8y9wMKD0FjdHVhdG9yU2VydmljZRJzCg9HZXRBY3R1YXRvckluZm8SIy5ieXRlYmFzZS52MS5HZXRBY3R1YXRvckluZm9SZXF1ZXN0GhkuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvIiDaQQCA6jABgtPkkwITEhEvdjEvYWN0dWF0b3IvaW5mbxKCAQoLU2V0dXBTYW1wbGUSHy5ieXRlYmFzZS52MS5TZXR1cFNhbXBsZVJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiOorqMBJiYi5wcm9qZWN0cy5jcmVhdGWQ6jABgtPkkwIaIhgvdjEvYWN0dWF0b3I6c2V0dXBTYW1wbGUSZgoLRGVsZXRlQ2FjaGUSHy5ieXRlYmFzZS52MS5EZWxldGVDYWNoZVJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiHoDqMAGC0+STAhQqEi92MS9hY3R1YXRvci9jYWNoZRKBAQoSR2V0UmVzb3VyY2VQYWNrYWdlEiYuYnl0ZWJhc2UudjEuR2V0UmVzb3VyY2VQYWNrYWdlUmVxdWVzdBocLmJ5dGViYXNlLnYxLlJlc291cmNlUGFja2FnZSIl2kEAgOowAYLT5JMCGBIWL3YxL2FjdHVhdG9yL3Jlc291cmNlc0KqAQoPY29tLmJ5dGViYXNlLnYxQhRBY3R1YXRvclNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_protobuf_empty, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_user_service]);
+ fileDesc("Chl2MS9hY3R1YXRvcl9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSIbChlHZXRSZXNvdXJjZVBhY2thZ2VSZXF1ZXN0Ih8KD1Jlc291cmNlUGFja2FnZRIMCgRsb2dvGAEgASgMIhQKElNldHVwU2FtcGxlUmVxdWVzdCIYChZHZXRBY3R1YXRvckluZm9SZXF1ZXN0IhQKEkRlbGV0ZUNhY2hlUmVxdWVzdCKvAQoLUmVzdHJpY3Rpb24SHAoPZGlzYWxsb3dfc2lnbnVwGAEgASgIQgPgQQMSJQoYZGlzYWxsb3dfcGFzc3dvcmRfc2lnbmluGAIgASgIQgPgQQMSWwoUcGFzc3dvcmRfcmVzdHJpY3Rpb24YAyABKAsyOC5ieXRlYmFzZS52MS5Xb3Jrc3BhY2VQcm9maWxlU2V0dGluZy5QYXNzd29yZFJlc3RyaWN0aW9uQgPgQQMihQYKDEFjdHVhdG9ySW5mbxIUCgd2ZXJzaW9uGAEgASgJQgPgQQMSFwoKZ2l0X2NvbW1pdBgCIAEoCUID4EEDEhUKCHJlYWRvbmx5GAMgASgIQgPgQQMSEQoEc2FhcxgEIAEoCEID4EEDEhEKBGRlbW8YBSABKAhCA+BBAxIRCgRob3N0GAYgASgJQgPgQQMSEQoEcG9ydBgHIAEoCUID4EEDEhkKDGV4dGVybmFsX3VybBgIIAEoCUID4EEDEh0KEG5lZWRfYWRtaW5fc2V0dXAYCSABKAhCA+BBAxI5ChBsYXN0X2FjdGl2ZV90aW1lGAsgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEhkKDHdvcmtzcGFjZV9pZBgNIAEoCUID4EEDEiAKE3VubGljZW5zZWRfZmVhdHVyZXMYDyADKAlCA+BBAxITCgZkb2NrZXIYEiABKAhCA+BBAxI7Cgp1c2VyX3N0YXRzGBMgAygLMiIuYnl0ZWJhc2UudjEuQWN0dWF0b3JJbmZvLlN0YXRVc2VyQgPgQQMSJQoYYWN0aXZhdGVkX2luc3RhbmNlX2NvdW50GBQgASgFQgPgQQMSIQoUdG90YWxfaW5zdGFuY2VfY291bnQYFSABKAVCA+BBAxIaCg1lbmFibGVfc2FtcGxlGBYgASgIQgPgQQMSIwoWZXh0ZXJuYWxfdXJsX2Zyb21fZmxhZxgXIAEoCEID4EEDEhoKDXJlcGxpY2FfY291bnQYGCABKAVCA+BBAxIyCgtyZXN0cmljdGlvbhgZIAEoCzIYLmJ5dGViYXNlLnYxLlJlc3RyaWN0aW9uQgPgQQMaZgoIU3RhdFVzZXISKAoJdXNlcl90eXBlGAEgASgOMhUuYnl0ZWJhc2UudjEuVXNlclR5cGUSIQoFc3RhdGUYAiABKA4yEi5ieXRlYmFzZS52MS5TdGF0ZRINCgVjb3VudBgDIAEoBUoECAoQC0oECAwQDUoECBAQEUoECBEQEkoECA4QDzL3AwoPQWN0dWF0b3JTZXJ2aWNlEnMKD0dldEFjdHVhdG9ySW5mbxIjLmJ5dGViYXNlLnYxLkdldEFjdHVhdG9ySW5mb1JlcXVlc3QaGS5ieXRlYmFzZS52MS5BY3R1YXRvckluZm8iINpBAIDqMAGC0+STAhMSES92MS9hY3R1YXRvci9pbmZvEoIBCgtTZXR1cFNhbXBsZRIfLmJ5dGViYXNlLnYxLlNldHVwU2FtcGxlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSI6iuowEmJiLnByb2plY3RzLmNyZWF0ZZDqMAGC0+STAhoiGC92MS9hY3R1YXRvcjpzZXR1cFNhbXBsZRJmCgtEZWxldGVDYWNoZRIfLmJ5dGViYXNlLnYxLkRlbGV0ZUNhY2hlUmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSIegOowAYLT5JMCFCoSL3YxL2FjdHVhdG9yL2NhY2hlEoEBChJHZXRSZXNvdXJjZVBhY2thZ2USJi5ieXRlYmFzZS52MS5HZXRSZXNvdXJjZVBhY2thZ2VSZXF1ZXN0GhwuYnl0ZWJhc2UudjEuUmVzb3VyY2VQYWNrYWdlIiXaQQCA6jABgtPkkwIYEhYvdjEvYWN0dWF0b3IvcmVzb3VyY2VzQqoBCg9jb20uYnl0ZWJhc2UudjFCFEFjdHVhdG9yU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_protobuf_empty, file_google_protobuf_timestamp, file_v1_annotation, file_v1_common, file_v1_setting_service, file_v1_user_service]);
/**
* Describes the message bytebase.v1.GetResourcePackageRequest.
@@ -52,19 +53,26 @@ export const GetActuatorInfoRequestSchema = /*@__PURE__*/
export const DeleteCacheRequestSchema = /*@__PURE__*/
messageDesc(file_v1_actuator_service, 4);
+/**
+ * Describes the message bytebase.v1.Restriction.
+ * Use `create(RestrictionSchema)` to create a new message.
+ */
+export const RestrictionSchema = /*@__PURE__*/
+ messageDesc(file_v1_actuator_service, 5);
+
/**
* Describes the message bytebase.v1.ActuatorInfo.
* Use `create(ActuatorInfoSchema)` to create a new message.
*/
export const ActuatorInfoSchema = /*@__PURE__*/
- messageDesc(file_v1_actuator_service, 5);
+ messageDesc(file_v1_actuator_service, 6);
/**
* Describes the message bytebase.v1.ActuatorInfo.StatUser.
* Use `create(ActuatorInfo_StatUserSchema)` to create a new message.
*/
export const ActuatorInfo_StatUserSchema = /*@__PURE__*/
- messageDesc(file_v1_actuator_service, 5, 0);
+ messageDesc(file_v1_actuator_service, 6, 0);
/**
* ActuatorService manages system health and operational information.
diff --git a/frontend/src/views/auth/PasswordReset.vue b/frontend/src/views/auth/PasswordReset.vue
index df1dd530a0..b16fc7285a 100644
--- a/frontend/src/views/auth/PasswordReset.vue
+++ b/frontend/src/views/auth/PasswordReset.vue
@@ -43,9 +43,9 @@ import { useRouter } from "vue-router";
import UserPassword from "@/components/User/Settings/UserPassword.vue";
import {
pushNotification,
+ useActuatorV1Store,
useAuthStore,
useCurrentUserV1,
- useSettingV1Store,
useUserStore,
} from "@/store";
import type { User } from "@/types/proto-es/v1/user_service_pb";
@@ -69,7 +69,7 @@ const userPasswordRef = ref<InstanceType<typeof UserPassword>>();
const router = useRouter();
const passwordRestrictionSetting = computed(
- () => useSettingV1Store().workspaceProfile.passwordRestriction
+ () => useActuatorV1Store().serverInfo?.restriction?.passwordRestriction
);
const redirectQuery = computed(() => {
diff --git a/frontend/src/views/auth/Signin.vue b/frontend/src/views/auth/Signin.vue
index 872c6a2189..826038e133 100644
--- a/frontend/src/views/auth/Signin.vue
+++ b/frontend/src/views/auth/Signin.vue
@@ -13,7 +13,7 @@
pane-style="padding: 12px 0 0 0"
>
<NTabPane
- v-if="!workspaceProfile.disallowPasswordSignin"
+ v-if="!serverInfo?.restriction?.disallowPasswordSignin"
name="standard"
tab="Standard"
>
@@ -194,7 +194,6 @@ import {
useActuatorV1Store,
useAuthStore,
useIdentityProviderStore,
- useSettingV1Store,
} from "@/store";
import { idpNamePrefix } from "@/store/modules/v1/common";
import {
@@ -228,7 +227,6 @@ interface LocalState {
const router = useRouter();
const route = useRoute();
const actuatorStore = useActuatorV1Store();
-const settingV1Store = useSettingV1Store();
const authStore = useAuthStore();
const identityProviderStore = useIdentityProviderStore();
@@ -240,10 +238,10 @@ const state = reactive<LocalState>({
});
const initialized = ref(false);
const { isDemo } = storeToRefs(actuatorStore);
-const { workspaceProfile } = storeToRefs(settingV1Store);
+const { serverInfo } = storeToRefs(actuatorStore);
const disallowSignup = computed(
- () => !props.allowSignup || workspaceProfile.value.disallowSignup
+ () => !props.allowSignup || serverInfo.value?.restriction?.disallowSignup
);
const separatedIdentityProviderList = computed(() =>
@@ -259,13 +257,13 @@ const groupedIdentityProviderList = computed(() =>
const showSignInForm = computed(() => {
return (
- !workspaceProfile.value.disallowPasswordSignin ||
+ !serverInfo.value?.restriction?.disallowPasswordSignin ||
groupedIdentityProviderList.value.length > 0
);
});
const defaultTabValue = computed(() => {
- if (!workspaceProfile.value.disallowPasswordSignin) {
+ if (!serverInfo.value?.restriction?.disallowPasswordSignin) {
return "standard";
}
if (groupedIdentityProviderList.value.length > 0) {
diff --git a/frontend/src/views/auth/Signup.vue b/frontend/src/views/auth/Signup.vue
index 598d10a56c..577379caec 100644
--- a/frontend/src/views/auth/Signup.vue
+++ b/frontend/src/views/auth/Signup.vue
@@ -48,7 +48,7 @@
v-model:password="state.password"
v-model:password-confirm="state.passwordConfirm"
:show-learn-more="false"
- :password-restriction="workspaceProfile.passwordRestriction"
+ :password-restriction="serverInfo?.restriction?.passwordRestriction"
/>
<div>
@@ -148,7 +148,7 @@ import BytebaseLogo from "@/components/BytebaseLogo.vue";
import RequiredStar from "@/components/RequiredStar.vue";
import UserPassword from "@/components/User/Settings/UserPassword.vue";
import { AUTH_SIGNIN_MODULE } from "@/router/auth";
-import { useActuatorV1Store, useAuthStore, useSettingV1Store } from "@/store";
+import { useActuatorV1Store, useAuthStore } from "@/store";
import type { User } from "@/types/proto-es/v1/user_service_pb";
import { isValidEmail } from "@/utils";
import AuthFooter from "./AuthFooter.vue";
@@ -164,7 +164,6 @@ interface LocalState {
}
const actuatorStore = useActuatorV1Store();
-const settingV1Store = useSettingV1Store();
const userPasswordRef = ref<InstanceType<typeof UserPassword>>();
const state = reactive<LocalState>({
@@ -177,8 +176,7 @@ const state = reactive<LocalState>({
isLoading: false,
});
-const { needAdminSetup } = storeToRefs(actuatorStore);
-const { workspaceProfile } = storeToRefs(settingV1Store);
+const { needAdminSetup, serverInfo } = storeToRefs(actuatorStore);
const allowSignup = computed(() => {
return (
@@ -188,7 +186,7 @@ const allowSignup = computed(() => {
!userPasswordRef.value?.passwordHint &&
!userPasswordRef.value?.passwordMismatch &&
state.acceptTermsAndPolicy &&
- !workspaceProfile.value.disallowSignup
+ !serverInfo.value?.restriction?.disallowSignup
);
});
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 732f4dea65..7308ed1ceb 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -10006,6 +10006,10 @@ components:
format: int32
description: The number of active replicas (servers sharing the same database).
readOnly: true
+ restriction:
+ title: restriction
+ readOnly: true
+ $ref: '#/components/schemas/bytebase.v1.Restriction'
title: ActuatorInfo
additionalProperties: false
description: |-
@@ -17807,6 +17811,26 @@ components:
title: ResourcePackage
additionalProperties: false
description: Custom branding resources for the Bytebase instance.
+ bytebase.v1.Restriction:
+ type: object
+ properties:
+ disallowSignup:
+ type: boolean
+ title: disallow_signup
+ description: Whether self-service user signup is disabled.
+ readOnly: true
+ disallowPasswordSignin:
+ type: boolean
+ title: disallow_password_signin
+ description: Whether password-based signin is disabled (except for workspace admins).
+ readOnly: true
+ passwordRestriction:
+ title: password_restriction
+ description: Password complexity and restriction requirements.
+ readOnly: true
+ $ref: '#/components/schemas/bytebase.v1.WorkspaceProfileSetting.PasswordRestriction'
+ title: Restriction
+ additionalProperties: false
bytebase.v1.ReviewConfig:
type: object
properties:
@@ -22757,6 +22781,10 @@ components:
documentation for additional information.
security: []
tags:
+ - name: IssueService
+ description: IssueService manages issues for tracking database changes and tasks.
+ - name: SettingService
+ description: SettingService manages workspace-level settings and configurations.
- name: UserService
description: UserService manages user accounts and authentication.
- name: ActuatorService
@@ -22781,8 +22809,6 @@ tags:
description: GroupService manages user groups for organizing users and permissions.
- name: IdentityProviderService
description: IdentityProviderService manages external identity providers for SSO authentication.
- - name: IssueService
- description: IssueService manages issues for tracking database changes and tasks.
- name: OrgPolicyService
description: OrgPolicyService manages organizational policies at various resource levels.
- name: SQLService
@@ -22801,8 +22827,6 @@ tags:
description: RoleService manages workspace roles and permissions.
- name: RolloutService
description: RolloutService manages the execution of deployment plans.
- - name: SettingService
- description: SettingService manages workspace-level settings and configurations.
- name: SheetService
description: SheetService manages SQL scripts and saved queries.
- name: SubscriptionService
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index 76b7ba9170..8105f70cb2 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -24,6 +24,89 @@
- [VCSType](#bytebase-v1-VCSType)
- [WebhookType](#bytebase-v1-WebhookType)
+- [v1/issue_service.proto](#v1_issue_service-proto)
+ - [ApprovalFlow](#bytebase-v1-ApprovalFlow)
+ - [ApprovalTemplate](#bytebase-v1-ApprovalTemplate)
+ - [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest)
+ - [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest)
+ - [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse)
+ - [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest)
+ - [CreateIssueRequest](#bytebase-v1-CreateIssueRequest)
+ - [GetIssueRequest](#bytebase-v1-GetIssueRequest)
+ - [GrantRequest](#bytebase-v1-GrantRequest)
+ - [Issue](#bytebase-v1-Issue)
+ - [Issue.Approver](#bytebase-v1-Issue-Approver)
+ - [IssueComment](#bytebase-v1-IssueComment)
+ - [IssueComment.Approval](#bytebase-v1-IssueComment-Approval)
+ - [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate)
+ - [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate)
+ - [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest)
+ - [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse)
+ - [ListIssuesRequest](#bytebase-v1-ListIssuesRequest)
+ - [ListIssuesResponse](#bytebase-v1-ListIssuesResponse)
+ - [RejectIssueRequest](#bytebase-v1-RejectIssueRequest)
+ - [RequestIssueRequest](#bytebase-v1-RequestIssueRequest)
+ - [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest)
+ - [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse)
+ - [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest)
+ - [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest)
+
+ - [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus)
+ - [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status)
+ - [Issue.Type](#bytebase-v1-Issue-Type)
+ - [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status)
+ - [IssueStatus](#bytebase-v1-IssueStatus)
+
+ - [IssueService](#bytebase-v1-IssueService)
+
+- [v1/setting_service.proto](#v1_setting_service-proto)
+ - [AISetting](#bytebase-v1-AISetting)
+ - [Algorithm](#bytebase-v1-Algorithm)
+ - [Algorithm.FullMask](#bytebase-v1-Algorithm-FullMask)
+ - [Algorithm.InnerOuterMask](#bytebase-v1-Algorithm-InnerOuterMask)
+ - [Algorithm.MD5Mask](#bytebase-v1-Algorithm-MD5Mask)
+ - [Algorithm.RangeMask](#bytebase-v1-Algorithm-RangeMask)
+ - [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice)
+ - [Announcement](#bytebase-v1-Announcement)
+ - [AppIMSetting](#bytebase-v1-AppIMSetting)
+ - [AppIMSetting.DingTalk](#bytebase-v1-AppIMSetting-DingTalk)
+ - [AppIMSetting.Feishu](#bytebase-v1-AppIMSetting-Feishu)
+ - [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting)
+ - [AppIMSetting.Lark](#bytebase-v1-AppIMSetting-Lark)
+ - [AppIMSetting.Slack](#bytebase-v1-AppIMSetting-Slack)
+ - [AppIMSetting.Teams](#bytebase-v1-AppIMSetting-Teams)
+ - [AppIMSetting.Wecom](#bytebase-v1-AppIMSetting-Wecom)
+ - [DataClassificationSetting](#bytebase-v1-DataClassificationSetting)
+ - [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig)
+ - [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry)
+ - [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification)
+ - [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level)
+ - [EnvironmentSetting](#bytebase-v1-EnvironmentSetting)
+ - [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment)
+ - [EnvironmentSetting.Environment.TagsEntry](#bytebase-v1-EnvironmentSetting-Environment-TagsEntry)
+ - [GetSettingRequest](#bytebase-v1-GetSettingRequest)
+ - [GetSettingResponse](#bytebase-v1-GetSettingResponse)
+ - [ListSettingsRequest](#bytebase-v1-ListSettingsRequest)
+ - [ListSettingsResponse](#bytebase-v1-ListSettingsResponse)
+ - [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting)
+ - [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType)
+ - [Setting](#bytebase-v1-Setting)
+ - [SettingValue](#bytebase-v1-SettingValue)
+ - [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest)
+ - [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting)
+ - [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule)
+ - [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting)
+ - [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction)
+
+ - [AISetting.Provider](#bytebase-v1-AISetting-Provider)
+ - [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType)
+ - [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel)
+ - [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode)
+ - [Setting.SettingName](#bytebase-v1-Setting-SettingName)
+ - [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source)
+
+ - [SettingService](#bytebase-v1-SettingService)
+
- [v1/user_service.proto](#v1_user_service-proto)
- [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest)
- [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse)
@@ -51,6 +134,7 @@
- [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest)
- [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest)
- [ResourcePackage](#bytebase-v1-ResourcePackage)
+ - [Restriction](#bytebase-v1-Restriction)
- [SetupSampleRequest](#bytebase-v1-SetupSampleRequest)
- [ActuatorService](#bytebase-v1-ActuatorService)
@@ -296,41 +380,6 @@
- [IdentityProviderService](#bytebase-v1-IdentityProviderService)
-- [v1/issue_service.proto](#v1_issue_service-proto)
- - [ApprovalFlow](#bytebase-v1-ApprovalFlow)
- - [ApprovalTemplate](#bytebase-v1-ApprovalTemplate)
- - [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest)
- - [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest)
- - [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse)
- - [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest)
- - [CreateIssueRequest](#bytebase-v1-CreateIssueRequest)
- - [GetIssueRequest](#bytebase-v1-GetIssueRequest)
- - [GrantRequest](#bytebase-v1-GrantRequest)
- - [Issue](#bytebase-v1-Issue)
- - [Issue.Approver](#bytebase-v1-Issue-Approver)
- - [IssueComment](#bytebase-v1-IssueComment)
- - [IssueComment.Approval](#bytebase-v1-IssueComment-Approval)
- - [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate)
- - [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate)
- - [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest)
- - [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse)
- - [ListIssuesRequest](#bytebase-v1-ListIssuesRequest)
- - [ListIssuesResponse](#bytebase-v1-ListIssuesResponse)
- - [RejectIssueRequest](#bytebase-v1-RejectIssueRequest)
- - [RequestIssueRequest](#bytebase-v1-RequestIssueRequest)
- - [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest)
- - [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse)
- - [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest)
- - [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest)
-
- - [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus)
- - [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status)
- - [Issue.Type](#bytebase-v1-Issue-Type)
- - [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status)
- - [IssueStatus](#bytebase-v1-IssueStatus)
-
- - [IssueService](#bytebase-v1-IssueService)
-
- [v1/org_policy_service.proto](#v1_org_policy_service-proto)
- [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest)
- [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest)
@@ -575,54 +624,6 @@
- [RolloutService](#bytebase-v1-RolloutService)
-- [v1/setting_service.proto](#v1_setting_service-proto)
- - [AISetting](#bytebase-v1-AISetting)
- - [Algorithm](#bytebase-v1-Algorithm)
- - [Algorithm.FullMask](#bytebase-v1-Algorithm-FullMask)
- - [Algorithm.InnerOuterMask](#bytebase-v1-Algorithm-InnerOuterMask)
- - [Algorithm.MD5Mask](#bytebase-v1-Algorithm-MD5Mask)
- - [Algorithm.RangeMask](#bytebase-v1-Algorithm-RangeMask)
- - [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice)
- - [Announcement](#bytebase-v1-Announcement)
- - [AppIMSetting](#bytebase-v1-AppIMSetting)
- - [AppIMSetting.DingTalk](#bytebase-v1-AppIMSetting-DingTalk)
- - [AppIMSetting.Feishu](#bytebase-v1-AppIMSetting-Feishu)
- - [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting)
- - [AppIMSetting.Lark](#bytebase-v1-AppIMSetting-Lark)
- - [AppIMSetting.Slack](#bytebase-v1-AppIMSetting-Slack)
- - [AppIMSetting.Teams](#bytebase-v1-AppIMSetting-Teams)
- - [AppIMSetting.Wecom](#bytebase-v1-AppIMSetting-Wecom)
- - [DataClassificationSetting](#bytebase-v1-DataClassificationSetting)
- - [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig)
- - [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry)
- - [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification)
- - [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level)
- - [EnvironmentSetting](#bytebase-v1-EnvironmentSetting)
- - [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment)
- - [EnvironmentSetting.Environment.TagsEntry](#bytebase-v1-EnvironmentSetting-Environment-TagsEntry)
- - [GetSettingRequest](#bytebase-v1-GetSettingRequest)
- - [GetSettingResponse](#bytebase-v1-GetSettingResponse)
- - [ListSettingsRequest](#bytebase-v1-ListSettingsRequest)
- - [ListSettingsResponse](#bytebase-v1-ListSettingsResponse)
- - [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting)
- - [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType)
- - [Setting](#bytebase-v1-Setting)
- - [SettingValue](#bytebase-v1-SettingValue)
- - [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest)
- - [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting)
- - [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule)
- - [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting)
- - [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction)
-
- - [AISetting.Provider](#bytebase-v1-AISetting-Provider)
- - [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType)
- - [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel)
- - [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode)
- - [Setting.SettingName](#bytebase-v1-Setting-SettingName)
- - [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source)
-
- - [SettingService](#bytebase-v1-SettingService)
-
- [v1/sheet_service.proto](#v1_sheet_service-proto)
- [BatchCreateSheetsRequest](#bytebase-v1-BatchCreateSheetsRequest)
- [BatchCreateSheetsResponse](#bytebase-v1-BatchCreateSheetsResponse)
@@ -952,1037 +953,958 @@ Webhook integration type.
-<a name="v1_user_service-proto"></a>
+<a name="v1_issue_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/user_service.proto
+## v1/issue_service.proto
-<a name="bytebase-v1-BatchGetUsersRequest"></a>
+<a name="bytebase-v1-ApprovalFlow"></a>
-### BatchGetUsersRequest
+### ApprovalFlow
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The user names to retrieve. Format: users/{email} |
+| roles | [string](#string) | repeated | The roles required for approval in order. |
-<a name="bytebase-v1-BatchGetUsersResponse"></a>
+<a name="bytebase-v1-ApprovalTemplate"></a>
-### BatchGetUsersResponse
+### ApprovalTemplate
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
+| flow | [ApprovalFlow](#bytebase-v1-ApprovalFlow) | | The approval flow definition. |
+| title | [string](#string) | | The title of the approval template. |
+| description | [string](#string) | | The description of the approval template. |
-<a name="bytebase-v1-CreateUserRequest"></a>
+<a name="bytebase-v1-ApproveIssueRequest"></a>
-### CreateUserRequest
+### ApproveIssueRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| user | [User](#bytebase-v1-User) | | The user to create. |
+| name | [string](#string) | | The name of the issue to add an approver. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the approval decision. |
-<a name="bytebase-v1-DeleteUserRequest"></a>
+<a name="bytebase-v1-BatchUpdateIssuesStatusRequest"></a>
-### DeleteUserRequest
+### BatchUpdateIssuesStatusRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user to delete. Format: users/{email} |
-
-
+| parent | [string](#string) | | The parent resource shared by all issues being updated. Format: projects/{project} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the status of databases for now. |
+| issues | [string](#string) | repeated | The list of issues to update. Format: projects/{project}/issues/{issue} |
+| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The new status. |
+| reason | [string](#string) | | The reason for the status change. |
-<a name="bytebase-v1-GetUserRequest"></a>
-### GetUserRequest
+<a name="bytebase-v1-BatchUpdateIssuesStatusResponse"></a>
+### BatchUpdateIssuesStatusResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user to retrieve. Format: users/{email} |
-<a name="bytebase-v1-ListUsersRequest"></a>
+<a name="bytebase-v1-CreateIssueCommentRequest"></a>
-### ListUsersRequest
+### CreateIssueCommentRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 10 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListUsers` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted users if specified. |
-| filter | [string](#string) | | Filter is used to filter users returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator. - user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - state: check State enum for values, support &#34;==&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-
-For example: name == &#34;ed&#34; name.matches(&#34;ed&#34;) email == &#34;[email protected]&#34; email.matches(&#34;ed&#34;) user_type == &#34;SERVICE_ACCOUNT&#34; user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;] !(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]) state == &#34;DELETED&#34; project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; (name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; |
+| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
+| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to create. |
-<a name="bytebase-v1-ListUsersResponse"></a>
+<a name="bytebase-v1-CreateIssueRequest"></a>
-### ListUsersResponse
+### CreateIssueRequest
| 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. |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
+| issue | [Issue](#bytebase-v1-Issue) | | The issue to create. |
-<a name="bytebase-v1-UndeleteUserRequest"></a>
+<a name="bytebase-v1-GetIssueRequest"></a>
-### UndeleteUserRequest
+### GetIssueRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted user. Format: users/{email} |
+| name | [string](#string) | | The name of the issue to retrieve. Format: projects/{project}/issues/{issue} |
+| force | [bool](#bool) | | If set to true, bypass cache and fetch the latest data. |
-<a name="bytebase-v1-UpdateEmailRequest"></a>
+<a name="bytebase-v1-GrantRequest"></a>
-### UpdateEmailRequest
+### GrantRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user whose email to update. Format: users/{email} Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. |
-| email | [string](#string) | | The new email address. |
+| role | [string](#string) | | The requested role. Format: roles/EXPORTER. |
+| user | [string](#string) | | The user to be granted. Format: users/{email}. |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition for the role. Same as the condition in IAM Binding message. |
+| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for which the grant is valid. |
-<a name="bytebase-v1-UpdateUserRequest"></a>
+<a name="bytebase-v1-Issue"></a>
-### UpdateUserRequest
+### Issue
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| user | [User](#bytebase-v1-User) | | The user to update.
-
-The user&#39;s `name` field is used to identify the user to update. Format: users/{email} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
-| regenerate_temp_mfa_secret | [bool](#bool) | | The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user. This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. |
-| regenerate_recovery_codes | [bool](#bool) | | The regenerate_recovery_codes flag means to regenerate recovery codes for user. |
-| allow_missing | [bool](#bool) | | If set to true, and the user is not found, a new user will be created. In this situation, `update_mask` is ignored. |
-
+| name | [string](#string) | | The name of the issue. Format: projects/{project}/issues/{issue} |
+| title | [string](#string) | | The title of the issue. |
+| description | [string](#string) | | The description of the issue. |
+| type | [Issue.Type](#bytebase-v1-Issue-Type) | | |
+| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The status of the issue. |
+| approvers | [Issue.Approver](#bytebase-v1-Issue-Approver) | repeated | |
+| approval_template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | The approval template for the issue. |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| plan | [string](#string) | | The plan associated with the issue. Can be empty. Format: projects/{project}/plans/{plan} |
+| grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. |
+| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. |
+| approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | |
-<a name="bytebase-v1-User"></a>
-### User
+<a name="bytebase-v1-Issue-Approver"></a>
+### Issue.Approver
+Approvers and their approval status for the issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user. Format: users/{email} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |
-| email | [string](#string) | | The email address of the user, used for login and notifications. |
-| title | [string](#string) | | The display title or full name of the user. |
-| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |
-| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |
-| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. |
-| mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. |
-| temp_otp_secret | [string](#string) | | Temporary OTP secret used during MFA setup and regeneration. |
-| temp_recovery_codes | [string](#string) | repeated | Temporary recovery codes used during MFA setup and regeneration. |
-| temp_otp_secret_created_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. |
-| phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |
-| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. |
-| groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |
-| workload_identity_config | [WorkloadIdentityConfig](#bytebase-v1-WorkloadIdentityConfig) | | Workload Identity configuration (only for WORKLOAD_IDENTITY type) |
-
+| status | [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status) | | The new status. |
+| principal | [string](#string) | | Format: users/[email protected] |
-<a name="bytebase-v1-User-Profile"></a>
-### User.Profile
+<a name="bytebase-v1-IssueComment"></a>
+### IssueComment
+A comment on an issue.
| 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. |
+| name | [string](#string) | | Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} |
+| comment | [string](#string) | | The text content of the comment. |
+| payload | [string](#string) | | TODO: use struct message instead. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| creator | [string](#string) | | Format: users/{email} |
+| approval | [IssueComment.Approval](#bytebase-v1-IssueComment-Approval) | | Approval event. |
+| issue_update | [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate) | | Issue update event. |
+| plan_spec_update | [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate) | | Plan spec update event. |
-<a name="bytebase-v1-WorkloadIdentityConfig"></a>
+<a name="bytebase-v1-IssueComment-Approval"></a>
-### WorkloadIdentityConfig
-WorkloadIdentityConfig for API layer
+### IssueComment.Approval
+Approval event information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| provider_type | [WorkloadIdentityConfig.ProviderType](#bytebase-v1-WorkloadIdentityConfig-ProviderType) | | Platform type (currently only GITHUB is supported) |
-| issuer_url | [string](#string) | | OIDC Issuer URL (auto-filled based on provider_type, can be overridden) |
-| allowed_audiences | [string](#string) | repeated | Allowed audiences for token validation |
-| subject_pattern | [string](#string) | | Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) |
+| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |
-
+<a name="bytebase-v1-IssueComment-IssueUpdate"></a>
-<a name="bytebase-v1-UserType"></a>
+### IssueComment.IssueUpdate
+Issue update event information.
-### UserType
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| from_title | [string](#string) | optional | |
+| to_title | [string](#string) | optional | |
+| from_description | [string](#string) | optional | |
+| to_description | [string](#string) | optional | |
+| from_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
+| to_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
+| from_labels | [string](#string) | repeated | |
+| to_labels | [string](#string) | repeated | |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| USER_TYPE_UNSPECIFIED | 0 | Unspecified user type. |
-| USER | 1 | Regular human user account. |
-| SYSTEM_BOT | 2 | System-managed bot account for automated operations. |
-| SERVICE_ACCOUNT | 3 | Service account for API integrations. |
-| WORKLOAD_IDENTITY | 4 | External CI/CD workload identity. |
-<a name="bytebase-v1-WorkloadIdentityConfig-ProviderType"></a>
-### WorkloadIdentityConfig.ProviderType
-ProviderType identifies the CI/CD platform.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| PROVIDER_TYPE_UNSPECIFIED | 0 | |
-| GITHUB | 1 | |
-| GITLAB | 2 | |
+<a name="bytebase-v1-IssueComment-PlanSpecUpdate"></a>
+### IssueComment.PlanSpecUpdate
+Plan spec update event information (tracks sheet changes to plan specs).
-
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| spec | [string](#string) | | The spec that was updated. Format: projects/{project}/plans/{plan}/specs/{spec} |
+| from_sheet | [string](#string) | optional | The previous sheet. Format: projects/{project}/sheets/{sheet} |
+| to_sheet | [string](#string) | optional | The new sheet. Format: projects/{project}/sheets/{sheet} |
-<a name="bytebase-v1-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. Note: Email updates are not supported through this API. Use UpdateEmail instead. Permissions required: bb.users.update (or self) |
-| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |
-| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |
-| UpdateEmail | [UpdateEmailRequest](#bytebase-v1-UpdateEmailRequest) | [User](#bytebase-v1-User) | Updates a user&#39;s email address. Permissions required: bb.users.updateEmail |
-
+<a name="bytebase-v1-ListIssueCommentsRequest"></a>
+### ListIssueCommentsRequest
-<a name="v1_actuator_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/actuator_service.proto
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | Format: projects/{projects}/issues/{issue} |
+| page_size | [int32](#int32) | | The maximum number of issue comments to return. The service may return fewer than this value. If unspecified, at most 10 issue comments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListIssueComments` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListIssueComments` must match the call that provided the page token. |
-<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 |
-| ----- | ---- | ----- | ----------- |
-| version | [string](#string) | | The Bytebase server version. |
-| git_commit | [string](#string) | | The git commit hash of the build. |
-| readonly | [bool](#bool) | | Whether the Bytebase instance is running in read-only mode. |
-| saas | [bool](#bool) | | Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. |
-| demo | [bool](#bool) | | Whether the Bytebase instance is running in demo mode. |
-| host | [string](#string) | | The host address of the Bytebase instance. |
-| port | [string](#string) | | The port number of the Bytebase instance. |
-| external_url | [string](#string) | | The external URL where users or webhook callbacks access Bytebase. |
-| need_admin_setup | [bool](#bool) | | Whether the Bytebase instance requires initial admin setup. |
-| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |
-| workspace_id | [string](#string) | | The unique identifier for the workspace. |
-| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |
-| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |
-| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |
-| activated_instance_count | [int32](#int32) | | The number of activated database instances. |
-| total_instance_count | [int32](#int32) | | The total number of database instances. |
-| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |
-| external_url_from_flag | [bool](#bool) | | Whether the external URL is set via command-line flag (and thus cannot be changed via UI). |
-| replica_count | [int32](#int32) | | The number of active replicas (servers sharing the same database). |
+<a name="bytebase-v1-ListIssueCommentsResponse"></a>
+### ListIssueCommentsResponse
-<a name="bytebase-v1-ActuatorInfo-StatUser"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | The issue comments from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-### 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. |
+<a name="bytebase-v1-ListIssuesRequest"></a>
+### ListIssuesRequest
-<a name="bytebase-v1-DeleteCacheRequest"></a>
-### DeleteCacheRequest
-Request message for deleting cache.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
+| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListIssues` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListIssues` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter issues returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filters: - creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values. - create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values. - labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator. - approval_status: issue approval status, support &#34;==&#34; operator. - current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
+For example: creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;] status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34; labels in [&#34;label1&#34;, &#34;label2&#34;] create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; |
+| query | [string](#string) | | Query is the query statement. |
-<a name="bytebase-v1-GetActuatorInfoRequest"></a>
-### GetActuatorInfoRequest
-Request message for getting actuator information.
+<a name="bytebase-v1-ListIssuesResponse"></a>
+### ListIssuesResponse
-<a name="bytebase-v1-GetResourcePackageRequest"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-### GetResourcePackageRequest
-Request message for getting branding resources.
+<a name="bytebase-v1-RejectIssueRequest"></a>
-<a name="bytebase-v1-ResourcePackage"></a>
+### RejectIssueRequest
-### ResourcePackage
-Custom branding resources for the Bytebase instance.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| logo | [bytes](#bytes) | | The branding logo. |
+| name | [string](#string) | | The name of the issue to add a rejection. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the rejection decision. |
-<a name="bytebase-v1-SetupSampleRequest"></a>
+<a name="bytebase-v1-RequestIssueRequest"></a>
-### SetupSampleRequest
-Request message for setting up sample data.
+### RequestIssueRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the issue to request a issue. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the request. |
-
-
-
-<a name="bytebase-v1-ActuatorService"></a>
+<a name="bytebase-v1-SearchIssuesRequest"></a>
-### ActuatorService
-ActuatorService manages system health and operational information.
+### SearchIssuesRequest
-| 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 |
-| 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 |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} Use &#34;projects/-&#34; to list all issues from all projects. |
+| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchIssues` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchIssues` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter issues returned in the list. Check the filter field in the ListIssuesRequest message. |
+| query | [string](#string) | | Query is the query statement. |
-<a name="v1_iam_policy-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/iam_policy.proto
-<a name="bytebase-v1-Binding"></a>
+<a name="bytebase-v1-SearchIssuesResponse"></a>
+
+### SearchIssuesResponse
-### Binding
-Binding associates members with a role and optional conditions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [string](#string) | | The role that is assigned to the members. Format: roles/{role} |
-| members | [string](#string) | repeated | Specifies the principals requesting access for a Bytebase resource. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this binding, only used in the project IAM policy. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables: resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
+| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-For example: resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;] resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;] request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) |
-| parsed_expr | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | | The parsed expression of the condition. |
+<a name="bytebase-v1-UpdateIssueCommentRequest"></a>
-<a name="bytebase-v1-BindingDelta"></a>
+### UpdateIssueCommentRequest
-### 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. |
+| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
+| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-GetIamPolicyRequest"></a>
+<a name="bytebase-v1-UpdateIssueRequest"></a>
+
+### UpdateIssueRequest
-### 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} |
+| issue | [Issue](#bytebase-v1-Issue) | | The issue to update.
+The issue&#39;s `name` field is used to identify the issue to update. Format: projects/{project}/issues/{issue} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the issue is not found, a new issue will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-IamPolicy"></a>
+
-### IamPolicy
-IAM policy that binds members to roles.
+<a name="bytebase-v1-Issue-ApprovalStatus"></a>
-| 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. |
+### Issue.ApprovalStatus
+The overall approval status for the issue.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| APPROVAL_STATUS_UNSPECIFIED | 0 | Unspecified approval status. |
+| CHECKING | 1 | Approval checks are being evaluated. |
+| PENDING | 2 | Approval is pending. |
+| APPROVED | 3 | Issue has been approved. |
+| REJECTED | 4 | Issue has been rejected. |
+| SKIPPED | 5 | Approval was skipped. |
+<a name="bytebase-v1-Issue-Approver-Status"></a>
+### Issue.Approver.Status
+The approval status of an approver.
-<a name="bytebase-v1-PolicyDelta"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Awaiting approval. |
+| APPROVED | 2 | Approved. |
+| REJECTED | 3 | Rejected. |
-### 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-Issue-Type"></a>
+### Issue.Type
+The type of issue.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified issue type. |
+| DATABASE_CHANGE | 1 | Database schema or data change. |
+| GRANT_REQUEST | 2 | Database access grant request. |
+| DATABASE_EXPORT | 3 | Database data export request. |
+<a name="bytebase-v1-IssueComment-Approval-Status"></a>
-<a name="bytebase-v1-SetIamPolicyRequest"></a>
+### IssueComment.Approval.Status
+Approval status values.
-### SetIamPolicyRequest
-Request message for setting an IAM policy.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Approval pending. |
+| APPROVED | 2 | Approved. |
+| REJECTED | 3 | Rejected. |
-| 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. |
+<a name="bytebase-v1-IssueStatus"></a>
+### IssueStatus
+The status of an issue.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ISSUE_STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| OPEN | 1 | Issue is open and active. |
+| DONE | 2 | Issue is completed. |
+| CANCELED | 3 | Issue is canceled. |
+
-<a name="bytebase-v1-BindingDelta-Action"></a>
-
-### BindingDelta.Action
-Type of action performed on a binding.
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| ACTION_UNSPECIFIED | 0 | Unspecified action. |
-| ADD | 1 | Add a binding. |
-| REMOVE | 2 | Remove a binding. |
+<a name="bytebase-v1-IssueService"></a>
-
+### IssueService
+IssueService manages issues for tracking database changes and tasks.
-
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetIssue | [GetIssueRequest](#bytebase-v1-GetIssueRequest) | [Issue](#bytebase-v1-Issue) | Retrieves an issue by name. Permissions required: bb.issues.get |
+| CreateIssue | [CreateIssueRequest](#bytebase-v1-CreateIssueRequest) | [Issue](#bytebase-v1-Issue) | Creates a new issue for database changes or tasks. Permissions required: bb.issues.create |
+| ListIssues | [ListIssuesRequest](#bytebase-v1-ListIssuesRequest) | [ListIssuesResponse](#bytebase-v1-ListIssuesResponse) | Lists issues in a project. Permissions required: bb.issues.list |
+| SearchIssues | [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest) | [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse) | Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query. Permissions required: bb.issues.get |
+| UpdateIssue | [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest) | [Issue](#bytebase-v1-Issue) | Updates an issue&#39;s properties such as title, description, or labels. Permissions required: bb.issues.update |
+| ListIssueComments | [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest) | [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse) | Lists comments on an issue. Permissions required: bb.issueComments.list |
+| CreateIssueComment | [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Adds a comment to an issue. Permissions required: bb.issueComments.create |
+| UpdateIssueComment | [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Updates an existing issue comment. Permissions required: bb.issueComments.update |
+| BatchUpdateIssuesStatus | [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest) | [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse) | Updates the status of multiple issues in a single operation. Permissions required: bb.issues.update |
+| ApproveIssue | [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest) | [Issue](#bytebase-v1-Issue) | Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
+| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
+| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
-<a name="v1_audit_log_service-proto"></a>
+<a name="v1_setting_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/audit_log_service.proto
+## v1/setting_service.proto
-<a name="bytebase-v1-AuditData"></a>
+<a name="bytebase-v1-AISetting"></a>
+
+### AISetting
-### AuditData
-Additional audit data specific to certain operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |
+| enabled | [bool](#bool) | | |
+| provider | [AISetting.Provider](#bytebase-v1-AISetting-Provider) | | |
+| endpoint | [string](#string) | | |
+| api_key | [string](#string) | | |
+| model | [string](#string) | | |
+| version | [string](#string) | | |
-<a name="bytebase-v1-AuditLog"></a>
+<a name="bytebase-v1-Algorithm"></a>
+
+### Algorithm
-### AuditLog
-Audit log entry recording system activity or API call.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the log. Formats: - projects/{project}/auditLogs/{uid} - workspaces/{workspace}/auditLogs/{uid} |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The timestamp when the audit log was created. |
-| user | [string](#string) | | The user who performed the action. Format: users/{email} |
-| method | [string](#string) | | The method or action being audited. For example: /bytebase.v1.SQLService/Query or bb.project.repository.push |
-| severity | [AuditLog.Severity](#bytebase-v1-AuditLog-Severity) | | The severity level of this audit log entry. |
-| resource | [string](#string) | | The resource associated with this audit log. |
-| request | [string](#string) | | The request payload in JSON format. |
-| response | [string](#string) | | The response payload in JSON format. Some fields may be omitted if they are too large or contain sensitive information. |
-| status | [google.rpc.Status](#google-rpc-Status) | | The status of the operation. |
-| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration of the operation. |
-| service_data | [google.protobuf.Any](#google-protobuf-Any) | | Service-specific metadata about the request, response, and activities. |
-| request_metadata | [RequestMetadata](#bytebase-v1-RequestMetadata) | | Metadata about the request context. |
+| 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-ExportAuditLogsRequest"></a>
+<a name="bytebase-v1-Algorithm-FullMask"></a>
+
+### Algorithm.FullMask
-### ExportAuditLogsRequest
-Request message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | |
-| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. Check the filter field in the SearchAuditLogsRequest message. |
-| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
-| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The export format. |
-| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
-| page_token | [string](#string) | | A page token, received from a previous `ExportAuditLogs` call. Provide this to retrieve the subsequent page. |
+| 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-ExportAuditLogsResponse"></a>
+<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>
+
+### Algorithm.InnerOuterMask
-### ExportAuditLogsResponse
-Response message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [bytes](#bytes) | | The exported audit log content in the requested format. |
-| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
+| prefix_len | [int32](#int32) | | |
+| suffix_len | [int32](#int32) | | |
+| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |
+| substitution | [string](#string) | | |
-<a name="bytebase-v1-RequestMetadata"></a>
+<a name="bytebase-v1-Algorithm-MD5Mask"></a>
+
+### Algorithm.MD5Mask
-### 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. |
+| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |
-<a name="bytebase-v1-SearchAuditLogsRequest"></a>
+<a name="bytebase-v1-Algorithm-RangeMask"></a>
+
+### Algorithm.RangeMask
-### SearchAuditLogsRequest
-Request message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | |
-| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator. - severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values. - user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator. - create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
+| 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. |
-For example: - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; |
-| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
-| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchLogs` call. Provide this to retrieve the subsequent page. |
+<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>
-<a name="bytebase-v1-SearchAuditLogsResponse"></a>
+### Algorithm.RangeMask.Slice
-### SearchAuditLogsResponse
-Response message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| audit_logs | [AuditLog](#bytebase-v1-AuditLog) | repeated | |
-| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
+| start | [int32](#int32) | | start is the start character index (0-based) of the original value, should be less than end. Uses character indices (not byte offsets) for display-oriented masking. Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). |
+| end | [int32](#int32) | | end is the end character index (exclusive) of the original value. Uses character indices (not byte offsets) for display-oriented masking. |
+| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |
-
+<a name="bytebase-v1-Announcement"></a>
-<a name="bytebase-v1-AuditLog-Severity"></a>
+### Announcement
-### 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 |
+| ----- | ---- | ----- | ----------- |
+| 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-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="v1_auth_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-
-## v1/auth_service.proto
+<a name="bytebase-v1-AppIMSetting"></a>
-<a name="bytebase-v1-ExchangeTokenRequest"></a>
-
-### ExchangeTokenRequest
+### AppIMSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | External OIDC token (JWT) from CI/CD platform. |
-| email | [string](#string) | | Workload Identity email for identifying which identity to authenticate as. Format: {name}@workload.bytebase.com |
+| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |
-<a name="bytebase-v1-ExchangeTokenResponse"></a>
+<a name="bytebase-v1-AppIMSetting-DingTalk"></a>
-### ExchangeTokenResponse
+### AppIMSetting.DingTalk
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| access_token | [string](#string) | | Bytebase access token. |
+| client_id | [string](#string) | | |
+| client_secret | [string](#string) | | |
+| robot_code | [string](#string) | | |
-<a name="bytebase-v1-IdentityProviderContext"></a>
+<a name="bytebase-v1-AppIMSetting-Feishu"></a>
+
+### AppIMSetting.Feishu
-### IdentityProviderContext
-Context for identity provider authentication.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |
-| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |
+| app_id | [string](#string) | | |
+| app_secret | [string](#string) | | |
-<a name="bytebase-v1-LoginRequest"></a>
+<a name="bytebase-v1-AppIMSetting-IMSetting"></a>
-### LoginRequest
+### AppIMSetting.IMSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| email | [string](#string) | | User&#39;s email address. |
-| password | [string](#string) | | User&#39;s password for authentication. |
-| web | [bool](#bool) | | If true, sets access token and refresh token as HTTP-only cookies instead of returning the token in the response body. Use for browser-based clients. |
-| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
-| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is used to get the user information from identity provider. |
-| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
-| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user&#39;s identity with MFA. |
-| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user&#39;s identity by MFA. |
+| 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-LoginResponse"></a>
+<a name="bytebase-v1-AppIMSetting-Lark"></a>
-### LoginResponse
+### AppIMSetting.Lark
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | Access token for authenticated requests. Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. |
-| mfa_temp_token | [string](#string) | optional | Temporary token for MFA verification. |
-| require_reset_password | [bool](#bool) | | Whether user must reset password before continuing. |
-| user | [User](#bytebase-v1-User) | | The user from the successful login. |
-
-
-
-
-
-
-<a name="bytebase-v1-LogoutRequest"></a>
+| app_id | [string](#string) | | |
+| app_secret | [string](#string) | | |
-### LogoutRequest
-Request to logout current user session.
+<a name="bytebase-v1-AppIMSetting-Slack"></a>
-<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>
+### AppIMSetting.Slack
-### OAuth2IdentityProviderContext
-OAuth2 authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorization code from OAuth2 provider. |
+| token | [string](#string) | | |
-<a name="bytebase-v1-OIDCIdentityProviderContext"></a>
+<a name="bytebase-v1-AppIMSetting-Teams"></a>
+
+### AppIMSetting.Teams
-### OIDCIdentityProviderContext
-OpenID Connect authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorization code from OIDC provider. |
-
-
-
-
-
-
-<a name="bytebase-v1-RefreshRequest"></a>
+| 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. |
-### RefreshRequest
-Request to refresh the access token.
+<a name="bytebase-v1-AppIMSetting-Wecom"></a>
-<a name="bytebase-v1-RefreshResponse"></a>
+### AppIMSetting.Wecom
-### RefreshResponse
-Response from refreshing the access token.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| corp_id | [string](#string) | | |
+| agent_id | [string](#string) | | |
+| secret | [string](#string) | | |
-
-
-
+<a name="bytebase-v1-DataClassificationSetting"></a>
-<a name="bytebase-v1-AuthService"></a>
+### DataClassificationSetting
-### AuthService
-AuthService handles user authentication operations.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |
-| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |
-| ExchangeToken | [ExchangeTokenRequest](#bytebase-v1-ExchangeTokenRequest) | [ExchangeTokenResponse](#bytebase-v1-ExchangeTokenResponse) | Exchanges an external OIDC token for a Bytebase access token. Used by CI/CD pipelines with Workload Identity Federation. Permissions required: None (validates via OIDC token) |
-| Refresh | [RefreshRequest](#bytebase-v1-RefreshRequest) | [RefreshResponse](#bytebase-v1-RefreshResponse) | Refreshes the access token using the refresh token cookie. Permissions required: None (validates via refresh token cookie) |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |
-<a name="v1_cel_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/cel_service.proto
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>
-<a name="bytebase-v1-BatchDeparseRequest"></a>
+### DataClassificationSetting.DataClassificationConfig
-### 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. |
+| id | [string](#string) | | id is the uuid for classification. Each project can chose one classification config. |
+| title | [string](#string) | | |
+| levels | [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level) | repeated | levels is user defined level list for classification. The order for the level decides its priority. |
+| classification | [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry) | repeated | classification is the id - DataClassification map. The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
-<a name="bytebase-v1-BatchDeparseResponse"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>
+
+### DataClassificationSetting.DataClassificationConfig.ClassificationEntry
-### BatchDeparseResponse
-Response message for batch deparsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |
+| key | [string](#string) | | |
+| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |
-<a name="bytebase-v1-BatchParseRequest"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>
+
+### DataClassificationSetting.DataClassificationConfig.DataClassification
-### BatchParseRequest
-Request message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [string](#string) | repeated | The CEL expression strings to parse. |
+| id | [string](#string) | | id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
+| title | [string](#string) | | |
+| description | [string](#string) | | |
+| level_id | [string](#string) | optional | |
-<a name="bytebase-v1-BatchParseResponse"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>
+
+### DataClassificationSetting.DataClassificationConfig.Level
-### 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. |
-
-
+| id | [string](#string) | | |
+| title | [string](#string) | | |
+| description | [string](#string) | | |
-
-
-
+<a name="bytebase-v1-EnvironmentSetting"></a>
-<a name="bytebase-v1-CelService"></a>
+### EnvironmentSetting
-### CelService
-CelService manages CEL (Common Expression Language) parsing and formatting operations.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Parses multiple CEL expression strings into AST representations. Permissions required: None |
-| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Converts multiple CEL AST representations back into expression strings. Permissions required: None |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |
-<a name="v1_database_catalog_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/database_catalog_service.proto
+<a name="bytebase-v1-EnvironmentSetting-Environment"></a>
-<a name="bytebase-v1-ColumnCatalog"></a>
+### EnvironmentSetting.Environment
-### 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 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-ColumnCatalog-LabelsEntry"></a>
+<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>
-### ColumnCatalog.LabelsEntry
+### EnvironmentSetting.Environment.TagsEntry
@@ -1996,2680 +1918,2542 @@ Column metadata within a table.
-<a name="bytebase-v1-DatabaseCatalog"></a>
+<a name="bytebase-v1-GetSettingRequest"></a>
-### DatabaseCatalog
-Catalog metadata for a database including schemas, tables, and columns.
+### GetSettingRequest
+The request message for getting a setting.
| 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. |
+| name | [string](#string) | | The resource name of the setting. |
-<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>
+<a name="bytebase-v1-GetSettingResponse"></a>
-### GetDatabaseCatalogRequest
-Request message for getting a database catalog.
+### GetSettingResponse
+The response message for getting a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |
+| setting | [Setting](#bytebase-v1-Setting) | | |
-<a name="bytebase-v1-ObjectSchema"></a>
+<a name="bytebase-v1-ListSettingsRequest"></a>
-### ObjectSchema
-Schema definition for object-type columns.
+### ListSettingsRequest
-| 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. |
+<a name="bytebase-v1-ListSettingsResponse"></a>
-<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>
+### ListSettingsResponse
-### ObjectSchema.ArrayKind
-Array type with element schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |
+| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |
-<a name="bytebase-v1-ObjectSchema-StructKind"></a>
+<a name="bytebase-v1-SemanticTypeSetting"></a>
+
+### SemanticTypeSetting
-### 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. |
+| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |
-<a name="bytebase-v1-ObjectSchema-StructKind-PropertiesEntry"></a>
+<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>
-### ObjectSchema.StructKind.PropertiesEntry
+### SemanticTypeSetting.SemanticType
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |
+| 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-SchemaCatalog"></a>
+<a name="bytebase-v1-Setting"></a>
-### SchemaCatalog
-Schema metadata within a database.
+### Setting
+The schema of setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The schema name. |
-| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |
+| name | [string](#string) | | The resource name of the setting. Format: settings/{setting} Example: &#34;settings/SEMANTIC_TYPES&#34; |
+| value | [SettingValue](#bytebase-v1-SettingValue) | | The configuration value of the setting. |
-<a name="bytebase-v1-TableCatalog"></a>
+<a name="bytebase-v1-SettingValue"></a>
-### TableCatalog
-Table metadata within a schema.
+### SettingValue
+The data in setting value.
| 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. |
+| 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-TableCatalog-Columns"></a>
+<a name="bytebase-v1-UpdateSettingRequest"></a>
-### TableCatalog.Columns
-Column list for regular tables.
+### UpdateSettingRequest
+The request message for updating or creating a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |
+| setting | [Setting](#bytebase-v1-Setting) | | The setting to update. |
+| validate_only | [bool](#bool) | | validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true. |
+| allow_missing | [bool](#bool) | | |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | |
-<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>
+<a name="bytebase-v1-WorkspaceApprovalSetting"></a>
+
+### WorkspaceApprovalSetting
-### UpdateDatabaseCatalogRequest
-Request message for updating a database catalog.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.
-
-The catalog&#39;s `name` field is used to identify the database catalog to update. Format: instances/{instance}/databases/{database}/catalog |
-| 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. |
-
-
-
+| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |
-
-<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-WorkspaceApprovalSetting-Rule"></a>
+### WorkspaceApprovalSetting.Rule
-
-
+| 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
-<a name="bytebase-v1-DatabaseCatalogService"></a>
+The `source` field filters which rules apply. The `condition` field then evaluates with full context.
-### DatabaseCatalogService
-DatabaseCatalogService manages database schema metadata and classification.
+All supported variables: statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values. statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-| 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 |
+When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*) When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
-
+For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100 resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; |
+| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |
-<a name="v1_database_group_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/database_group_service.proto
+<a name="bytebase-v1-WorkspaceProfileSetting"></a>
-<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>
+### WorkspaceProfileSetting
-### 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&#39;s resource name.
+| external_url | [string](#string) | | The external URL is used for sso authentication callback. |
+| disallow_signup | [bool](#bool) | | Disallow self-service signup, users can only be invited by the owner. |
+| require_2fa | [bool](#bool) | | Require 2FA for all users. |
+| refresh_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for refresh token. Default is 7 days. |
+| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
+| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
+| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
+| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
+| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
+| disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |
+| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
+| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. |
+| enable_audit_log_stdout | [bool](#bool) | | Whether to enable audit logging to stdout in structured JSON format. Requires TEAM or ENTERPRISE license. |
+| watermark | [bool](#bool) | | Whether to display watermark on pages. Requires ENTERPRISE license. |
+| directory_sync_token | [string](#string) | | The token for directory sync authentication. |
+| branding_logo | [string](#string) | | The branding logo as a data URI (e.g. data:image/png;base64,...). |
+| password_restriction | [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction) | | Password restriction settings. |
+| access_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for access token. Default is 1 hour. |
+| enable_debug | [bool](#bool) | | Whether debug mode is enabled. |
-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-WorkspaceProfileSetting-PasswordRestriction"></a>
-<a name="bytebase-v1-DatabaseGroup"></a>
+### WorkspaceProfileSetting.PasswordRestriction
-### 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
+| 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. |
-Support variables: resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations. resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_labels: the database labels. Support map access operations. All variables should join with &#34;&amp;&amp;&#34; condition.
-For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;) resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; |
-| matched_databases | [DatabaseGroup.Database](#bytebase-v1-DatabaseGroup-Database) | repeated | The list of databases that match the database group condition. |
+
+<a name="bytebase-v1-AISetting-Provider"></a>
-<a name="bytebase-v1-DatabaseGroup-Database"></a>
+### AISetting.Provider
-### DatabaseGroup.Database
-A database within a database group.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PROVIDER_UNSPECIFIED | 0 | |
+| OPEN_AI | 1 | |
+| CLAUDE | 2 | |
+| GEMINI | 3 | |
+| AZURE_OPENAI | 4 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |
+<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>
+### Algorithm.InnerOuterMask.MaskType
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| MASK_TYPE_UNSPECIFIED | 0 | |
+| INNER | 1 | |
+| OUTER | 2 | |
-<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>
-### DeleteDatabaseGroupRequest
-Request message for deleting a database group.
+<a name="bytebase-v1-Announcement-AlertLevel"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |
+### 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-DatabaseChangeMode"></a>
+### DatabaseChangeMode
-<a name="bytebase-v1-GetDatabaseGroupRequest"></a>
-### GetDatabaseGroupRequest
-Request message for getting a database group.
+| 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 |
-| ----- | ---- | ----- | ----------- |
-| 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-Setting-SettingName"></a>
+### Setting.SettingName
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SETTING_NAME_UNSPECIFIED | 0 | |
+| WORKSPACE_PROFILE | 1 | |
+| WORKSPACE_APPROVAL | 2 | |
+| APP_IM | 3 | |
+| AI | 4 | |
+| DATA_CLASSIFICATION | 5 | |
+| SEMANTIC_TYPES | 6 | |
+| ENVIRONMENT | 7 | |
-<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>
-### ListDatabaseGroupsRequest
-Request message for listing database groups.
+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>
+### WorkspaceApprovalSetting.Rule.Source
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource whose database groups are to be listed. Format: projects/{project} |
-| view | [DatabaseGroupView](#bytebase-v1-DatabaseGroupView) | | The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SOURCE_UNSPECIFIED | 0 | |
+| CHANGE_DATABASE | 1 | |
+| CREATE_DATABASE | 2 | |
+| EXPORT_DATA | 3 | |
+| REQUEST_ROLE | 4 | |
+
+
-<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>
+<a name="bytebase-v1-SettingService"></a>
-### ListDatabaseGroupsResponse
-Response message for listing database groups.
+### 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 |
-| ----- | ---- | ----- | ----------- |
-| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |
+
+<a name="v1_user_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/user_service.proto
-<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>
-### UpdateDatabaseGroupRequest
-Request message for updating a database group.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.
-
-The database group&#39;s `name` field is used to identify the database group to update. Format: projects/{project}/databaseGroups/{databaseGroup} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the database group is not found, a new database group will be created. In this situation, `update_mask` is ignored. |
+<a name="bytebase-v1-BatchGetUsersRequest"></a>
+### BatchGetUsersRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| names | [string](#string) | repeated | The user names to retrieve. Format: users/{email} |
-
-
-
-<a name="bytebase-v1-DatabaseGroupView"></a>
-
-### DatabaseGroupView
-View options for database group responses.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| DATABASE_GROUP_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
-| DATABASE_GROUP_VIEW_BASIC | 1 | Include basic information about the database group, but exclude the list of matched databases and unmatched databases. |
-| DATABASE_GROUP_VIEW_FULL | 2 | Include everything. |
-
-
+<a name="bytebase-v1-BatchGetUsersResponse"></a>
-<a name="bytebase-v1-DatabaseGroupService"></a>
+### BatchGetUsersResponse
-### 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 |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
-<a name="v1_instance_role_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/instance_role_service.proto
+<a name="bytebase-v1-CreateUserRequest"></a>
-<a name="bytebase-v1-InstanceRole"></a>
+### CreateUserRequest
-### InstanceRole
-InstanceRole is the API message for instance role.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role. Format: instances/{instance}/roles/{role} The role name is the unique name for the role. |
-| role_name | [string](#string) | | The role name. It&#39;s unique within the instance. |
-| password | [string](#string) | optional | The role password. |
-| connection_limit | [int32](#int32) | optional | The connection count limit for this role. |
-| valid_until | [string](#string) | optional | The expiration for the role&#39;s password. |
-| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |
+| user | [User](#bytebase-v1-User) | | The user to create. |
-<a name="bytebase-v1-ListInstanceRolesRequest"></a>
+<a name="bytebase-v1-DeleteUserRequest"></a>
-### ListInstanceRolesRequest
+### DeleteUserRequest
| 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 the user to delete. Format: users/{email} |
-<a name="bytebase-v1-ListInstanceRolesResponse"></a>
+<a name="bytebase-v1-GetUserRequest"></a>
-### ListInstanceRolesResponse
+### GetUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | The roles from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| name | [string](#string) | | The name of the user to retrieve. Format: users/{email} |
-
-
+<a name="bytebase-v1-ListUsersRequest"></a>
-
+### ListUsersRequest
-<a name="bytebase-v1-InstanceRoleService"></a>
-### InstanceRoleService
-InstanceRoleService manages database roles within instances.
+| 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.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |
+When paginating, all other parameters provided to `ListUsers` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted users if specified. |
+| filter | [string](#string) | | Filter is used to filter users returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
+Supported filter: - name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator. - user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - state: check State enum for values, support &#34;==&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+For example: name == &#34;ed&#34; name.matches(&#34;ed&#34;) email == &#34;[email protected]&#34; email.matches(&#34;ed&#34;) user_type == &#34;SERVICE_ACCOUNT&#34; user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;] !(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]) state == &#34;DELETED&#34; project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; (name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; |
-<a name="v1_instance_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/instance_service.proto
-<a name="bytebase-v1-AddDataSourceRequest"></a>
+<a name="bytebase-v1-ListUsersResponse"></a>
-### AddDataSourceRequest
+### ListUsersResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to add a data source to. Format: instances/{instance} |
-| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. Only READ_ONLY data source can be added. |
-| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
+| 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-BatchSyncInstancesRequest"></a>
+<a name="bytebase-v1-UndeleteUserRequest"></a>
-### BatchSyncInstancesRequest
+### UndeleteUserRequest
| 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. |
-
-
-
-
-
-
-<a name="bytebase-v1-BatchSyncInstancesResponse"></a>
-
-### BatchSyncInstancesResponse
-
+| name | [string](#string) | | The name of the deleted user. Format: users/{email} |
-<a name="bytebase-v1-BatchUpdateInstancesRequest"></a>
+<a name="bytebase-v1-UpdateEmailRequest"></a>
-### BatchUpdateInstancesRequest
+### UpdateEmailRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |
+| name | [string](#string) | | The name of the user whose email to update. Format: users/{email} Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. |
+| email | [string](#string) | | The new email address. |
-<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>
+<a name="bytebase-v1-UpdateUserRequest"></a>
-### BatchUpdateInstancesResponse
+### UpdateUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instances | [Instance](#bytebase-v1-Instance) | repeated | |
+| user | [User](#bytebase-v1-User) | | The user to update.
+The user&#39;s `name` field is used to identify the user to update. Format: users/{email} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
+| regenerate_temp_mfa_secret | [bool](#bool) | | The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user. This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response. |
+| regenerate_recovery_codes | [bool](#bool) | | The regenerate_recovery_codes flag means to regenerate recovery codes for user. |
+| allow_missing | [bool](#bool) | | If set to true, and the user is not found, a new user will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-CreateInstanceRequest"></a>
-### CreateInstanceRequest
+<a name="bytebase-v1-User"></a>
+
+### User
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instance | [Instance](#bytebase-v1-Instance) | | The instance to create. |
-| instance_id | [string](#string) | | The ID to use for the instance, which will become the final component of the instance&#39;s resource name.
-
-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. |
+| name | [string](#string) | | The name of the user. Format: users/{email} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |
+| email | [string](#string) | | The email address of the user, used for login and notifications. |
+| title | [string](#string) | | The display title or full name of the user. |
+| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |
+| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |
+| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. |
+| mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. |
+| temp_otp_secret | [string](#string) | | Temporary OTP secret used during MFA setup and regeneration. |
+| temp_recovery_codes | [string](#string) | repeated | Temporary recovery codes used during MFA setup and regeneration. |
+| temp_otp_secret_created_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. |
+| phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |
+| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. |
+| groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |
+| workload_identity_config | [WorkloadIdentityConfig](#bytebase-v1-WorkloadIdentityConfig) | | Workload Identity configuration (only for WORKLOAD_IDENTITY type) |
-<a name="bytebase-v1-DataSource"></a>
+<a name="bytebase-v1-User-Profile"></a>
-### DataSource
+### User.Profile
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | The unique identifier for this data source. |
-| type | [DataSourceType](#bytebase-v1-DataSourceType) | | The type of data source (ADMIN or READ_ONLY). |
-| username | [string](#string) | | The username for database authentication. |
-| password | [string](#string) | | The password for database authentication. |
-| use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use system default SSL configuration. |
-| ssl_ca | [string](#string) | | The SSL certificate authority certificate. |
-| ssl_cert | [string](#string) | | The SSL client certificate. |
-| ssl_key | [string](#string) | | The SSL client private key. |
-| verify_tls_certificate | [bool](#bool) | | verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). |
-| host | [string](#string) | | The hostname or IP address of the database server. |
-| port | [string](#string) | | The port number of the database server. |
-| database | [string](#string) | | The name of the database to connect to. |
-| srv | [bool](#bool) | | srv, authentication_database and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record. |
-| authentication_database | [string](#string) | | authentication_database is the database name to authenticate against, which stores the user credentials. |
-| replica_set | [string](#string) | | replica_set is used for MongoDB replica set. |
-| sid | [string](#string) | | sid and service_name are used for Oracle. |
-| service_name | [string](#string) | | |
-| ssh_host | [string](#string) | | Connection over SSH. The hostname of the SSH server agent. Required. |
-| ssh_port | [string](#string) | | The port of the SSH server agent. It&#39;s 22 typically. Required. |
-| ssh_user | [string](#string) | | The user to login the server. Required. |
-| ssh_password | [string](#string) | | The password to login the server. If it&#39;s empty string, no password is required. |
-| ssh_private_key | [string](#string) | | The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). |
-| authentication_private_key | [string](#string) | | PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required. Used for authentication when connecting to the data source. |
-| authentication_private_key_passphrase | [string](#string) | | Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. |
-| external_secret | [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret) | | |
-| authentication_type | [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType) | | |
-| azure_credential | [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential) | | |
-| aws_credential | [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential) | | |
-| gcp_credential | [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential) | | |
-| sasl_config | [SASLConfig](#bytebase-v1-SASLConfig) | | |
-| additional_addresses | [DataSource.Address](#bytebase-v1-DataSource-Address) | repeated | additional_addresses is used for MongoDB replica set. |
-| direct_connection | [bool](#bool) | | direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. |
-| region | [string](#string) | | region is the location of where the DB is, works for AWS RDS. For example, us-east-1. |
-| warehouse_id | [string](#string) | | warehouse_id is used by Databricks. |
-| master_name | [string](#string) | | master_name is the master name used by connecting redis-master via redis sentinel. |
-| master_username | [string](#string) | | master_username and master_password are master credentials used by redis sentinel mode. |
-| master_password | [string](#string) | | |
-| redis_type | [DataSource.RedisType](#bytebase-v1-DataSource-RedisType) | | |
-| cluster | [string](#string) | | Cluster is the cluster name for the data source. Used by CockroachDB. |
-| extra_connection_parameters | [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry) | repeated | Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write |
-
+| 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-DataSource-AWSCredential"></a>
-### DataSource.AWSCredential
+<a name="bytebase-v1-WorkloadIdentityConfig"></a>
+### WorkloadIdentityConfig
+WorkloadIdentityConfig for API layer
| 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 |
+| provider_type | [WorkloadIdentityConfig.ProviderType](#bytebase-v1-WorkloadIdentityConfig-ProviderType) | | Platform type (currently only GITHUB is supported) |
+| issuer_url | [string](#string) | | OIDC Issuer URL (auto-filled based on provider_type, can be overridden) |
+| allowed_audiences | [string](#string) | repeated | Allowed audiences for token validation |
+| subject_pattern | [string](#string) | | Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) |
+
-<a name="bytebase-v1-DataSource-Address"></a>
-### DataSource.Address
+<a name="bytebase-v1-UserType"></a>
+### UserType
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| host | [string](#string) | | |
-| port | [string](#string) | | |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| USER_TYPE_UNSPECIFIED | 0 | Unspecified user type. |
+| USER | 1 | Regular human user account. |
+| SYSTEM_BOT | 2 | System-managed bot account for automated operations. |
+| SERVICE_ACCOUNT | 3 | Service account for API integrations. |
+| WORKLOAD_IDENTITY | 4 | External CI/CD workload identity. |
+<a name="bytebase-v1-WorkloadIdentityConfig-ProviderType"></a>
+### WorkloadIdentityConfig.ProviderType
+ProviderType identifies the CI/CD platform.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PROVIDER_TYPE_UNSPECIFIED | 0 | |
+| GITHUB | 1 | |
+| GITLAB | 2 | |
-<a name="bytebase-v1-DataSource-AzureCredential"></a>
-### DataSource.AzureCredential
+
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| tenant_id | [string](#string) | | |
-| client_id | [string](#string) | | |
-| client_secret | [string](#string) | | |
+<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. Note: Email updates are not supported through this API. Use UpdateEmail instead. Permissions required: bb.users.update (or self) |
+| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |
+| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |
+| UpdateEmail | [UpdateEmailRequest](#bytebase-v1-UpdateEmailRequest) | [User](#bytebase-v1-User) | Updates a user&#39;s email address. Permissions required: bb.users.updateEmail |
+
+
+<a name="v1_actuator_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/actuator_service.proto
-<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>
-### DataSource.ExtraConnectionParametersEntry
+<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. |
+| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |
+| workspace_id | [string](#string) | | The unique identifier for the workspace. |
+| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |
+| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |
+| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |
+| activated_instance_count | [int32](#int32) | | The number of activated database instances. |
+| total_instance_count | [int32](#int32) | | The total number of database instances. |
+| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |
+| external_url_from_flag | [bool](#bool) | | Whether the external URL is set via command-line flag (and thus cannot be changed via UI). |
+| replica_count | [int32](#int32) | | The number of active replicas (servers sharing the same database). |
+| restriction | [Restriction](#bytebase-v1-Restriction) | | |
-<a name="bytebase-v1-DataSource-GCPCredential"></a>
-### DataSource.GCPCredential
+<a name="bytebase-v1-ActuatorInfo-StatUser"></a>
+### ActuatorInfo.StatUser
+User statistics by type and state.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [string](#string) | | |
+| 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-DataSourceExternalSecret"></a>
+<a name="bytebase-v1-DeleteCacheRequest"></a>
-### DataSourceExternalSecret
+### DeleteCacheRequest
+Request message for deleting cache.
-| 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-GetActuatorInfoRequest"></a>
+### GetActuatorInfoRequest
+Request message for getting actuator information.
-<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption"></a>
-### 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="bytebase-v1-GetResourcePackageRequest"></a>
+### GetResourcePackageRequest
+Request message for getting branding resources.
-<a name="bytebase-v1-DeleteInstanceRequest"></a>
-### DeleteInstanceRequest
+<a name="bytebase-v1-ResourcePackage"></a>
+### ResourcePackage
+Custom branding resources for the Bytebase instance.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the 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. |
+| logo | [bytes](#bytes) | | The branding logo. |
-<a name="bytebase-v1-GetInstanceRequest"></a>
+<a name="bytebase-v1-Restriction"></a>
-### GetInstanceRequest
+### Restriction
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |
-
+| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |
+| 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. |
-<a name="bytebase-v1-Instance"></a>
-### Instance
+<a name="bytebase-v1-SetupSampleRequest"></a>
+### SetupSampleRequest
+Request message for setting up sample data.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |
-| title | [string](#string) | | The display title of the instance. |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
-| engine_version | [string](#string) | | The version of the database engine. |
-| external_link | [string](#string) | | External URL to the database instance console. |
-| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. |
-| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-| activation | [bool](#bool) | | Whether the instance is activated for use. |
-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. |
-| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |
-| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas &amp; databases. |
-| last_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the instance was synced. |
-| labels | [Instance.LabelsEntry](#bytebase-v1-Instance-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the instance. For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } |
+
+
+
-<a name="bytebase-v1-Instance-LabelsEntry"></a>
-### Instance.LabelsEntry
+<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 |
+| 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 | [string](#string) | | |
+
+<a name="v1_iam_policy-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/iam_policy.proto
-<a name="bytebase-v1-InstanceResource"></a>
-### InstanceResource
+<a name="bytebase-v1-Binding"></a>
+### Binding
+Binding associates members with a role and optional conditions.
| 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. |
+| role | [string](#string) | | The role that is assigned to the members. Format: roles/{role} |
+| members | [string](#string) | repeated | Specifies the principals requesting access for a Bytebase resource. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this binding, only used in the project IAM policy. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Support variables: resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
+For example: resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;] resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;] request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) |
+| parsed_expr | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | | The parsed expression of the condition. |
-<a name="bytebase-v1-KerberosConfig"></a>
-### KerberosConfig
+<a name="bytebase-v1-BindingDelta"></a>
+
+### BindingDelta
+A single change to a binding.
| 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). |
-
+| 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-ListInstanceDatabaseRequest"></a>
-### ListInstanceDatabaseRequest
+<a name="bytebase-v1-GetIamPolicyRequest"></a>
+### GetIamPolicyRequest
+Request message for getting an IAM policy.
| 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. |
-
+| resource | [string](#string) | | The name of the resource to get the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
-<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>
-### ListInstanceDatabaseResponse
+<a name="bytebase-v1-IamPolicy"></a>
+### IamPolicy
+IAM policy that binds members to roles.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [string](#string) | repeated | All database name list in the instance. |
-
+| bindings | [Binding](#bytebase-v1-Binding) | repeated | Collection of binding. A binding binds one or more project members to a single project role. |
+| etag | [string](#string) | | The current etag of the policy. If an etag is provided and does not match the current etag of the policy, the call will be blocked and an ABORTED error will be returned. |
-<a name="bytebase-v1-ListInstancesRequest"></a>
-### ListInstancesRequest
+<a name="bytebase-v1-PolicyDelta"></a>
+### PolicyDelta
+Describes changes between two IAM policies.
| 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.
+| binding_deltas | [BindingDelta](#bytebase-v1-BindingDelta) | repeated | The delta for Bindings between two policies. |
-When paginating, all other parameters provided to `ListInstances` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted instances if specified. |
-| filter | [string](#string) | | Filter the instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-Supported filters: - name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator. - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - state: the instance state, check State enum for values, support &#34;==&#34; operator. - engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator. - port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
-For example: name == &#34;sample instance&#34; name.matches(&#34;sample&#34;) resource_id == &#34;sample-instance&#34; resource_id.matches(&#34;sample&#34;) state == &#34;DELETED&#34; environment == &#34;environments/test&#34; environment == &#34;&#34; (find instances which environment is not set) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) host == &#34;127.0.0.1&#34; host.matches(&#34;127.0&#34;) port == &#34;54321&#34; port.matches(&#34;543&#34;) labels.org_group == &#34;infrastructure&#34; labels.environment in [&#34;prod&#34;, &#34;production&#34;] project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34; host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; |
-| order_by | [string](#string) | | The order by of instances. Support title, environment. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title desc, environment asc&#34; |
+<a name="bytebase-v1-SetIamPolicyRequest"></a>
+### SetIamPolicyRequest
+Request message for setting an IAM policy.
-<a name="bytebase-v1-ListInstancesResponse"></a>
+| 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. |
-### ListInstancesResponse
-| 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-BindingDelta-Action"></a>
+### BindingDelta.Action
+Type of action performed on a binding.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| ACTION_UNSPECIFIED | 0 | Unspecified action. |
+| ADD | 1 | Add a binding. |
+| REMOVE | 2 | Remove a binding. |
-<a name="bytebase-v1-RemoveDataSourceRequest"></a>
-### RemoveDataSourceRequest
+
+
+
-| 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. |
+<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-SASLConfig"></a>
-
-### SASLConfig
+<a name="bytebase-v1-AuditData"></a>
+### AuditData
+Additional audit data specific to certain operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |
-
+| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |
-<a name="bytebase-v1-SyncInstanceRequest"></a>
-### SyncInstanceRequest
+<a name="bytebase-v1-AuditLog"></a>
+### AuditLog
+Audit log entry recording system activity or API call.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of instance. Format: instances/{instance} |
-| enable_full_sync | [bool](#bool) | | When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only the instance metadata (such as the database list) and any newly discovered databases will be synced. |
-
+| name | [string](#string) | | The name 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-SyncInstanceResponse"></a>
-### SyncInstanceResponse
+<a name="bytebase-v1-ExportAuditLogsRequest"></a>
+### ExportAuditLogsRequest
+Request message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [string](#string) | repeated | All database name list in the instance. |
-
+| parent | [string](#string) | | |
+| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. Check the filter field in the SearchAuditLogsRequest message. |
+| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
+| format | [ExportFormat](#bytebase-v1-ExportFormat) | | The export format. |
+| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
+| page_token | [string](#string) | | A page token, received from a previous `ExportAuditLogs` call. Provide this to retrieve the subsequent page. |
-<a name="bytebase-v1-UndeleteInstanceRequest"></a>
-### UndeleteInstanceRequest
+<a name="bytebase-v1-ExportAuditLogsResponse"></a>
+### ExportAuditLogsResponse
+Response message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |
-
+| 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-UpdateDataSourceRequest"></a>
-### UpdateDataSourceRequest
+<a name="bytebase-v1-RequestMetadata"></a>
+### RequestMetadata
+Metadata about the incoming request.
| 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. |
-
+| 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-UpdateInstanceRequest"></a>
-### UpdateInstanceRequest
+<a name="bytebase-v1-SearchAuditLogsRequest"></a>
+### SearchAuditLogsRequest
+Request message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.
-
-The instance&#39;s `name` field is used to identify the instance to update. Format: instances/{instance} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the instance is not found, a new instance will be created. In this situation, `update_mask` is ignored. |
-
-
+| parent | [string](#string) | | |
+| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator. - severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values. - user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator. - create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
+For example: - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34; - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; |
+| order_by | [string](#string) | | The order by of the log. Only support order by create_time. The default sorting order is ascending. For example: - order_by = &#34;create_time asc&#34; - order_by = &#34;create_time desc&#34; |
+| page_size | [int32](#int32) | | The maximum number of logs to return. The service may return fewer than this value. If unspecified, at most 10 log entries will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchLogs` call. Provide this to retrieve the subsequent page. |
-
-<a name="bytebase-v1-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-SearchAuditLogsResponse"></a>
+### SearchAuditLogsResponse
+Response message for searching audit logs.
-<a name="bytebase-v1-DataSource-RedisType"></a>
+| 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. |
-### DataSource.RedisType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| REDIS_TYPE_UNSPECIFIED | 0 | |
-| STANDALONE | 1 | |
-| SENTINEL | 2 | |
-| CLUSTER | 3 | |
+
-<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>
-### DataSourceExternalSecret.AppRoleAuthOption.SecretType
+<a name="bytebase-v1-AuditLog-Severity"></a>
+### AuditLog.Severity
+Severity level for audit log entries.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
-| PLAIN | 1 | Plain text secret. |
-| ENVIRONMENT | 2 | Secret from environment variable. |
+| 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-DataSourceExternalSecret-AuthType"></a>
+
-### DataSourceExternalSecret.AuthType
+<a name="bytebase-v1-AuditLogService"></a>
-| 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 |
+### 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-DataSourceExternalSecret-SecretType"></a>
-### DataSourceExternalSecret.SecretType
+<a name="v1_auth_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
-| VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 |
-| AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html |
-| GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |
-| AZURE_KEY_VAULT | 4 | ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets |
+## v1/auth_service.proto
-<a name="bytebase-v1-DataSourceType"></a>
+<a name="bytebase-v1-ExchangeTokenRequest"></a>
-### DataSourceType
+### ExchangeTokenRequest
-| 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 |
+| ----- | ---- | ----- | ----------- |
+| token | [string](#string) | | External OIDC token (JWT) from CI/CD platform. |
+| email | [string](#string) | | Workload Identity email for identifying which identity to authenticate as. Format: {name}@workload.bytebase.com |
-
-
-<a name="bytebase-v1-InstanceService"></a>
-### InstanceService
-InstanceService manages database instances and their connections.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Gets a database instance by name. Permissions required: bb.instances.get |
-| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Lists all database instances. Permissions required: bb.instances.list |
-| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Creates a new database instance. Permissions required: bb.instances.create |
-| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Updates a database instance. Permissions required: bb.instances.update |
-| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete |
-| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Restores a soft-deleted database instance. Permissions required: bb.instances.undelete |
-| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync |
-| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Lists all databases within an instance without creating them. Permissions required: bb.instances.get |
-| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Syncs multiple instances in a single request. Permissions required: bb.instances.sync |
-| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Updates multiple instances in a single request. Permissions required: bb.instances.update |
-| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Adds a read-only data source to an instance. Permissions required: bb.instances.update |
-| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Removes a read-only data source from an instance. Permissions required: bb.instances.update |
-| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Updates a data source configuration. Permissions required: bb.instances.update |
+<a name="bytebase-v1-ExchangeTokenResponse"></a>
-
+### ExchangeTokenResponse
-<a name="v1_database_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| access_token | [string](#string) | | Bytebase access token. |
-## v1/database_service.proto
-<a name="bytebase-v1-BatchGetDatabasesRequest"></a>
-### BatchGetDatabasesRequest
+<a name="bytebase-v1-IdentityProviderContext"></a>
+
+### IdentityProviderContext
+Context for identity provider authentication.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all databases being retrieved. - projects/{project}: batch get databases in a project; - instances/{instances}: batch get databases in a instance; Use &#34;-&#34; as wildcard to batch get databases across parent. |
-| names | [string](#string) | repeated | The list of database names to retrieve. |
+| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |
+| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |
-<a name="bytebase-v1-BatchGetDatabasesResponse"></a>
+<a name="bytebase-v1-LoginRequest"></a>
-### BatchGetDatabasesResponse
+### LoginRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
+| email | [string](#string) | | User&#39;s email address. |
+| password | [string](#string) | | User&#39;s password for authentication. |
+| web | [bool](#bool) | | If true, sets access token and refresh token as HTTP-only cookies instead of returning the token in the response body. Use for browser-based clients. |
+| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
+| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is used to get the user information from identity provider. |
+| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
+| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user&#39;s identity with MFA. |
+| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user&#39;s identity by MFA. |
-<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>
+<a name="bytebase-v1-LoginResponse"></a>
-### BatchSyncDatabasesRequest
+### LoginResponse
| 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. |
-
-
+| token | [string](#string) | | Access token for authenticated requests. Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. |
+| mfa_temp_token | [string](#string) | optional | Temporary token for MFA verification. |
+| require_reset_password | [bool](#bool) | | Whether user must reset password before continuing. |
+| user | [User](#bytebase-v1-User) | | The user from the successful login. |
-<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>
-### BatchSyncDatabasesResponse
+<a name="bytebase-v1-LogoutRequest"></a>
+### LogoutRequest
+Request to logout current user session.
-<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>
-### BatchUpdateDatabasesRequest
+<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>
+### OAuth2IdentityProviderContext
+OAuth2 authentication context.
| 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. |
-
+| code | [string](#string) | | Authorization code from OAuth2 provider. |
-<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>
-### BatchUpdateDatabasesResponse
+<a name="bytebase-v1-OIDCIdentityProviderContext"></a>
+### OIDCIdentityProviderContext
+OpenID Connect authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |
+| code | [string](#string) | | Authorization code from OIDC provider. |
-<a name="bytebase-v1-BoundingBox"></a>
-
-### BoundingBox
-BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.
+<a name="bytebase-v1-RefreshRequest"></a>
+### RefreshRequest
+Request to refresh the access token.
-| 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 |
+<a name="bytebase-v1-RefreshResponse"></a>
-<a name="bytebase-v1-Changelog"></a>
+### RefreshResponse
+Response from refreshing the access token.
-### Changelog
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |
-| schema | [string](#string) | | |
-| schema_size | [int64](#int64) | | |
-| task_run | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| plan_title | [string](#string) | | The title of the plan associated with this changelog&#39;s task run. This field is populated by deriving the plan from task_run for display purposes. |
+
+
+
+<a name="bytebase-v1-AuthService"></a>
-<a name="bytebase-v1-CheckConstraintMetadata"></a>
+### AuthService
+AuthService handles user authentication operations.
-### CheckConstraintMetadata
-CheckConstraintMetadata is the metadata for check constraints.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |
+| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |
+| ExchangeToken | [ExchangeTokenRequest](#bytebase-v1-ExchangeTokenRequest) | [ExchangeTokenResponse](#bytebase-v1-ExchangeTokenResponse) | Exchanges an external OIDC token for a Bytebase access token. Used by CI/CD pipelines with Workload Identity Federation. Permissions required: None (validates via OIDC token) |
+| Refresh | [RefreshRequest](#bytebase-v1-RefreshRequest) | [RefreshResponse](#bytebase-v1-RefreshResponse) | Refreshes the access token using the refresh token cookie. Permissions required: None (validates via refresh token cookie) |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| 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="v1_cel_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/cel_service.proto
-<a name="bytebase-v1-ColumnMetadata"></a>
+<a name="bytebase-v1-BatchDeparseRequest"></a>
-### ColumnMetadata
-ColumnMetadata is the metadata for columns.
+### BatchDeparseRequest
+Request message for batch deparsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a column. |
-| position | [int32](#int32) | | The position is the position in columns. |
-| has_default | [bool](#bool) | | |
-| default | [string](#string) | | The default value of column. |
-| default_on_null | [bool](#bool) | | Oracle specific metadata. The default_on_null is the default on null of a column. |
-| on_update | [string](#string) | | The on_update is the on update action of a column. For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with CURRENT_TIMESTAMP as on update value. |
-| nullable | [bool](#bool) | | The nullable is the nullable of a column. |
-| type | [string](#string) | | The type is the type of a column. |
-| character_set | [string](#string) | | The character_set is the character_set of a column. |
-| collation | [string](#string) | | The collation is the collation of a column. |
-| comment | [string](#string) | | The comment is the comment of a column. |
-| generation | [GenerationMetadata](#bytebase-v1-GenerationMetadata) | | The generation is the generation of a column. |
-| is_identity | [bool](#bool) | | |
-| identity_generation | [ColumnMetadata.IdentityGeneration](#bytebase-v1-ColumnMetadata-IdentityGeneration) | | The identity_generation is for identity columns, PG only. |
-| identity_seed | [int64](#int64) | | The identity_seed is for identity columns, MSSQL only. |
-| identity_increment | [int64](#int64) | | The identity_increment is for identity columns, MSSQL only. |
-| default_constraint_name | [string](#string) | | The default_constraint_name is the name of the default constraint, MSSQL only. In MSSQL, default values are implemented as named constraints. When modifying or dropping a column&#39;s default value, you must reference the constraint by name. This field stores the actual constraint name from the database.
-
-Example: A column definition like: CREATE TABLE employees ( status NVARCHAR(20) DEFAULT &#39;active&#39; )
-
-Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39; or a user-defined name if specified: ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
-
-To modify the default, you must first drop the existing constraint by name: ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760 ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
-
-This field is populated when syncing from the database. When empty (e.g., when parsing from SQL files), the system cannot automatically drop the constraint. |
-
+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |
-<a name="bytebase-v1-Database"></a>
-### Database
+<a name="bytebase-v1-BatchDeparseResponse"></a>
+### BatchDeparseResponse
+Response message for batch deparsing CEL expressions.
| 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} |
-| release | [string](#string) | | The release that was last applied to this database. Format: projects/{project}/releases/{release_id} Example: projects/my-project/releases/release_20260115-RC00 |
-| 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. |
-
+| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |
-<a name="bytebase-v1-Database-LabelsEntry"></a>
-### Database.LabelsEntry
+<a name="bytebase-v1-BatchParseRequest"></a>
+### BatchParseRequest
+Request message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| expressions | [string](#string) | repeated | The CEL expression strings to parse. |
-<a name="bytebase-v1-DatabaseMetadata"></a>
+<a name="bytebase-v1-BatchParseResponse"></a>
-### DatabaseMetadata
-DatabaseMetadata is the metadata for databases.
+### BatchParseResponse
+Response message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The database metadata name.
+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |
-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-DatabaseSDLSchema"></a>
+
-### DatabaseSDLSchema
-DatabaseSDLSchema contains the schema in SDL format.
+<a name="bytebase-v1-CelService"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| schema | [bytes](#bytes) | | The SDL schema content. - For SINGLE_FILE format: contains the complete SDL schema as a text string. - For MULTI_FILE format: contains the ZIP archive as binary data. |
-| content_type | [string](#string) | | The MIME type of the schema content. Indicates how the client should interpret the schema field. Examples: - &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format - &#34;application/zip&#34; for MULTI_FILE format |
+### CelService
+CelService manages CEL (Common Expression Language) parsing and formatting operations.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Parses multiple CEL expression strings into AST representations. Permissions required: None |
+| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Converts multiple CEL AST representations back into expression strings. Permissions required: None |
+
+<a name="v1_database_catalog_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
-<a name="bytebase-v1-DatabaseSchema"></a>
+## v1/database_catalog_service.proto
-### DatabaseSchema
-DatabaseSchema is the metadata for databases.
+
+
+<a name="bytebase-v1-ColumnCatalog"></a>
+
+### ColumnCatalog
+Column metadata within a table.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema dump from database. |
+| 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-DependencyColumn"></a>
+<a name="bytebase-v1-ColumnCatalog-LabelsEntry"></a>
+
+### ColumnCatalog.LabelsEntry
-### DependencyColumn
-DependencyColumn is the metadata for dependency columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema is the schema of a reference column. |
-| table | [string](#string) | | The table is the table of a reference column. |
-| column | [string](#string) | | The column is the name of a reference column. |
-
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-DependencyTable"></a>
-### DependencyTable
+<a name="bytebase-v1-DatabaseCatalog"></a>
+### DatabaseCatalog
+Catalog metadata for a database including schemas, tables, and columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema is the schema of a reference table. |
-| table | [string](#string) | | The table is the name of a reference table. |
-
+| name | [string](#string) | | The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog |
+| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | The schemas in the database. |
-<a name="bytebase-v1-DiffSchemaRequest"></a>
-### DiffSchemaRequest
+<a name="bytebase-v1-GetDatabaseCatalogRequest"></a>
+### GetDatabaseCatalogRequest
+Request message for getting a database catalog.
| 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} |
-
+| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |
-<a name="bytebase-v1-DiffSchemaResponse"></a>
-### DiffSchemaResponse
+<a name="bytebase-v1-ObjectSchema"></a>
+### ObjectSchema
+Schema definition for object-type columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| diff | [string](#string) | | |
+| 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-DimensionConstraint"></a>
+<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>
-### DimensionConstraint
-DimensionConstraint defines constraints for a spatial dimension.
+### ObjectSchema.ArrayKind
+Array type with element schema.
| 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 |
+| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |
-<a name="bytebase-v1-DimensionalConfig"></a>
+<a name="bytebase-v1-ObjectSchema-StructKind"></a>
-### DimensionalConfig
-DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
+### ObjectSchema.StructKind
+Structure type with named properties.
| 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 |
+| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |
-<a name="bytebase-v1-EnumTypeMetadata"></a>
+<a name="bytebase-v1-ObjectSchema-StructKind-PropertiesEntry"></a>
-### EnumTypeMetadata
+### ObjectSchema.StructKind.PropertiesEntry
| 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. |
-
+| key | [string](#string) | | |
+| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |
-<a name="bytebase-v1-EventMetadata"></a>
-### EventMetadata
+<a name="bytebase-v1-SchemaCatalog"></a>
+### SchemaCatalog
+Schema metadata within a database.
| 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 schema name. |
+| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |
-<a name="bytebase-v1-ExtensionMetadata"></a>
+<a name="bytebase-v1-TableCatalog"></a>
-### ExtensionMetadata
-ExtensionMetadata is the metadata for extensions.
+### TableCatalog
+Table metadata within a schema.
| 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. |
-
+| 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-ExternalTableMetadata"></a>
-### ExternalTableMetadata
+<a name="bytebase-v1-TableCatalog-Columns"></a>
+### TableCatalog.Columns
+Column list for regular tables.
| 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. |
+| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |
-<a name="bytebase-v1-ForeignKeyMetadata"></a>
+<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>
-### ForeignKeyMetadata
-ForeignKeyMetadata is the metadata for foreign keys.
+### UpdateDatabaseCatalogRequest
+Request message for updating a database catalog.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a foreign key. |
-| columns | [string](#string) | repeated | The columns are the ordered referencing columns of a foreign key. |
-| referenced_schema | [string](#string) | | The referenced_schema is the referenced schema name of a foreign key. It is an empty string for databases without such concept such as MySQL. |
-| referenced_table | [string](#string) | | The referenced_table is the referenced table name of a foreign key. |
-| referenced_columns | [string](#string) | repeated | The referenced_columns are the ordered referenced columns of a foreign key. |
-| on_delete | [string](#string) | | The on_delete is the on delete action of a foreign key. |
-| on_update | [string](#string) | | The on_update is the on update action of a foreign key. |
-| match_type | [string](#string) | | The match_type is the match type of a foreign key. The match_type is the PostgreSQL specific field. It&#39;s empty string for other databases. |
-
+| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.
+The catalog&#39;s `name` field is used to identify the database catalog to update. Format: instances/{instance}/databases/{database}/catalog |
+| 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-FunctionMetadata"></a>
-### FunctionMetadata
-FunctionMetadata is the metadata for functions.
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a function. |
-| definition | [string](#string) | | The definition is the definition of a function. |
-| signature | [string](#string) | | The signature is the name with the number and type of input arguments the function takes. |
-| character_set_client | [string](#string) | | MySQL specific metadata. |
-| collation_connection | [string](#string) | | |
-| database_collation | [string](#string) | | |
-| sql_mode | [string](#string) | | |
-| comment | [string](#string) | | |
-| dependency_tables | [DependencyTable](#bytebase-v1-DependencyTable) | repeated | The dependency_tables is the list of dependency tables of a function. For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. |
-| skip_dump | [bool](#bool) | | |
+<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-GenerationMetadata"></a>
-### GenerationMetadata
+<a name="bytebase-v1-DatabaseCatalogService"></a>
+### DatabaseCatalogService
+DatabaseCatalogService manages database schema metadata and classification.
+| 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 |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |
-| expression | [string](#string) | | |
+
+<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-GetChangelogRequest"></a>
-### GetChangelogRequest
+<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>
+### CreateDatabaseGroupRequest
+Request message for creating a database group.
| 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) | | |
+| parent | [string](#string) | | The parent resource where this database group will be created. Format: projects/{project} |
+| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to create. |
+| database_group_id | [string](#string) | | The ID to use for the database group, which will become the final component of the database group&#39;s resource name.
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| validate_only | [bool](#bool) | | If set, validate the create request and preview the full database group response, but do not actually create it. |
-<a name="bytebase-v1-GetDatabaseMetadataRequest"></a>
-### GetDatabaseMetadataRequest
+<a name="bytebase-v1-DatabaseGroup"></a>
+### DatabaseGroup
+A group of databases matched by expressions.
| 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
-
-Supported filter: - schema: the schema name, support &#34;==&#34; operator. - table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+| 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
-For example: schema == &#34;schema-a&#34; table == &#34;table-a&#34; table.matches(&#34;table-a&#34;) schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;) The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;. The column masking level will only be returned when a table filter is used. |
-| limit | [int32](#int32) | | Limit the response size of returned table metadata per schema. For example, if the database has 3 schemas, and each schema has 100 tables, if limit is 20, then only 20 tables will be returned for each schema, total 60 tables. Default 0, means no limit. |
+Support variables: resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations. resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations. resource.database_labels: the database labels. Support map access operations. All variables should join with &#34;&amp;&amp;&#34; condition.
+For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;) resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; |
+| matched_databases | [DatabaseGroup.Database](#bytebase-v1-DatabaseGroup-Database) | repeated | The list of databases that match the database group condition. |
-<a name="bytebase-v1-GetDatabaseRequest"></a>
-### GetDatabaseRequest
+<a name="bytebase-v1-DatabaseGroup-Database"></a>
+### DatabaseGroup.Database
+A database within a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |
-
+| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |
-<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>
-### GetDatabaseSDLSchemaRequest
+<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>
+### DeleteDatabaseGroupRequest
+Request message for deleting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the 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 | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |
-<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>
-### GetDatabaseSchemaRequest
+<a name="bytebase-v1-GetDatabaseGroupRequest"></a>
+### GetDatabaseGroupRequest
+Request message for getting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |
-
+| 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-GetSchemaStringRequest"></a>
-### GetSchemaStringRequest
+<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>
+### ListDatabaseGroupsRequest
+Request message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} |
-| type | [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType) | | |
-| schema | [string](#string) | | It&#39;s empty for DATABASE. |
-| object | [string](#string) | | It&#39;s empty for DATABASE and SCHEMA. |
-| metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED. Also the schema and object are empty. |
-
+| 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-GetSchemaStringResponse"></a>
-### GetSchemaStringResponse
+<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>
+### ListDatabaseGroupsResponse
+Response message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema_string | [string](#string) | | |
+| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |
-<a name="bytebase-v1-GridLevel"></a>
+<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>
-### GridLevel
-GridLevel defines a tessellation grid level with its density.
+### UpdateDatabaseGroupRequest
+Request message for updating a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |
-| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |
-
-
-
-
+| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.
+The database group&#39;s `name` field is used to identify the database group to update. Format: projects/{project}/databaseGroups/{databaseGroup} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the database group is not found, a new database group will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-IndexMetadata"></a>
-### IndexMetadata
-IndexMetadata is the metadata for indexes.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of an index. |
-| expressions | [string](#string) | repeated | The expressions are the ordered columns or expressions of an index. This could refer to a column or an expression. |
-| key_length | [int64](#int64) | repeated | The key_lengths are the ordered key lengths of an index. If the key length is not specified, it&#39;s -1. |
-| descending | [bool](#bool) | repeated | The descending is the ordered descending of an index. |
-| type | [string](#string) | | The type is the type of an index. |
-| unique | [bool](#bool) | | The unique is whether the index is unique. |
-| primary | [bool](#bool) | | The primary is whether the index is a primary key index. |
-| visible | [bool](#bool) | | The visible is whether the index is visible. |
-| comment | [string](#string) | | The comment is the comment of an index. |
-| definition | [string](#string) | | The definition of an index. |
-| parent_index_schema | [string](#string) | | The schema name of the parent index. |
-| parent_index_name | [string](#string) | | The index name of the parent index. |
-| granularity | [int64](#int64) | | The number of granules in the block. It&#39;s a ClickHouse specific field. |
-| is_constraint | [bool](#bool) | | It&#39;s a PostgreSQL specific field. The unique constraint and unique index are not the same thing in PostgreSQL. |
-| spatial_config | [SpatialIndexConfig](#bytebase-v1-SpatialIndexConfig) | | Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. |
-| opclass_names | [string](#string) | repeated | https://www.postgresql.org/docs/current/catalog-pg-opclass.html Name of the operator class for each column. (PostgreSQL specific). |
-| opclass_defaults | [bool](#bool) | repeated | True if the operator class is the default. (PostgreSQL specific). |
+
+<a name="bytebase-v1-DatabaseGroupView"></a>
+### DatabaseGroupView
+View options for database group responses.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DATABASE_GROUP_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
+| DATABASE_GROUP_VIEW_BASIC | 1 | Include basic information about the database group, but exclude the list of matched databases and unmatched databases. |
+| DATABASE_GROUP_VIEW_FULL | 2 | Include everything. |
-<a name="bytebase-v1-ListChangelogsRequest"></a>
-### ListChangelogsRequest
+
+
-| 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.
+<a name="bytebase-v1-DatabaseGroupService"></a>
-When paginating, all other parameters provided must match the call that provided the page token. |
-| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
-| filter | [string](#string) | | Filter is used to filter changelogs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+### DatabaseGroupService
+DatabaseGroupService manages database groups for organizing databases by criteria.
-Supported filter: - status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values. - create_time: the changelog create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+| 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 |
-Example: status == &#34;DONE&#34; status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; create_time &gt;= &#34;2024-01-01T00:00:00Z&#34; &amp;&amp; create_time &lt;= &#34;2024-01-02T00:00:00Z&#34; |
+
+<a name="v1_instance_role_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/instance_role_service.proto
-<a name="bytebase-v1-ListChangelogsResponse"></a>
-### ListChangelogsResponse
+<a name="bytebase-v1-InstanceRole"></a>
+### InstanceRole
+InstanceRole is the API message for instance role.
| 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. |
+| name | [string](#string) | | The name of the role. Format: instances/{instance}/roles/{role} The role name is the unique name for the role. |
+| role_name | [string](#string) | | The role name. It&#39;s unique within the instance. |
+| password | [string](#string) | optional | The role password. |
+| connection_limit | [int32](#int32) | optional | The connection count limit for this role. |
+| valid_until | [string](#string) | optional | The expiration for the role&#39;s password. |
+| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |
-<a name="bytebase-v1-ListDatabasesRequest"></a>
+<a name="bytebase-v1-ListInstanceRolesRequest"></a>
-### ListDatabasesRequest
+### ListInstanceRolesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | - projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission. - workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission. - instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission |
-| page_size | [int32](#int32) | | The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.
+| 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 `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
+When paginating, all other parameters provided to `ListInstanceRoles` must match the call that provided the page token. |
+| refresh | [bool](#bool) | | Refresh will refresh and return the latest data. |
-Supported filter: - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - name: the database name, support &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator. - table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator. - labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example: environment == &#34;environments/{environment resource id}&#34; environment == &#34;&#34; (find databases which environment is not set) project == &#34;projects/{project resource id}&#34; instance == &#34;instances/{instance resource id}&#34; name.matches(&#34;database name&#34;) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) exclude_unassigned == true table == &#34;sample&#34; table.matches(&#34;sam&#34;) labels.environment == &#34;production&#34; labels.region == &#34;asia&#34; labels.region in [&#34;asia&#34;, &#34;europe&#34;]
-
-You can combine filter conditions like: environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) |
-| show_deleted | [bool](#bool) | | Show deleted database if specified. |
-| order_by | [string](#string) | | The order by of databases. Support name, project, instance. The default sorting order is ascending. For example: - order_by = &#34;name&#34; - order by name ascending - order_by = &#34;name desc&#34; - order_by = &#34;name desc, project asc&#34; |
+<a name="bytebase-v1-ListInstanceRolesResponse"></a>
-<a name="bytebase-v1-ListDatabasesResponse"></a>
-
-### ListDatabasesResponse
+### ListInstanceRolesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
+| 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. |
+
-<a name="bytebase-v1-MaterializedViewMetadata"></a>
+
-### MaterializedViewMetadata
-MaterializedViewMetadata is the metadata for materialized views.
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a materialized view. |
-| definition | [string](#string) | | The definition is the definition of a materialized view. |
-| comment | [string](#string) | | The comment is the comment of a materialized view. |
-| dependency_columns | [DependencyColumn](#bytebase-v1-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a materialized view. |
-| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The columns is the ordered list of columns in a table. |
-| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | The indexes is the list of indexes in a table. |
-| skip_dump | [bool](#bool) | | |
+<a name="bytebase-v1-InstanceRoleService"></a>
+
+### InstanceRoleService
+InstanceRoleService manages database roles within instances.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |
+
+<a name="v1_instance_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
-<a name="bytebase-v1-PackageMetadata"></a>
+## v1/instance_service.proto
+
+
+
+<a name="bytebase-v1-AddDataSourceRequest"></a>
+
+### AddDataSourceRequest
-### PackageMetadata
-PackageMetadata is the metadata for packages.
| 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 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-ProcedureMetadata"></a>
+<a name="bytebase-v1-BatchSyncInstancesRequest"></a>
+
+### BatchSyncInstancesRequest
-### ProcedureMetadata
-ProcedureMetadata is the metadata for procedures.
| 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) | | |
-
+| 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-SchemaMetadata"></a>
-### SchemaMetadata
-SchemaMetadata is the metadata for schemas.
-This is the concept of schema in Postgres, but it&#39;s a no-op for MySQL.
+<a name="bytebase-v1-BatchSyncInstancesResponse"></a>
+### BatchSyncInstancesResponse
-| 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. |
-<a name="bytebase-v1-SequenceMetadata"></a>
+<a name="bytebase-v1-BatchUpdateInstancesRequest"></a>
-### SequenceMetadata
+### BatchUpdateInstancesRequest
| 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. |
+| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |
-<a name="bytebase-v1-SpatialIndexConfig"></a>
+<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>
+
+### BatchUpdateInstancesResponse
-### SpatialIndexConfig
-SpatialIndexConfig defines the spatial index configuration for spatial databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| method | [string](#string) | | Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) |
-| tessellation | [TessellationConfig](#bytebase-v1-TessellationConfig) | | Tessellation configuration for grid-based spatial indexes |
-| storage | [StorageConfig](#bytebase-v1-StorageConfig) | | Storage and performance configuration |
-| dimensional | [DimensionalConfig](#bytebase-v1-DimensionalConfig) | | Dimensional configuration |
+| instances | [Instance](#bytebase-v1-Instance) | repeated | |
-<a name="bytebase-v1-StorageConfig"></a>
+<a name="bytebase-v1-CreateInstanceRequest"></a>
+
+### CreateInstanceRequest
-### StorageConfig
-StorageConfig defines storage and performance parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| fillfactor | [int32](#int32) | | Fill factor percentage (1-100) |
-| buffering | [string](#string) | | Buffering mode for PostgreSQL (auto, on, off) |
-| tablespace | [string](#string) | | Tablespace configuration for Oracle |
-| work_tablespace | [string](#string) | | |
-| sdo_level | [int32](#int32) | | |
-| commit_interval | [int32](#int32) | | |
-| pad_index | [bool](#bool) | | SQL Server specific parameters |
-| sort_in_tempdb | [string](#string) | | ON, OFF |
-| drop_existing | [bool](#bool) | | |
-| online | [bool](#bool) | | |
-| allow_row_locks | [bool](#bool) | | |
-| allow_page_locks | [bool](#bool) | | |
-| maxdop | [int32](#int32) | | |
-| data_compression | [string](#string) | | NONE, ROW, PAGE |
+| instance | [Instance](#bytebase-v1-Instance) | | The instance to create. |
+| instance_id | [string](#string) | | The ID to use for the instance, which will become the final component of the instance&#39;s resource name.
+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-StreamMetadata"></a>
-### StreamMetadata
+<a name="bytebase-v1-DataSource"></a>
+
+### DataSource
| 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. |
+| id | [string](#string) | | The unique identifier for this data source. |
+| type | [DataSourceType](#bytebase-v1-DataSourceType) | | The type of data source (ADMIN or READ_ONLY). |
+| username | [string](#string) | | The username for database authentication. |
+| password | [string](#string) | | The password for database authentication. |
+| use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use system default SSL configuration. |
+| ssl_ca | [string](#string) | | The SSL certificate authority certificate. |
+| ssl_cert | [string](#string) | | The SSL client certificate. |
+| ssl_key | [string](#string) | | The SSL client private key. |
+| verify_tls_certificate | [bool](#bool) | | verify_tls_certificate enables TLS certificate verification for SSL connections. Default is false (no verification) for backward compatibility. Set to true for secure connections (recommended for production). Only set to false for development or when certificates cannot be properly validated (e.g., self-signed certs, VPN environments). |
+| host | [string](#string) | | The hostname or IP address of the database server. |
+| port | [string](#string) | | The port number of the database server. |
+| database | [string](#string) | | The name of the database to connect to. |
+| srv | [bool](#bool) | | srv, authentication_database and replica_set are used for MongoDB. srv is a boolean flag that indicates whether the host is a DNS SRV record. |
+| authentication_database | [string](#string) | | authentication_database is the database name to authenticate against, which stores the user credentials. |
+| replica_set | [string](#string) | | replica_set is used for MongoDB replica set. |
+| sid | [string](#string) | | sid and service_name are used for Oracle. |
+| service_name | [string](#string) | | |
+| ssh_host | [string](#string) | | Connection over SSH. The hostname of the SSH server agent. Required. |
+| ssh_port | [string](#string) | | The port of the SSH server agent. It&#39;s 22 typically. Required. |
+| ssh_user | [string](#string) | | The user to login the server. Required. |
+| ssh_password | [string](#string) | | The password to login the server. If it&#39;s empty string, no password is required. |
+| ssh_private_key | [string](#string) | | The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). |
+| authentication_private_key | [string](#string) | | PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required. Used for authentication when connecting to the data source. |
+| authentication_private_key_passphrase | [string](#string) | | Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. |
+| external_secret | [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret) | | |
+| authentication_type | [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType) | | |
+| azure_credential | [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential) | | |
+| aws_credential | [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential) | | |
+| gcp_credential | [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential) | | |
+| sasl_config | [SASLConfig](#bytebase-v1-SASLConfig) | | |
+| additional_addresses | [DataSource.Address](#bytebase-v1-DataSource-Address) | repeated | additional_addresses is used for MongoDB replica set. |
+| direct_connection | [bool](#bool) | | direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. |
+| region | [string](#string) | | region is the location of where the DB is, works for AWS RDS. For example, us-east-1. |
+| warehouse_id | [string](#string) | | warehouse_id is used by Databricks. |
+| master_name | [string](#string) | | master_name is the master name used by connecting redis-master via redis sentinel. |
+| master_username | [string](#string) | | master_username and master_password are master credentials used by redis sentinel mode. |
+| master_password | [string](#string) | | |
+| redis_type | [DataSource.RedisType](#bytebase-v1-DataSource-RedisType) | | |
+| cluster | [string](#string) | | Cluster is the cluster name for the data source. Used by CockroachDB. |
+| extra_connection_parameters | [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry) | repeated | Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write |
-<a name="bytebase-v1-SyncDatabaseRequest"></a>
+<a name="bytebase-v1-DataSource-AWSCredential"></a>
-### SyncDatabaseRequest
+### DataSource.AWSCredential
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |
+| 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-SyncDatabaseResponse"></a>
+<a name="bytebase-v1-DataSource-Address"></a>
+
+### DataSource.Address
+
-### SyncDatabaseResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| host | [string](#string) | | |
+| port | [string](#string) | | |
-<a name="bytebase-v1-TableMetadata"></a>
+<a name="bytebase-v1-DataSource-AzureCredential"></a>
+
+### DataSource.AzureCredential
-### 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. |
+| tenant_id | [string](#string) | | |
+| client_id | [string](#string) | | |
+| client_secret | [string](#string) | | |
-<a name="bytebase-v1-TablePartitionMetadata"></a>
+<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>
+
+### DataSource.ExtraConnectionParametersEntry
-### TablePartitionMetadata
-TablePartitionMetadata is the metadata for table partitions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a table partition. |
-| type | [TablePartitionMetadata.Type](#bytebase-v1-TablePartitionMetadata-Type) | | The type of a table partition. |
-| expression | [string](#string) | | The expression is the expression of a table partition. For PostgreSQL, the expression is the text of {FOR VALUES partition_bound_spec}, see https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL, the expression is the `expr` or `column_list` of the following syntax. PARTITION BY { [LINEAR] HASH(expr) | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) | RANGE{(expr) | COLUMNS(column_list)} | LIST{(expr) | COLUMNS(column_list)} }. |
-| value | [string](#string) | | The value is the value of a table partition. For MySQL, the value is for RANGE and LIST partition types, - For a RANGE partition, it contains the value set in the partition&#39;s VALUES LESS THAN clause, which can be either an integer or MAXVALUE. - For a LIST partition, this column contains the values defined in the partition&#39;s VALUES IN clause, which is a list of comma-separated integer values. - For others, it&#39;s an empty string. |
-| use_default | [string](#string) | | The use_default is whether the users use the default partition, it stores the different value for different database engines. For MySQL, it&#39;s [INT] type, 0 means not use default partition, otherwise, it&#39;s equals to number in syntax [SUB]PARTITION {number}. |
-| subpartitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The subpartitions is the list of subpartitions in a table partition. |
-| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | |
-| check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-TaskMetadata"></a>
+<a name="bytebase-v1-DataSource-GCPCredential"></a>
-### TaskMetadata
+### DataSource.GCPCredential
| 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. |
+| content | [string](#string) | | |
-<a name="bytebase-v1-TessellationConfig"></a>
+<a name="bytebase-v1-DataSourceExternalSecret"></a>
+
+### DataSourceExternalSecret
-### TessellationConfig
-TessellationConfig defines tessellation parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| scheme | [string](#string) | | Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) |
-| grid_levels | [GridLevel](#bytebase-v1-GridLevel) | repeated | Grid levels and densities for multi-level tessellation |
-| cells_per_object | [int32](#int32) | | Number of cells per object (1-8192 for SQL Server) |
-| bounding_box | [BoundingBox](#bytebase-v1-BoundingBox) | | Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) |
+| 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-TriggerMetadata"></a>
+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption"></a>
-### TriggerMetadata
+### DataSourceExternalSecret.AppRoleAuthOption
| 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. |
+| role_id | [string](#string) | | The role ID for Vault AppRole authentication. |
+| secret_id | [string](#string) | | the secret id for the role without ttl. |
+| type | [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType) | | The type of secret for AppRole authentication. |
+| mount_path | [string](#string) | | The path where the approle auth method is mounted. |
-<a name="bytebase-v1-UpdateDatabaseRequest"></a>
+<a name="bytebase-v1-DeleteInstanceRequest"></a>
-### UpdateDatabaseRequest
+### DeleteInstanceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| database | [Database](#bytebase-v1-Database) | | The database to update.
+| 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. |
-The database&#39;s `name` field is used to identify the database to update. Format: instances/{instance}/databases/{database} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the database is not found, a new database will be created. In this situation, `update_mask` is ignored. |
+<a name="bytebase-v1-GetInstanceRequest"></a>
-<a name="bytebase-v1-ViewMetadata"></a>
+### GetInstanceRequest
-### ViewMetadata
-ViewMetadata is the metadata for views.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a view. |
-| definition | [string](#string) | | The definition is the definition of a view. |
-| comment | [string](#string) | | The comment is the comment of a view. |
-| dependency_columns | [DependencyColumn](#bytebase-v1-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a view. |
-| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. |
-| triggers | [TriggerMetadata](#bytebase-v1-TriggerMetadata) | repeated | The triggers is the list of triggers in a view. |
-| skip_dump | [bool](#bool) | | |
+| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |
-
+<a name="bytebase-v1-Instance"></a>
-<a name="bytebase-v1-Changelog-Status"></a>
+### Instance
-### Changelog.Status
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | |
-| PENDING | 1 | |
-| DONE | 2 | |
-| FAILED | 3 | |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |
+| title | [string](#string) | | The display title of the instance. |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
+| engine_version | [string](#string) | | The version of the database engine. |
+| external_link | [string](#string) | | External URL to the database instance console. |
+| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. |
+| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
+| activation | [bool](#bool) | | Whether the instance is activated for use. |
+| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. |
+| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |
+| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas &amp; databases. |
+| last_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time the instance was synced. |
+| labels | [Instance.LabelsEntry](#bytebase-v1-Instance-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the instance. For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } |
-<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-Instance-LabelsEntry"></a>
+### Instance.LabelsEntry
-<a name="bytebase-v1-ColumnMetadata-IdentityGeneration"></a>
-### ColumnMetadata.IdentityGeneration
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| IDENTITY_GENERATION_UNSPECIFIED | 0 | |
-| ALWAYS | 1 | |
-| BY_DEFAULT | 2 | |
-<a name="bytebase-v1-GenerationMetadata-Type"></a>
-### GenerationMetadata.Type
+<a name="bytebase-v1-InstanceResource"></a>
+### InstanceResource
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| VIRTUAL | 1 | |
-| STORED | 2 | |
+| 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. |
-<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>
+<a name="bytebase-v1-KerberosConfig"></a>
-### GetSchemaStringRequest.ObjectType
+### KerberosConfig
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| OBJECT_TYPE_UNSPECIFIED | 0 | |
-| DATABASE | 1 | |
-| SCHEMA | 2 | |
-| TABLE | 3 | |
-| VIEW | 4 | |
-| MATERIALIZED_VIEW | 5 | |
-| FUNCTION | 6 | |
-| PROCEDURE | 7 | |
-| SEQUENCE | 8 | |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| 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-StreamMetadata-Mode"></a>
-### StreamMetadata.Mode
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| MODE_UNSPECIFIED | 0 | |
-| DEFAULT | 1 | |
-| APPEND_ONLY | 2 | |
-| INSERT_ONLY | 3 | |
+<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>
+### ListInstanceDatabaseRequest
-<a name="bytebase-v1-StreamMetadata-Type"></a>
-### StreamMetadata.Type
+| 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 | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| DELTA | 1 | |
-<a name="bytebase-v1-TablePartitionMetadata-Type"></a>
-### TablePartitionMetadata.Type
-Type is the type of a table partition, some database engines may not
-support all types. Only avilable for the following database engines now:
-MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,
-LINEAR_KEY
-(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:
-RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,
-LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| RANGE | 1 | |
-| RANGE_COLUMNS | 2 | |
-| LIST | 3 | |
-| LIST_COLUMNS | 4 | |
-| HASH | 5 | |
-| LINEAR_HASH | 6 | |
-| KEY | 7 | |
-| LINEAR_KEY | 8 | |
+<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>
+### ListInstanceDatabaseResponse
-<a name="bytebase-v1-TaskMetadata-State"></a>
-### TaskMetadata.State
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| databases | [string](#string) | repeated | All database name list in the instance. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATE_UNSPECIFIED | 0 | |
-| STARTED | 1 | |
-| SUSPENDED | 2 | |
-
-
+<a name="bytebase-v1-ListInstancesRequest"></a>
-<a name="bytebase-v1-DatabaseService"></a>
+### ListInstancesRequest
-### DatabaseService
-DatabaseService manages databases and their schemas.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetDatabase | [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest) | [Database](#bytebase-v1-Database) | Retrieves a database by name. Permissions required: bb.databases.get |
-| BatchGetDatabases | [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest) | [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse) | Retrieves multiple databases by their names. Permissions required: bb.databases.get |
-| ListDatabases | [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest) | [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse) | Lists databases in a project, instance, or workspace. Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent) |
-| UpdateDatabase | [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest) | [Database](#bytebase-v1-Database) | Updates database properties such as labels and project assignment. Permissions required: bb.databases.update |
-| BatchUpdateDatabases | [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest) | [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse) | Updates multiple databases in a single batch operation. Permissions required: bb.databases.update |
-| SyncDatabase | [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest) | [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse) | Synchronizes database schema from the instance. Permissions required: bb.databases.sync |
-| BatchSyncDatabases | [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest) | [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse) | Synchronizes multiple databases in a single batch operation. Permissions required: bb.databases.sync |
-| GetDatabaseMetadata | [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest) | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | Retrieves database metadata including tables, columns, and indexes. Permissions required: bb.databases.getSchema |
-| GetDatabaseSchema | [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest) | [DatabaseSchema](#bytebase-v1-DatabaseSchema) | Retrieves database schema as DDL statements. Permissions required: bb.databases.getSchema |
-| GetDatabaseSDLSchema | [GetDatabaseSDLSchemaRequest](#bytebase-v1-GetDatabaseSDLSchemaRequest) | [DatabaseSDLSchema](#bytebase-v1-DatabaseSDLSchema) | Retrieves database schema in SDL (Schema Definition Language) format. Permissions required: bb.databases.getSchema |
-| DiffSchema | [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest) | [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse) | Compares and generates migration statements between two schemas. Permissions required: bb.databases.get |
-| ListChangelogs | [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest) | [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse) | Lists migration history for a database. Permissions required: bb.changelogs.list |
-| GetChangelog | [GetChangelogRequest](#bytebase-v1-GetChangelogRequest) | [Changelog](#bytebase-v1-Changelog) | Retrieves a specific changelog entry. Permissions required: bb.changelogs.get |
-| GetSchemaString | [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest) | [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse) | Generates schema DDL for a database object. Permissions required: bb.databases.getSchema |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| page_size | [int32](#int32) | | The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 10 instances will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListInstances` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListInstances` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted instances if specified. |
+| filter | [string](#string) | | Filter the instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filters: - name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator. - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - state: the instance state, check State enum for values, support &#34;==&#34; operator. - engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator. - port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
-<a name="v1_group_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+For example: name == &#34;sample instance&#34; name.matches(&#34;sample&#34;) resource_id == &#34;sample-instance&#34; resource_id.matches(&#34;sample&#34;) state == &#34;DELETED&#34; environment == &#34;environments/test&#34; environment == &#34;&#34; (find instances which environment is not set) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) host == &#34;127.0.0.1&#34; host.matches(&#34;127.0&#34;) port == &#34;54321&#34; port.matches(&#34;543&#34;) labels.org_group == &#34;infrastructure&#34; labels.environment in [&#34;prod&#34;, &#34;production&#34;] project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34; host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; |
+| order_by | [string](#string) | | The order by of instances. Support title, environment. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title desc, environment asc&#34; |
-## v1/group_service.proto
-<a name="bytebase-v1-BatchGetGroupsRequest"></a>
-### BatchGetGroupsRequest
-Request message for batch getting groups.
+
+<a name="bytebase-v1-ListInstancesResponse"></a>
+
+### ListInstancesResponse
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The group names to retrieve. Format: groups/{email} |
+| 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-BatchGetGroupsResponse"></a>
+<a name="bytebase-v1-RemoveDataSourceRequest"></a>
+
+### RemoveDataSourceRequest
-### BatchGetGroupsResponse
-Response message for batch getting groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |
+| 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-CreateGroupRequest"></a>
+<a name="bytebase-v1-SASLConfig"></a>
+
+### SASLConfig
-### CreateGroupRequest
-Request message for creating a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| group | [Group](#bytebase-v1-Group) | | The group to create. |
-| group_email | [string](#string) | | The email to use for the group, which will become the final component of the group&#39;s resource name. |
+| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |
-<a name="bytebase-v1-DeleteGroupRequest"></a>
+<a name="bytebase-v1-SyncInstanceRequest"></a>
+
+### SyncInstanceRequest
-### DeleteGroupRequest
-Request message for deleting a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the group to delete. Format: groups/{email} |
+| 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-GetGroupRequest"></a>
+<a name="bytebase-v1-SyncInstanceResponse"></a>
+
+### SyncInstanceResponse
-### GetGroupRequest
-Request message for getting a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the group to retrieve. Format: groups/{email} |
+| databases | [string](#string) | repeated | All database name list in the instance. |
-<a name="bytebase-v1-Group"></a>
+<a name="bytebase-v1-UndeleteInstanceRequest"></a>
+
+### UndeleteInstanceRequest
-### 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. |
+| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |
-<a name="bytebase-v1-GroupMember"></a>
+<a name="bytebase-v1-UpdateDataSourceRequest"></a>
+
+### UpdateDataSourceRequest
-### 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.
+| 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. |
-Format: users/[email protected] |
-| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | The member&#39;s role in the group. |
+<a name="bytebase-v1-UpdateInstanceRequest"></a>
-<a name="bytebase-v1-ListGroupsRequest"></a>
+### UpdateInstanceRequest
-### 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.
+| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.
-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
+The instance&#39;s `name` field is used to identify the instance to update. Format: instances/{instance} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the instance is not found, a new instance will be created. In this situation, `update_mask` is ignored. |
-Supported filter: - title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-For example: title == &#34;dba&#34; email == &#34;[email protected]&#34; title.matches(&#34;dba&#34;) email.matches(&#34;dba&#34;) project == &#34;projects/sample-project&#34; You can combine filter conditions like: title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) |
+
+<a name="bytebase-v1-DataSource-AuthenticationType"></a>
-<a name="bytebase-v1-ListGroupsResponse"></a>
+### DataSource.AuthenticationType
-### ListGroupsResponse
-Response message for listing groups.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| AUTHENTICATION_UNSPECIFIED | 0 | |
+| PASSWORD | 1 | |
+| GOOGLE_CLOUD_SQL_IAM | 2 | |
+| AWS_RDS_IAM | 3 | |
+| AZURE_IAM | 4 | |
-| 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. |
+<a name="bytebase-v1-DataSource-RedisType"></a>
+
+### DataSource.RedisType
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| REDIS_TYPE_UNSPECIFIED | 0 | |
+| STANDALONE | 1 | |
+| SENTINEL | 2 | |
+| CLUSTER | 3 | |
+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>
-<a name="bytebase-v1-UpdateGroupRequest"></a>
+### DataSourceExternalSecret.AppRoleAuthOption.SecretType
-### UpdateGroupRequest
-Request message for updating a group.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
+| PLAIN | 1 | Plain text secret. |
+| ENVIRONMENT | 2 | Secret from environment variable. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| group | [Group](#bytebase-v1-Group) | | The group to update.
-The group&#39;s `name` field is used to identify the group to update. Format: groups/{email} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the group is not found, a new group will be created. In this situation, `update_mask` is ignored. |
+<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></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 |
-
-<a name="bytebase-v1-GroupMember-Role"></a>
+<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>
+
+### DataSourceExternalSecret.SecretType
-### GroupMember.Role
-The role of a group member.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| ROLE_UNSPECIFIED | 0 | Unspecified role. |
-| OWNER | 1 | Group owner. |
-| MEMBER | 2 | Group member. |
+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
+| VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 |
+| AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html |
+| GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |
+| AZURE_KEY_VAULT | 4 | ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets |
+
+
+
+<a name="bytebase-v1-DataSourceType"></a>
+
+### DataSourceType
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DATA_SOURCE_UNSPECIFIED | 0 | Unspecified data source type. |
+| ADMIN | 1 | Admin data source with write permissions. |
+| READ_ONLY | 2 | Read-only data source for query operations. |
@@ -4677,706 +4461,750 @@ The role of a group member.
-<a name="bytebase-v1-GroupService"></a>
+<a name="bytebase-v1-InstanceService"></a>
-### GroupService
-GroupService manages user groups for organizing users and permissions.
+### InstanceService
+InstanceService manages database instances and their connections.
| 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 |
+| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Gets a database instance by name. Permissions required: bb.instances.get |
+| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Lists all database instances. Permissions required: bb.instances.list |
+| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Creates a new database instance. Permissions required: bb.instances.create |
+| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Updates a database instance. Permissions required: bb.instances.update |
+| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete |
+| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Restores a soft-deleted database instance. Permissions required: bb.instances.undelete |
+| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync |
+| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Lists all databases within an instance without creating them. Permissions required: bb.instances.get |
+| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Syncs multiple instances in a single request. Permissions required: bb.instances.sync |
+| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Updates multiple instances in a single request. Permissions required: bb.instances.update |
+| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Adds a read-only data source to an instance. Permissions required: bb.instances.update |
+| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Removes a read-only data source from an instance. Permissions required: bb.instances.update |
+| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Updates a data source configuration. Permissions required: bb.instances.update |
-<a name="v1_idp_service-proto"></a>
+<a name="v1_database_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/idp_service.proto
+## v1/database_service.proto
-<a name="bytebase-v1-CreateIdentityProviderRequest"></a>
+<a name="bytebase-v1-BatchGetDatabasesRequest"></a>
-### CreateIdentityProviderRequest
+### BatchGetDatabasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to create. |
-| identity_provider_id | [string](#string) | | The ID to use for the identity provider, which will become the final component of the identity provider&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-| validate_only | [bool](#bool) | | If set to true, the request will be validated without actually creating the identity provider. |
+| parent | [string](#string) | | The parent resource shared by all databases being retrieved. - projects/{project}: batch get databases in a project; - instances/{instances}: batch get databases in a instance; Use &#34;-&#34; as wildcard to batch get databases across parent. |
+| names | [string](#string) | repeated | The list of database names to retrieve. |
-<a name="bytebase-v1-DeleteIdentityProviderRequest"></a>
+<a name="bytebase-v1-BatchGetDatabasesResponse"></a>
-### DeleteIdentityProviderRequest
+### BatchGetDatabasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the identity provider to delete. Format: idps/{identity_provider} |
+| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-<a name="bytebase-v1-FieldMapping"></a>
+<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>
+
+### BatchSyncDatabasesRequest
-### 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/ |
+| 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-GetIdentityProviderRequest"></a>
+<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>
-### GetIdentityProviderRequest
+### BatchSyncDatabasesResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |
+<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>
-
-<a name="bytebase-v1-IdentityProvider"></a>
-
-### IdentityProvider
+### BatchUpdateDatabasesRequest
| 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 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-IdentityProviderConfig"></a>
+<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>
-### IdentityProviderConfig
+### BatchUpdateDatabasesResponse
| 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. |
+| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |
-<a name="bytebase-v1-LDAPIdentityProviderConfig"></a>
+<a name="bytebase-v1-BoundingBox"></a>
-### LDAPIdentityProviderConfig
-LDAPIdentityProviderConfig is the structure for LDAP identity provider config.
+### BoundingBox
+BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., &#34;ldap.example.com&#34;. |
-| port | [int32](#int32) | | Port is the port number of the LDAP server, e.g., 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS. |
-| skip_tls_verify | [bool](#bool) | | SkipTLSVerify controls whether to skip TLS certificate verification. |
-| bind_dn | [string](#string) | | BindDN is the DN of the user to bind as a service account to perform search requests. |
-| bind_password | [string](#string) | | BindPassword is the password of the user to bind as a service account. |
-| base_dn | [string](#string) | | BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. |
-| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. |
-| security_protocol | [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol) | | SecurityProtocol is the security protocol to be used for establishing connections with the LDAP server. |
-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | FieldMapping is the mapping of the user attributes returned by the LDAP server. |
+| 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-ListIdentityProvidersRequest"></a>
+<a name="bytebase-v1-Changelog"></a>
-### ListIdentityProvidersRequest
+### Changelog
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |
+| schema | [string](#string) | | |
+| schema_size | [int64](#int64) | | |
+| task_run | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| plan_title | [string](#string) | | The title of the plan associated with this changelog&#39;s task run. This field is populated by deriving the plan from task_run for display purposes. |
+
-<a name="bytebase-v1-ListIdentityProvidersResponse"></a>
-### ListIdentityProvidersResponse
+<a name="bytebase-v1-CheckConstraintMetadata"></a>
+### CheckConstraintMetadata
+CheckConstraintMetadata is the metadata for check constraints.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_providers | [IdentityProvider](#bytebase-v1-IdentityProvider) | repeated | The identity providers from the specified request. |
+| 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-OAuth2IdentityProviderConfig"></a>
+<a name="bytebase-v1-ColumnMetadata"></a>
-### OAuth2IdentityProviderConfig
-OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.
+### ColumnMetadata
+ColumnMetadata is the metadata for columns.
| 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. |
+| name | [string](#string) | | The name is the name of a column. |
+| position | [int32](#int32) | | The position is the position in columns. |
+| has_default | [bool](#bool) | | |
+| default | [string](#string) | | The default value of column. |
+| default_on_null | [bool](#bool) | | Oracle specific metadata. The default_on_null is the default on null of a column. |
+| on_update | [string](#string) | | The on_update is the on update action of a column. For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with CURRENT_TIMESTAMP as on update value. |
+| nullable | [bool](#bool) | | The nullable is the nullable of a column. |
+| type | [string](#string) | | The type is the type of a column. |
+| character_set | [string](#string) | | The character_set is the character_set of a column. |
+| collation | [string](#string) | | The collation is the collation of a column. |
+| comment | [string](#string) | | The comment is the comment of a column. |
+| generation | [GenerationMetadata](#bytebase-v1-GenerationMetadata) | | The generation is the generation of a column. |
+| is_identity | [bool](#bool) | | |
+| identity_generation | [ColumnMetadata.IdentityGeneration](#bytebase-v1-ColumnMetadata-IdentityGeneration) | | The identity_generation is for identity columns, PG only. |
+| identity_seed | [int64](#int64) | | The identity_seed is for identity columns, MSSQL only. |
+| identity_increment | [int64](#int64) | | The identity_increment is for identity columns, MSSQL only. |
+| default_constraint_name | [string](#string) | | The default_constraint_name is the name of the default constraint, MSSQL only. In MSSQL, default values are implemented as named constraints. When modifying or dropping a column&#39;s default value, you must reference the constraint by name. This field stores the actual constraint name from the database.
+Example: A column definition like: CREATE TABLE employees ( status NVARCHAR(20) DEFAULT &#39;active&#39; )
+Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39; or a user-defined name if specified: ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
+To modify the default, you must first drop the existing constraint by name: ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760 ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
+This field is populated when syncing from the database. When empty (e.g., when parsing from SQL files), the system cannot automatically drop the constraint. |
-<a name="bytebase-v1-OAuth2IdentityProviderTestRequestContext"></a>
-### OAuth2IdentityProviderTestRequestContext
+
+
+
+<a name="bytebase-v1-Database"></a>
+
+### Database
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorize code from website. |
+| 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} |
+| release | [string](#string) | | The release that was last applied to this database. Format: projects/{project}/releases/{release_id} Example: projects/my-project/releases/release_20260115-RC00 |
+| 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. |
-<a name="bytebase-v1-OIDCIdentityProviderConfig"></a>
+<a name="bytebase-v1-Database-LabelsEntry"></a>
+
+### Database.LabelsEntry
-### OIDCIdentityProviderConfig
-OIDCIdentityProviderConfig is the structure for OIDC identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issuer | [string](#string) | | The OIDC issuer URL for the identity provider. |
-| client_id | [string](#string) | | The OIDC client identifier. |
-| client_secret | [string](#string) | | The OIDC client secret for authentication. |
-| scopes | [string](#string) | repeated | The scopes that the OIDC provider supports. Should be fetched from the well-known configuration file of the OIDC provider. |
-| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | Mapping configuration for user attributes from OIDC claims. |
-| skip_tls_verify | [bool](#bool) | | Whether to skip TLS certificate verification. |
-| auth_style | [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle) | | The authentication style for client credentials. |
-| auth_endpoint | [string](#string) | | The authorization endpoint of the OIDC provider. Should be fetched from the well-known configuration file of the OIDC provider. |
-
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-OIDCIdentityProviderTestRequestContext"></a>
-### OIDCIdentityProviderTestRequestContext
+<a name="bytebase-v1-DatabaseMetadata"></a>
+### DatabaseMetadata
+DatabaseMetadata is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorize code from OIDC provider. |
+| 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-TestIdentityProviderRequest"></a>
-### TestIdentityProviderRequest
+<a name="bytebase-v1-DatabaseSDLSchema"></a>
+### DatabaseSDLSchema
+DatabaseSDLSchema contains the schema in SDL format.
| 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. |
-
+| schema | [bytes](#bytes) | | The SDL schema content. - For SINGLE_FILE format: contains the complete SDL schema as a text string. - For MULTI_FILE format: contains the ZIP archive as binary data. |
+| content_type | [string](#string) | | The MIME type of the schema content. Indicates how the client should interpret the schema field. Examples: - &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format - &#34;application/zip&#34; for MULTI_FILE format |
-<a name="bytebase-v1-TestIdentityProviderResponse"></a>
-### TestIdentityProviderResponse
+<a name="bytebase-v1-DatabaseSchema"></a>
+### DatabaseSchema
+DatabaseSchema is the metadata for databases.
| 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. |
-
+| schema | [string](#string) | | The schema dump from database. |
-<a name="bytebase-v1-TestIdentityProviderResponse-ClaimsEntry"></a>
-### TestIdentityProviderResponse.ClaimsEntry
+<a name="bytebase-v1-DependencyColumn"></a>
+### DependencyColumn
+DependencyColumn is the metadata for dependency columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| 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-TestIdentityProviderResponse-UserInfoEntry"></a>
+<a name="bytebase-v1-DependencyTable"></a>
-### TestIdentityProviderResponse.UserInfoEntry
+### DependencyTable
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| 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-UpdateIdentityProviderRequest"></a>
+<a name="bytebase-v1-DiffSchemaRequest"></a>
-### UpdateIdentityProviderRequest
+### DiffSchemaRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to update.
+| 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} |
-The identity provider&#39;s `name` field is used to identify the identity provider to update. Format: idps/{identity_provider} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the identity provider is not found, a new identity provider will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-DiffSchemaResponse"></a>
+### DiffSchemaResponse
-<a name="bytebase-v1-IdentityProviderType"></a>
-### IdentityProviderType
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| diff | [string](#string) | | |
-| 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
+<a name="bytebase-v1-DimensionConstraint"></a>
-| 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. |
+### 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 |
-<a name="bytebase-v1-OAuth2AuthStyle"></a>
-### OAuth2AuthStyle
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | |
-| IN_PARAMS | 1 | IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body as application/x-www-form-urlencoded parameters. |
-| IN_HEADER | 2 | IN_HEADER sends the client_id and client_password using HTTP Basic Authorization. This is an optional style described in the OAuth2 RFC 6749 section 2.3.1. |
-
+<a name="bytebase-v1-DimensionalConfig"></a>
-
+### DimensionalConfig
+DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
-<a name="bytebase-v1-IdentityProviderService"></a>
+| 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 |
-### IdentityProviderService
-IdentityProviderService manages external identity providers for SSO authentication.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetIdentityProvider | [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Gets an identity provider by name. Permissions required: bb.identityProviders.get |
-| ListIdentityProviders | [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest) | [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse) | Lists all configured identity providers (public endpoint for login page). Permissions required: None |
-| CreateIdentityProvider | [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Creates a new identity provider. Permissions required: bb.identityProviders.create |
-| UpdateIdentityProvider | [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Updates an identity provider. Permissions required: bb.identityProviders.update When allow_missing=true, also requires: bb.identityProviders.create |
-| DeleteIdentityProvider | [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an identity provider. Permissions required: bb.identityProviders.delete |
-| TestIdentityProvider | [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest) | [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse) | Tests the connection and configuration of an identity provider. Permissions required: bb.identityProviders.update |
-
-<a name="v1_issue_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+<a name="bytebase-v1-EnumTypeMetadata"></a>
-## v1/issue_service.proto
+### EnumTypeMetadata
-<a name="bytebase-v1-ApprovalFlow"></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. |
-### ApprovalFlow
+
+
+
+
+
+<a name="bytebase-v1-EventMetadata"></a>
+
+### EventMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [string](#string) | repeated | The roles required for approval in order. |
-
+| name | [string](#string) | | The name of the event. |
+| definition | [string](#string) | | The schedule of the event. |
+| time_zone | [string](#string) | | The time zone of the event. |
+| sql_mode | [string](#string) | | The SQL mode setting for the event. |
+| character_set_client | [string](#string) | | The character set used by the client creating the event. |
+| collation_connection | [string](#string) | | The collation used for the connection when creating the event. |
+| comment | [string](#string) | | The comment is the comment of an event. |
-<a name="bytebase-v1-ApprovalTemplate"></a>
-### ApprovalTemplate
+<a name="bytebase-v1-ExtensionMetadata"></a>
+### ExtensionMetadata
+ExtensionMetadata is the metadata for extensions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| flow | [ApprovalFlow](#bytebase-v1-ApprovalFlow) | | The approval flow definition. |
-| title | [string](#string) | | The title of the approval template. |
-| description | [string](#string) | | The description of the approval template. |
+| 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-ApproveIssueRequest"></a>
+<a name="bytebase-v1-ExternalTableMetadata"></a>
-### ApproveIssueRequest
+### ExternalTableMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to add an approver. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the approval decision. |
-
+| 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-BatchUpdateIssuesStatusRequest"></a>
-### BatchUpdateIssuesStatusRequest
+<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 issues being updated. Format: projects/{project} If the operation spans parents, a dash (-) may be accepted as a wildcard. We only support updating the status of databases for now. |
-| issues | [string](#string) | repeated | The list of issues to update. Format: projects/{project}/issues/{issue} |
-| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The new status. |
-| reason | [string](#string) | | The reason for the status change. |
+| name | [string](#string) | | The name is the name of a foreign key. |
+| columns | [string](#string) | repeated | The columns are the ordered referencing columns of a foreign key. |
+| referenced_schema | [string](#string) | | The referenced_schema is the referenced schema name of a foreign key. It is an empty string for databases without such concept such as MySQL. |
+| referenced_table | [string](#string) | | The referenced_table is the referenced table name of a foreign key. |
+| referenced_columns | [string](#string) | repeated | The referenced_columns are the ordered referenced columns of a foreign key. |
+| on_delete | [string](#string) | | The on_delete is the on delete action of a foreign key. |
+| on_update | [string](#string) | | The on_update is the on update action of a foreign key. |
+| match_type | [string](#string) | | The match_type is the match type of a foreign key. The match_type is the PostgreSQL specific field. It&#39;s empty string for other databases. |
-<a name="bytebase-v1-BatchUpdateIssuesStatusResponse"></a>
+<a name="bytebase-v1-FunctionMetadata"></a>
-### BatchUpdateIssuesStatusResponse
+### FunctionMetadata
+FunctionMetadata is the metadata for functions.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name is the name of a function. |
+| definition | [string](#string) | | The definition is the definition of a function. |
+| signature | [string](#string) | | The signature is the name with the number and type of input arguments the function takes. |
+| character_set_client | [string](#string) | | MySQL specific metadata. |
+| collation_connection | [string](#string) | | |
+| database_collation | [string](#string) | | |
+| sql_mode | [string](#string) | | |
+| comment | [string](#string) | | |
+| dependency_tables | [DependencyTable](#bytebase-v1-DependencyTable) | repeated | The dependency_tables is the list of dependency tables of a function. For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. |
+| skip_dump | [bool](#bool) | | |
+
-<a name="bytebase-v1-CreateIssueCommentRequest"></a>
+<a name="bytebase-v1-GenerationMetadata"></a>
-### CreateIssueCommentRequest
+### GenerationMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to create. |
+| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |
+| expression | [string](#string) | | |
-<a name="bytebase-v1-CreateIssueRequest"></a>
+<a name="bytebase-v1-GetChangelogRequest"></a>
-### CreateIssueRequest
+### GetChangelogRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
-| issue | [Issue](#bytebase-v1-Issue) | | The issue to create. |
+| 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-GetIssueRequest"></a>
+<a name="bytebase-v1-GetDatabaseMetadataRequest"></a>
-### GetIssueRequest
+### GetDatabaseMetadataRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to retrieve. Format: projects/{project}/issues/{issue} |
-| force | [bool](#bool) | | If set to true, bypass cache and fetch the latest data. |
+| name | [string](#string) | | The name of the 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 &#34;==&#34; operator. - table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+
+For example: schema == &#34;schema-a&#34; table == &#34;table-a&#34; table.matches(&#34;table-a&#34;) schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;) The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;. The column masking level will only be returned when a table filter is used. |
+| limit | [int32](#int32) | | Limit the response size of returned table metadata per schema. For example, if the database has 3 schemas, and each schema has 100 tables, if limit is 20, then only 20 tables will be returned for each schema, total 60 tables. Default 0, means no limit. |
-<a name="bytebase-v1-GrantRequest"></a>
+<a name="bytebase-v1-GetDatabaseRequest"></a>
-### GrantRequest
+### GetDatabaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [string](#string) | | The requested role. Format: roles/EXPORTER. |
-| user | [string](#string) | | The user to be granted. Format: users/{email}. |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition for the role. Same as the condition in IAM Binding message. |
-| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for which the grant is valid. |
+| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |
-<a name="bytebase-v1-Issue"></a>
+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>
-### Issue
+### GetDatabaseSDLSchemaRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue. Format: projects/{project}/issues/{issue} |
-| title | [string](#string) | | The title of the issue. |
-| description | [string](#string) | | The description of the issue. |
-| type | [Issue.Type](#bytebase-v1-Issue-Type) | | |
-| status | [IssueStatus](#bytebase-v1-IssueStatus) | | The status of the issue. |
-| approvers | [Issue.Approver](#bytebase-v1-Issue-Approver) | repeated | |
-| approval_template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | The approval template for the issue. |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| plan | [string](#string) | | The plan associated with the issue. Can be empty. Format: projects/{project}/plans/{plan} |
-| grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. |
-| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. |
-| approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | |
+| 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-Issue-Approver"></a>
+<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>
+
+### GetDatabaseSchemaRequest
-### Issue.Approver
-Approvers and their approval status for the issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status) | | The new status. |
-| principal | [string](#string) | | Format: users/[email protected] |
+| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |
-<a name="bytebase-v1-IssueComment"></a>
+<a name="bytebase-v1-GetSchemaStringRequest"></a>
+
+### GetSchemaStringRequest
-### IssueComment
-A comment on an issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} |
-| comment | [string](#string) | | The text content of the comment. |
-| payload | [string](#string) | | TODO: use struct message instead. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| creator | [string](#string) | | Format: users/{email} |
-| approval | [IssueComment.Approval](#bytebase-v1-IssueComment-Approval) | | Approval event. |
-| issue_update | [IssueComment.IssueUpdate](#bytebase-v1-IssueComment-IssueUpdate) | | Issue update event. |
-| plan_spec_update | [IssueComment.PlanSpecUpdate](#bytebase-v1-IssueComment-PlanSpecUpdate) | | Plan spec update event. |
+| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} |
+| type | [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType) | | |
+| schema | [string](#string) | | It&#39;s empty for DATABASE. |
+| object | [string](#string) | | It&#39;s empty for DATABASE and SCHEMA. |
+| metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED. Also the schema and object are empty. |
-<a name="bytebase-v1-IssueComment-Approval"></a>
+<a name="bytebase-v1-GetSchemaStringResponse"></a>
+
+### GetSchemaStringResponse
-### IssueComment.Approval
-Approval event information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |
+| schema_string | [string](#string) | | |
-<a name="bytebase-v1-IssueComment-IssueUpdate"></a>
+<a name="bytebase-v1-GridLevel"></a>
-### IssueComment.IssueUpdate
-Issue update event information.
+### GridLevel
+GridLevel defines a tessellation grid level with its density.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| from_title | [string](#string) | optional | |
-| to_title | [string](#string) | optional | |
-| from_description | [string](#string) | optional | |
-| to_description | [string](#string) | optional | |
-| from_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
-| to_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
-| from_labels | [string](#string) | repeated | |
-| to_labels | [string](#string) | repeated | |
+| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |
+| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |
-<a name="bytebase-v1-IssueComment-PlanSpecUpdate"></a>
+<a name="bytebase-v1-IndexMetadata"></a>
-### IssueComment.PlanSpecUpdate
-Plan spec update event information (tracks sheet changes to plan specs).
+### IndexMetadata
+IndexMetadata is the metadata for indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| spec | [string](#string) | | The spec that was updated. Format: projects/{project}/plans/{plan}/specs/{spec} |
-| from_sheet | [string](#string) | optional | The previous sheet. Format: projects/{project}/sheets/{sheet} |
-| to_sheet | [string](#string) | optional | The new sheet. Format: projects/{project}/sheets/{sheet} |
+| name | [string](#string) | | The name is the name of an index. |
+| expressions | [string](#string) | repeated | The expressions are the ordered columns or expressions of an index. This could refer to a column or an expression. |
+| key_length | [int64](#int64) | repeated | The key_lengths are the ordered key lengths of an index. If the key length is not specified, it&#39;s -1. |
+| descending | [bool](#bool) | repeated | The descending is the ordered descending of an index. |
+| type | [string](#string) | | The type is the type of an index. |
+| unique | [bool](#bool) | | The unique is whether the index is unique. |
+| primary | [bool](#bool) | | The primary is whether the index is a primary key index. |
+| visible | [bool](#bool) | | The visible is whether the index is visible. |
+| comment | [string](#string) | | The comment is the comment of an index. |
+| definition | [string](#string) | | The definition of an index. |
+| parent_index_schema | [string](#string) | | The schema name of the parent index. |
+| parent_index_name | [string](#string) | | The index name of the parent index. |
+| granularity | [int64](#int64) | | The number of granules in the block. It&#39;s a ClickHouse specific field. |
+| is_constraint | [bool](#bool) | | It&#39;s a PostgreSQL specific field. The unique constraint and unique index are not the same thing in PostgreSQL. |
+| spatial_config | [SpatialIndexConfig](#bytebase-v1-SpatialIndexConfig) | | Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. |
+| opclass_names | [string](#string) | repeated | https://www.postgresql.org/docs/current/catalog-pg-opclass.html Name of the operator class for each column. (PostgreSQL specific). |
+| opclass_defaults | [bool](#bool) | repeated | True if the operator class is the default. (PostgreSQL specific). |
-<a name="bytebase-v1-ListIssueCommentsRequest"></a>
+<a name="bytebase-v1-ListChangelogsRequest"></a>
-### ListIssueCommentsRequest
+### ListChangelogsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{projects}/issues/{issue} |
-| page_size | [int32](#int32) | | The maximum number of issue comments to return. The service may return fewer than this value. If unspecified, at most 10 issue comments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListIssueComments` call. Provide this to retrieve the subsequent page.
+| 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 to `ListIssueComments` must match the call that provided the page token. |
+When paginating, all other parameters provided must match the call that provided the page token. |
+| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
+| filter | [string](#string) | | Filter is used to filter changelogs returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values. - create_time: the changelog create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+Example: status == &#34;DONE&#34; status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34; create_time &gt;= &#34;2024-01-01T00:00:00Z&#34; &amp;&amp; create_time &lt;= &#34;2024-01-02T00:00:00Z&#34; |
-<a name="bytebase-v1-ListIssueCommentsResponse"></a>
-### ListIssueCommentsResponse
+
+<a name="bytebase-v1-ListChangelogsResponse"></a>
+
+### ListChangelogsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | The issue comments from the specified request. |
+| 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. |
@@ -5384,40 +5212,43 @@ When paginating, all other parameters provided to `ListIssueComments` must match
-<a name="bytebase-v1-ListIssuesRequest"></a>
+<a name="bytebase-v1-ListDatabasesRequest"></a>
-### ListIssuesRequest
+### ListDatabasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} |
-| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListIssues` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListIssues` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter issues returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+| parent | [string](#string) | | - projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission. - workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission. - instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission |
+| page_size | [int32](#int32) | | The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.
-Supported filters: - creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values. - create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values. - labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator. - approval_status: issue approval status, support &#34;==&#34; operator. - current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
+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
-For example: creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;] status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34; labels in [&#34;label1&#34;, &#34;label2&#34;] create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; |
-| query | [string](#string) | | Query is the query statement. |
+Supported filter: - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - name: the database name, support &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator. - table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator. - labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+For example: environment == &#34;environments/{environment resource id}&#34; environment == &#34;&#34; (find databases which environment is not set) project == &#34;projects/{project resource id}&#34; instance == &#34;instances/{instance resource id}&#34; name.matches(&#34;database name&#34;) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) exclude_unassigned == true table == &#34;sample&#34; table.matches(&#34;sam&#34;) labels.environment == &#34;production&#34; labels.region == &#34;asia&#34; labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+You can combine filter conditions like: environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) |
+| show_deleted | [bool](#bool) | | Show deleted database if specified. |
+| order_by | [string](#string) | | The order by of databases. Support name, project, instance. The default sorting order is ascending. For example: - order_by = &#34;name&#34; - order by name ascending - order_by = &#34;name desc&#34; - order_by = &#34;name desc, project asc&#34; |
-<a name="bytebase-v1-ListIssuesResponse"></a>
-### ListIssuesResponse
+
+<a name="bytebase-v1-ListDatabasesResponse"></a>
+
+### ListDatabasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| 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. |
@@ -5425,1375 +5256,1398 @@ For example: creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#
-<a name="bytebase-v1-RejectIssueRequest"></a>
-
-### RejectIssueRequest
+<a name="bytebase-v1-MaterializedViewMetadata"></a>
+### MaterializedViewMetadata
+MaterializedViewMetadata is the metadata for materialized views.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to add a rejection. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the rejection decision. |
-
+| 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-RequestIssueRequest"></a>
-### RequestIssueRequest
+<a name="bytebase-v1-PackageMetadata"></a>
+### PackageMetadata
+PackageMetadata is the metadata for packages.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to request a issue. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the request. |
-
+| 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-SearchIssuesRequest"></a>
-### SearchIssuesRequest
+<a name="bytebase-v1-ProcedureMetadata"></a>
+### ProcedureMetadata
+ProcedureMetadata is the metadata for procedures.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} Use &#34;projects/-&#34; to list all issues from all projects. |
-| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchIssues` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchIssues` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter issues returned in the list. Check the filter field in the ListIssuesRequest message. |
-| query | [string](#string) | | Query is the query statement. |
-
+| 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-SearchIssuesResponse"></a>
-### SearchIssuesResponse
+<a name="bytebase-v1-SchemaMetadata"></a>
+### SchemaMetadata
+SchemaMetadata is the metadata for schemas.
+This is the concept of schema in Postgres, but it&#39;s a no-op for MySQL.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| 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-UpdateIssueCommentRequest"></a>
+<a name="bytebase-v1-SequenceMetadata"></a>
-### UpdateIssueCommentRequest
+### SequenceMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, `update_mask` is ignored. |
-
+| 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-UpdateIssueRequest"></a>
-### UpdateIssueRequest
+<a name="bytebase-v1-SpatialIndexConfig"></a>
+### SpatialIndexConfig
+SpatialIndexConfig defines the spatial index configuration for spatial databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issue | [Issue](#bytebase-v1-Issue) | | The issue to update.
-
-The issue&#39;s `name` field is used to identify the issue to update. Format: projects/{project}/issues/{issue} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the issue is not found, a new issue will be created. In this situation, `update_mask` is ignored. |
-
-
+| method | [string](#string) | | Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) |
+| tessellation | [TessellationConfig](#bytebase-v1-TessellationConfig) | | Tessellation configuration for grid-based spatial indexes |
+| storage | [StorageConfig](#bytebase-v1-StorageConfig) | | Storage and performance configuration |
+| dimensional | [DimensionalConfig](#bytebase-v1-DimensionalConfig) | | Dimensional configuration |
-
-<a name="bytebase-v1-Issue-ApprovalStatus"></a>
-### Issue.ApprovalStatus
-The overall approval status for the issue.
+<a name="bytebase-v1-StorageConfig"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| APPROVAL_STATUS_UNSPECIFIED | 0 | Unspecified approval status. |
-| CHECKING | 1 | Approval checks are being evaluated. |
-| PENDING | 2 | Approval is pending. |
-| APPROVED | 3 | Issue has been approved. |
-| REJECTED | 4 | Issue has been rejected. |
-| SKIPPED | 5 | Approval was skipped. |
+### StorageConfig
+StorageConfig defines storage and performance parameters for spatial indexes.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| fillfactor | [int32](#int32) | | Fill factor percentage (1-100) |
+| buffering | [string](#string) | | Buffering mode for PostgreSQL (auto, on, off) |
+| tablespace | [string](#string) | | Tablespace configuration for Oracle |
+| work_tablespace | [string](#string) | | |
+| sdo_level | [int32](#int32) | | |
+| commit_interval | [int32](#int32) | | |
+| pad_index | [bool](#bool) | | SQL Server specific parameters |
+| sort_in_tempdb | [string](#string) | | ON, OFF |
+| drop_existing | [bool](#bool) | | |
+| online | [bool](#bool) | | |
+| allow_row_locks | [bool](#bool) | | |
+| allow_page_locks | [bool](#bool) | | |
+| maxdop | [int32](#int32) | | |
+| data_compression | [string](#string) | | NONE, ROW, PAGE |
-<a name="bytebase-v1-Issue-Approver-Status"></a>
-### Issue.Approver.Status
-The approval status of an approver.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Awaiting approval. |
-| APPROVED | 2 | Approved. |
-| REJECTED | 3 | Rejected. |
-<a name="bytebase-v1-Issue-Type"></a>
+<a name="bytebase-v1-StreamMetadata"></a>
-### Issue.Type
-The type of issue.
+### StreamMetadata
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified issue type. |
-| DATABASE_CHANGE | 1 | Database schema or data change. |
-| GRANT_REQUEST | 2 | Database access grant request. |
-| DATABASE_EXPORT | 3 | Database data export request. |
+| 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="bytebase-v1-IssueComment-Approval-Status"></a>
-### IssueComment.Approval.Status
-Approval status values.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Approval pending. |
-| APPROVED | 2 | Approved. |
-| REJECTED | 3 | Rejected. |
-<a name="bytebase-v1-IssueStatus"></a>
+<a name="bytebase-v1-SyncDatabaseRequest"></a>
-### IssueStatus
-The status of an issue.
+### SyncDatabaseRequest
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| ISSUE_STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| OPEN | 1 | Issue is open and active. |
-| DONE | 2 | Issue is completed. |
-| CANCELED | 3 | Issue is canceled. |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |
-
-<a name="bytebase-v1-IssueService"></a>
-### IssueService
-IssueService manages issues for tracking database changes and tasks.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetIssue | [GetIssueRequest](#bytebase-v1-GetIssueRequest) | [Issue](#bytebase-v1-Issue) | Retrieves an issue by name. Permissions required: bb.issues.get |
-| CreateIssue | [CreateIssueRequest](#bytebase-v1-CreateIssueRequest) | [Issue](#bytebase-v1-Issue) | Creates a new issue for database changes or tasks. Permissions required: bb.issues.create |
-| ListIssues | [ListIssuesRequest](#bytebase-v1-ListIssuesRequest) | [ListIssuesResponse](#bytebase-v1-ListIssuesResponse) | Lists issues in a project. Permissions required: bb.issues.list |
-| SearchIssues | [SearchIssuesRequest](#bytebase-v1-SearchIssuesRequest) | [SearchIssuesResponse](#bytebase-v1-SearchIssuesResponse) | Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query. Permissions required: bb.issues.get |
-| UpdateIssue | [UpdateIssueRequest](#bytebase-v1-UpdateIssueRequest) | [Issue](#bytebase-v1-Issue) | Updates an issue&#39;s properties such as title, description, or labels. Permissions required: bb.issues.update |
-| ListIssueComments | [ListIssueCommentsRequest](#bytebase-v1-ListIssueCommentsRequest) | [ListIssueCommentsResponse](#bytebase-v1-ListIssueCommentsResponse) | Lists comments on an issue. Permissions required: bb.issueComments.list |
-| CreateIssueComment | [CreateIssueCommentRequest](#bytebase-v1-CreateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Adds a comment to an issue. Permissions required: bb.issueComments.create |
-| UpdateIssueComment | [UpdateIssueCommentRequest](#bytebase-v1-UpdateIssueCommentRequest) | [IssueComment](#bytebase-v1-IssueComment) | Updates an existing issue comment. Permissions required: bb.issueComments.update |
-| BatchUpdateIssuesStatus | [BatchUpdateIssuesStatusRequest](#bytebase-v1-BatchUpdateIssuesStatusRequest) | [BatchUpdateIssuesStatusResponse](#bytebase-v1-BatchUpdateIssuesStatusResponse) | Updates the status of multiple issues in a single operation. Permissions required: bb.issues.update |
-| ApproveIssue | [ApproveIssueRequest](#bytebase-v1-ApproveIssueRequest) | [Issue](#bytebase-v1-Issue) | Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
-| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
-| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
-
+<a name="bytebase-v1-SyncDatabaseResponse"></a>
+### SyncDatabaseResponse
-<a name="v1_org_policy_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/org_policy_service.proto
-<a name="bytebase-v1-CreatePolicyRequest"></a>
-### CreatePolicyRequest
+<a name="bytebase-v1-TableMetadata"></a>
+### TableMetadata
+TableMetadata is the metadata for tables.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| policy | [Policy](#bytebase-v1-Policy) | | The policy to create. |
-| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy to create. |
-
-
-
-
-
-
-<a name="bytebase-v1-DeletePolicyRequest"></a>
-
-### DeletePolicyRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-
+| name | [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-GetPolicyRequest"></a>
-### GetPolicyRequest
+<a name="bytebase-v1-TablePartitionMetadata"></a>
+### TablePartitionMetadata
+TablePartitionMetadata is the metadata for table partitions.
| 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 name of a table partition. |
+| type | [TablePartitionMetadata.Type](#bytebase-v1-TablePartitionMetadata-Type) | | The type of a table partition. |
+| expression | [string](#string) | | The expression is the expression of a table partition. For PostgreSQL, the expression is the text of {FOR VALUES partition_bound_spec}, see https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL, the expression is the `expr` or `column_list` of the following syntax. PARTITION BY { [LINEAR] HASH(expr) | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) | RANGE{(expr) | COLUMNS(column_list)} | LIST{(expr) | COLUMNS(column_list)} }. |
+| value | [string](#string) | | The value is the value of a table partition. For MySQL, the value is for RANGE and LIST partition types, - For a RANGE partition, it contains the value set in the partition&#39;s VALUES LESS THAN clause, which can be either an integer or MAXVALUE. - For a LIST partition, this column contains the values defined in the partition&#39;s VALUES IN clause, which is a list of comma-separated integer values. - For others, it&#39;s an empty string. |
+| use_default | [string](#string) | | The use_default is whether the users use the default partition, it stores the different value for different database engines. For MySQL, it&#39;s [INT] type, 0 means not use default partition, otherwise, it&#39;s equals to number in syntax [SUB]PARTITION {number}. |
+| subpartitions | [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata) | repeated | The subpartitions is the list of subpartitions in a table partition. |
+| indexes | [IndexMetadata](#bytebase-v1-IndexMetadata) | repeated | |
+| check_constraints | [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata) | repeated | |
-<a name="bytebase-v1-ListPoliciesRequest"></a>
+<a name="bytebase-v1-TaskMetadata"></a>
-### ListPoliciesRequest
+### TaskMetadata
| 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. |
-
+| 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-ListPoliciesResponse"></a>
-### ListPoliciesResponse
+<a name="bytebase-v1-TessellationConfig"></a>
+### TessellationConfig
+TessellationConfig defines tessellation parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policies | [Policy](#bytebase-v1-Policy) | repeated | The policies from the specified request. |
+| scheme | [string](#string) | | Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) |
+| grid_levels | [GridLevel](#bytebase-v1-GridLevel) | repeated | Grid levels and densities for multi-level tessellation |
+| cells_per_object | [int32](#int32) | | Number of cells per object (1-8192 for SQL Server) |
+| bounding_box | [BoundingBox](#bytebase-v1-BoundingBox) | | Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) |
-<a name="bytebase-v1-MaskingExemptionPolicy"></a>
+<a name="bytebase-v1-TriggerMetadata"></a>
+
+### TriggerMetadata
-### MaskingExemptionPolicy
-MaskingExemptionPolicy is the allowlist of users who can access sensitive data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| exemptions | [MaskingExemptionPolicy.Exemption](#bytebase-v1-MaskingExemptionPolicy-Exemption) | repeated | |
+| 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-MaskingExemptionPolicy-Exemption"></a>
+<a name="bytebase-v1-UpdateDatabaseRequest"></a>
-### MaskingExemptionPolicy.Exemption
+### UpdateDatabaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| members | [string](#string) | repeated | Specifies the principals who are exempt from masking. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this exception policy instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec If the condition is empty, means the user can access all databases without expiration.
-
-Support variables: resource.instance_id: the instance resource id. Only support &#34;==&#34; operation. resource.database_name: the database name. Only support &#34;==&#34; operation. resource.schema_name: the schema name. Only support &#34;==&#34; operation. resource.table_name: the table name. Only support &#34;==&#34; operation. resource.column_name: the column name. Only support &#34;==&#34; operation. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)` All variables should join with &#34;&amp;&amp;&#34; condition.
+| database | [Database](#bytebase-v1-Database) | | The database to update.
-For example: resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;) resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; |
+The database&#39;s `name` field is used to identify the database to update. Format: instances/{instance}/databases/{database} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the database is not found, a new database will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-MaskingRulePolicy"></a>
+<a name="bytebase-v1-ViewMetadata"></a>
-### MaskingRulePolicy
-Policy for configuring data masking rules.
+### ViewMetadata
+ViewMetadata is the metadata for views.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |
+| 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-MaskingRulePolicy-MaskingRule"></a>
-### MaskingRulePolicy.MaskingRule
-A rule that defines when and how to mask data.
+<a name="bytebase-v1-Changelog-Status"></a>
+### Changelog.Status
-| 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.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | |
+| PENDING | 1 | |
+| DONE | 2 | |
+| FAILED | 3 | |
-Each variable support following operations: ==: the value equals the target. !=: the value not equals the target. in: the value matches one of the targets. !(in): the value not matches any of the targets.
-For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34; resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;] resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;]) resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) |
-| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). |
+<a name="bytebase-v1-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-Policy"></a>
-### Policy
+<a name="bytebase-v1-ColumnMetadata-IdentityGeneration"></a>
+### ColumnMetadata.IdentityGeneration
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| inherit_from_parent | [bool](#bool) | | Whether this policy inherits from its parent resource. |
-| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy. |
-| rollout_policy | [RolloutPolicy](#bytebase-v1-RolloutPolicy) | | |
-| masking_rule_policy | [MaskingRulePolicy](#bytebase-v1-MaskingRulePolicy) | | |
-| masking_exemption_policy | [MaskingExemptionPolicy](#bytebase-v1-MaskingExemptionPolicy) | | |
-| tag_policy | [TagPolicy](#bytebase-v1-TagPolicy) | | |
-| 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. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDENTITY_GENERATION_UNSPECIFIED | 0 | |
+| ALWAYS | 1 | |
+| BY_DEFAULT | 2 | |
+<a name="bytebase-v1-GenerationMetadata-Type"></a>
+### GenerationMetadata.Type
-<a name="bytebase-v1-QueryDataPolicy"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| VIRTUAL | 1 | |
+| STORED | 2 | |
-### 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 &lt;= 0. |
-| maximum_result_rows | [int32](#int32) | | The maximum number of rows to return. The default value is -1, means no limit. |
-| disable_copy_data | [bool](#bool) | | Disable copying query results. |
-| admin_data_source_restriction | [QueryDataPolicy.Restriction](#bytebase-v1-QueryDataPolicy-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-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>
-<a name="bytebase-v1-RolloutPolicy"></a>
+### GetSchemaStringRequest.ObjectType
-### RolloutPolicy
-Rollout policy configuration.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OBJECT_TYPE_UNSPECIFIED | 0 | |
+| DATABASE | 1 | |
+| SCHEMA | 2 | |
+| TABLE | 3 | |
+| VIEW | 4 | |
+| MATERIALIZED_VIEW | 5 | |
+| FUNCTION | 6 | |
+| PROCEDURE | 7 | |
+| SEQUENCE | 8 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| automatic | [bool](#bool) | | Whether rollout is automatic without manual approval. |
-| roles | [string](#string) | repeated | The roles that can approve rollout execution. |
+<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-TagPolicy"></a>
-### TagPolicy
-Policy for tagging resources with metadata.
+<a name="bytebase-v1-StreamMetadata-Type"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| tags | [TagPolicy.TagsEntry](#bytebase-v1-TagPolicy-TagsEntry) | repeated | tags is the key - value map for resources. for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; |
+### StreamMetadata.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| DELTA | 1 | |
+<a name="bytebase-v1-TablePartitionMetadata-Type"></a>
-<a name="bytebase-v1-TagPolicy-TagsEntry"></a>
+### TablePartitionMetadata.Type
+Type is the type of a table partition, some database engines may not
+support all types. Only avilable for the following database engines now:
+MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,
+LINEAR_KEY
+(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:
+RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,
+LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)
-### TagPolicy.TagsEntry
+| 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 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
-
+<a name="bytebase-v1-TaskMetadata-State"></a>
+### TaskMetadata.State
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATE_UNSPECIFIED | 0 | |
+| STARTED | 1 | |
+| SUSPENDED | 2 | |
-<a name="bytebase-v1-UpdatePolicyRequest"></a>
+
-### UpdatePolicyRequest
+
+<a name="bytebase-v1-DatabaseService"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| policy | [Policy](#bytebase-v1-Policy) | | The policy to update.
+### DatabaseService
+DatabaseService manages databases and their schemas.
-The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the policy is not found, a new policy will be created. In this situation, `update_mask` is ignored. |
+| 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="v1_group_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
-
+## v1/group_service.proto
-<a name="bytebase-v1-PolicyResourceType"></a>
-### PolicyResourceType
-The resource type that a policy can be attached to.
+<a name="bytebase-v1-BatchGetGroupsRequest"></a>
-| 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. |
+### BatchGetGroupsRequest
+Request message for batch getting groups.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| names | [string](#string) | repeated | The group names to retrieve. Format: groups/{email} |
-<a name="bytebase-v1-PolicyType"></a>
-### PolicyType
-The type of organizational policy.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |
-| MASKING_RULE | 1 | Data masking rule policy. |
-| MASKING_EXEMPTION | 2 | Data masking exemption policy. |
-| ROLLOUT_POLICY | 3 | Rollout deployment policy. |
-| TAG | 4 | Resource tag policy. |
-| DATA_QUERY | 6 | Query data access policy. |
-<a name="bytebase-v1-QueryDataPolicy-Restriction"></a>
+<a name="bytebase-v1-BatchGetGroupsResponse"></a>
-### QueryDataPolicy.Restriction
-Restriction level for admin data source access.
+### BatchGetGroupsResponse
+Response message for batch getting groups.
-| 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 |
+| ----- | ---- | ----- | ----------- |
+| groups | [Group](#bytebase-v1-Group) | repeated | The groups from the specified request. |
-
-
-<a name="bytebase-v1-OrgPolicyService"></a>
-### OrgPolicyService
-OrgPolicyService manages organizational policies at various resource levels.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetPolicy | [GetPolicyRequest](#bytebase-v1-GetPolicyRequest) | [Policy](#bytebase-v1-Policy) | Retrieves a policy by name. Permissions required: bb.policies.get |
-| ListPolicies | [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest) | [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse) | Lists policies at a specified resource level. Permissions required: bb.policies.list |
-| CreatePolicy | [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Creates a new organizational policy. Permissions required: bb.policies.create |
-| UpdatePolicy | [UpdatePolicyRequest](#bytebase-v1-UpdatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Updates an existing organizational policy. Permissions required: bb.policies.update |
-| DeletePolicy | [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an organizational policy. Permissions required: bb.policies.delete |
+<a name="bytebase-v1-CreateGroupRequest"></a>
-
+### CreateGroupRequest
+Request message for creating a group.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| group | [Group](#bytebase-v1-Group) | | The group to create. |
+| group_email | [string](#string) | | The email to use for the group, which will become the final component of the group&#39;s resource name. |
-<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>
-### AICompletionRequest
+<a name="bytebase-v1-DeleteGroupRequest"></a>
+### DeleteGroupRequest
+Request message for deleting a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| messages | [AICompletionRequest.Message](#bytebase-v1-AICompletionRequest-Message) | repeated | |
-
+| name | [string](#string) | | The name of the group to delete. Format: groups/{email} |
-<a name="bytebase-v1-AICompletionRequest-Message"></a>
-### AICompletionRequest.Message
+<a name="bytebase-v1-GetGroupRequest"></a>
+### GetGroupRequest
+Request message for getting a group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [string](#string) | | |
-| content | [string](#string) | | |
-
+| name | [string](#string) | | The name of the group to retrieve. Format: groups/{email} |
-<a name="bytebase-v1-AICompletionResponse"></a>
-### AICompletionResponse
+<a name="bytebase-v1-Group"></a>
+### Group
+A group of users within the workspace.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| candidates | [AICompletionResponse.Candidate](#bytebase-v1-AICompletionResponse-Candidate) | repeated | candidates is used for results with multiple choices and candidates. Used for OpenAI and Gemini. |
-
+| name | [string](#string) | | The name of the 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-AICompletionResponse-Candidate"></a>
-### AICompletionResponse.Candidate
+<a name="bytebase-v1-GroupMember"></a>
+### GroupMember
+A member of a group with a role.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [AICompletionResponse.Candidate.Content](#bytebase-v1-AICompletionResponse-Candidate-Content) | | |
+| member | [string](#string) | | Member is the principal who belong to this group.
+Format: users/[email protected] |
+| role | [GroupMember.Role](#bytebase-v1-GroupMember-Role) | | The member&#39;s role in the group. |
-<a name="bytebase-v1-AICompletionResponse-Candidate-Content"></a>
-### AICompletionResponse.Candidate.Content
+<a name="bytebase-v1-ListGroupsRequest"></a>
+### ListGroupsRequest
+Request message for listing groups.
| 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. |
+| page_size | [int32](#int32) | | The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 10 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListGroups` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter groups returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filter: - title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator. - email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+For example: title == &#34;dba&#34; email == &#34;[email protected]&#34; title.matches(&#34;dba&#34;) email.matches(&#34;dba&#34;) project == &#34;projects/sample-project&#34; You can combine filter conditions like: title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) |
-<a name="bytebase-v1-AICompletionResponse-Candidate-Content-Part"></a>
-### AICompletionResponse.Candidate.Content.Part
+<a name="bytebase-v1-ListGroupsResponse"></a>
+
+### ListGroupsResponse
+Response message for listing groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| text | [string](#string) | | |
-
+| 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-AdminExecuteRequest"></a>
-### AdminExecuteRequest
+<a name="bytebase-v1-UpdateGroupRequest"></a>
+### UpdateGroupRequest
+Request message for updating a group.
| 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. |
-
+| group | [Group](#bytebase-v1-Group) | | The group to update.
+The group&#39;s `name` field is used to identify the group to update. Format: groups/{email} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the group is not found, a new group will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-AdminExecuteResponse"></a>
-### AdminExecuteResponse
+
+<a name="bytebase-v1-GroupMember-Role"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
+### 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-Advice"></a>
+<a name="bytebase-v1-GroupService"></a>
-### Advice
+### 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 |
-| ----- | ---- | ----- | ----------- |
-| 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_idp_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/idp_service.proto
-<a name="bytebase-v1-DiffMetadataRequest"></a>
+<a name="bytebase-v1-CreateIdentityProviderRequest"></a>
-### DiffMetadataRequest
+### CreateIdentityProviderRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| source_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the source schema. |
-| target_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the target schema. |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine of the schema. |
+| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to create. |
+| identity_provider_id | [string](#string) | | The ID to use for the identity provider, which will become the final component of the identity provider&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| validate_only | [bool](#bool) | | If set to true, the request will be validated without actually creating the identity provider. |
-<a name="bytebase-v1-DiffMetadataResponse"></a>
+<a name="bytebase-v1-DeleteIdentityProviderRequest"></a>
-### DiffMetadataResponse
+### DeleteIdentityProviderRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| diff | [string](#string) | | The diff of the metadata. |
-
+| name | [string](#string) | | The name of the identity provider to delete. Format: idps/{identity_provider} |
-<a name="bytebase-v1-ExportRequest"></a>
-### ExportRequest
+<a name="bytebase-v1-FieldMapping"></a>
+### 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 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. |
+| identifier | [string](#string) | | Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. |
+| display_name | [string](#string) | | DisplayName is the field name of display name in 3rd-party idp user info. Optional. |
+| phone | [string](#string) | | Phone is the field name of primary phone in 3rd-party idp user info. Optional. |
+| groups | [string](#string) | | Groups is the field name of groups in 3rd-party idp user info. Optional. Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/ |
-<a name="bytebase-v1-ExportResponse"></a>
+<a name="bytebase-v1-GetIdentityProviderRequest"></a>
-### ExportResponse
+### GetIdentityProviderRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| content | [bytes](#bytes) | | The export file content. |
+| name | [string](#string) | | The name of the identity provider to retrieve. Format: idps/{idp} |
-<a name="bytebase-v1-MaskingReason"></a>
+<a name="bytebase-v1-IdentityProvider"></a>
-### MaskingReason
+### IdentityProvider
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| semantic_type_id | [string](#string) | | The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). |
-| semantic_type_title | [string](#string) | | Human-readable semantic type title. |
-| masking_rule_id | [string](#string) | | The masking rule ID that matched (if applicable). |
-| algorithm | [string](#string) | | The masking algorithm used. |
-| context | [string](#string) | | Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). |
-| classification_level | [string](#string) | | Whether masking was due to classification level. |
-| semantic_type_icon | [string](#string) | | Icon associated with the semantic type (if any). |
+| name | [string](#string) | | The 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-QueryHistory"></a>
+<a name="bytebase-v1-IdentityProviderConfig"></a>
-### QueryHistory
+### IdentityProviderConfig
| 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) | | |
-
+| 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-QueryOption"></a>
-### QueryOption
+<a name="bytebase-v1-LDAPIdentityProviderConfig"></a>
+### LDAPIdentityProviderConfig
+LDAPIdentityProviderConfig is the structure for LDAP identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| redis_run_commands_on | [QueryOption.RedisRunCommandsOn](#bytebase-v1-QueryOption-RedisRunCommandsOn) | | |
-| mssql_explain_format | [QueryOption.MSSQLExplainFormat](#bytebase-v1-QueryOption-MSSQLExplainFormat) | | |
-
-
+| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., &#34;ldap.example.com&#34;. |
+| port | [int32](#int32) | | Port is the port number of the LDAP server, e.g., 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS. |
+| skip_tls_verify | [bool](#bool) | | SkipTLSVerify controls whether to skip TLS certificate verification. |
+| bind_dn | [string](#string) | | BindDN is the DN of the user to bind as a service account to perform search requests. |
+| bind_password | [string](#string) | | BindPassword is the password of the user to bind as a service account. |
+| base_dn | [string](#string) | | BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. |
+| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. |
+| security_protocol | [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol) | | SecurityProtocol is the security protocol to be used for establishing connections with the LDAP server. |
+| field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | FieldMapping is the mapping of the user attributes returned by the LDAP server. |
-<a name="bytebase-v1-QueryRequest"></a>
-### QueryRequest
+<a name="bytebase-v1-ListIdentityProvidersRequest"></a>
+### ListIdentityProvidersRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the instance name to execute the query against. Format: instances/{instance}/databases/{databaseName} |
-| statement | [string](#string) | | The SQL statement to execute. |
-| limit | [int32](#int32) | | The maximum number of rows to return. |
-| data_source_id | [string](#string) | | The id of data source. It is used for querying admin data source even if the instance has read-only data sources. Or it can be used to query a specific read-only data source. |
-| explain | [bool](#bool) | | Explain the statement. |
-| schema | [string](#string) | optional | The default schema to search objects. Equals to the current schema in Oracle and search path in Postgres. |
-| query_option | [QueryOption](#bytebase-v1-QueryOption) | | |
-| container | [string](#string) | optional | Container is the container name to execute the query against, used for CosmosDB only. |
-<a name="bytebase-v1-QueryResponse"></a>
+<a name="bytebase-v1-ListIdentityProvidersResponse"></a>
-### QueryResponse
+### ListIdentityProvidersResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
-
+| identity_providers | [IdentityProvider](#bytebase-v1-IdentityProvider) | repeated | The identity providers from the specified request. |
-<a name="bytebase-v1-QueryResult"></a>
-### QueryResult
+<a name="bytebase-v1-OAuth2IdentityProviderConfig"></a>
+### OAuth2IdentityProviderConfig
+OAuth2IdentityProviderConfig is the structure for OAuth2 identity provider config.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| column_names | [string](#string) | repeated | Column names of the query result. |
-| column_type_names | [string](#string) | repeated | Column types of the query result. The types come from the Golang SQL driver. |
-| rows | [QueryRow](#bytebase-v1-QueryRow) | repeated | Rows of the query result. |
-| rows_count | [int64](#int64) | | |
-| error | [string](#string) | | The error message if the query failed. |
-| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The time it takes to execute the query. |
-| statement | [string](#string) | | The query statement for the result. |
-| postgres_error | [QueryResult.PostgresError](#bytebase-v1-QueryResult-PostgresError) | | |
-| syntax_error | [QueryResult.SyntaxError](#bytebase-v1-QueryResult-SyntaxError) | | |
-| permission_denied | [QueryResult.PermissionDenied](#bytebase-v1-QueryResult-PermissionDenied) | | |
-| messages | [QueryResult.Message](#bytebase-v1-QueryResult-Message) | repeated | Informational or debug messages returned by the database engine during query execution. Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. |
-| masked | [MaskingReason](#bytebase-v1-MaskingReason) | repeated | Masking reasons for each column (empty for non-masked columns). |
+| 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-QueryResult-Message"></a>
+<a name="bytebase-v1-OAuth2IdentityProviderTestRequestContext"></a>
-### QueryResult.Message
+### OAuth2IdentityProviderTestRequestContext
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [QueryResult.Message.Level](#bytebase-v1-QueryResult-Message-Level) | | |
-| content | [string](#string) | | |
+| code | [string](#string) | | Authorize code from website. |
-<a name="bytebase-v1-QueryResult-PermissionDenied"></a>
+<a name="bytebase-v1-OIDCIdentityProviderConfig"></a>
-### QueryResult.PermissionDenied
-Permission denied with resource information or disallowed command_type.
-Either resources or command_type is available.
+### OIDCIdentityProviderConfig
+OIDCIdentityProviderConfig is the structure for OIDC identity provider config.
| 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. |
+| 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-QueryResult-PostgresError"></a>
+<a name="bytebase-v1-OIDCIdentityProviderTestRequestContext"></a>
+
+### OIDCIdentityProviderTestRequestContext
-### 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) | | |
+| code | [string](#string) | | Authorize code from OIDC provider. |
-<a name="bytebase-v1-QueryResult-SyntaxError"></a>
+<a name="bytebase-v1-TestIdentityProviderRequest"></a>
+
+### TestIdentityProviderRequest
-### 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 |
+| 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-QueryRow"></a>
+<a name="bytebase-v1-TestIdentityProviderResponse"></a>
-### QueryRow
+### TestIdentityProviderResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| values | [RowValue](#bytebase-v1-RowValue) | repeated | Row values of the query result. |
+| 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-RowValue"></a>
+<a name="bytebase-v1-TestIdentityProviderResponse-ClaimsEntry"></a>
-### RowValue
+### TestIdentityProviderResponse.ClaimsEntry
| 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. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-RowValue-Timestamp"></a>
+<a name="bytebase-v1-TestIdentityProviderResponse-UserInfoEntry"></a>
-### RowValue.Timestamp
+### TestIdentityProviderResponse.UserInfoEntry
| 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. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-RowValue-TimestampTZ"></a>
+<a name="bytebase-v1-UpdateIdentityProviderRequest"></a>
-### RowValue.TimestampTZ
+### UpdateIdentityProviderRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| zone | [string](#string) | | Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;, &#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We retrieve the time zone information from the timestamptz field in the database. A timestamp is in UTC or epoch time, and with zone info, we can convert it to a local time string. Zone and offset are returned by time.Time.Zone() |
-| offset | [int32](#int32) | | The offset is in seconds east of UTC |
-| accuracy | [int32](#int32) | | |
-
+| identity_provider | [IdentityProvider](#bytebase-v1-IdentityProvider) | | The identity provider to update.
+The identity provider&#39;s `name` field is used to identify the identity provider to update. Format: idps/{identity_provider} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the identity provider is not found, a new identity provider will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-SearchQueryHistoriesRequest"></a>
-### SearchQueryHistoriesRequest
+
+<a name="bytebase-v1-IdentityProviderType"></a>
-| 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
+### IdentityProviderType
-Supported filter: - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator. - statement: the SQL statement, support &#34;.matches()&#34; operator.
-For example: project == &#34;projects/{project}&#34; database == &#34;instances/{instance}/databases/{database}&#34; instance == &#34;instances/{instance}&#34; type == &#34;QUERY&#34; type == &#34;EXPORT&#34; statement.matches(&#34;select&#34;) type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) |
+| 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
-<a name="bytebase-v1-SearchQueryHistoriesResponse"></a>
+| 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. |
-### SearchQueryHistoriesResponse
+<a name="bytebase-v1-OAuth2AuthStyle"></a>
-| 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. |
+### OAuth2AuthStyle
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | |
+| IN_PARAMS | 1 | IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body as application/x-www-form-urlencoded parameters. |
+| IN_HEADER | 2 | IN_HEADER sends the client_id and client_password using HTTP Basic Authorization. This is an optional style described in the OAuth2 RFC 6749 section 2.3.1. |
+
-<a name="bytebase-v1-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. |
+<a name="bytebase-v1-IdentityProviderService"></a>
+### IdentityProviderService
+IdentityProviderService manages external identity providers for SSO authentication.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetIdentityProvider | [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Gets an identity provider by name. Permissions required: bb.identityProviders.get |
+| ListIdentityProviders | [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest) | [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse) | Lists all configured identity providers (public endpoint for login page). Permissions required: None |
+| CreateIdentityProvider | [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Creates a new identity provider. Permissions required: bb.identityProviders.create |
+| UpdateIdentityProvider | [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest) | [IdentityProvider](#bytebase-v1-IdentityProvider) | Updates an identity provider. Permissions required: bb.identityProviders.update When allow_missing=true, also requires: bb.identityProviders.create |
+| DeleteIdentityProvider | [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an identity provider. Permissions required: bb.identityProviders.delete |
+| TestIdentityProvider | [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest) | [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse) | Tests the connection and configuration of an identity provider. Permissions required: bb.identityProviders.update |
-<a name="bytebase-v1-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="v1_org_policy_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/org_policy_service.proto
-<a name="bytebase-v1-QueryHistory-Type"></a>
-### QueryHistory.Type
+<a name="bytebase-v1-CreatePolicyRequest"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified query history type. |
-| QUERY | 1 | Query execution for data retrieval. |
-| EXPORT | 2 | Data export operation to file. |
+### CreatePolicyRequest
-<a name="bytebase-v1-QueryOption-MSSQLExplainFormat"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource where this instance will be created. Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
+| policy | [Policy](#bytebase-v1-Policy) | | The policy to create. |
+| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy to create. |
-### 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-QueryOption-RedisRunCommandsOn"></a>
+<a name="bytebase-v1-DeletePolicyRequest"></a>
-### QueryOption.RedisRunCommandsOn
+### DeletePolicyRequest
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| REDIS_RUN_COMMANDS_ON_UNSPECIFIED | 0 | UNSPECIFIED defaults to SINGLE_NODE. |
-| SINGLE_NODE | 1 | Execute Redis commands on a single node in the cluster. |
-| ALL_NODES | 2 | Execute Redis commands on all nodes in the cluster for cluster-wide operations. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
-<a name="bytebase-v1-QueryResult-Message-Level"></a>
-### QueryResult.Message.Level
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| LEVEL_UNSPECIFIED | 0 | Unspecified message level. |
-| INFO | 1 | Informational message. |
-| WARNING | 2 | Warning message indicating potential issues. |
-| DEBUG | 3 | Debug message for development and troubleshooting. |
-| LOG | 4 | General log message. |
-| NOTICE | 5 | Notice message for important information. |
-| EXCEPTION | 6 | Exception message indicating error conditions. |
+<a name="bytebase-v1-GetPolicyRequest"></a>
+### GetPolicyRequest
-<a name="bytebase-v1-QueryResult-PermissionDenied-CommandType"></a>
-### QueryResult.PermissionDenied.CommandType
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the policy to retrieve. Format: {resource type}/{resource id}/policies/{policy type} |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| COMMAND_TYPE_UNSPECIFIED | 0 | |
-| DDL | 1 | |
-| DML | 2 | |
-| NON_READ_ONLY | 3 | |
-
-
-<a name="bytebase-v1-SQLService"></a>
+<a name="bytebase-v1-ListPoliciesRequest"></a>
-### SQLService
-SQLService executes SQL queries and manages query operations.
+### ListPoliciesRequest
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| Query | [QueryRequest](#bytebase-v1-QueryRequest) | [QueryResponse](#bytebase-v1-QueryResponse) | Executes a read-only SQL query against a database. Permissions required: bb.databases.get |
-| AdminExecute | [AdminExecuteRequest](#bytebase-v1-AdminExecuteRequest) stream | [AdminExecuteResponse](#bytebase-v1-AdminExecuteResponse) stream | Executes SQL with admin privileges via streaming connection. Permissions required: bb.sql.admin |
-| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller&#39;s own query histories) |
-| Export | [ExportRequest](#bytebase-v1-ExportRequest) | [ExportResponse](#bytebase-v1-ExportResponse) | Exports query results to a file format. Permissions required: bb.databases.get |
-| DiffMetadata | [DiffMetadataRequest](#bytebase-v1-DiffMetadataRequest) | [DiffMetadataResponse](#bytebase-v1-DiffMetadataResponse) | Computes schema differences between two database metadata. Permissions required: None |
-| AICompletion | [AICompletionRequest](#bytebase-v1-AICompletionRequest) | [AICompletionResponse](#bytebase-v1-AICompletionResponse) | Provides AI-powered SQL completion and generation. Permissions required: None (authenticated users only, requires AI to be enabled) |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| 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="v1_plan_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/plan_service.proto
-<a name="bytebase-v1-CancelPlanCheckRunRequest"></a>
+<a name="bytebase-v1-ListPoliciesResponse"></a>
-### CancelPlanCheckRunRequest
+### ListPoliciesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan check run to cancel. Format: projects/{project}/plans/{plan}/planCheckRun |
+| policies | [Policy](#bytebase-v1-Policy) | repeated | The policies from the specified request. |
-<a name="bytebase-v1-CancelPlanCheckRunResponse"></a>
+<a name="bytebase-v1-MaskingExemptionPolicy"></a>
+
+### MaskingExemptionPolicy
+MaskingExemptionPolicy is the allowlist of users who can access sensitive data.
-### CancelPlanCheckRunResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| exemptions | [MaskingExemptionPolicy.Exemption](#bytebase-v1-MaskingExemptionPolicy-Exemption) | repeated | |
-<a name="bytebase-v1-CreatePlanRequest"></a>
+<a name="bytebase-v1-MaskingExemptionPolicy-Exemption"></a>
-### CreatePlanRequest
+### MaskingExemptionPolicy.Exemption
| 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. |
+| members | [string](#string) | repeated | Specifies the principals who are exempt from masking. For users, the member should be: user:{email} For groups, the member should be: group:{email} |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this exception policy instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec If the condition is empty, means the user can access all databases without expiration.
+Support variables: resource.instance_id: the instance resource id. Only support &#34;==&#34; operation. resource.database_name: the database name. Only support &#34;==&#34; operation. resource.schema_name: the schema name. Only support &#34;==&#34; operation. resource.table_name: the table name. Only support &#34;==&#34; operation. resource.column_name: the column name. Only support &#34;==&#34; operation. request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)` All variables should join with &#34;&amp;&amp;&#34; condition.
+For example: resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;) resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; |
-<a name="bytebase-v1-GetPlanCheckRunRequest"></a>
-### GetPlanCheckRunRequest
+<a name="bytebase-v1-MaskingRulePolicy"></a>
+
+### MaskingRulePolicy
+Policy for configuring data masking rules.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan check run to retrieve. Format: projects/{project}/plans/{plan}/planCheckRun |
-
+| rules | [MaskingRulePolicy.MaskingRule](#bytebase-v1-MaskingRulePolicy-MaskingRule) | repeated | The list of masking rules. |
-<a name="bytebase-v1-GetPlanRequest"></a>
-### GetPlanRequest
+<a name="bytebase-v1-MaskingRulePolicy-MaskingRule"></a>
+### MaskingRulePolicy.MaskingRule
+A rule that defines when and how to mask data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan to retrieve. Format: projects/{project}/plans/{plan} |
-
+| id | [string](#string) | | A unique identifier for the rule in UUID format. |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition for the masking rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Support variables: resource.environment_id: the environment resource id. resource.project_id: the project resource id. resource.instance_id: the instance resource id. resource.database_name: the database name. resource.table_name: the table name. resource.column_name: the column name. resource.classification_level: the classification level.
+Each variable support following operations: ==: the value equals the target. !=: the value not equals the target. in: the value matches one of the targets. !(in): the value not matches any of the targets.
+For example: resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34; resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;] resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;]) resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) |
+| semantic_type | [string](#string) | | The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). |
-<a name="bytebase-v1-ListPlansRequest"></a>
-### ListPlansRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use &#34;projects/-&#34; to list all plans from all projects. |
-| page_size | [int32](#int32) | | The maximum number of plans to return. The service may return fewer than this value. If unspecified, at most 10 plans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListPlans` call. Provide this to retrieve the subsequent page.
+<a name="bytebase-v1-Policy"></a>
-When paginating, all other parameters provided to `ListPlans` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter plans returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+### Policy
-Supported filters: - creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match. - spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;. - state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
-For example: creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; has_rollout == false &amp;&amp; has_issue == true title == &#34;My Plan&#34; title.matches(&#34;database migration&#34;) spec_type == &#34;change_database_config&#34; state == &#34;ACTIVE&#34; |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the policy. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
+| inherit_from_parent | [bool](#bool) | | Whether this policy inherits from its parent resource. |
+| type | [PolicyType](#bytebase-v1-PolicyType) | | The type of policy. |
+| rollout_policy | [RolloutPolicy](#bytebase-v1-RolloutPolicy) | | |
+| masking_rule_policy | [MaskingRulePolicy](#bytebase-v1-MaskingRulePolicy) | | |
+| masking_exemption_policy | [MaskingExemptionPolicy](#bytebase-v1-MaskingExemptionPolicy) | | |
+| tag_policy | [TagPolicy](#bytebase-v1-TagPolicy) | | |
+| 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-ListPlansResponse"></a>
-### ListPlansResponse
+<a name="bytebase-v1-QueryDataPolicy"></a>
+### QueryDataPolicy
+QueryDataPolicy is the policy configuration for querying data.
| 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. |
-
+| timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The query timeout duration. |
+| disable_export | [bool](#bool) | | Disable data export in the SQL editor. |
+| maximum_result_size | [int64](#int64) | | The maximum result size limit in bytes. The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. |
+| maximum_result_rows | [int32](#int32) | | The maximum number of rows to return. The default value is -1, means no limit. |
+| disable_copy_data | [bool](#bool) | | Disable copying query results. |
+| admin_data_source_restriction | [QueryDataPolicy.Restriction](#bytebase-v1-QueryDataPolicy-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-Plan"></a>
-### Plan
+<a name="bytebase-v1-RolloutPolicy"></a>
+### RolloutPolicy
+Rollout policy configuration.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the plan. `plan` is a system generated ID. Format: projects/{project}/plans/{plan} |
-| state | [State](#bytebase-v1-State) | | The state of the plan. |
-| issue | [string](#string) | | The issue associated with the plan. Can be empty. Format: projects/{project}/issues/{issue} |
-| title | [string](#string) | | The title of the plan. |
-| description | [string](#string) | | The description of the plan. |
-| specs | [Plan.Spec](#bytebase-v1-Plan-Spec) | repeated | The deployment specs for the plan. |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| plan_check_run_status_count | [Plan.PlanCheckRunStatusCountEntry](#bytebase-v1-Plan-PlanCheckRunStatusCountEntry) | repeated | The status count of the latest plan check runs. Keys are: - SUCCESS - WARNING - ERROR - RUNNING |
-| has_rollout | [bool](#bool) | | Whether the plan has started the rollout. |
-
+| automatic | [bool](#bool) | | Whether rollout is automatic without manual approval. |
+| roles | [string](#string) | repeated | The roles that can approve rollout execution. |
-<a name="bytebase-v1-Plan-ChangeDatabaseConfig"></a>
-### Plan.ChangeDatabaseConfig
+<a name="bytebase-v1-TagPolicy"></a>
+### TagPolicy
+Policy for tagging resources with metadata.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. |
-| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
-| release | [string](#string) | | The resource name of the release. Format: projects/{project}/releases/{release} |
-| ghost_flags | [Plan.ChangeDatabaseConfig.GhostFlagsEntry](#bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry) | repeated | |
-| enable_prior_backup | [bool](#bool) | | If set, a backup of the modified data will be created automatically before any changes are applied. |
-| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
+| tags | [TagPolicy.TagsEntry](#bytebase-v1-TagPolicy-TagsEntry) | repeated | tags is the key - value map for resources. for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; |
-<a name="bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry"></a>
+<a name="bytebase-v1-TagPolicy-TagsEntry"></a>
-### Plan.ChangeDatabaseConfig.GhostFlagsEntry
+### TagPolicy.TagsEntry
@@ -6807,672 +6661,724 @@ For example: creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &
-<a name="bytebase-v1-Plan-CreateDatabaseConfig"></a>
+<a name="bytebase-v1-UpdatePolicyRequest"></a>
-### Plan.CreateDatabaseConfig
+### UpdatePolicyRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| target | [string](#string) | | The resource name of the instance on which the database is created. Format: instances/{instance} |
-| database | [string](#string) | | The name of the database to create. |
-| table | [string](#string) | | table is the name of the table, if it is not empty, Bytebase should create a table after creating the database. For example, in MongoDB, it only creates the database when we first store data in that database. |
-| character_set | [string](#string) | | character_set is the character set of the database. |
-| collation | [string](#string) | | collation is the collation of the database. |
-| cluster | [string](#string) | | cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. |
-| owner | [string](#string) | | owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. |
-| environment | [string](#string) | | The environment resource. Format: environments/prod where prod is the environment resource ID. |
+| policy | [Policy](#bytebase-v1-Policy) | | The policy to update.
+The policy&#39;s `name` field is used to identify the instance to update. Format: {resource name}/policies/{policy type} Workspace resource name: &#34;&#34;. Environment resource name: environments/environment-id. Instance resource name: instances/instance-id. Database resource name: instances/instance-id/databases/database-name. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the policy is not found, a new policy will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-Plan-ExportDataConfig"></a>
-
-### Plan.ExportDataConfig
+
+<a name="bytebase-v1-PolicyResourceType"></a>
-| 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. |
+### PolicyResourceType
+The resource type that a policy can be attached to.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| RESOURCE_TYPE_UNSPECIFIED | 0 | Unspecified resource type. |
+| WORKSPACE | 1 | Workspace-level policy. |
+| ENVIRONMENT | 2 | Environment-level policy. |
+| PROJECT | 3 | Project-level policy. |
+<a name="bytebase-v1-PolicyType"></a>
+### PolicyType
+The type of organizational policy.
-<a name="bytebase-v1-Plan-PlanCheckRunStatusCountEntry"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| POLICY_TYPE_UNSPECIFIED | 0 | Unspecified policy type. |
+| MASKING_RULE | 1 | Data masking rule policy. |
+| MASKING_EXEMPTION | 2 | Data masking exemption policy. |
+| ROLLOUT_POLICY | 3 | Rollout deployment policy. |
+| TAG | 4 | Resource tag policy. |
+| DATA_QUERY | 6 | Query data access policy. |
-### Plan.PlanCheckRunStatusCountEntry
+<a name="bytebase-v1-QueryDataPolicy-Restriction"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [int32](#int32) | | |
+### QueryDataPolicy.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-Plan-Spec"></a>
+<a name="bytebase-v1-OrgPolicyService"></a>
-### Plan.Spec
+### OrgPolicyService
+OrgPolicyService manages organizational policies at various resource levels.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetPolicy | [GetPolicyRequest](#bytebase-v1-GetPolicyRequest) | [Policy](#bytebase-v1-Policy) | Retrieves a policy by name. Permissions required: bb.policies.get |
+| ListPolicies | [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest) | [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse) | Lists policies at a specified resource level. Permissions required: bb.policies.list |
+| CreatePolicy | [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Creates a new organizational policy. Permissions required: bb.policies.create |
+| UpdatePolicy | [UpdatePolicyRequest](#bytebase-v1-UpdatePolicyRequest) | [Policy](#bytebase-v1-Policy) | Updates an existing organizational policy. Permissions required: bb.policies.update |
+| DeletePolicy | [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes an organizational policy. Permissions required: bb.policies.delete |
+
-| 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) | | |
+<a name="v1_sql_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/sql_service.proto
-<a name="bytebase-v1-PlanCheckRun"></a>
+<a name="bytebase-v1-AICompletionRequest"></a>
-### PlanCheckRun
+### AICompletionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/planCheckRun |
-| status | [PlanCheckRun.Status](#bytebase-v1-PlanCheckRun-Status) | | |
-| results | [PlanCheckRun.Result](#bytebase-v1-PlanCheckRun-Result) | repeated | |
-| error | [string](#string) | | error is set if the Status is FAILED. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| messages | [AICompletionRequest.Message](#bytebase-v1-AICompletionRequest-Message) | repeated | |
-<a name="bytebase-v1-PlanCheckRun-Result"></a>
+<a name="bytebase-v1-AICompletionRequest-Message"></a>
-### PlanCheckRun.Result
+### AICompletionRequest.Message
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [Advice.Level](#bytebase-v1-Advice-Level) | | |
-| title | [string](#string) | | |
+| role | [string](#string) | | |
| content | [string](#string) | | |
-| code | [int32](#int32) | | |
-| target | [string](#string) | | Target identification for consolidated results. Format: instances/{instance}/databases/{database} |
-| type | [PlanCheckRun.Result.Type](#bytebase-v1-PlanCheckRun-Result-Type) | | |
-| sql_summary_report | [PlanCheckRun.Result.SqlSummaryReport](#bytebase-v1-PlanCheckRun-Result-SqlSummaryReport) | | |
-| sql_review_report | [PlanCheckRun.Result.SqlReviewReport](#bytebase-v1-PlanCheckRun-Result-SqlReviewReport) | | |
-<a name="bytebase-v1-PlanCheckRun-Result-SqlReviewReport"></a>
+<a name="bytebase-v1-AICompletionResponse"></a>
-### PlanCheckRun.Result.SqlReviewReport
+### AICompletionResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_position | [Position](#bytebase-v1-Position) | | Position of the SQL statement. |
-| end_position | [Position](#bytebase-v1-Position) | | |
+| 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-PlanCheckRun-Result-SqlSummaryReport"></a>
+<a name="bytebase-v1-AICompletionResponse-Candidate"></a>
-### PlanCheckRun.Result.SqlSummaryReport
+### AICompletionResponse.Candidate
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| statement_types | [StatementType](#bytebase-v1-StatementType) | repeated | statement_types are the types of statements that are found in the sql. |
-| affected_rows | [int64](#int64) | | |
+| content | [AICompletionResponse.Candidate.Content](#bytebase-v1-AICompletionResponse-Candidate-Content) | | |
-<a name="bytebase-v1-RunPlanChecksRequest"></a>
+<a name="bytebase-v1-AICompletionResponse-Candidate-Content"></a>
-### RunPlanChecksRequest
+### AICompletionResponse.Candidate.Content
| 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. |
-
+| 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-RunPlanChecksResponse"></a>
-### RunPlanChecksResponse
+<a name="bytebase-v1-AICompletionResponse-Candidate-Content-Part"></a>
+### AICompletionResponse.Candidate.Content.Part
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| text | [string](#string) | | |
-<a name="bytebase-v1-UpdatePlanRequest"></a>
-### UpdatePlanRequest
+<a name="bytebase-v1-AdminExecuteRequest"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| plan | [Plan](#bytebase-v1-Plan) | | The plan to update.
+### AdminExecuteRequest
-The plan&#39;s `name` field is used to identify the plan to update. Format: projects/{project}/plans/{plan} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the plan is not found, a new plan will be created. In this situation, `update_mask` is ignored. |
+| 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. |
-
-<a name="bytebase-v1-PlanCheckRun-Result-Type"></a>
-### PlanCheckRun.Result.Type
+<a name="bytebase-v1-AdminExecuteResponse"></a>
+### AdminExecuteResponse
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| STATEMENT_ADVISE | 1 | |
-| STATEMENT_SUMMARY_REPORT | 2 | |
-| GHOST_SYNC | 3 | |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
-<a name="bytebase-v1-PlanCheckRun-Status"></a>
-### PlanCheckRun.Status
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | |
-| RUNNING | 1 | |
-| DONE | 2 | |
-| FAILED | 3 | |
-| CANCELED | 4 | |
-
+<a name="bytebase-v1-Advice"></a>
-
+### Advice
-<a name="bytebase-v1-PlanService"></a>
-### PlanService
-PlanService manages deployment plans for database changes.
+| 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. |
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetPlan | [GetPlanRequest](#bytebase-v1-GetPlanRequest) | [Plan](#bytebase-v1-Plan) | Retrieves a deployment plan by name. Permissions required: bb.plans.get |
-| ListPlans | [ListPlansRequest](#bytebase-v1-ListPlansRequest) | [ListPlansResponse](#bytebase-v1-ListPlansResponse) | Lists deployment plans in a project. Permissions required: bb.plans.list |
-| CreatePlan | [CreatePlanRequest](#bytebase-v1-CreatePlanRequest) | [Plan](#bytebase-v1-Plan) | Creates a new deployment plan. Permissions required: bb.plans.create |
-| UpdatePlan | [UpdatePlanRequest](#bytebase-v1-UpdatePlanRequest) | [Plan](#bytebase-v1-Plan) | UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update (or creator) |
-| GetPlanCheckRun | [GetPlanCheckRunRequest](#bytebase-v1-GetPlanCheckRunRequest) | [PlanCheckRun](#bytebase-v1-PlanCheckRun) | Gets the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.get |
-| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |
-| CancelPlanCheckRun | [CancelPlanCheckRunRequest](#bytebase-v1-CancelPlanCheckRunRequest) | [CancelPlanCheckRunResponse](#bytebase-v1-CancelPlanCheckRunResponse) | Cancels the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.run |
-
-<a name="v1_project_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/project_service.proto
+<a name="bytebase-v1-DiffMetadataRequest"></a>
+### DiffMetadataRequest
-<a name="bytebase-v1-Activity"></a>
-### Activity
-Activity types for webhook notifications.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| source_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the source schema. |
+| target_metadata | [DatabaseMetadata](#bytebase-v1-DatabaseMetadata) | | The metadata of the target schema. |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine of the schema. |
-<a name="bytebase-v1-AddWebhookRequest"></a>
+<a name="bytebase-v1-DiffMetadataResponse"></a>
-### AddWebhookRequest
+### DiffMetadataResponse
| 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. |
+| diff | [string](#string) | | The diff of the metadata. |
-<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>
+<a name="bytebase-v1-ExportRequest"></a>
-### BatchDeleteProjectsRequest
+### ExportRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The names of the projects to delete. Format: projects/{project} |
-| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted projects and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted projects. All projects must already be soft-deleted for this to work. When purge=true, all databases will be moved to the default project before deletion. When purge=false (soft delete/archive), the projects and their databases/issues remain unchanged. |
+| 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-BatchGetProjectsRequest"></a>
+<a name="bytebase-v1-ExportResponse"></a>
-### BatchGetProjectsRequest
+### ExportResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The names of projects to retrieve. Format: projects/{project} |
+| content | [bytes](#bytes) | | The export file content. |
-<a name="bytebase-v1-BatchGetProjectsResponse"></a>
+<a name="bytebase-v1-MaskingReason"></a>
-### BatchGetProjectsResponse
+### MaskingReason
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
+| semantic_type_id | [string](#string) | | The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). |
+| semantic_type_title | [string](#string) | | Human-readable semantic type title. |
+| masking_rule_id | [string](#string) | | The masking rule ID that matched (if applicable). |
+| algorithm | [string](#string) | | The masking algorithm used. |
+| context | [string](#string) | | Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). |
+| classification_level | [string](#string) | | Whether masking was due to classification level. |
+| semantic_type_icon | [string](#string) | | Icon associated with the semantic type (if any). |
-<a name="bytebase-v1-CreateProjectRequest"></a>
+<a name="bytebase-v1-QueryHistory"></a>
-### CreateProjectRequest
+### QueryHistory
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| project | [Project](#bytebase-v1-Project) | | The project to create. |
-| project_id | [string](#string) | | The ID to use for the project, which will become the final component of the project&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
+| name | [string](#string) | | The name 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-DeleteProjectRequest"></a>
+<a name="bytebase-v1-QueryOption"></a>
-### DeleteProjectRequest
+### QueryOption
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project to delete. Format: projects/{project} |
-| 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. When purge=true, all databases will be moved to the default project before deletion. When purge=false (soft delete/archive), the project and its databases/issues remain unchanged. |
+| redis_run_commands_on | [QueryOption.RedisRunCommandsOn](#bytebase-v1-QueryOption-RedisRunCommandsOn) | | |
+| mssql_explain_format | [QueryOption.MSSQLExplainFormat](#bytebase-v1-QueryOption-MSSQLExplainFormat) | | |
-<a name="bytebase-v1-GetProjectRequest"></a>
+<a name="bytebase-v1-QueryRequest"></a>
-### GetProjectRequest
+### QueryRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |
+| 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-Label"></a>
+<a name="bytebase-v1-QueryResponse"></a>
+
+### QueryResponse
-### 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. |
+| results | [QueryResult](#bytebase-v1-QueryResult) | repeated | The query results. |
-<a name="bytebase-v1-ListProjectsRequest"></a>
+<a name="bytebase-v1-QueryResult"></a>
-### ListProjectsRequest
+### QueryResult
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListProjects` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListProjects` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
-| filter | [string](#string) | | Filter the project. Check filter for SearchProjectsRequest for details. Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). |
-| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
+| column_names | [string](#string) | repeated | Column names of the query result. |
+| column_type_names | [string](#string) | repeated | Column types of the query result. The types come from the Golang SQL driver. |
+| rows | [QueryRow](#bytebase-v1-QueryRow) | repeated | Rows of the query result. |
+| rows_count | [int64](#int64) | | |
+| error | [string](#string) | | The error message if the query failed. |
+| latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The time it takes to execute the query. |
+| statement | [string](#string) | | The query statement for the result. |
+| postgres_error | [QueryResult.PostgresError](#bytebase-v1-QueryResult-PostgresError) | | |
+| syntax_error | [QueryResult.SyntaxError](#bytebase-v1-QueryResult-SyntaxError) | | |
+| permission_denied | [QueryResult.PermissionDenied](#bytebase-v1-QueryResult-PermissionDenied) | | |
+| messages | [QueryResult.Message](#bytebase-v1-QueryResult-Message) | repeated | Informational or debug messages returned by the database engine during query execution. Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. |
+| masked | [MaskingReason](#bytebase-v1-MaskingReason) | repeated | Masking reasons for each column (empty for non-masked columns). |
-<a name="bytebase-v1-ListProjectsResponse"></a>
+<a name="bytebase-v1-QueryResult-Message"></a>
-### ListProjectsResponse
+### QueryResult.Message
| 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. |
-
+| level | [QueryResult.Message.Level](#bytebase-v1-QueryResult-Message-Level) | | |
+| content | [string](#string) | | |
-<a name="bytebase-v1-Project"></a>
-### Project
+<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 |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project. Format: projects/{project} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the project. |
-| title | [string](#string) | | The title or name of a project. It&#39;s not unique within the workspace. |
-| webhooks | [Webhook](#bytebase-v1-Webhook) | repeated | The list of webhooks configured for the project. |
-| data_classification_config_id | [string](#string) | | The data classification configuration ID for the project. |
-| issue_labels | [Label](#bytebase-v1-Label) | repeated | Labels available for tagging issues in this project. |
-| force_issue_labels | [bool](#bool) | | Force issue labels to be used when creating an issue. |
-| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |
-| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |
-| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |
-| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. |
-| allow_self_approval | [bool](#bool) | | Whether to allow issue creators to self-approve their own issues. |
-| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy) | | Execution retry policy for task runs. |
-| ci_sampling_size | [int32](#int32) | | The maximum number of database rows to sample during CI data validation. Without specification, sampling is disabled, resulting in full validation. |
-| parallel_tasks_per_rollout | [int32](#int32) | | The maximum number of parallel tasks allowed during rollout execution. |
-| labels | [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the project. For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } |
-| enforce_sql_review | [bool](#bool) | | Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors. |
-| require_issue_approval | [bool](#bool) | | Whether to require issue approval before rollout. |
-| require_plan_check_no_error | [bool](#bool) | | Whether to require plan check to have no error before rollout. |
-| allow_request_role | [bool](#bool) | | |
+| 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-Project-ExecutionRetryPolicy"></a>
+<a name="bytebase-v1-QueryResult-PostgresError"></a>
-### Project.ExecutionRetryPolicy
-Execution retry policy configuration.
+### QueryResult.PostgresError
+refer https://www.postgresql.org/docs/11/protocol-error-fields.html
+for field description.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |
-
+| 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-Project-LabelsEntry"></a>
-### Project.LabelsEntry
+<a name="bytebase-v1-QueryResult-SyntaxError"></a>
+### QueryResult.SyntaxError
+Syntax error with position information for editor highlighting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| start_position | [Position](#bytebase-v1-Position) | | Position information for highlighting in editor |
-<a name="bytebase-v1-RemoveWebhookRequest"></a>
+<a name="bytebase-v1-QueryRow"></a>
-### RemoveWebhookRequest
+### QueryRow
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |
+| values | [RowValue](#bytebase-v1-RowValue) | repeated | Row values of the query result. |
-<a name="bytebase-v1-SearchProjectsRequest"></a>
+<a name="bytebase-v1-RowValue"></a>
-### SearchProjectsRequest
+### RowValue
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
-| filter | [string](#string) | | Filter the project. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator. - exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator. - state: check the State enum for the values, support &#34;==&#34; operator. - labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example: name == &#34;project name&#34; name.matches(&#34;project name&#34;) resource_id == &#34;project id&#34; resource_id.matches(&#34;project id&#34;) exclude_default == true state == &#34;DELETED&#34; labels.environment == &#34;production&#34; labels.tier == &#34;critical&#34; labels.environment in [&#34;staging&#34;, &#34;prod&#34;] You can combine filter conditions like: name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;) name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34; labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; |
-| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchProjects` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchProjects` must match the call that provided the page token. |
-| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
+| null_value | [google.protobuf.NullValue](#google-protobuf-NullValue) | | |
+| bool_value | [bool](#bool) | | |
+| bytes_value | [bytes](#bytes) | | |
+| double_value | [double](#double) | | |
+| float_value | [float](#float) | | |
+| int32_value | [int32](#int32) | | |
+| int64_value | [int64](#int64) | | |
+| string_value | [string](#string) | | |
+| uint32_value | [uint32](#uint32) | | |
+| uint64_value | [uint64](#uint64) | | |
+| value_value | [google.protobuf.Value](#google-protobuf-Value) | | value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. |
+| timestamp_value | [RowValue.Timestamp](#bytebase-v1-RowValue-Timestamp) | | timestamp_value is used for the timestamp without time zone data type, meaning it only includes the timestamp without any time zone or location info. Although it may be expressed as a UTC value, it should be seen as a timestamp missing location context. |
+| timestamp_tz_value | [RowValue.TimestampTZ](#bytebase-v1-RowValue-TimestampTZ) | | timestamp_tz_value is used for the timestamptz data type, which accurately represents the timestamp with location information. |
-<a name="bytebase-v1-SearchProjectsResponse"></a>
+<a name="bytebase-v1-RowValue-Timestamp"></a>
-### SearchProjectsResponse
+### RowValue.Timestamp
| 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. |
+| 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-TestWebhookRequest"></a>
+<a name="bytebase-v1-RowValue-TimestampTZ"></a>
-### TestWebhookRequest
+### RowValue.TimestampTZ
| 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. |
+| google_timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| zone | [string](#string) | | Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;, &#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We retrieve the time zone information from the timestamptz field in the database. A timestamp is in UTC or epoch time, and with zone info, we can convert it to a local time string. Zone and offset are returned by time.Time.Zone() |
+| offset | [int32](#int32) | | The offset is in seconds east of UTC |
+| accuracy | [int32](#int32) | | |
-<a name="bytebase-v1-TestWebhookResponse"></a>
+<a name="bytebase-v1-SearchQueryHistoriesRequest"></a>
-### TestWebhookResponse
+### SearchQueryHistoriesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| error | [string](#string) | | The result of the test, empty if the test is successful. |
+| page_size | [int32](#int32) | | The maximum number of histories to return. The service may return fewer than this value. If unspecified, at most 10 history entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListQueryHistory` call. Provide this to retrieve the subsequent page. |
+| filter | [string](#string) | | Filter is the filter to apply on the search query history The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator. - statement: the SQL statement, support &#34;.matches()&#34; operator.
+For example: project == &#34;projects/{project}&#34; database == &#34;instances/{instance}/databases/{database}&#34; instance == &#34;instances/{instance}&#34; type == &#34;QUERY&#34; type == &#34;EXPORT&#34; statement.matches(&#34;select&#34;) type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) |
-<a name="bytebase-v1-UndeleteProjectRequest"></a>
-### UndeleteProjectRequest
+<a name="bytebase-v1-SearchQueryHistoriesResponse"></a>
+
+### SearchQueryHistoriesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |
+| 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-UpdateProjectRequest"></a>
-### UpdateProjectRequest
+<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 |
-| ----- | ---- | ----- | ----------- |
-| project | [Project](#bytebase-v1-Project) | | The project to update.
-The project&#39;s `name` field is used to identify the project to update. Format: projects/{project} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the project is not found, a new project will be created. In this situation, `update_mask` is ignored. |
+<a name="bytebase-v1-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-UpdateWebhookRequest"></a>
+<a name="bytebase-v1-QueryHistory-Type"></a>
-### UpdateWebhookRequest
+### 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. |
-| 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. |
+<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-Webhook"></a>
-### Webhook
+<a name="bytebase-v1-QueryOption-RedisRunCommandsOn"></a>
+### QueryOption.RedisRunCommandsOn
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook} |
-| type | [WebhookType](#bytebase-v1-WebhookType) | | Webhook integration type. type is the type of the webhook. |
-| title | [string](#string) | | title is the title of the webhook. |
-| url | [string](#string) | | url is the url of the webhook, should be unique within the project. |
-| direct_message | [bool](#bool) | | if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work. |
-| notification_types | [Activity.Type](#bytebase-v1-Activity-Type) | repeated | notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following: - ISSUE_CREATED - ISSUE_APPROVAL_REQUESTED - ISSUE_SENT_BACK - PIPELINE_FAILED - PIPELINE_COMPLETED |
+| 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-Activity-Type"></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. |
+
+
+
+<a name="bytebase-v1-QueryResult-PermissionDenied-CommandType"></a>
+
+### QueryResult.PermissionDenied.CommandType
-### Activity.Type
-Activity type enumeration.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| ISSUE_CREATED | 10 | ISSUE_CREATED represents a new issue creation event. |
-| ISSUE_APPROVAL_REQUESTED | 11 | ISSUE_APPROVAL_REQUESTED represents an approval request event. |
-| ISSUE_SENT_BACK | 12 | ISSUE_SENT_BACK represents an issue being sent back by an approver. |
-| PIPELINE_FAILED | 13 | PIPELINE_FAILED represents a pipeline failure event. |
-| PIPELINE_COMPLETED | 14 | PIPELINE_COMPLETED represents a pipeline completion event. |
+| COMMAND_TYPE_UNSPECIFIED | 0 | |
+| DDL | 1 | |
+| DML | 2 | |
+| NON_READ_ONLY | 3 | |
@@ -7480,1018 +7386,1167 @@ Activity type enumeration.
-<a name="bytebase-v1-ProjectService"></a>
+<a name="bytebase-v1-SQLService"></a>
-### ProjectService
-ProjectService manages projects that group databases and changes.
+### SQLService
+SQLService executes SQL queries and manages query operations.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method. Permissions required: bb.projects.get |
-| BatchGetProjects | [BatchGetProjectsRequest](#bytebase-v1-BatchGetProjectsRequest) | [BatchGetProjectsResponse](#bytebase-v1-BatchGetProjectsResponse) | BatchGetProjects retrieves multiple projects by their names. Permissions required: bb.projects.get |
-| ListProjects | [ListProjectsRequest](#bytebase-v1-ListProjectsRequest) | [ListProjectsResponse](#bytebase-v1-ListProjectsResponse) | Lists all projects in the workspace with optional filtering. Permissions required: bb.projects.list |
-| SearchProjects | [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest) | [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse) | Searches for projects with advanced filtering capabilities. Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects) |
-| CreateProject | [CreateProjectRequest](#bytebase-v1-CreateProjectRequest) | [Project](#bytebase-v1-Project) | Creates a new project in the workspace. Permissions required: bb.projects.create |
-| UpdateProject | [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest) | [Project](#bytebase-v1-Project) | Updates an existing project&#39;s properties. Permissions required: bb.projects.update |
-| DeleteProject | [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes (soft-delete or purge) a project. Permissions required: bb.projects.delete |
-| UndeleteProject | [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest) | [Project](#bytebase-v1-Project) | Restores a soft-deleted project. Permissions required: bb.projects.undelete |
-| BatchDeleteProjects | [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes multiple projects in a single operation. Permissions required: bb.projects.delete |
-| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Retrieves the IAM policy for a project. Permissions required: bb.projects.getIamPolicy |
-| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |
-| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |
-| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |
-| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |
-| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |
+| Query | [QueryRequest](#bytebase-v1-QueryRequest) | [QueryResponse](#bytebase-v1-QueryResponse) | Executes a read-only SQL query against a database. Permissions required: bb.databases.get |
+| AdminExecute | [AdminExecuteRequest](#bytebase-v1-AdminExecuteRequest) stream | [AdminExecuteResponse](#bytebase-v1-AdminExecuteResponse) stream | Executes SQL with admin privileges via streaming connection. Permissions required: bb.sql.admin |
+| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller&#39;s own query histories) |
+| Export | [ExportRequest](#bytebase-v1-ExportRequest) | [ExportResponse](#bytebase-v1-ExportResponse) | Exports query results to a file format. Permissions required: bb.databases.get |
+| DiffMetadata | [DiffMetadataRequest](#bytebase-v1-DiffMetadataRequest) | [DiffMetadataResponse](#bytebase-v1-DiffMetadataResponse) | Computes schema differences between two database metadata. Permissions required: None |
+| AICompletion | [AICompletionRequest](#bytebase-v1-AICompletionRequest) | [AICompletionResponse](#bytebase-v1-AICompletionResponse) | Provides AI-powered SQL completion and generation. Permissions required: None (authenticated users only, requires AI to be enabled) |
-<a name="v1_release_service-proto"></a>
+<a name="v1_plan_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/release_service.proto
+## v1/plan_service.proto
-<a name="bytebase-v1-CheckReleaseRequest"></a>
+<a name="bytebase-v1-CancelPlanCheckRunRequest"></a>
-### CheckReleaseRequest
+### CancelPlanCheckRunRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
-| release | [Release](#bytebase-v1-Release) | | The release to check. |
-| targets | [string](#string) | repeated | The targets to dry-run the release. Can be database or databaseGroup. Format: projects/{project}/databaseGroups/{databaseGroup} instances/{instance}/databases/{database} |
-| custom_rules | [string](#string) | | Custom linting rules in natural language for AI-powered validation. Each rule should be a clear statement describing the desired schema constraint. Example: &#34;All tables must have a primary key&#34; Example: &#34;VARCHAR columns should specify a maximum length&#34; |
-
+| name | [string](#string) | | The name of the plan check run to cancel. Format: projects/{project}/plans/{plan}/planCheckRun |
-<a name="bytebase-v1-CheckReleaseResponse"></a>
-### CheckReleaseResponse
+<a name="bytebase-v1-CancelPlanCheckRunResponse"></a>
+### CancelPlanCheckRunResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| results | [CheckReleaseResponse.CheckResult](#bytebase-v1-CheckReleaseResponse-CheckResult) | repeated | The check results for each file and target combination. |
-| affected_rows | [int64](#int64) | | The total affected rows across all checks. |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The aggregated risk level of the check. |
+<a name="bytebase-v1-CreatePlanRequest"></a>
-<a name="bytebase-v1-CheckReleaseResponse-CheckResult"></a>
+### CreatePlanRequest
-### CheckReleaseResponse.CheckResult
-Check result for a single release file on a target database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| file | [string](#string) | | The file path that is being checked. |
-| target | [string](#string) | | The target that the check is performed on. Should be a database. Format: instances/{instance}/databases/{database} |
-| advices | [Advice](#bytebase-v1-Advice) | repeated | The list of advice for the file and the target. |
-| affected_rows | [int64](#int64) | | The count of affected rows of the statement on the target. |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the statement on the target. |
+| parent | [string](#string) | | The parent project where this plan will be created. Format: projects/{project} |
+| plan | [Plan](#bytebase-v1-Plan) | | The plan to create. |
-<a name="bytebase-v1-CreateReleaseRequest"></a>
+<a name="bytebase-v1-GetPlanCheckRunRequest"></a>
-### CreateReleaseRequest
+### GetPlanCheckRunRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
-| release | [Release](#bytebase-v1-Release) | | The release to create. |
-| train | [string](#string) | | Train for iteration tracking (template rendered without {iteration}). Used to group releases and determine the next iteration number. |
+| name | [string](#string) | | The name of the plan check run to retrieve. Format: projects/{project}/plans/{plan}/planCheckRun |
-<a name="bytebase-v1-DeleteReleaseRequest"></a>
+<a name="bytebase-v1-GetPlanRequest"></a>
-### DeleteReleaseRequest
+### GetPlanRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the release to delete. Format: projects/{project}/releases/{release} |
+| name | [string](#string) | | The name of the plan to retrieve. Format: projects/{project}/plans/{plan} |
-<a name="bytebase-v1-GetReleaseRequest"></a>
+<a name="bytebase-v1-ListPlansRequest"></a>
-### GetReleaseRequest
+### ListPlansRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/releases/{release} |
+| parent | [string](#string) | | The parent, which owns this collection of plans. Format: projects/{project} Use &#34;projects/-&#34; to list all plans from all projects. |
+| page_size | [int32](#int32) | | The maximum number of plans to return. The service may return fewer than this value. If unspecified, at most 10 plans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListPlans` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListPlans` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter plans returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filters: - creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator. - create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;. - title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match. - spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;. - state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
+For example: creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; has_rollout == false &amp;&amp; has_issue == true title == &#34;My Plan&#34; title.matches(&#34;database migration&#34;) spec_type == &#34;change_database_config&#34; state == &#34;ACTIVE&#34; |
-<a name="bytebase-v1-ListReleaseCategoriesRequest"></a>
-### ListReleaseCategoriesRequest
+
+<a name="bytebase-v1-ListPlansResponse"></a>
+
+### ListPlansResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
+| 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-ListReleaseCategoriesResponse"></a>
+<a name="bytebase-v1-Plan"></a>
-### ListReleaseCategoriesResponse
+### Plan
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| categories | [string](#string) | repeated | The unique category values in the project. |
+| name | [string](#string) | | The name of the plan. `plan` is a system generated ID. Format: projects/{project}/plans/{plan} |
+| state | [State](#bytebase-v1-State) | | The state of the plan. |
+| issue | [string](#string) | | The issue associated with the plan. Can be empty. Format: projects/{project}/issues/{issue} |
+| title | [string](#string) | | The title of the plan. |
+| description | [string](#string) | | The description of the plan. |
+| specs | [Plan.Spec](#bytebase-v1-Plan-Spec) | repeated | The deployment specs for the plan. |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| plan_check_run_status_count | [Plan.PlanCheckRunStatusCountEntry](#bytebase-v1-Plan-PlanCheckRunStatusCountEntry) | repeated | The status count of the latest plan check runs. Keys are: - SUCCESS - WARNING - ERROR - RUNNING |
+| has_rollout | [bool](#bool) | | Whether the plan has started the rollout. |
-<a name="bytebase-v1-ListReleasesRequest"></a>
+<a name="bytebase-v1-Plan-ChangeDatabaseConfig"></a>
-### ListReleasesRequest
+### Plan.ChangeDatabaseConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project} |
-| page_size | [int32](#int32) | | The maximum number of releases to return. The service may return fewer than this value. If unspecified, at most 10 releases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Show deleted releases if specified. |
-| filter | [string](#string) | | Filter is used to filter releases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - category: release category, support &#34;==&#34; operator.
-
-For example: category == &#34;webapp&#34; |
+| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. |
+| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
+| release | [string](#string) | | The resource name of the release. Format: projects/{project}/releases/{release} |
+| ghost_flags | [Plan.ChangeDatabaseConfig.GhostFlagsEntry](#bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry) | repeated | |
+| enable_prior_backup | [bool](#bool) | | If set, a backup of the modified data will be created automatically before any changes are applied. |
+| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
-<a name="bytebase-v1-ListReleasesResponse"></a>
+<a name="bytebase-v1-Plan-ChangeDatabaseConfig-GhostFlagsEntry"></a>
-### ListReleasesResponse
+### Plan.ChangeDatabaseConfig.GhostFlagsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| releases | [Release](#bytebase-v1-Release) | repeated | The releases from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-Release"></a>
+<a name="bytebase-v1-Plan-CreateDatabaseConfig"></a>
-### Release
+### Plan.CreateDatabaseConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/releases/{release} |
-| category | [string](#string) | | Category extracted from release name (e.g., &#34;webapp&#34;, &#34;analytics&#34;). Set by Bytebase action during release creation. |
-| files | [Release.File](#bytebase-v1-Release-File) | repeated | The SQL files included in the release. |
-| vcs_source | [Release.VCSSource](#bytebase-v1-Release-VCSSource) | | The version control source of the release. |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the release. |
-| type | [Release.Type](#bytebase-v1-Release-Type) | | The type of schema change for all files in this release. |
+| target | [string](#string) | | The resource name of the instance on which the database is created. Format: instances/{instance} |
+| database | [string](#string) | | The name of the database to create. |
+| table | [string](#string) | | table is the name of the table, if it is not empty, Bytebase should create a table after creating the database. For example, in MongoDB, it only creates the database when we first store data in that database. |
+| character_set | [string](#string) | | character_set is the character set of the database. |
+| collation | [string](#string) | | collation is the collation of the database. |
+| cluster | [string](#string) | | cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. |
+| owner | [string](#string) | | owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. |
+| environment | [string](#string) | | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-<a name="bytebase-v1-Release-File"></a>
+<a name="bytebase-v1-Plan-ExportDataConfig"></a>
+
+### Plan.ExportDataConfig
-### Release.File
-A SQL file in a release.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| path | [string](#string) | | The path of the file. e.g., `2.2/V0001_create_table.sql`. |
-| version | [string](#string) | | The version identifier for the file. |
-| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
-| sheet | [string](#string) | | For inputs, we must either use `sheet` or `statement`. For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
+| 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. |
-The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
-| statement | [bytes](#bytes) | | The raw SQL statement content. |
-| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet content or the statement. |
+<a name="bytebase-v1-Plan-PlanCheckRunStatusCountEntry"></a>
-<a name="bytebase-v1-Release-VCSSource"></a>
+### Plan.PlanCheckRunStatusCountEntry
-### Release.VCSSource
-Version control system source information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| vcs_type | [VCSType](#bytebase-v1-VCSType) | | The type of VCS. |
-| url | [string](#string) | | The url link to the e.g., GitHub commit or pull request. |
+| key | [string](#string) | | |
+| value | [int32](#int32) | | |
-<a name="bytebase-v1-UndeleteReleaseRequest"></a>
+<a name="bytebase-v1-Plan-Spec"></a>
-### UndeleteReleaseRequest
+### Plan.Spec
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted release. Format: projects/{project}/releases/{release} |
+| 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-UpdateReleaseRequest"></a>
+<a name="bytebase-v1-PlanCheckRun"></a>
-### UpdateReleaseRequest
+### PlanCheckRun
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| release | [Release](#bytebase-v1-Release) | | The release to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. |
-
-
-
-
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/planCheckRun |
+| status | [PlanCheckRun.Status](#bytebase-v1-PlanCheckRun-Status) | | |
+| results | [PlanCheckRun.Result](#bytebase-v1-PlanCheckRun-Result) | repeated | |
+| error | [string](#string) | | error is set if the Status is FAILED. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-
-<a name="bytebase-v1-Release-Type"></a>
-### Release.Type
-The type of schema change.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| VERSIONED | 1 | Versioned schema migration. |
-| DECLARATIVE | 2 | Declarative schema definition. |
+<a name="bytebase-v1-PlanCheckRun-Result"></a>
-
+### PlanCheckRun.Result
-
-<a name="bytebase-v1-ReleaseService"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| status | [Advice.Level](#bytebase-v1-Advice-Level) | | |
+| title | [string](#string) | | |
+| content | [string](#string) | | |
+| code | [int32](#int32) | | |
+| target | [string](#string) | | Target identification for consolidated results. Format: instances/{instance}/databases/{database} |
+| type | [PlanCheckRun.Result.Type](#bytebase-v1-PlanCheckRun-Result-Type) | | |
+| sql_summary_report | [PlanCheckRun.Result.SqlSummaryReport](#bytebase-v1-PlanCheckRun-Result-SqlSummaryReport) | | |
+| sql_review_report | [PlanCheckRun.Result.SqlReviewReport](#bytebase-v1-PlanCheckRun-Result-SqlReviewReport) | | |
-### ReleaseService
-ReleaseService manages releases for coordinating deployments.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetRelease | [GetReleaseRequest](#bytebase-v1-GetReleaseRequest) | [Release](#bytebase-v1-Release) | Retrieves a release by name. Permissions required: bb.releases.get |
-| ListReleases | [ListReleasesRequest](#bytebase-v1-ListReleasesRequest) | [ListReleasesResponse](#bytebase-v1-ListReleasesResponse) | Lists releases in a project. Permissions required: bb.releases.list |
-| CreateRelease | [CreateReleaseRequest](#bytebase-v1-CreateReleaseRequest) | [Release](#bytebase-v1-Release) | Creates a new release with SQL files. Permissions required: bb.releases.create |
-| UpdateRelease | [UpdateReleaseRequest](#bytebase-v1-UpdateReleaseRequest) | [Release](#bytebase-v1-Release) | Updates an existing release. Permissions required: bb.releases.update When allow_missing=true, also requires: bb.releases.create |
-| DeleteRelease | [DeleteReleaseRequest](#bytebase-v1-DeleteReleaseRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a release. Permissions required: bb.releases.delete |
-| UndeleteRelease | [UndeleteReleaseRequest](#bytebase-v1-UndeleteReleaseRequest) | [Release](#bytebase-v1-Release) | Restores a deleted release. Permissions required: bb.releases.undelete |
-| CheckRelease | [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest) | [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse) | Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check |
-| ListReleaseCategories | [ListReleaseCategoriesRequest](#bytebase-v1-ListReleaseCategoriesRequest) | [ListReleaseCategoriesResponse](#bytebase-v1-ListReleaseCategoriesResponse) | Lists all unique categories in a project. Permissions required: bb.releases.list |
-
-<a name="v1_review_config_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+<a name="bytebase-v1-PlanCheckRun-Result-SqlReviewReport"></a>
-## v1/review_config_service.proto
+### PlanCheckRun.Result.SqlReviewReport
-<a name="bytebase-v1-CreateReviewConfigRequest"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| start_position | [Position](#bytebase-v1-Position) | | Position of the SQL statement. |
+| end_position | [Position](#bytebase-v1-Position) | | |
-### CreateReviewConfigRequest
+
+
+
+
+
+<a name="bytebase-v1-PlanCheckRun-Result-SqlSummaryReport"></a>
+
+### PlanCheckRun.Result.SqlSummaryReport
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to create. |
+| statement_types | [StatementType](#bytebase-v1-StatementType) | repeated | statement_types are the types of statements that are found in the sql. |
+| affected_rows | [int64](#int64) | | |
-<a name="bytebase-v1-DeleteReviewConfigRequest"></a>
+<a name="bytebase-v1-RunPlanChecksRequest"></a>
-### DeleteReviewConfigRequest
+### RunPlanChecksRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the SQL review config to delete. Format: reviewConfigs/{reviewConfig} |
+| name | [string](#string) | | The plan to run plan checks. Format: projects/{project}/plans/{plan} |
+| spec_id | [string](#string) | optional | The UUID of the specific spec to run plan checks for. This should match the spec.id field in Plan.Spec. If not set, all specs in the plan will be used. |
-<a name="bytebase-v1-GetReviewConfigRequest"></a>
+<a name="bytebase-v1-RunPlanChecksResponse"></a>
-### GetReviewConfigRequest
+### RunPlanChecksResponse
+
+
+
+
+
+
+
+<a name="bytebase-v1-UpdatePlanRequest"></a>
+
+### UpdatePlanRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the SQL review config to retrieve. Format: reviewConfigs/{reviewConfig} |
+| plan | [Plan](#bytebase-v1-Plan) | | The plan to update.
+The plan&#39;s `name` field is used to identify the plan to update. Format: projects/{project}/plans/{plan} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the plan is not found, a new plan will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-ListReviewConfigsRequest"></a>
+
-### ListReviewConfigsRequest
+<a name="bytebase-v1-PlanCheckRun-Result-Type"></a>
+### PlanCheckRun.Result.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| STATEMENT_ADVISE | 1 | |
+| STATEMENT_SUMMARY_REPORT | 2 | |
+| GHOST_SYNC | 3 | |
-<a name="bytebase-v1-ListReviewConfigsResponse"></a>
+<a name="bytebase-v1-PlanCheckRun-Status"></a>
-### ListReviewConfigsResponse
+### PlanCheckRun.Status
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | |
+| RUNNING | 1 | |
+| DONE | 2 | |
+| FAILED | 3 | |
+| CANCELED | 4 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| review_configs | [ReviewConfig](#bytebase-v1-ReviewConfig) | repeated | The SQL review configs from the specified request. |
+
+
+<a name="bytebase-v1-PlanService"></a>
+### PlanService
+PlanService manages deployment plans for database changes.
-<a name="bytebase-v1-ReviewConfig"></a>
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetPlan | [GetPlanRequest](#bytebase-v1-GetPlanRequest) | [Plan](#bytebase-v1-Plan) | Retrieves a deployment plan by name. Permissions required: bb.plans.get |
+| ListPlans | [ListPlansRequest](#bytebase-v1-ListPlansRequest) | [ListPlansResponse](#bytebase-v1-ListPlansResponse) | Lists deployment plans in a project. Permissions required: bb.plans.list |
+| CreatePlan | [CreatePlanRequest](#bytebase-v1-CreatePlanRequest) | [Plan](#bytebase-v1-Plan) | Creates a new deployment plan. Permissions required: bb.plans.create |
+| UpdatePlan | [UpdatePlanRequest](#bytebase-v1-UpdatePlanRequest) | [Plan](#bytebase-v1-Plan) | UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update (or creator) |
+| GetPlanCheckRun | [GetPlanCheckRunRequest](#bytebase-v1-GetPlanCheckRunRequest) | [PlanCheckRun](#bytebase-v1-PlanCheckRun) | Gets the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.get |
+| RunPlanChecks | [RunPlanChecksRequest](#bytebase-v1-RunPlanChecksRequest) | [RunPlanChecksResponse](#bytebase-v1-RunPlanChecksResponse) | Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run |
+| CancelPlanCheckRun | [CancelPlanCheckRunRequest](#bytebase-v1-CancelPlanCheckRunRequest) | [CancelPlanCheckRunResponse](#bytebase-v1-CancelPlanCheckRunResponse) | Cancels the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.run |
+
+
+
+
+
+<a name="v1_project_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/project_service.proto
+
+
+
+<a name="bytebase-v1-Activity"></a>
+
+### Activity
+Activity types for webhook notifications.
-### ReviewConfig
+
+
+
+
+
+<a name="bytebase-v1-AddWebhookRequest"></a>
+
+### AddWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the SQL review config. Format: reviewConfigs/{reviewConfig} |
-| title | [string](#string) | | The title of the review configuration. |
-| enabled | [bool](#bool) | | Whether the review configuration is enabled. |
-| rules | [SQLReviewRule](#bytebase-v1-SQLReviewRule) | repeated | The SQL review rules to enforce. |
-| resources | [string](#string) | repeated | Resources using the config. Format: {resource}/{resource id}, e.g., environments/test. |
+| 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-SQLReviewRule"></a>
+<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>
+
+### BatchDeleteProjectsRequest
-### SQLReviewRule
-SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [SQLReviewRule.Type](#bytebase-v1-SQLReviewRule-Type) | | The type of SQL review rule. |
-| level | [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level) | | The severity level of the rule. |
-| naming_payload | [SQLReviewRule.NamingRulePayload](#bytebase-v1-SQLReviewRule-NamingRulePayload) | | |
-| number_payload | [SQLReviewRule.NumberRulePayload](#bytebase-v1-SQLReviewRule-NumberRulePayload) | | |
-| string_array_payload | [SQLReviewRule.StringArrayRulePayload](#bytebase-v1-SQLReviewRule-StringArrayRulePayload) | | |
-| comment_convention_payload | [SQLReviewRule.CommentConventionRulePayload](#bytebase-v1-SQLReviewRule-CommentConventionRulePayload) | | |
-| string_payload | [SQLReviewRule.StringRulePayload](#bytebase-v1-SQLReviewRule-StringRulePayload) | | |
-| naming_case_payload | [SQLReviewRule.NamingCaseRulePayload](#bytebase-v1-SQLReviewRule-NamingCaseRulePayload) | | |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |
+| names | [string](#string) | repeated | The names of the projects to delete. Format: projects/{project} |
+| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted projects and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted projects. All projects must already be soft-deleted for this to work. When purge=true, all databases will be moved to the default project before deletion. When purge=false (soft delete/archive), the projects and their databases/issues remain unchanged. |
-<a name="bytebase-v1-SQLReviewRule-CommentConventionRulePayload"></a>
+<a name="bytebase-v1-BatchGetProjectsRequest"></a>
-### SQLReviewRule.CommentConventionRulePayload
+### BatchGetProjectsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| required | [bool](#bool) | | |
-| max_length | [int32](#int32) | | |
+| names | [string](#string) | repeated | The names of projects to retrieve. Format: projects/{project} |
-<a name="bytebase-v1-SQLReviewRule-NamingCaseRulePayload"></a>
+<a name="bytebase-v1-BatchGetProjectsResponse"></a>
-### SQLReviewRule.NamingCaseRulePayload
+### BatchGetProjectsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| upper | [bool](#bool) | | |
+| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
-<a name="bytebase-v1-SQLReviewRule-NamingRulePayload"></a>
+<a name="bytebase-v1-CreateProjectRequest"></a>
+
+### CreateProjectRequest
-### SQLReviewRule.NamingRulePayload
-Payload message types for SQL review rules
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| max_length | [int32](#int32) | | |
-| format | [string](#string) | | |
+| project | [Project](#bytebase-v1-Project) | | The project to create. |
+| project_id | [string](#string) | | The ID to use for the project, which will become the final component of the project&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-<a name="bytebase-v1-SQLReviewRule-NumberRulePayload"></a>
+<a name="bytebase-v1-DeleteProjectRequest"></a>
-### SQLReviewRule.NumberRulePayload
+### DeleteProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| number | [int32](#int32) | | |
+| name | [string](#string) | | The name of the project to delete. Format: projects/{project} |
+| 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. When purge=true, all databases will be moved to the default project before deletion. When purge=false (soft delete/archive), the project and its databases/issues remain unchanged. |
-<a name="bytebase-v1-SQLReviewRule-StringArrayRulePayload"></a>
+<a name="bytebase-v1-GetProjectRequest"></a>
-### SQLReviewRule.StringArrayRulePayload
+### GetProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| list | [string](#string) | repeated | |
-
+| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |
-<a name="bytebase-v1-SQLReviewRule-StringRulePayload"></a>
-### SQLReviewRule.StringRulePayload
+<a name="bytebase-v1-Label"></a>
+### Label
+A label for categorizing and organizing issues.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| value | [string](#string) | | |
+| 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-UpdateReviewConfigRequest"></a>
+<a name="bytebase-v1-ListProjectsRequest"></a>
-### UpdateReviewConfigRequest
+### ListProjectsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to update.
+| 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.
-The name field is used to identify the SQL review config to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the config is not found, a new config will be created. In this situation, `update_mask` is ignored. |
+When paginating, all other parameters provided to `ListProjects` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
+| filter | [string](#string) | | Filter the project. Check filter for SearchProjectsRequest for details. Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). |
+| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
-
+<a name="bytebase-v1-ListProjectsResponse"></a>
-<a name="bytebase-v1-SQLReviewRule-Level"></a>
+### ListProjectsResponse
-### SQLReviewRule.Level
-The severity level for SQL review rules.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| LEVEL_UNSPECIFIED | 0 | Unspecified level. |
-| ERROR | 1 | Rule violation is an error. |
-| WARNING | 2 | Rule violation is a warning. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| 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-SQLReviewRule-Type"></a>
-### SQLReviewRule.Type
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| ENGINE_MYSQL_USE_INNODB | 1 | |
-| NAMING_FULLY_QUALIFIED | 2 | |
-| NAMING_TABLE | 3 | |
-| NAMING_COLUMN | 4 | |
-| NAMING_INDEX_PK | 5 | |
-| NAMING_INDEX_UK | 6 | |
-| NAMING_INDEX_FK | 7 | |
-| NAMING_INDEX_IDX | 8 | |
-| NAMING_COLUMN_AUTO_INCREMENT | 9 | |
-| NAMING_TABLE_NO_KEYWORD | 10 | |
-| NAMING_IDENTIFIER_NO_KEYWORD | 11 | |
-| NAMING_IDENTIFIER_CASE | 12 | |
-| STATEMENT_SELECT_NO_SELECT_ALL | 13 | |
-| STATEMENT_WHERE_REQUIRE_SELECT | 14 | |
-| STATEMENT_WHERE_REQUIRE_UPDATE_DELETE | 15 | |
-| STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE | 16 | |
-| STATEMENT_DISALLOW_ON_DEL_CASCADE | 17 | |
-| STATEMENT_DISALLOW_RM_TBL_CASCADE | 18 | |
-| STATEMENT_DISALLOW_COMMIT | 19 | |
-| STATEMENT_DISALLOW_LIMIT | 20 | |
-| STATEMENT_DISALLOW_ORDER_BY | 21 | |
-| STATEMENT_MERGE_ALTER_TABLE | 22 | |
-| STATEMENT_INSERT_ROW_LIMIT | 23 | |
-| STATEMENT_INSERT_MUST_SPECIFY_COLUMN | 24 | |
-| STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND | 25 | |
-| STATEMENT_AFFECTED_ROW_LIMIT | 26 | |
-| STATEMENT_DML_DRY_RUN | 27 | |
-| STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT | 28 | |
-| STATEMENT_ADD_CHECK_NOT_VALID | 29 | |
-| STATEMENT_ADD_FOREIGN_KEY_NOT_VALID | 30 | |
-| STATEMENT_DISALLOW_ADD_NOT_NULL | 31 | |
-| STATEMENT_SELECT_FULL_TABLE_SCAN | 32 | |
-| STATEMENT_CREATE_SPECIFY_SCHEMA | 33 | |
-| STATEMENT_CHECK_SET_ROLE_VARIABLE | 34 | |
-| STATEMENT_DISALLOW_USING_FILESORT | 35 | |
-| STATEMENT_DISALLOW_USING_TEMPORARY | 36 | |
-| STATEMENT_WHERE_NO_EQUAL_NULL | 37 | |
-| STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS | 38 | |
-| STATEMENT_QUERY_MINIMUM_PLAN_LEVEL | 39 | |
-| STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT | 40 | |
-| STATEMENT_MAXIMUM_LIMIT_VALUE | 41 | |
-| STATEMENT_MAXIMUM_JOIN_TABLE_COUNT | 42 | |
-| STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION | 43 | |
-| STATEMENT_JOIN_STRICT_COLUMN_ATTRS | 44 | |
-| STATEMENT_NON_TRANSACTIONAL | 45 | |
-| STATEMENT_ADD_COLUMN_WITHOUT_POSITION | 46 | |
-| STATEMENT_DISALLOW_OFFLINE_DDL | 47 | |
-| STATEMENT_DISALLOW_CROSS_DB_QUERIES | 48 | |
-| STATEMENT_MAX_EXECUTION_TIME | 49 | |
-| STATEMENT_REQUIRE_ALGORITHM_OPTION | 50 | |
-| STATEMENT_REQUIRE_LOCK_OPTION | 51 | |
-| STATEMENT_OBJECT_OWNER_CHECK | 52 | |
-| TABLE_REQUIRE_PK | 53 | |
-| TABLE_NO_FOREIGN_KEY | 54 | |
-| TABLE_DROP_NAMING_CONVENTION | 55 | |
-| TABLE_COMMENT | 56 | |
-| TABLE_DISALLOW_PARTITION | 57 | |
-| TABLE_DISALLOW_TRIGGER | 58 | |
-| TABLE_NO_DUPLICATE_INDEX | 59 | |
-| TABLE_TEXT_FIELDS_TOTAL_LENGTH | 60 | |
-| TABLE_DISALLOW_SET_CHARSET | 61 | |
-| TABLE_DISALLOW_DDL | 62 | |
-| TABLE_DISALLOW_DML | 63 | |
-| TABLE_LIMIT_SIZE | 64 | |
-| TABLE_REQUIRE_CHARSET | 65 | |
-| TABLE_REQUIRE_COLLATION | 66 | |
-| COLUMN_REQUIRED | 67 | |
-| COLUMN_NO_NULL | 68 | |
-| COLUMN_DISALLOW_CHANGE_TYPE | 69 | |
-| COLUMN_SET_DEFAULT_FOR_NOT_NULL | 70 | |
-| COLUMN_DISALLOW_CHANGE | 71 | |
-| COLUMN_DISALLOW_CHANGING_ORDER | 72 | |
-| COLUMN_DISALLOW_DROP | 73 | |
-| COLUMN_DISALLOW_DROP_IN_INDEX | 74 | |
-| COLUMN_COMMENT | 75 | |
-| COLUMN_AUTO_INCREMENT_MUST_INTEGER | 76 | |
-| COLUMN_TYPE_DISALLOW_LIST | 77 | |
-| COLUMN_DISALLOW_SET_CHARSET | 78 | |
-| COLUMN_MAXIMUM_CHARACTER_LENGTH | 79 | |
-| COLUMN_MAXIMUM_VARCHAR_LENGTH | 80 | |
-| COLUMN_AUTO_INCREMENT_INITIAL_VALUE | 81 | |
-| COLUMN_AUTO_INCREMENT_MUST_UNSIGNED | 82 | |
-| COLUMN_CURRENT_TIME_COUNT_LIMIT | 83 | |
-| COLUMN_REQUIRE_DEFAULT | 84 | |
-| COLUMN_DEFAULT_DISALLOW_VOLATILE | 85 | |
-| COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT | 86 | |
-| COLUMN_REQUIRE_CHARSET | 87 | |
-| COLUMN_REQUIRE_COLLATION | 88 | |
-| SCHEMA_BACKWARD_COMPATIBILITY | 89 | |
-| DATABASE_DROP_EMPTY_DATABASE | 90 | |
-| INDEX_NO_DUPLICATE_COLUMN | 91 | |
-| INDEX_KEY_NUMBER_LIMIT | 92 | |
-| INDEX_PK_TYPE_LIMIT | 93 | |
-| INDEX_TYPE_NO_BLOB | 94 | |
-| INDEX_TOTAL_NUMBER_LIMIT | 95 | |
-| INDEX_PRIMARY_KEY_TYPE_ALLOWLIST | 96 | |
-| INDEX_CREATE_CONCURRENTLY | 97 | |
-| INDEX_TYPE_ALLOW_LIST | 98 | |
-| INDEX_NOT_REDUNDANT | 99 | |
-| SYSTEM_CHARSET_ALLOWLIST | 100 | |
-| SYSTEM_COLLATION_ALLOWLIST | 101 | |
-| SYSTEM_COMMENT_LENGTH | 102 | |
-| SYSTEM_PROCEDURE_DISALLOW_CREATE | 103 | |
-| SYSTEM_EVENT_DISALLOW_CREATE | 104 | |
-| SYSTEM_VIEW_DISALLOW_CREATE | 105 | |
-| SYSTEM_FUNCTION_DISALLOW_CREATE | 106 | |
-| SYSTEM_FUNCTION_DISALLOWED_LIST | 107 | |
-| ADVICE_ONLINE_MIGRATION | 108 | |
-| BUILTIN_PRIOR_BACKUP_CHECK | 109 | |
+<a name="bytebase-v1-Project"></a>
-
+### Project
-
-<a name="bytebase-v1-ReviewConfigService"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the project. Format: projects/{project} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the project. |
+| title | [string](#string) | | The title or name of a project. It&#39;s not unique within the workspace. |
+| webhooks | [Webhook](#bytebase-v1-Webhook) | repeated | The list of webhooks configured for the project. |
+| data_classification_config_id | [string](#string) | | The data classification configuration ID for the project. |
+| issue_labels | [Label](#bytebase-v1-Label) | repeated | Labels available for tagging issues in this project. |
+| force_issue_labels | [bool](#bool) | | Force issue labels to be used when creating an issue. |
+| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |
+| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |
+| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |
+| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. |
+| allow_self_approval | [bool](#bool) | | Whether to allow issue creators to self-approve their own issues. |
+| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-v1-Project-ExecutionRetryPolicy) | | Execution retry policy for task runs. |
+| ci_sampling_size | [int32](#int32) | | The maximum number of database rows to sample during CI data validation. Without specification, sampling is disabled, resulting in full validation. |
+| parallel_tasks_per_rollout | [int32](#int32) | | The maximum number of parallel tasks allowed during rollout execution. |
+| labels | [Project.LabelsEntry](#bytebase-v1-Project-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the project. For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } |
+| enforce_sql_review | [bool](#bool) | | Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors. |
+| require_issue_approval | [bool](#bool) | | Whether to require issue approval before rollout. |
+| require_plan_check_no_error | [bool](#bool) | | Whether to require plan check to have no error before rollout. |
+| allow_request_role | [bool](#bool) | | |
-### ReviewConfigService
-ReviewConfigService manages approval flow configurations.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| CreateReviewConfig | [CreateReviewConfigRequest](#bytebase-v1-CreateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Creates a new SQL review configuration. Permissions required: bb.reviewConfigs.create |
-| ListReviewConfigs | [ListReviewConfigsRequest](#bytebase-v1-ListReviewConfigsRequest) | [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse) | Lists all SQL review configurations. Permissions required: bb.reviewConfigs.list |
-| GetReviewConfig | [GetReviewConfigRequest](#bytebase-v1-GetReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Retrieves a SQL review configuration by name. Permissions required: bb.reviewConfigs.get |
-| UpdateReviewConfig | [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Updates a SQL review configuration. Permissions required: bb.reviewConfigs.update When allow_missing=true, also requires: bb.reviewConfigs.create |
-| DeleteReviewConfig | [DeleteReviewConfigRequest](#bytebase-v1-DeleteReviewConfigRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a SQL review configuration. Permissions required: bb.reviewConfigs.delete |
-
-<a name="v1_revision_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>
-## v1/revision_service.proto
+### Project.ExecutionRetryPolicy
+Execution retry policy configuration.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |
-<a name="bytebase-v1-BatchCreateRevisionsRequest"></a>
-### BatchCreateRevisionsRequest
+
+
+<a name="bytebase-v1-Project-LabelsEntry"></a>
+
+### Project.LabelsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource shared by all revisions being created. Format: instances/{instance}/databases/{database} |
-| requests | [CreateRevisionRequest](#bytebase-v1-CreateRevisionRequest) | repeated | The request message specifying the revisions to create. A maximum of 100 revisions can be created in a batch. |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-BatchCreateRevisionsResponse"></a>
+<a name="bytebase-v1-RemoveWebhookRequest"></a>
-### BatchCreateRevisionsResponse
+### RemoveWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| revisions | [Revision](#bytebase-v1-Revision) | repeated | The created revisions. |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |
-<a name="bytebase-v1-CreateRevisionRequest"></a>
+<a name="bytebase-v1-SearchProjectsRequest"></a>
-### CreateRevisionRequest
+### SearchProjectsRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| show_deleted | [bool](#bool) | | Show deleted projects if specified. |
+| filter | [string](#string) | | Filter the project. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters: - name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator. - exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator. - state: check the State enum for the values, support &#34;==&#34; operator. - labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example: name == &#34;project name&#34; name.matches(&#34;project name&#34;) resource_id == &#34;project id&#34; resource_id.matches(&#34;project id&#34;) exclude_default == true state == &#34;DELETED&#34; labels.environment == &#34;production&#34; labels.tier == &#34;critical&#34; labels.environment in [&#34;staging&#34;, &#34;prod&#34;] You can combine filter conditions like: name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;) name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34; labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; |
+| page_size | [int32](#int32) | | The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchProjects` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchProjects` must match the call that provided the page token. |
+| order_by | [string](#string) | | The order by of projects. Support title. The default sorting order is ascending. For example: - order_by = &#34;title&#34; - order_by = &#34;title desc&#34; - order_by = &#34;title asc&#34; |
+
+
+
+
+
+
+<a name="bytebase-v1-SearchProjectsResponse"></a>
+
+### SearchProjectsResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+
+
+
+
+
+
+<a name="bytebase-v1-TestWebhookRequest"></a>
+
+### TestWebhookRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| project | [string](#string) | | The name of the project which owns the webhook to test. Format: projects/{project} |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to test. Identified by its url. |
+
+
+
+
+
+
+<a name="bytebase-v1-TestWebhookResponse"></a>
+
+### TestWebhookResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| error | [string](#string) | | The result of the test, empty if the test is successful. |
+
+
+
+
+
+
+<a name="bytebase-v1-UndeleteProjectRequest"></a>
+
+### UndeleteProjectRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |
+
+
+
+
+
+
+<a name="bytebase-v1-UpdateProjectRequest"></a>
+
+### UpdateProjectRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| project | [Project](#bytebase-v1-Project) | | The project to update.
+
+The project&#39;s `name` field is used to identify the project to update. Format: projects/{project} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the project is not found, a new project will be created. In this situation, `update_mask` is ignored. |
+
+
+
+
+
+
+<a name="bytebase-v1-UpdateWebhookRequest"></a>
+
+### UpdateWebhookRequest
+
+
+
+| 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. |
+
+
+
+
+
+
+<a name="bytebase-v1-Webhook"></a>
+
+### Webhook
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook} |
+| type | [WebhookType](#bytebase-v1-WebhookType) | | Webhook integration type. type is the type of the webhook. |
+| title | [string](#string) | | title is the title of the webhook. |
+| url | [string](#string) | | url is the url of the webhook, should be unique within the project. |
+| direct_message | [bool](#bool) | | if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work. |
+| notification_types | [Activity.Type](#bytebase-v1-Activity-Type) | repeated | notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following: - ISSUE_CREATED - ISSUE_APPROVAL_REQUESTED - ISSUE_SENT_BACK - PIPELINE_FAILED - PIPELINE_COMPLETED |
+
+
+
+
+
+
+
+
+<a name="bytebase-v1-Activity-Type"></a>
+
+### Activity.Type
+Activity type enumeration.
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| ISSUE_CREATED | 10 | ISSUE_CREATED represents a new issue creation event. |
+| ISSUE_APPROVAL_REQUESTED | 11 | ISSUE_APPROVAL_REQUESTED represents an approval request event. |
+| ISSUE_SENT_BACK | 12 | ISSUE_SENT_BACK represents an issue being sent back by an approver. |
+| PIPELINE_FAILED | 13 | PIPELINE_FAILED represents a pipeline failure event. |
+| PIPELINE_COMPLETED | 14 | PIPELINE_COMPLETED represents a pipeline completion event. |
+
+
+
+
+
+
+
+<a name="bytebase-v1-ProjectService"></a>
+
+### ProjectService
+ProjectService manages projects that group databases and changes.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetProject | [GetProjectRequest](#bytebase-v1-GetProjectRequest) | [Project](#bytebase-v1-Project) | GetProject retrieves a project by name. Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method. Permissions required: bb.projects.get |
+| BatchGetProjects | [BatchGetProjectsRequest](#bytebase-v1-BatchGetProjectsRequest) | [BatchGetProjectsResponse](#bytebase-v1-BatchGetProjectsResponse) | BatchGetProjects retrieves multiple projects by their names. Permissions required: bb.projects.get |
+| ListProjects | [ListProjectsRequest](#bytebase-v1-ListProjectsRequest) | [ListProjectsResponse](#bytebase-v1-ListProjectsResponse) | Lists all projects in the workspace with optional filtering. Permissions required: bb.projects.list |
+| SearchProjects | [SearchProjectsRequest](#bytebase-v1-SearchProjectsRequest) | [SearchProjectsResponse](#bytebase-v1-SearchProjectsResponse) | Searches for projects with advanced filtering capabilities. Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects) |
+| CreateProject | [CreateProjectRequest](#bytebase-v1-CreateProjectRequest) | [Project](#bytebase-v1-Project) | Creates a new project in the workspace. Permissions required: bb.projects.create |
+| UpdateProject | [UpdateProjectRequest](#bytebase-v1-UpdateProjectRequest) | [Project](#bytebase-v1-Project) | Updates an existing project&#39;s properties. Permissions required: bb.projects.update |
+| DeleteProject | [DeleteProjectRequest](#bytebase-v1-DeleteProjectRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes (soft-delete or purge) a project. Permissions required: bb.projects.delete |
+| UndeleteProject | [UndeleteProjectRequest](#bytebase-v1-UndeleteProjectRequest) | [Project](#bytebase-v1-Project) | Restores a soft-deleted project. Permissions required: bb.projects.undelete |
+| BatchDeleteProjects | [BatchDeleteProjectsRequest](#bytebase-v1-BatchDeleteProjectsRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes multiple projects in a single operation. Permissions required: bb.projects.delete |
+| GetIamPolicy | [GetIamPolicyRequest](#bytebase-v1-GetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Retrieves the IAM policy for a project. Permissions required: bb.projects.getIamPolicy |
+| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |
+| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |
+| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |
+| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |
+| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |
+
+
+
+
+
+<a name="v1_release_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/release_service.proto
+
+
+
+<a name="bytebase-v1-CheckReleaseRequest"></a>
+
+### CheckReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: instances/{instance}/databases/{database} |
-| revision | [Revision](#bytebase-v1-Revision) | | The revision to create. |
+| parent | [string](#string) | | Format: projects/{project} |
+| release | [Release](#bytebase-v1-Release) | | The release to check. |
+| targets | [string](#string) | repeated | The targets to dry-run the release. Can be database or databaseGroup. Format: projects/{project}/databaseGroups/{databaseGroup} instances/{instance}/databases/{database} |
+| custom_rules | [string](#string) | | Custom linting rules in natural language for AI-powered validation. Each rule should be a clear statement describing the desired schema constraint. Example: &#34;All tables must have a primary key&#34; Example: &#34;VARCHAR columns should specify a maximum length&#34; |
-<a name="bytebase-v1-DeleteRevisionRequest"></a>
+<a name="bytebase-v1-CheckReleaseResponse"></a>
-### DeleteRevisionRequest
+### CheckReleaseResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the revision to delete. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-
+| results | [CheckReleaseResponse.CheckResult](#bytebase-v1-CheckReleaseResponse-CheckResult) | repeated | The check results for each file and target combination. |
+| affected_rows | [int64](#int64) | | The total affected rows across all checks. |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The aggregated risk level of the check. |
-<a name="bytebase-v1-GetRevisionRequest"></a>
-### GetRevisionRequest
+<a name="bytebase-v1-CheckReleaseResponse-CheckResult"></a>
+### CheckReleaseResponse.CheckResult
+Check result for a single release file on a target database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the revision. Format: instances/{instance}/databases/{database}/revisions/{revision} |
+| file | [string](#string) | | The file path that is being checked. |
+| target | [string](#string) | | The target that the check is performed on. Should be a database. Format: instances/{instance}/databases/{database} |
+| advices | [Advice](#bytebase-v1-Advice) | repeated | The list of advice for the file and the target. |
+| affected_rows | [int64](#int64) | | The count of affected rows of the statement on the target. |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the statement on the target. |
-<a name="bytebase-v1-ListRevisionsRequest"></a>
+<a name="bytebase-v1-CreateReleaseRequest"></a>
-### ListRevisionsRequest
+### CreateReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent of the revisions. Format: instances/{instance}/databases/{database} |
-| page_size | [int32](#int32) | | The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 10 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListRevisions` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRevisions` must match the call that provided the page token. |
-| show_deleted | [bool](#bool) | | Whether to include deleted revisions in the results. |
+| parent | [string](#string) | | Format: projects/{project} |
+| release | [Release](#bytebase-v1-Release) | | The release to create. |
+| train | [string](#string) | | Train for iteration tracking (template rendered without {iteration}). Used to group releases and determine the next iteration number. |
-<a name="bytebase-v1-ListRevisionsResponse"></a>
+<a name="bytebase-v1-DeleteReleaseRequest"></a>
-### ListRevisionsResponse
+### DeleteReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| revisions | [Revision](#bytebase-v1-Revision) | repeated | The revisions from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| name | [string](#string) | | The name of the release to delete. Format: projects/{project}/releases/{release} |
-<a name="bytebase-v1-Revision"></a>
+<a name="bytebase-v1-GetReleaseRequest"></a>
-### Revision
+### GetReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: instances/{instance}/databases/{database}/revisions/{revision} |
-| release | [string](#string) | | Format: projects/{project}/releases/{release} Can be empty. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| deleter | [string](#string) | | Format: users/[email protected] Can be empty. |
-| delete_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Can be empty. |
-| file | [string](#string) | | Format: projects/{project}/releases/{release}/files/{id} Can be empty. |
-| version | [string](#string) | | The schema version string for this revision. |
-| sheet | [string](#string) | | The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
-| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet. |
-| task_run | [string](#string) | | The task run associated with the revision. Can be empty. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| type | [Revision.Type](#bytebase-v1-Revision-Type) | | The type of the revision. |
+| name | [string](#string) | | Format: projects/{project}/releases/{release} |
-
+<a name="bytebase-v1-ListReleaseCategoriesRequest"></a>
-<a name="bytebase-v1-Revision-Type"></a>
+### ListReleaseCategoriesRequest
-### Revision.Type
-The type of schema revision.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| VERSIONED | 1 | Versioned schema migration. |
-| DECLARATIVE | 2 | Declarative schema definition. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | Format: projects/{project} |
-
-
-<a name="bytebase-v1-RevisionService"></a>
-### RevisionService
-RevisionService manages schema revision history.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| ListRevisions | [ListRevisionsRequest](#bytebase-v1-ListRevisionsRequest) | [ListRevisionsResponse](#bytebase-v1-ListRevisionsResponse) | Lists schema revisions for a database. Permissions required: bb.revisions.list |
-| GetRevision | [GetRevisionRequest](#bytebase-v1-GetRevisionRequest) | [Revision](#bytebase-v1-Revision) | Retrieves a schema revision by name. Permissions required: bb.revisions.get |
-| BatchCreateRevisions | [BatchCreateRevisionsRequest](#bytebase-v1-BatchCreateRevisionsRequest) | [BatchCreateRevisionsResponse](#bytebase-v1-BatchCreateRevisionsResponse) | Creates multiple schema revisions in a single operation. Permissions required: bb.revisions.create |
-| DeleteRevision | [DeleteRevisionRequest](#bytebase-v1-DeleteRevisionRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a schema revision. Permissions required: bb.revisions.delete |
+<a name="bytebase-v1-ListReleaseCategoriesResponse"></a>
-
+### ListReleaseCategoriesResponse
-<a name="v1_role_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| categories | [string](#string) | repeated | The unique category values in the project. |
-## v1/role_service.proto
-<a name="bytebase-v1-CreateRoleRequest"></a>
-### CreateRoleRequest
+
+<a name="bytebase-v1-ListReleasesRequest"></a>
+
+### ListReleasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [Role](#bytebase-v1-Role) | | The role to create. |
-| role_id | [string](#string) | | The ID to use for the role, which will become the final component of the role&#39;s resource name.
+| parent | [string](#string) | | Format: projects/{project} |
+| page_size | [int32](#int32) | | The maximum number of releases to return. The service may return fewer than this value. If unspecified, at most 10 releases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListReleases` call. Provide this to retrieve the subsequent page.
-This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/. |
+When paginating, all other parameters provided to `ListReleases` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted releases if specified. |
+| filter | [string](#string) | | Filter is used to filter releases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+Supported filters: - category: release category, support &#34;==&#34; operator.
+For example: category == &#34;webapp&#34; |
-<a name="bytebase-v1-DeleteRoleRequest"></a>
-### DeleteRoleRequest
+
+<a name="bytebase-v1-ListReleasesResponse"></a>
+
+### ListReleasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role to delete. Format: roles/{role} |
+| releases | [Release](#bytebase-v1-Release) | repeated | The releases from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-GetRoleRequest"></a>
+<a name="bytebase-v1-Release"></a>
-### GetRoleRequest
+### Release
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role to retrieve. Format: roles/{role} |
+| name | [string](#string) | | Format: projects/{project}/releases/{release} |
+| category | [string](#string) | | Category extracted from release name (e.g., &#34;webapp&#34;, &#34;analytics&#34;). Set by Bytebase action during release creation. |
+| files | [Release.File](#bytebase-v1-Release-File) | repeated | The SQL files included in the release. |
+| vcs_source | [Release.VCSSource](#bytebase-v1-Release-VCSSource) | | The version control source of the release. |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the release. |
+| type | [Release.Type](#bytebase-v1-Release-Type) | | The type of schema change for all files in this release. |
-<a name="bytebase-v1-ListRolesRequest"></a>
+<a name="bytebase-v1-Release-File"></a>
+
+### Release.File
+A SQL file in a release.
-### ListRolesRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| path | [string](#string) | | The path of the file. e.g., `2.2/V0001_create_table.sql`. |
+| version | [string](#string) | | The version identifier for the file. |
+| enable_ghost | [bool](#bool) | | Whether to use gh-ost for online schema migration. |
+| sheet | [string](#string) | | For inputs, we must either use `sheet` or `statement`. For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
+The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
+| statement | [bytes](#bytes) | | The raw SQL statement content. |
+| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet content or the statement. |
-<a name="bytebase-v1-ListRolesResponse"></a>
-### ListRolesResponse
+<a name="bytebase-v1-Release-VCSSource"></a>
+### Release.VCSSource
+Version control system source information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [Role](#bytebase-v1-Role) | repeated | The roles from the specified request. |
+| vcs_type | [VCSType](#bytebase-v1-VCSType) | | The type of VCS. |
+| url | [string](#string) | | The url link to the e.g., GitHub commit or pull request. |
-<a name="bytebase-v1-Role"></a>
+<a name="bytebase-v1-UndeleteReleaseRequest"></a>
+
+### UndeleteReleaseRequest
-### Role
-Role defines a set of permissions that can be assigned to users.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Resource name. Format: roles/{role} |
-| title | [string](#string) | | Human-readable title. |
-| description | [string](#string) | | Optional description of the role. |
-| permissions | [string](#string) | repeated | List of permission identifiers granted by this role. |
-| type | [Role.Type](#bytebase-v1-Role-Type) | | Role type indicating if it&#39;s built-in or custom. |
+| name | [string](#string) | | The name of the deleted release. Format: projects/{project}/releases/{release} |
-<a name="bytebase-v1-UpdateRoleRequest"></a>
+<a name="bytebase-v1-UpdateReleaseRequest"></a>
-### UpdateRoleRequest
+### UpdateReleaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| role | [Role](#bytebase-v1-Role) | | The role to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the role is not found, a new role will be created. In this situation, `update_mask` is ignored. |
+| release | [Release](#bytebase-v1-Release) | | The release to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. |
@@ -8500,16 +8555,16 @@ Role defines a set of permissions that can be assigned to users.
-<a name="bytebase-v1-Role-Type"></a>
-
-### Role.Type
+<a name="bytebase-v1-Release-Type"></a>
+### Release.Type
+The type of schema change.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| BUILT_IN | 1 | System-defined role that cannot be modified. |
-| CUSTOM | 2 | User-defined role that can be modified. |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| VERSIONED | 1 | Versioned schema migration. |
+| DECLARATIVE | 2 | Declarative schema definition. |
@@ -8517,1523 +8572,1471 @@ Role defines a set of permissions that can be assigned to users.
-<a name="bytebase-v1-RoleService"></a>
+<a name="bytebase-v1-ReleaseService"></a>
-### RoleService
-RoleService manages workspace roles and permissions.
+### ReleaseService
+ReleaseService manages releases for coordinating deployments.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| ListRoles | [ListRolesRequest](#bytebase-v1-ListRolesRequest) | [ListRolesResponse](#bytebase-v1-ListRolesResponse) | Lists roles in the workspace. Permissions required: bb.roles.list |
-| GetRole | [GetRoleRequest](#bytebase-v1-GetRoleRequest) | [Role](#bytebase-v1-Role) | Retrieves a role by name. Permissions required: bb.roles.get |
-| CreateRole | [CreateRoleRequest](#bytebase-v1-CreateRoleRequest) | [Role](#bytebase-v1-Role) | Creates a new custom role. Permissions required: bb.roles.create |
-| UpdateRole | [UpdateRoleRequest](#bytebase-v1-UpdateRoleRequest) | [Role](#bytebase-v1-Role) | Updates a role&#39;s properties. Permissions required: bb.roles.update When allow_missing=true, also requires: bb.roles.create |
-| DeleteRole | [DeleteRoleRequest](#bytebase-v1-DeleteRoleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a custom role. Permissions required: bb.roles.delete |
+| GetRelease | [GetReleaseRequest](#bytebase-v1-GetReleaseRequest) | [Release](#bytebase-v1-Release) | Retrieves a release by name. Permissions required: bb.releases.get |
+| ListReleases | [ListReleasesRequest](#bytebase-v1-ListReleasesRequest) | [ListReleasesResponse](#bytebase-v1-ListReleasesResponse) | Lists releases in a project. Permissions required: bb.releases.list |
+| CreateRelease | [CreateReleaseRequest](#bytebase-v1-CreateReleaseRequest) | [Release](#bytebase-v1-Release) | Creates a new release with SQL files. Permissions required: bb.releases.create |
+| UpdateRelease | [UpdateReleaseRequest](#bytebase-v1-UpdateReleaseRequest) | [Release](#bytebase-v1-Release) | Updates an existing release. Permissions required: bb.releases.update When allow_missing=true, also requires: bb.releases.create |
+| DeleteRelease | [DeleteReleaseRequest](#bytebase-v1-DeleteReleaseRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a release. Permissions required: bb.releases.delete |
+| UndeleteRelease | [UndeleteReleaseRequest](#bytebase-v1-UndeleteReleaseRequest) | [Release](#bytebase-v1-Release) | Restores a deleted release. Permissions required: bb.releases.undelete |
+| CheckRelease | [CheckReleaseRequest](#bytebase-v1-CheckReleaseRequest) | [CheckReleaseResponse](#bytebase-v1-CheckReleaseResponse) | Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check |
+| ListReleaseCategories | [ListReleaseCategoriesRequest](#bytebase-v1-ListReleaseCategoriesRequest) | [ListReleaseCategoriesResponse](#bytebase-v1-ListReleaseCategoriesResponse) | Lists all unique categories in a project. Permissions required: bb.releases.list |
-<a name="v1_rollout_service-proto"></a>
+<a name="v1_review_config_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/rollout_service.proto
-
-
-
-<a name="bytebase-v1-BatchCancelTaskRunsRequest"></a>
-
-### BatchCancelTaskRunsRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The task name for the taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. |
-| task_runs | [string](#string) | repeated | The taskRuns to cancel. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-
-
-
-
-
-
-<a name="bytebase-v1-BatchCancelTaskRunsResponse"></a>
-
-### BatchCancelTaskRunsResponse
-
-
-
-
-
-
-
-<a name="bytebase-v1-BatchRunTasksRequest"></a>
-
-### BatchRunTasksRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
-| tasks | [string](#string) | repeated | The tasks to run. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
-| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. |
-
+## v1/review_config_service.proto
+<a name="bytebase-v1-CreateReviewConfigRequest"></a>
+### CreateReviewConfigRequest
-<a name="bytebase-v1-BatchRunTasksResponse"></a>
-### BatchRunTasksResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to create. |
-<a name="bytebase-v1-BatchSkipTasksRequest"></a>
+<a name="bytebase-v1-DeleteReviewConfigRequest"></a>
-### BatchSkipTasksRequest
+### DeleteReviewConfigRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
-| tasks | [string](#string) | repeated | The tasks to skip. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
-| reason | [string](#string) | | The reason for skipping the tasks. |
+| name | [string](#string) | | The name of the SQL review config to delete. Format: reviewConfigs/{reviewConfig} |
-<a name="bytebase-v1-BatchSkipTasksResponse"></a>
+<a name="bytebase-v1-GetReviewConfigRequest"></a>
-### BatchSkipTasksResponse
+### GetReviewConfigRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the SQL review config to retrieve. Format: reviewConfigs/{reviewConfig} |
-<a name="bytebase-v1-CreateRolloutRequest"></a>
-### CreateRolloutRequest
+<a name="bytebase-v1-ListReviewConfigsRequest"></a>
+### ListReviewConfigsRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent plan for which this rollout will be created. Format: projects/{project}/plans/{plan} |
-| target | [string](#string) | optional | Create the rollout only for the specified target. Format: environments/{environment} If unspecified, all stages are created. If set to &#34;&#34;, no stages are created. |
-<a name="bytebase-v1-GetRolloutRequest"></a>
+<a name="bytebase-v1-ListReviewConfigsResponse"></a>
-### GetRolloutRequest
+### ListReviewConfigsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the rollout to retrieve. This is the rollout resource name, which is the plan name plus /rollout suffix. Format: projects/{project}/plans/{plan}/rollout |
+| review_configs | [ReviewConfig](#bytebase-v1-ReviewConfig) | repeated | The SQL review configs from the specified request. |
-<a name="bytebase-v1-GetTaskRunLogRequest"></a>
+<a name="bytebase-v1-ReviewConfig"></a>
-### GetTaskRunLogRequest
+### ReviewConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-
+| name | [string](#string) | | The name of the SQL review config. Format: reviewConfigs/{reviewConfig} |
+| title | [string](#string) | | The title of the review configuration. |
+| enabled | [bool](#bool) | | Whether the review configuration is enabled. |
+| rules | [SQLReviewRule](#bytebase-v1-SQLReviewRule) | repeated | The SQL review rules to enforce. |
+| resources | [string](#string) | repeated | Resources using the config. Format: {resource}/{resource id}, e.g., environments/test. |
-<a name="bytebase-v1-GetTaskRunRequest"></a>
-### GetTaskRunRequest
+<a name="bytebase-v1-SQLReviewRule"></a>
+### SQLReviewRule
+SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| type | [SQLReviewRule.Type](#bytebase-v1-SQLReviewRule-Type) | | The type of SQL review rule. |
+| level | [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level) | | The severity level of the rule. |
+| naming_payload | [SQLReviewRule.NamingRulePayload](#bytebase-v1-SQLReviewRule-NamingRulePayload) | | |
+| number_payload | [SQLReviewRule.NumberRulePayload](#bytebase-v1-SQLReviewRule-NumberRulePayload) | | |
+| string_array_payload | [SQLReviewRule.StringArrayRulePayload](#bytebase-v1-SQLReviewRule-StringArrayRulePayload) | | |
+| comment_convention_payload | [SQLReviewRule.CommentConventionRulePayload](#bytebase-v1-SQLReviewRule-CommentConventionRulePayload) | | |
+| string_payload | [SQLReviewRule.StringRulePayload](#bytebase-v1-SQLReviewRule-StringRulePayload) | | |
+| naming_case_payload | [SQLReviewRule.NamingCaseRulePayload](#bytebase-v1-SQLReviewRule-NamingCaseRulePayload) | | |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |
-<a name="bytebase-v1-GetTaskRunSessionRequest"></a>
+<a name="bytebase-v1-SQLReviewRule-CommentConventionRulePayload"></a>
-### GetTaskRunSessionRequest
+### SQLReviewRule.CommentConventionRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| required | [bool](#bool) | | |
+| max_length | [int32](#int32) | | |
-<a name="bytebase-v1-ListRolloutsRequest"></a>
+<a name="bytebase-v1-SQLReviewRule-NamingCaseRulePayload"></a>
-### ListRolloutsRequest
+### SQLReviewRule.NamingCaseRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of rollouts. Format: projects/{project} Use &#34;projects/-&#34; to list all rollouts from all projects. |
-| page_size | [int32](#int32) | | The maximum number of rollouts to return. The service may return fewer than this value. If unspecified, at most 10 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token. |
-| filter | [string](#string) | | Filter is used to filter rollouts returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters: - update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
-
-For example: update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] |
-
+| upper | [bool](#bool) | | |
-<a name="bytebase-v1-ListRolloutsResponse"></a>
-### ListRolloutsResponse
+<a name="bytebase-v1-SQLReviewRule-NamingRulePayload"></a>
+### SQLReviewRule.NamingRulePayload
+Payload message types for SQL review rules
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| rollouts | [Rollout](#bytebase-v1-Rollout) | repeated | The rollouts from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| max_length | [int32](#int32) | | |
+| format | [string](#string) | | |
-<a name="bytebase-v1-ListTaskRunsRequest"></a>
+<a name="bytebase-v1-SQLReviewRule-NumberRulePayload"></a>
-### ListTaskRunsRequest
+### SQLReviewRule.NumberRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent, which owns this collection of taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. |
+| number | [int32](#int32) | | |
-<a name="bytebase-v1-ListTaskRunsResponse"></a>
+<a name="bytebase-v1-SQLReviewRule-StringArrayRulePayload"></a>
-### ListTaskRunsResponse
+### SQLReviewRule.StringArrayRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| task_runs | [TaskRun](#bytebase-v1-TaskRun) | repeated | The taskRuns from the specified request. |
+| list | [string](#string) | repeated | |
-<a name="bytebase-v1-PreviewTaskRunRollbackRequest"></a>
+<a name="bytebase-v1-SQLReviewRule-StringRulePayload"></a>
-### PreviewTaskRunRollbackRequest
+### SQLReviewRule.StringRulePayload
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| value | [string](#string) | | |
-<a name="bytebase-v1-PreviewTaskRunRollbackResponse"></a>
+<a name="bytebase-v1-UpdateReviewConfigRequest"></a>
-### PreviewTaskRunRollbackResponse
+### UpdateReviewConfigRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| statement | [string](#string) | | The rollback SQL statement that would undo the task run. |
-
-
-
-
+| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to update.
+The name field is used to identify the SQL review config to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the config is not found, a new config will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-Rollout"></a>
-### Rollout
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the rollout. Format: projects/{project}/plans/{plan}/rollout |
-| title | [string](#string) | | The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set. |
-| stages | [Stage](#bytebase-v1-Stage) | repeated | Stages and thus tasks of the rollout. |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+
+<a name="bytebase-v1-SQLReviewRule-Level"></a>
+### SQLReviewRule.Level
+The severity level for SQL review rules.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| LEVEL_UNSPECIFIED | 0 | Unspecified level. |
+| ERROR | 1 | Rule violation is an error. |
+| WARNING | 2 | Rule violation is a warning. |
-<a name="bytebase-v1-Stage"></a>
-### Stage
+<a name="bytebase-v1-SQLReviewRule-Type"></a>
+### SQLReviewRule.Type
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage} Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. |
-| id | [string](#string) | | id is the environment id of the stage. e.g., &#34;prod&#34;. Use &#34;-&#34; when the stage has no environment or deleted environment. |
-| environment | [string](#string) | | environment is the environment of the stage. Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. |
-| tasks | [Task](#bytebase-v1-Task) | repeated | The tasks within this stage. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| ENGINE_MYSQL_USE_INNODB | 1 | |
+| NAMING_FULLY_QUALIFIED | 2 | |
+| NAMING_TABLE | 3 | |
+| NAMING_COLUMN | 4 | |
+| NAMING_INDEX_PK | 5 | |
+| NAMING_INDEX_UK | 6 | |
+| NAMING_INDEX_FK | 7 | |
+| NAMING_INDEX_IDX | 8 | |
+| NAMING_COLUMN_AUTO_INCREMENT | 9 | |
+| NAMING_TABLE_NO_KEYWORD | 10 | |
+| NAMING_IDENTIFIER_NO_KEYWORD | 11 | |
+| NAMING_IDENTIFIER_CASE | 12 | |
+| STATEMENT_SELECT_NO_SELECT_ALL | 13 | |
+| STATEMENT_WHERE_REQUIRE_SELECT | 14 | |
+| STATEMENT_WHERE_REQUIRE_UPDATE_DELETE | 15 | |
+| STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE | 16 | |
+| STATEMENT_DISALLOW_ON_DEL_CASCADE | 17 | |
+| STATEMENT_DISALLOW_RM_TBL_CASCADE | 18 | |
+| STATEMENT_DISALLOW_COMMIT | 19 | |
+| STATEMENT_DISALLOW_LIMIT | 20 | |
+| STATEMENT_DISALLOW_ORDER_BY | 21 | |
+| STATEMENT_MERGE_ALTER_TABLE | 22 | |
+| STATEMENT_INSERT_ROW_LIMIT | 23 | |
+| STATEMENT_INSERT_MUST_SPECIFY_COLUMN | 24 | |
+| STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND | 25 | |
+| STATEMENT_AFFECTED_ROW_LIMIT | 26 | |
+| STATEMENT_DML_DRY_RUN | 27 | |
+| STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT | 28 | |
+| STATEMENT_ADD_CHECK_NOT_VALID | 29 | |
+| STATEMENT_ADD_FOREIGN_KEY_NOT_VALID | 30 | |
+| STATEMENT_DISALLOW_ADD_NOT_NULL | 31 | |
+| STATEMENT_SELECT_FULL_TABLE_SCAN | 32 | |
+| STATEMENT_CREATE_SPECIFY_SCHEMA | 33 | |
+| STATEMENT_CHECK_SET_ROLE_VARIABLE | 34 | |
+| STATEMENT_DISALLOW_USING_FILESORT | 35 | |
+| STATEMENT_DISALLOW_USING_TEMPORARY | 36 | |
+| STATEMENT_WHERE_NO_EQUAL_NULL | 37 | |
+| STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS | 38 | |
+| STATEMENT_QUERY_MINIMUM_PLAN_LEVEL | 39 | |
+| STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT | 40 | |
+| STATEMENT_MAXIMUM_LIMIT_VALUE | 41 | |
+| STATEMENT_MAXIMUM_JOIN_TABLE_COUNT | 42 | |
+| STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION | 43 | |
+| STATEMENT_JOIN_STRICT_COLUMN_ATTRS | 44 | |
+| STATEMENT_NON_TRANSACTIONAL | 45 | |
+| STATEMENT_ADD_COLUMN_WITHOUT_POSITION | 46 | |
+| STATEMENT_DISALLOW_OFFLINE_DDL | 47 | |
+| STATEMENT_DISALLOW_CROSS_DB_QUERIES | 48 | |
+| STATEMENT_MAX_EXECUTION_TIME | 49 | |
+| STATEMENT_REQUIRE_ALGORITHM_OPTION | 50 | |
+| STATEMENT_REQUIRE_LOCK_OPTION | 51 | |
+| STATEMENT_OBJECT_OWNER_CHECK | 52 | |
+| TABLE_REQUIRE_PK | 53 | |
+| TABLE_NO_FOREIGN_KEY | 54 | |
+| TABLE_DROP_NAMING_CONVENTION | 55 | |
+| TABLE_COMMENT | 56 | |
+| TABLE_DISALLOW_PARTITION | 57 | |
+| TABLE_DISALLOW_TRIGGER | 58 | |
+| TABLE_NO_DUPLICATE_INDEX | 59 | |
+| TABLE_TEXT_FIELDS_TOTAL_LENGTH | 60 | |
+| TABLE_DISALLOW_SET_CHARSET | 61 | |
+| TABLE_DISALLOW_DDL | 62 | |
+| TABLE_DISALLOW_DML | 63 | |
+| TABLE_LIMIT_SIZE | 64 | |
+| TABLE_REQUIRE_CHARSET | 65 | |
+| TABLE_REQUIRE_COLLATION | 66 | |
+| COLUMN_REQUIRED | 67 | |
+| COLUMN_NO_NULL | 68 | |
+| COLUMN_DISALLOW_CHANGE_TYPE | 69 | |
+| COLUMN_SET_DEFAULT_FOR_NOT_NULL | 70 | |
+| COLUMN_DISALLOW_CHANGE | 71 | |
+| COLUMN_DISALLOW_CHANGING_ORDER | 72 | |
+| COLUMN_DISALLOW_DROP | 73 | |
+| COLUMN_DISALLOW_DROP_IN_INDEX | 74 | |
+| COLUMN_COMMENT | 75 | |
+| COLUMN_AUTO_INCREMENT_MUST_INTEGER | 76 | |
+| COLUMN_TYPE_DISALLOW_LIST | 77 | |
+| COLUMN_DISALLOW_SET_CHARSET | 78 | |
+| COLUMN_MAXIMUM_CHARACTER_LENGTH | 79 | |
+| COLUMN_MAXIMUM_VARCHAR_LENGTH | 80 | |
+| COLUMN_AUTO_INCREMENT_INITIAL_VALUE | 81 | |
+| COLUMN_AUTO_INCREMENT_MUST_UNSIGNED | 82 | |
+| COLUMN_CURRENT_TIME_COUNT_LIMIT | 83 | |
+| COLUMN_REQUIRE_DEFAULT | 84 | |
+| COLUMN_DEFAULT_DISALLOW_VOLATILE | 85 | |
+| COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT | 86 | |
+| COLUMN_REQUIRE_CHARSET | 87 | |
+| COLUMN_REQUIRE_COLLATION | 88 | |
+| SCHEMA_BACKWARD_COMPATIBILITY | 89 | |
+| DATABASE_DROP_EMPTY_DATABASE | 90 | |
+| INDEX_NO_DUPLICATE_COLUMN | 91 | |
+| INDEX_KEY_NUMBER_LIMIT | 92 | |
+| INDEX_PK_TYPE_LIMIT | 93 | |
+| INDEX_TYPE_NO_BLOB | 94 | |
+| INDEX_TOTAL_NUMBER_LIMIT | 95 | |
+| INDEX_PRIMARY_KEY_TYPE_ALLOWLIST | 96 | |
+| INDEX_CREATE_CONCURRENTLY | 97 | |
+| INDEX_TYPE_ALLOW_LIST | 98 | |
+| INDEX_NOT_REDUNDANT | 99 | |
+| SYSTEM_CHARSET_ALLOWLIST | 100 | |
+| SYSTEM_COLLATION_ALLOWLIST | 101 | |
+| SYSTEM_COMMENT_LENGTH | 102 | |
+| SYSTEM_PROCEDURE_DISALLOW_CREATE | 103 | |
+| SYSTEM_EVENT_DISALLOW_CREATE | 104 | |
+| SYSTEM_VIEW_DISALLOW_CREATE | 105 | |
+| SYSTEM_FUNCTION_DISALLOW_CREATE | 106 | |
+| SYSTEM_FUNCTION_DISALLOWED_LIST | 107 | |
+| ADVICE_ONLINE_MIGRATION | 108 | |
+| BUILTIN_PRIOR_BACKUP_CHECK | 109 | |
+
+
+<a name="bytebase-v1-ReviewConfigService"></a>
-<a name="bytebase-v1-Task"></a>
+### ReviewConfigService
+ReviewConfigService manages approval flow configurations.
-### Task
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| CreateReviewConfig | [CreateReviewConfigRequest](#bytebase-v1-CreateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Creates a new SQL review configuration. Permissions required: bb.reviewConfigs.create |
+| ListReviewConfigs | [ListReviewConfigsRequest](#bytebase-v1-ListReviewConfigsRequest) | [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse) | Lists all SQL review configurations. Permissions required: bb.reviewConfigs.list |
+| GetReviewConfig | [GetReviewConfigRequest](#bytebase-v1-GetReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Retrieves a SQL review configuration by name. Permissions required: bb.reviewConfigs.get |
+| UpdateReviewConfig | [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest) | [ReviewConfig](#bytebase-v1-ReviewConfig) | Updates a SQL review configuration. Permissions required: bb.reviewConfigs.update When allow_missing=true, also requires: bb.reviewConfigs.create |
+| DeleteReviewConfig | [DeleteReviewConfigRequest](#bytebase-v1-DeleteReviewConfigRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a SQL review configuration. Permissions required: bb.reviewConfigs.delete |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
-| spec_id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. |
-| status | [Task.Status](#bytebase-v1-Task-Status) | | Status is the status of the task. |
-| skipped_reason | [string](#string) | | The reason why the task was skipped. |
-| type | [Task.Type](#bytebase-v1-Task-Type) | | |
-| target | [string](#string) | | Format: instances/{instance} if the task is DatabaseCreate. Format: instances/{instance}/databases/{database} |
-| database_create | [Task.DatabaseCreate](#bytebase-v1-Task-DatabaseCreate) | | |
-| database_update | [Task.DatabaseUpdate](#bytebase-v1-Task-DatabaseUpdate) | | |
-| database_data_export | [Task.DatabaseDataExport](#bytebase-v1-Task-DatabaseDataExport) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The update_time is the update time of latest task run. If there are no task runs, it will be empty. |
-| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The run_time is the scheduled run time of latest task run. If there are no task runs or the task run is not scheduled, it will be empty. |
+<a name="v1_revision_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/revision_service.proto
+<a name="bytebase-v1-BatchCreateRevisionsRequest"></a>
-<a name="bytebase-v1-Task-DatabaseCreate"></a>
+### BatchCreateRevisionsRequest
-### Task.DatabaseCreate
-Payload for creating a new database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
-
-
-
-
-
-
-<a name="bytebase-v1-Task-DatabaseDataExport"></a>
-
-### Task.DatabaseDataExport
-Payload for exporting database data.
-
+| parent | [string](#string) | | The parent resource shared by all revisions being created. Format: instances/{instance}/databases/{database} |
+| requests | [CreateRevisionRequest](#bytebase-v1-CreateRevisionRequest) | repeated | The request message specifying the revisions to create. A maximum of 100 revisions can be created in a batch. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
+<a name="bytebase-v1-BatchCreateRevisionsResponse"></a>
-<a name="bytebase-v1-Task-DatabaseUpdate"></a>
+### BatchCreateRevisionsResponse
-### Task.DatabaseUpdate
-Payload for updating a database schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
-| release | [string](#string) | | Format: projects/{project}/releases/{release} |
+| revisions | [Revision](#bytebase-v1-Revision) | repeated | The created revisions. |
-<a name="bytebase-v1-TaskRun"></a>
+<a name="bytebase-v1-CreateRevisionRequest"></a>
-### TaskRun
+### CreateRevisionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| creator | [string](#string) | | Format: users/[email protected] |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| status | [TaskRun.Status](#bytebase-v1-TaskRun-Status) | | The current execution status of the task run. |
-| detail | [string](#string) | | Below are the results of a task run. Detailed information about the task run result. |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the task run started execution. |
-| export_archive_status | [TaskRun.ExportArchiveStatus](#bytebase-v1-TaskRun-ExportArchiveStatus) | | The export archive status for data export tasks. |
-| has_prior_backup | [bool](#bool) | | Indicates whether a prior backup was created for this task run. When true, rollback SQL can be generated via PreviewTaskRunRollback. Backup details are available in the task run logs. |
-| scheduler_info | [TaskRun.SchedulerInfo](#bytebase-v1-TaskRun-SchedulerInfo) | | Scheduling information about the task run. |
-| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. This can only be set when creating the task run calling BatchRunTasks. |
-
-
-
-
-
-
-<a name="bytebase-v1-TaskRun-SchedulerInfo"></a>
-
-### TaskRun.SchedulerInfo
-Information about task run scheduling.
-
+| parent | [string](#string) | | Format: instances/{instance}/databases/{database} |
+| revision | [Revision](#bytebase-v1-Revision) | | The revision to create. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the scheduling info was reported. |
-| waiting_cause | [TaskRun.SchedulerInfo.WaitingCause](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause) | | The cause for the task run waiting. |
+<a name="bytebase-v1-DeleteRevisionRequest"></a>
-<a name="bytebase-v1-TaskRun-SchedulerInfo-WaitingCause"></a>
+### DeleteRevisionRequest
-### TaskRun.SchedulerInfo.WaitingCause
-Information about why a task run is waiting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parallel_tasks_limit | [bool](#bool) | | Waiting due to parallel tasks limit. |
+| name | [string](#string) | | The name of the revision to delete. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-<a name="bytebase-v1-TaskRunLog"></a>
+<a name="bytebase-v1-GetRevisionRequest"></a>
-### TaskRunLog
+### GetRevisionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log |
-| entries | [TaskRunLogEntry](#bytebase-v1-TaskRunLogEntry) | repeated | The log entries for this task run. |
+| name | [string](#string) | | The name of the revision. Format: instances/{instance}/databases/{database}/revisions/{revision} |
-<a name="bytebase-v1-TaskRunLogEntry"></a>
+<a name="bytebase-v1-ListRevisionsRequest"></a>
-### TaskRunLogEntry
+### ListRevisionsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [TaskRunLogEntry.Type](#bytebase-v1-TaskRunLogEntry-Type) | | The type of this log entry. |
-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the log was recorded. |
-| replica_id | [string](#string) | | The replica ID for this log entry. |
-| schema_dump | [TaskRunLogEntry.SchemaDump](#bytebase-v1-TaskRunLogEntry-SchemaDump) | | Schema dump details (if type is SCHEMA_DUMP). |
-| command_execute | [TaskRunLogEntry.CommandExecute](#bytebase-v1-TaskRunLogEntry-CommandExecute) | | Command execution details (if type is COMMAND_EXECUTE). |
-| database_sync | [TaskRunLogEntry.DatabaseSync](#bytebase-v1-TaskRunLogEntry-DatabaseSync) | | Database sync details (if type is DATABASE_SYNC). |
-| transaction_control | [TaskRunLogEntry.TransactionControl](#bytebase-v1-TaskRunLogEntry-TransactionControl) | | Transaction control details (if type is TRANSACTION_CONTROL). |
-| prior_backup | [TaskRunLogEntry.PriorBackup](#bytebase-v1-TaskRunLogEntry-PriorBackup) | | Prior backup details (if type is PRIOR_BACKUP). |
-| retry_info | [TaskRunLogEntry.RetryInfo](#bytebase-v1-TaskRunLogEntry-RetryInfo) | | Retry information details (if type is RETRY_INFO). |
-| compute_diff | [TaskRunLogEntry.ComputeDiff](#bytebase-v1-TaskRunLogEntry-ComputeDiff) | | Compute diff details (if type is COMPUTE_DIFF). |
-| release_file_execute | [TaskRunLogEntry.ReleaseFileExecute](#bytebase-v1-TaskRunLogEntry-ReleaseFileExecute) | | Release file execution details (if type is RELEASE_FILE_EXECUTE). |
-
-
-
-
-
-
-<a name="bytebase-v1-TaskRunLogEntry-CommandExecute"></a>
-
-### TaskRunLogEntry.CommandExecute
-Command execution details.
+| parent | [string](#string) | | The parent of the revisions. Format: instances/{instance}/databases/{database} |
+| page_size | [int32](#int32) | | The maximum number of revisions to return. The service may return fewer than this value. If unspecified, at most 10 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListRevisions` call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided to `ListRevisions` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Whether to include deleted revisions in the results. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the command was logged. |
-| range | [Range](#bytebase-v1-Range) | | The byte offset range of the executed command in the sheet. Uses byte offsets (not character indices) for efficient slicing of sheet content bytes. Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. |
-| statement | [string](#string) | | The executed statement. |
-| response | [TaskRunLogEntry.CommandExecute.CommandResponse](#bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse) | | The response from executing the command. |
+<a name="bytebase-v1-ListRevisionsResponse"></a>
-<a name="bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse"></a>
+### ListRevisionsResponse
-### TaskRunLogEntry.CommandExecute.CommandResponse
-Command execution response.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the response was logged. |
-| error | [string](#string) | | Error message if command execution failed. |
-| affected_rows | [int64](#int64) | | Total affected rows. |
-| all_affected_rows | [int64](#int64) | repeated | `all_affected_rows` is the affected rows of each command. `all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. |
+| revisions | [Revision](#bytebase-v1-Revision) | repeated | The revisions from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-TaskRunLogEntry-ComputeDiff"></a>
+<a name="bytebase-v1-Revision"></a>
+
+### Revision
-### TaskRunLogEntry.ComputeDiff
-Schema diff computation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation ended. |
-| error | [string](#string) | | Error message if computation failed. |
+| name | [string](#string) | | Format: instances/{instance}/databases/{database}/revisions/{revision} |
+| release | [string](#string) | | Format: projects/{project}/releases/{release} Can be empty. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| deleter | [string](#string) | | Format: users/[email protected] Can be empty. |
+| delete_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Can be empty. |
+| file | [string](#string) | | Format: projects/{project}/releases/{release}/files/{id} Can be empty. |
+| version | [string](#string) | | The schema version string for this revision. |
+| sheet | [string](#string) | | The sheet that holds the content. Format: projects/{project}/sheets/{sheet} |
+| sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet. |
+| task_run | [string](#string) | | The task run associated with the revision. Can be empty. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| type | [Revision.Type](#bytebase-v1-Revision-Type) | | The type of the revision. |
+
-<a name="bytebase-v1-TaskRunLogEntry-DatabaseSync"></a>
-### TaskRunLogEntry.DatabaseSync
-Database synchronization details.
+<a name="bytebase-v1-Revision-Type"></a>
+### Revision.Type
+The type of schema revision.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync ended. |
-| error | [string](#string) | | Error message if sync failed. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| VERSIONED | 1 | Versioned schema migration. |
+| DECLARATIVE | 2 | Declarative schema definition. |
+
+
+<a name="bytebase-v1-RevisionService"></a>
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup"></a>
+### RevisionService
+RevisionService manages schema revision history.
-### TaskRunLogEntry.PriorBackup
-Prior backup operation details.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| ListRevisions | [ListRevisionsRequest](#bytebase-v1-ListRevisionsRequest) | [ListRevisionsResponse](#bytebase-v1-ListRevisionsResponse) | Lists schema revisions for a database. Permissions required: bb.revisions.list |
+| GetRevision | [GetRevisionRequest](#bytebase-v1-GetRevisionRequest) | [Revision](#bytebase-v1-Revision) | Retrieves a schema revision by name. Permissions required: bb.revisions.get |
+| BatchCreateRevisions | [BatchCreateRevisionsRequest](#bytebase-v1-BatchCreateRevisionsRequest) | [BatchCreateRevisionsResponse](#bytebase-v1-BatchCreateRevisionsResponse) | Creates multiple schema revisions in a single operation. Permissions required: bb.revisions.create |
+| DeleteRevision | [DeleteRevisionRequest](#bytebase-v1-DeleteRevisionRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a schema revision. Permissions required: bb.revisions.delete |
+
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup ended. |
-| prior_backup_detail | [TaskRunLogEntry.PriorBackup.PriorBackupDetail](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail) | | The backup details. |
-| error | [string](#string) | | Error message if the backup failed. |
+<a name="v1_role_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/role_service.proto
+<a name="bytebase-v1-CreateRoleRequest"></a>
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail"></a>
+### CreateRoleRequest
-### TaskRunLogEntry.PriorBackup.PriorBackupDetail
-Prior backup detail for rollback purposes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| items | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item) | repeated | The list of backed up tables. |
+| role | [Role](#bytebase-v1-Role) | | The role to create. |
+| role_id | [string](#string) | | The ID to use for the role, which will become the final component of the role&#39;s resource name.
+This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]/. |
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item"></a>
-### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item
-A single backup table mapping.
+<a name="bytebase-v1-DeleteRoleRequest"></a>
+
+### DeleteRoleRequest
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| source_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The original table information. |
-| target_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The target backup table information. |
-| start_position | [Position](#bytebase-v1-Position) | | The start position in the SQL statement. |
-| end_position | [Position](#bytebase-v1-Position) | | The end position in the SQL statement. |
+| name | [string](#string) | | The name of the role to delete. Format: roles/{role} |
-<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table"></a>
+<a name="bytebase-v1-GetRoleRequest"></a>
+
+### GetRoleRequest
-### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table
-Table information.
| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| database | [string](#string) | | The database information. Format: instances/{instance}/databases/{database} |
-| schema | [string](#string) | | The schema name. |
-| table | [string](#string) | | The table name. |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the role to retrieve. Format: roles/{role} |
-<a name="bytebase-v1-TaskRunLogEntry-ReleaseFileExecute"></a>
+<a name="bytebase-v1-ListRolesRequest"></a>
-### TaskRunLogEntry.ReleaseFileExecute
-Release file execution details.
+### ListRolesRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| version | [string](#string) | | The version of the file being executed (e.g., &#34;0001&#34;). |
-| file_path | [string](#string) | | The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). |
+<a name="bytebase-v1-ListRolesResponse"></a>
-<a name="bytebase-v1-TaskRunLogEntry-RetryInfo"></a>
+### ListRolesResponse
-### TaskRunLogEntry.RetryInfo
-Retry information for failed operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| error | [string](#string) | | The error that triggered the retry. |
-| retry_count | [int32](#int32) | | Current retry attempt number. |
-| maximum_retries | [int32](#int32) | | Maximum number of retries allowed. |
+| roles | [Role](#bytebase-v1-Role) | repeated | The roles from the specified request. |
-<a name="bytebase-v1-TaskRunLogEntry-SchemaDump"></a>
+<a name="bytebase-v1-Role"></a>
-### TaskRunLogEntry.SchemaDump
-Schema dump operation details.
+### Role
+Role defines a set of permissions that can be assigned to users.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump started. |
-| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump ended. |
-| error | [string](#string) | | Error message if the schema dump failed. |
+| name | [string](#string) | | Resource name. Format: roles/{role} |
+| title | [string](#string) | | Human-readable title. |
+| description | [string](#string) | | Optional description of the role. |
+| permissions | [string](#string) | repeated | List of permission identifiers granted by this role. |
+| type | [Role.Type](#bytebase-v1-Role-Type) | | Role type indicating if it&#39;s built-in or custom. |
-<a name="bytebase-v1-TaskRunLogEntry-TransactionControl"></a>
+<a name="bytebase-v1-UpdateRoleRequest"></a>
+
+### UpdateRoleRequest
-### TaskRunLogEntry.TransactionControl
-Transaction control operation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [TaskRunLogEntry.TransactionControl.Type](#bytebase-v1-TaskRunLogEntry-TransactionControl-Type) | | The type of transaction control. |
-| error | [string](#string) | | Error message if the operation failed. |
+| role | [Role](#bytebase-v1-Role) | | The role to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the role is not found, a new role will be created. In this situation, `update_mask` is ignored. |
+
-<a name="bytebase-v1-TaskRunSession"></a>
-### TaskRunSession
+<a name="bytebase-v1-Role-Type"></a>
+### Role.Type
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session |
-| postgres | [TaskRunSession.Postgres](#bytebase-v1-TaskRunSession-Postgres) | | PostgreSQL session information. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| BUILT_IN | 1 | System-defined role that cannot be modified. |
+| CUSTOM | 2 | User-defined role that can be modified. |
+
+
+<a name="bytebase-v1-RoleService"></a>
-<a name="bytebase-v1-TaskRunSession-Postgres"></a>
+### RoleService
+RoleService manages workspace roles and permissions.
-### TaskRunSession.Postgres
-PostgreSQL session information.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| ListRoles | [ListRolesRequest](#bytebase-v1-ListRolesRequest) | [ListRolesResponse](#bytebase-v1-ListRolesResponse) | Lists roles in the workspace. Permissions required: bb.roles.list |
+| GetRole | [GetRoleRequest](#bytebase-v1-GetRoleRequest) | [Role](#bytebase-v1-Role) | Retrieves a role by name. Permissions required: bb.roles.get |
+| CreateRole | [CreateRoleRequest](#bytebase-v1-CreateRoleRequest) | [Role](#bytebase-v1-Role) | Creates a new custom role. Permissions required: bb.roles.create |
+| UpdateRole | [UpdateRoleRequest](#bytebase-v1-UpdateRoleRequest) | [Role](#bytebase-v1-Role) | Updates a role&#39;s properties. Permissions required: bb.roles.update When allow_missing=true, also requires: bb.roles.create |
+| DeleteRole | [DeleteRoleRequest](#bytebase-v1-DeleteRoleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a custom role. Permissions required: bb.roles.delete |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| session | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | | `session` is the session of the task run executing commands. |
-| blocking_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocking_sessions` block `session`. |
-| blocked_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocked_sessions` are blocked by `session`. |
+<a name="v1_rollout_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/rollout_service.proto
-<a name="bytebase-v1-TaskRunSession-Postgres-Session"></a>
+<a name="bytebase-v1-BatchCancelTaskRunsRequest"></a>
+
+### BatchCancelTaskRunsRequest
-### TaskRunSession.Postgres.Session
-PostgreSQL session information read from `pg_stat_activity`.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| pid | [string](#string) | | Process ID of the session. |
-| blocked_by_pids | [string](#string) | repeated | PIDs of sessions blocking this session. |
-| query | [string](#string) | | Current query being executed. |
-| state | [string](#string) | optional | Session state (active, idle, etc.). |
-| wait_event_type | [string](#string) | optional | Wait event type if session is waiting. |
-| wait_event | [string](#string) | optional | Specific wait event if session is waiting. |
-| datname | [string](#string) | optional | Database name. |
-| usename | [string](#string) | optional | User name. |
-| application_name | [string](#string) | | Application name. |
-| client_addr | [string](#string) | optional | Client IP address. |
-| client_port | [string](#string) | optional | Client port number. |
-| backend_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backend process started. |
-| xact_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current transaction started. |
-| query_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current query started. |
-
-
-
+| parent | [string](#string) | | The task name for the taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. |
+| task_runs | [string](#string) | repeated | The taskRuns to cancel. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-
-<a name="bytebase-v1-Task-Status"></a>
-### Task.Status
+<a name="bytebase-v1-BatchCancelTaskRunsResponse"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| NOT_STARTED | 1 | Task has not started and is awaiting its turn in the deployment sequence. |
-| PENDING | 2 | Task is ready to run and waiting for approval or scheduled time. |
-| RUNNING | 3 | Task is currently executing. |
-| DONE | 4 | Task completed successfully. |
-| FAILED | 5 | Task execution failed with errors. |
-| CANCELED | 6 | Task execution was canceled by a user. |
-| SKIPPED | 7 | Task was skipped and will not be executed. |
+### BatchCancelTaskRunsResponse
-<a name="bytebase-v1-Task-Type"></a>
-### Task.Type
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified task type. |
-| GENERAL | 1 | General task for miscellaneous operations. |
-| DATABASE_CREATE | 2 | Database creation task that creates a new database. Use payload DatabaseCreate. |
-| DATABASE_MIGRATE | 3 | Database migration task that applies versioned schema changes. Use payload DatabaseUpdate. |
-| DATABASE_EXPORT | 4 | Database export task that exports query results or table data. Use payload DatabaseDataExport. |
+<a name="bytebase-v1-BatchRunTasksRequest"></a>
+### BatchRunTasksRequest
-<a name="bytebase-v1-TaskRun-ExportArchiveStatus"></a>
-### TaskRun.ExportArchiveStatus
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
+| tasks | [string](#string) | repeated | The tasks to run. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
+| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| EXPORT_ARCHIVE_STATUS_UNSPECIFIED | 0 | Unspecified export archive status. |
-| READY | 1 | Export archive is ready for download. |
-| EXPORTED | 2 | Export archive has been downloaded by the user. |
-<a name="bytebase-v1-TaskRun-Status"></a>
-### TaskRun.Status
+<a name="bytebase-v1-BatchRunTasksResponse"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Task run is queued and waiting to start execution. |
-| RUNNING | 2 | Task run is currently executing. |
-| DONE | 3 | Task run completed successfully. |
-| FAILED | 4 | Task run execution failed with errors. |
-| CANCELED | 5 | Task run execution was canceled by a user. |
-| AVAILABLE | 6 | Task run is ready for immediate execution. |
+### BatchRunTasksResponse
-<a name="bytebase-v1-TaskRunLogEntry-TransactionControl-Type"></a>
-### TaskRunLogEntry.TransactionControl.Type
-Transaction control type.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| BEGIN | 1 | Begin transaction. |
-| COMMIT | 2 | Commit transaction. |
-| ROLLBACK | 3 | Rollback transaction. |
+<a name="bytebase-v1-BatchSkipTasksRequest"></a>
-<a name="bytebase-v1-TaskRunLogEntry-Type"></a>
+### BatchSkipTasksRequest
-### TaskRunLogEntry.Type
-The type of log entry.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| SCHEMA_DUMP | 1 | Schema dump operation. |
-| COMMAND_EXECUTE | 2 | Command execution. |
-| DATABASE_SYNC | 3 | Database synchronization. |
-| TRANSACTION_CONTROL | 5 | Transaction control (BEGIN, COMMIT, ROLLBACK). |
-| PRIOR_BACKUP | 6 | Prior backup operation. |
-| RETRY_INFO | 7 | Retry information. |
-| COMPUTE_DIFF | 8 | Schema diff computation. |
-| RELEASE_FILE_EXECUTE | 9 | Release file execution. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The stage name for the tasks. Format: projects/{project}/plans/{plan}/rollout/stages/{stage} |
+| tasks | [string](#string) | repeated | The tasks to skip. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
+| reason | [string](#string) | | The reason for skipping the tasks. |
-
-
-<a name="bytebase-v1-RolloutService"></a>
-### RolloutService
-RolloutService manages the execution of deployment plans.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetRollout | [GetRolloutRequest](#bytebase-v1-GetRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Retrieves a rollout by its plan name. Permissions required: bb.rollouts.get |
-| ListRollouts | [ListRolloutsRequest](#bytebase-v1-ListRolloutsRequest) | [ListRolloutsResponse](#bytebase-v1-ListRolloutsResponse) | Lists rollouts in a project. Permissions required: bb.rollouts.list |
-| CreateRollout | [CreateRolloutRequest](#bytebase-v1-CreateRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Creates a new rollout for a plan. Permissions required: bb.rollouts.create |
-| ListTaskRuns | [ListTaskRunsRequest](#bytebase-v1-ListTaskRunsRequest) | [ListTaskRunsResponse](#bytebase-v1-ListTaskRunsResponse) | Lists task run executions for a task. Permissions required: bb.taskRuns.list |
-| GetTaskRun | [GetTaskRunRequest](#bytebase-v1-GetTaskRunRequest) | [TaskRun](#bytebase-v1-TaskRun) | Retrieves a task run by name. Permissions required: bb.taskRuns.list |
-| GetTaskRunLog | [GetTaskRunLogRequest](#bytebase-v1-GetTaskRunLogRequest) | [TaskRunLog](#bytebase-v1-TaskRunLog) | Retrieves execution logs for a task run. Permissions required: bb.taskRuns.list |
-| GetTaskRunSession | [GetTaskRunSessionRequest](#bytebase-v1-GetTaskRunSessionRequest) | [TaskRunSession](#bytebase-v1-TaskRunSession) | Retrieves database session information for a running task. Permissions required: bb.taskRuns.list |
-| BatchRunTasks | [BatchRunTasksRequest](#bytebase-v1-BatchRunTasksRequest) | [BatchRunTasksResponse](#bytebase-v1-BatchRunTasksResponse) | Executes multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
-| BatchSkipTasks | [BatchSkipTasksRequest](#bytebase-v1-BatchSkipTasksRequest) | [BatchSkipTasksResponse](#bytebase-v1-BatchSkipTasksResponse) | Skips multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
-| BatchCancelTaskRuns | [BatchCancelTaskRunsRequest](#bytebase-v1-BatchCancelTaskRunsRequest) | [BatchCancelTaskRunsResponse](#bytebase-v1-BatchCancelTaskRunsResponse) | Cancels multiple running task executions. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
-| PreviewTaskRunRollback | [PreviewTaskRunRollbackRequest](#bytebase-v1-PreviewTaskRunRollbackRequest) | [PreviewTaskRunRollbackResponse](#bytebase-v1-PreviewTaskRunRollbackResponse) | Generates rollback SQL for a completed task run. Permissions required: bb.taskRuns.list |
+<a name="bytebase-v1-BatchSkipTasksResponse"></a>
-
+### BatchSkipTasksResponse
-<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-CreateRolloutRequest"></a>
-### AISetting
+### CreateRolloutRequest
| 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) | | |
+| parent | [string](#string) | | The parent plan for which this rollout will be created. Format: projects/{project}/plans/{plan} |
+| target | [string](#string) | optional | Create the rollout only for the specified target. Format: environments/{environment} If unspecified, all stages are created. If set to &#34;&#34;, no stages are created. |
-<a name="bytebase-v1-Algorithm"></a>
+<a name="bytebase-v1-GetRolloutRequest"></a>
-### Algorithm
+### GetRolloutRequest
| 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) | | |
+| name | [string](#string) | | The name of the rollout to retrieve. This is the rollout resource name, which is the plan name plus /rollout suffix. Format: projects/{project}/plans/{plan}/rollout |
-<a name="bytebase-v1-Algorithm-FullMask"></a>
+<a name="bytebase-v1-GetTaskRunLogRequest"></a>
-### Algorithm.FullMask
+### GetTaskRunLogRequest
| 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. |
+| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>
+<a name="bytebase-v1-GetTaskRunRequest"></a>
-### Algorithm.InnerOuterMask
+### GetTaskRunRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| prefix_len | [int32](#int32) | | |
-| suffix_len | [int32](#int32) | | |
-| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |
-| substitution | [string](#string) | | |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-Algorithm-MD5Mask"></a>
+<a name="bytebase-v1-GetTaskRunSessionRequest"></a>
-### Algorithm.MD5Mask
+### GetTaskRunSessionRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |
+| parent | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-Algorithm-RangeMask"></a>
+<a name="bytebase-v1-ListRolloutsRequest"></a>
-### Algorithm.RangeMask
+### ListRolloutsRequest
| 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. |
+| parent | [string](#string) | | The parent, which owns this collection of rollouts. Format: projects/{project} Use &#34;projects/-&#34; to list all rollouts from all projects. |
+| page_size | [int32](#int32) | | The maximum number of rollouts to return. The service may return fewer than this value. If unspecified, at most 10 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter rollouts returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters: - update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator. - task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
+For example: update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] |
-<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>
-### Algorithm.RangeMask.Slice
+<a name="bytebase-v1-ListRolloutsResponse"></a>
+
+### ListRolloutsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start | [int32](#int32) | | start is the start character index (0-based) of the original value, should be less than end. Uses character indices (not byte offsets) for display-oriented masking. Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). |
-| end | [int32](#int32) | | end is the end character index (exclusive) of the original value. Uses character indices (not byte offsets) for display-oriented masking. |
-| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |
+| rollouts | [Rollout](#bytebase-v1-Rollout) | repeated | The rollouts from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-Announcement"></a>
+<a name="bytebase-v1-ListTaskRunsRequest"></a>
-### Announcement
+### ListTaskRunsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [Announcement.AlertLevel](#bytebase-v1-Announcement-AlertLevel) | | The alert level of announcement |
-| text | [string](#string) | | The text of announcement |
-| link | [string](#string) | | The optional link, user can follow the link to check extra details |
+| parent | [string](#string) | | The parent, which owns this collection of taskRuns. Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. |
-<a name="bytebase-v1-AppIMSetting"></a>
+<a name="bytebase-v1-ListTaskRunsResponse"></a>
-### AppIMSetting
+### ListTaskRunsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |
+| task_runs | [TaskRun](#bytebase-v1-TaskRun) | repeated | The taskRuns from the specified request. |
-<a name="bytebase-v1-AppIMSetting-DingTalk"></a>
+<a name="bytebase-v1-PreviewTaskRunRollbackRequest"></a>
-### AppIMSetting.DingTalk
+### PreviewTaskRunRollbackRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| client_id | [string](#string) | | |
-| client_secret | [string](#string) | | |
-| robot_code | [string](#string) | | |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-<a name="bytebase-v1-AppIMSetting-Feishu"></a>
+<a name="bytebase-v1-PreviewTaskRunRollbackResponse"></a>
-### AppIMSetting.Feishu
+### PreviewTaskRunRollbackResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| app_id | [string](#string) | | |
-| app_secret | [string](#string) | | |
+| statement | [string](#string) | | The rollback SQL statement that would undo the task run. |
-<a name="bytebase-v1-AppIMSetting-IMSetting"></a>
+<a name="bytebase-v1-Rollout"></a>
-### AppIMSetting.IMSetting
+### Rollout
| 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) | | |
+| name | [string](#string) | | The resource name of the rollout. Format: projects/{project}/plans/{plan}/rollout |
+| title | [string](#string) | | The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set. |
+| stages | [Stage](#bytebase-v1-Stage) | repeated | Stages and thus tasks of the rollout. |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-<a name="bytebase-v1-AppIMSetting-Lark"></a>
+<a name="bytebase-v1-Stage"></a>
-### AppIMSetting.Lark
+### Stage
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| app_id | [string](#string) | | |
-| app_secret | [string](#string) | | |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage} Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. |
+| id | [string](#string) | | id is the environment id of the stage. e.g., &#34;prod&#34;. Use &#34;-&#34; when the stage has no environment or deleted environment. |
+| environment | [string](#string) | | environment is the environment of the stage. Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. |
+| tasks | [Task](#bytebase-v1-Task) | repeated | The tasks within this stage. |
-<a name="bytebase-v1-AppIMSetting-Slack"></a>
+<a name="bytebase-v1-Task"></a>
-### AppIMSetting.Slack
+### Task
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | |
-
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} |
+| spec_id | [string](#string) | | A UUID4 string that uniquely identifies the Spec. |
+| status | [Task.Status](#bytebase-v1-Task-Status) | | Status is the status of the task. |
+| skipped_reason | [string](#string) | | The reason why the task was skipped. |
+| type | [Task.Type](#bytebase-v1-Task-Type) | | |
+| target | [string](#string) | | Format: instances/{instance} if the task is DatabaseCreate. Format: instances/{instance}/databases/{database} |
+| database_create | [Task.DatabaseCreate](#bytebase-v1-Task-DatabaseCreate) | | |
+| database_update | [Task.DatabaseUpdate](#bytebase-v1-Task-DatabaseUpdate) | | |
+| database_data_export | [Task.DatabaseDataExport](#bytebase-v1-Task-DatabaseDataExport) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The update_time is the update time of latest task run. If there are no task runs, it will be empty. |
+| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The run_time is the scheduled run time of latest task run. If there are no task runs or the task run is not scheduled, it will be empty. |
-<a name="bytebase-v1-AppIMSetting-Teams"></a>
-### AppIMSetting.Teams
+<a name="bytebase-v1-Task-DatabaseCreate"></a>
+### Task.DatabaseCreate
+Payload for creating a new database.
| 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. |
-
+| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
-<a name="bytebase-v1-AppIMSetting-Wecom"></a>
-### AppIMSetting.Wecom
+<a name="bytebase-v1-Task-DatabaseDataExport"></a>
+### Task.DatabaseDataExport
+Payload for exporting database data.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| corp_id | [string](#string) | | |
-| agent_id | [string](#string) | | |
-| secret | [string](#string) | | |
-
+| sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} |
-<a name="bytebase-v1-DataClassificationSetting"></a>
-### DataClassificationSetting
+<a name="bytebase-v1-Task-DatabaseUpdate"></a>
+### Task.DatabaseUpdate
+Payload for updating a database schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |
+| sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} |
+| release | [string](#string) | | Format: projects/{project}/releases/{release} |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>
+<a name="bytebase-v1-TaskRun"></a>
-### DataClassificationSetting.DataClassificationConfig
+### TaskRun
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | id is the uuid for classification. Each project can chose one classification config. |
-| title | [string](#string) | | |
-| levels | [DataClassificationSetting.DataClassificationConfig.Level](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level) | repeated | levels is user defined level list for classification. The order for the level decides its priority. |
-| classification | [DataClassificationSetting.DataClassificationConfig.ClassificationEntry](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry) | repeated | classification is the id - DataClassification map. The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
-
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| creator | [string](#string) | | Format: users/[email protected] |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| status | [TaskRun.Status](#bytebase-v1-TaskRun-Status) | | The current execution status of the task run. |
+| detail | [string](#string) | | Below are the results of a task run. Detailed information about the task run result. |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the task run started execution. |
+| export_archive_status | [TaskRun.ExportArchiveStatus](#bytebase-v1-TaskRun-ExportArchiveStatus) | | The export archive status for data export tasks. |
+| has_prior_backup | [bool](#bool) | | Indicates whether a prior backup was created for this task run. When true, rollback SQL can be generated via PreviewTaskRunRollback. Backup details are available in the task run logs. |
+| scheduler_info | [TaskRun.SchedulerInfo](#bytebase-v1-TaskRun-SchedulerInfo) | | Scheduling information about the task run. |
+| run_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | The task run should run after run_time. This can only be set when creating the task run calling BatchRunTasks. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>
-### DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+<a name="bytebase-v1-TaskRun-SchedulerInfo"></a>
+### TaskRun.SchedulerInfo
+Information about task run scheduling.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |
-
+| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the scheduling info was reported. |
+| waiting_cause | [TaskRun.SchedulerInfo.WaitingCause](#bytebase-v1-TaskRun-SchedulerInfo-WaitingCause) | | The cause for the task run waiting. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>
-### DataClassificationSetting.DataClassificationConfig.DataClassification
+<a name="bytebase-v1-TaskRun-SchedulerInfo-WaitingCause"></a>
+### TaskRun.SchedulerInfo.WaitingCause
+Information about why a task run is waiting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. |
-| title | [string](#string) | | |
-| description | [string](#string) | | |
-| level_id | [string](#string) | optional | |
+| parallel_tasks_limit | [bool](#bool) | | Waiting due to parallel tasks limit. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>
+<a name="bytebase-v1-TaskRunLog"></a>
-### DataClassificationSetting.DataClassificationConfig.Level
+### TaskRunLog
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| title | [string](#string) | | |
-| description | [string](#string) | | |
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log |
+| entries | [TaskRunLogEntry](#bytebase-v1-TaskRunLogEntry) | repeated | The log entries for this task run. |
-<a name="bytebase-v1-EnvironmentSetting"></a>
+<a name="bytebase-v1-TaskRunLogEntry"></a>
-### EnvironmentSetting
+### TaskRunLogEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |
-
+| type | [TaskRunLogEntry.Type](#bytebase-v1-TaskRunLogEntry-Type) | | The type of this log entry. |
+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The time when the log was recorded. |
+| replica_id | [string](#string) | | The replica ID for this log entry. |
+| schema_dump | [TaskRunLogEntry.SchemaDump](#bytebase-v1-TaskRunLogEntry-SchemaDump) | | Schema dump details (if type is SCHEMA_DUMP). |
+| command_execute | [TaskRunLogEntry.CommandExecute](#bytebase-v1-TaskRunLogEntry-CommandExecute) | | Command execution details (if type is COMMAND_EXECUTE). |
+| database_sync | [TaskRunLogEntry.DatabaseSync](#bytebase-v1-TaskRunLogEntry-DatabaseSync) | | Database sync details (if type is DATABASE_SYNC). |
+| transaction_control | [TaskRunLogEntry.TransactionControl](#bytebase-v1-TaskRunLogEntry-TransactionControl) | | Transaction control details (if type is TRANSACTION_CONTROL). |
+| prior_backup | [TaskRunLogEntry.PriorBackup](#bytebase-v1-TaskRunLogEntry-PriorBackup) | | Prior backup details (if type is PRIOR_BACKUP). |
+| retry_info | [TaskRunLogEntry.RetryInfo](#bytebase-v1-TaskRunLogEntry-RetryInfo) | | Retry information details (if type is RETRY_INFO). |
+| compute_diff | [TaskRunLogEntry.ComputeDiff](#bytebase-v1-TaskRunLogEntry-ComputeDiff) | | Compute diff details (if type is COMPUTE_DIFF). |
+| release_file_execute | [TaskRunLogEntry.ReleaseFileExecute](#bytebase-v1-TaskRunLogEntry-ReleaseFileExecute) | | Release file execution details (if type is RELEASE_FILE_EXECUTE). |
-<a name="bytebase-v1-EnvironmentSetting-Environment"></a>
-### EnvironmentSetting.Environment
+<a name="bytebase-v1-TaskRunLogEntry-CommandExecute"></a>
+### TaskRunLogEntry.CommandExecute
+Command execution details.
| 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) | | |
-
+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the command was logged. |
+| range | [Range](#bytebase-v1-Range) | | The byte offset range of the executed command in the sheet. Uses byte offsets (not character indices) for efficient slicing of sheet content bytes. Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. |
+| statement | [string](#string) | | The executed statement. |
+| response | [TaskRunLogEntry.CommandExecute.CommandResponse](#bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse) | | The response from executing the command. |
-<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>
-### EnvironmentSetting.Environment.TagsEntry
+<a name="bytebase-v1-TaskRunLogEntry-CommandExecute-CommandResponse"></a>
+### TaskRunLogEntry.CommandExecute.CommandResponse
+Command execution response.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| log_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the response was logged. |
+| error | [string](#string) | | Error message if command execution failed. |
+| affected_rows | [int64](#int64) | | Total affected rows. |
+| all_affected_rows | [int64](#int64) | repeated | `all_affected_rows` is the affected rows of each command. `all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. |
-<a name="bytebase-v1-GetSettingRequest"></a>
+<a name="bytebase-v1-TaskRunLogEntry-ComputeDiff"></a>
-### GetSettingRequest
-The request message for getting a setting.
+### TaskRunLogEntry.ComputeDiff
+Schema diff computation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the setting. |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When diff computation ended. |
+| error | [string](#string) | | Error message if computation failed. |
-<a name="bytebase-v1-GetSettingResponse"></a>
+<a name="bytebase-v1-TaskRunLogEntry-DatabaseSync"></a>
-### GetSettingResponse
-The response message for getting a setting.
+### TaskRunLogEntry.DatabaseSync
+Database synchronization details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| setting | [Setting](#bytebase-v1-Setting) | | |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the database sync ended. |
+| error | [string](#string) | | Error message if sync failed. |
-<a name="bytebase-v1-ListSettingsRequest"></a>
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup"></a>
-### ListSettingsRequest
+### TaskRunLogEntry.PriorBackup
+Prior backup operation details.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backup ended. |
+| prior_backup_detail | [TaskRunLogEntry.PriorBackup.PriorBackupDetail](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail) | | The backup details. |
+| error | [string](#string) | | Error message if the backup failed. |
-<a name="bytebase-v1-ListSettingsResponse"></a>
-### ListSettingsResponse
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail"></a>
+### TaskRunLogEntry.PriorBackup.PriorBackupDetail
+Prior backup detail for rollback purposes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |
-
+| items | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item) | repeated | The list of backed up tables. |
-<a name="bytebase-v1-SemanticTypeSetting"></a>
-### SemanticTypeSetting
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item"></a>
+### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item
+A single backup table mapping.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |
-
+| source_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The original table information. |
+| target_table | [TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table](#bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table) | | The target backup table information. |
+| start_position | [Position](#bytebase-v1-Position) | | The start position in the SQL statement. |
+| end_position | [Position](#bytebase-v1-Position) | | The end position in the SQL statement. |
-<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>
-### SemanticTypeSetting.SemanticType
+<a name="bytebase-v1-TaskRunLogEntry-PriorBackup-PriorBackupDetail-Item-Table"></a>
+### TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table
+Table information.
| 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. |
+| database | [string](#string) | | The database information. Format: instances/{instance}/databases/{database} |
+| schema | [string](#string) | | The schema name. |
+| table | [string](#string) | | The table name. |
-<a name="bytebase-v1-Setting"></a>
+<a name="bytebase-v1-TaskRunLogEntry-ReleaseFileExecute"></a>
-### Setting
-The schema of setting.
+### TaskRunLogEntry.ReleaseFileExecute
+Release file execution details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the setting. Format: settings/{setting} Example: &#34;settings/SEMANTIC_TYPES&#34; |
-| value | [SettingValue](#bytebase-v1-SettingValue) | | The configuration value of the setting. |
+| version | [string](#string) | | The version of the file being executed (e.g., &#34;0001&#34;). |
+| file_path | [string](#string) | | The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). |
-<a name="bytebase-v1-SettingValue"></a>
+<a name="bytebase-v1-TaskRunLogEntry-RetryInfo"></a>
-### SettingValue
-The data in setting value.
+### TaskRunLogEntry.RetryInfo
+Retry information for failed operations.
| 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) | | |
+| error | [string](#string) | | The error that triggered the retry. |
+| retry_count | [int32](#int32) | | Current retry attempt number. |
+| maximum_retries | [int32](#int32) | | Maximum number of retries allowed. |
-<a name="bytebase-v1-UpdateSettingRequest"></a>
+<a name="bytebase-v1-TaskRunLogEntry-SchemaDump"></a>
-### UpdateSettingRequest
-The request message for updating or creating a setting.
+### TaskRunLogEntry.SchemaDump
+Schema dump operation details.
| 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) | | |
-
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump started. |
+| end_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the schema dump ended. |
+| error | [string](#string) | | Error message if the schema dump failed. |
-<a name="bytebase-v1-WorkspaceApprovalSetting"></a>
-### WorkspaceApprovalSetting
+<a name="bytebase-v1-TaskRunLogEntry-TransactionControl"></a>
+### TaskRunLogEntry.TransactionControl
+Transaction control operation details.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |
+| type | [TaskRunLogEntry.TransactionControl.Type](#bytebase-v1-TaskRunLogEntry-TransactionControl-Type) | | The type of transaction control. |
+| error | [string](#string) | | Error message if the operation failed. |
-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>
+<a name="bytebase-v1-TaskRunSession"></a>
-### WorkspaceApprovalSetting.Rule
+### TaskRunSession
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | |
-| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with the rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-The `source` field filters which rules apply. The `condition` field then evaluates with full context.
-
-All supported variables: statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values. statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-
-When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*) When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
-
-For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100 resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; |
-| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |
-
+| name | [string](#string) | | Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session |
+| postgres | [TaskRunSession.Postgres](#bytebase-v1-TaskRunSession-Postgres) | | PostgreSQL session information. |
-<a name="bytebase-v1-WorkspaceProfileSetting"></a>
-### WorkspaceProfileSetting
+<a name="bytebase-v1-TaskRunSession-Postgres"></a>
+### TaskRunSession.Postgres
+PostgreSQL session information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| external_url | [string](#string) | | The external URL is used for sso authentication callback. |
-| disallow_signup | [bool](#bool) | | Disallow self-service signup, users can only be invited by the owner. |
-| require_2fa | [bool](#bool) | | Require 2FA for all users. |
-| refresh_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for refresh token. Default is 7 days. |
-| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
-| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
-| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
-| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
-| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
-| disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |
-| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
-| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. |
-| enable_audit_log_stdout | [bool](#bool) | | Whether to enable audit logging to stdout in structured JSON format. Requires TEAM or ENTERPRISE license. |
-| watermark | [bool](#bool) | | Whether to display watermark on pages. Requires ENTERPRISE license. |
-| directory_sync_token | [string](#string) | | The token for directory sync authentication. |
-| branding_logo | [string](#string) | | The branding logo as a data URI (e.g. data:image/png;base64,...). |
-| password_restriction | [WorkspaceProfileSetting.PasswordRestriction](#bytebase-v1-WorkspaceProfileSetting-PasswordRestriction) | | Password restriction settings. |
-| access_token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for access token. Default is 1 hour. |
-| enable_debug | [bool](#bool) | | Whether debug mode is enabled. |
-
+| session | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | | `session` is the session of the task run executing commands. |
+| blocking_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocking_sessions` block `session`. |
+| blocked_sessions | [TaskRunSession.Postgres.Session](#bytebase-v1-TaskRunSession-Postgres-Session) | repeated | `blocked_sessions` are blocked by `session`. |
-<a name="bytebase-v1-WorkspaceProfileSetting-PasswordRestriction"></a>
-### WorkspaceProfileSetting.PasswordRestriction
+<a name="bytebase-v1-TaskRunSession-Postgres-Session"></a>
+### TaskRunSession.Postgres.Session
+PostgreSQL session information read from `pg_stat_activity`.
| 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. |
+| pid | [string](#string) | | Process ID of the session. |
+| blocked_by_pids | [string](#string) | repeated | PIDs of sessions blocking this session. |
+| query | [string](#string) | | Current query being executed. |
+| state | [string](#string) | optional | Session state (active, idle, etc.). |
+| wait_event_type | [string](#string) | optional | Wait event type if session is waiting. |
+| wait_event | [string](#string) | optional | Specific wait event if session is waiting. |
+| datname | [string](#string) | optional | Database name. |
+| usename | [string](#string) | optional | User name. |
+| application_name | [string](#string) | | Application name. |
+| client_addr | [string](#string) | optional | Client IP address. |
+| client_port | [string](#string) | optional | Client port number. |
+| backend_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | When the backend process started. |
+| xact_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current transaction started. |
+| query_start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | When the current query started. |
@@ -10042,91 +10045,99 @@ For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.aff
-<a name="bytebase-v1-AISetting-Provider"></a>
+<a name="bytebase-v1-Task-Status"></a>
-### AISetting.Provider
+### Task.Status
| Name | Number | Description |
| ---- | ------ | ----------- |
-| PROVIDER_UNSPECIFIED | 0 | |
-| OPEN_AI | 1 | |
-| CLAUDE | 2 | |
-| GEMINI | 3 | |
-| AZURE_OPENAI | 4 | |
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| NOT_STARTED | 1 | Task has not started and is awaiting its turn in the deployment sequence. |
+| PENDING | 2 | Task is ready to run and waiting for approval or scheduled time. |
+| RUNNING | 3 | Task is currently executing. |
+| DONE | 4 | Task completed successfully. |
+| FAILED | 5 | Task execution failed with errors. |
+| CANCELED | 6 | Task execution was canceled by a user. |
+| SKIPPED | 7 | Task was skipped and will not be executed. |
-<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>
+<a name="bytebase-v1-Task-Type"></a>
-### Algorithm.InnerOuterMask.MaskType
+### Task.Type
| Name | Number | Description |
| ---- | ------ | ----------- |
-| MASK_TYPE_UNSPECIFIED | 0 | |
-| INNER | 1 | |
-| OUTER | 2 | |
+| TYPE_UNSPECIFIED | 0 | Unspecified task type. |
+| GENERAL | 1 | General task for miscellaneous operations. |
+| DATABASE_CREATE | 2 | Database creation task that creates a new database. Use payload DatabaseCreate. |
+| DATABASE_MIGRATE | 3 | Database migration task that applies versioned schema changes. Use payload DatabaseUpdate. |
+| DATABASE_EXPORT | 4 | Database export task that exports query results or table data. Use payload DatabaseDataExport. |
-<a name="bytebase-v1-Announcement-AlertLevel"></a>
+<a name="bytebase-v1-TaskRun-ExportArchiveStatus"></a>
+
+### TaskRun.ExportArchiveStatus
-### 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 | |
+| EXPORT_ARCHIVE_STATUS_UNSPECIFIED | 0 | Unspecified export archive status. |
+| READY | 1 | Export archive is ready for download. |
+| EXPORTED | 2 | Export archive has been downloaded by the user. |
-<a name="bytebase-v1-DatabaseChangeMode"></a>
+<a name="bytebase-v1-TaskRun-Status"></a>
-### DatabaseChangeMode
+### TaskRun.Status
| 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. |
-
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Task run is queued and waiting to start execution. |
+| RUNNING | 2 | Task run is currently executing. |
+| DONE | 3 | Task run completed successfully. |
+| FAILED | 4 | Task run execution failed with errors. |
+| CANCELED | 5 | Task run execution was canceled by a user. |
+| AVAILABLE | 6 | Task run is ready for immediate execution. |
-<a name="bytebase-v1-Setting-SettingName"></a>
-### Setting.SettingName
+<a name="bytebase-v1-TaskRunLogEntry-TransactionControl-Type"></a>
+### TaskRunLogEntry.TransactionControl.Type
+Transaction control type.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| SETTING_NAME_UNSPECIFIED | 0 | |
-| WORKSPACE_PROFILE | 1 | |
-| WORKSPACE_APPROVAL | 2 | |
-| APP_IM | 3 | |
-| AI | 4 | |
-| DATA_CLASSIFICATION | 5 | |
-| SEMANTIC_TYPES | 6 | |
-| ENVIRONMENT | 7 | |
-
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| BEGIN | 1 | Begin transaction. |
+| COMMIT | 2 | Commit transaction. |
+| ROLLBACK | 3 | Rollback transaction. |
-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>
-### WorkspaceApprovalSetting.Rule.Source
+<a name="bytebase-v1-TaskRunLogEntry-Type"></a>
+### TaskRunLogEntry.Type
+The type of log entry.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| SOURCE_UNSPECIFIED | 0 | |
-| CHANGE_DATABASE | 1 | |
-| CREATE_DATABASE | 2 | |
-| EXPORT_DATA | 3 | |
-| REQUEST_ROLE | 4 | |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| SCHEMA_DUMP | 1 | Schema dump operation. |
+| COMMAND_EXECUTE | 2 | Command execution. |
+| DATABASE_SYNC | 3 | Database synchronization. |
+| TRANSACTION_CONTROL | 5 | Transaction control (BEGIN, COMMIT, ROLLBACK). |
+| PRIOR_BACKUP | 6 | Prior backup operation. |
+| RETRY_INFO | 7 | Retry information. |
+| COMPUTE_DIFF | 8 | Schema diff computation. |
+| RELEASE_FILE_EXECUTE | 9 | Release file execution. |
@@ -10134,16 +10145,24 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.
-<a name="bytebase-v1-SettingService"></a>
+<a name="bytebase-v1-RolloutService"></a>
-### SettingService
-SettingService manages workspace-level settings and configurations.
+### RolloutService
+RolloutService manages the execution of deployment plans.
| 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 |
+| GetRollout | [GetRolloutRequest](#bytebase-v1-GetRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Retrieves a rollout by its plan name. Permissions required: bb.rollouts.get |
+| ListRollouts | [ListRolloutsRequest](#bytebase-v1-ListRolloutsRequest) | [ListRolloutsResponse](#bytebase-v1-ListRolloutsResponse) | Lists rollouts in a project. Permissions required: bb.rollouts.list |
+| CreateRollout | [CreateRolloutRequest](#bytebase-v1-CreateRolloutRequest) | [Rollout](#bytebase-v1-Rollout) | Creates a new rollout for a plan. Permissions required: bb.rollouts.create |
+| ListTaskRuns | [ListTaskRunsRequest](#bytebase-v1-ListTaskRunsRequest) | [ListTaskRunsResponse](#bytebase-v1-ListTaskRunsResponse) | Lists task run executions for a task. Permissions required: bb.taskRuns.list |
+| GetTaskRun | [GetTaskRunRequest](#bytebase-v1-GetTaskRunRequest) | [TaskRun](#bytebase-v1-TaskRun) | Retrieves a task run by name. Permissions required: bb.taskRuns.list |
+| GetTaskRunLog | [GetTaskRunLogRequest](#bytebase-v1-GetTaskRunLogRequest) | [TaskRunLog](#bytebase-v1-TaskRunLog) | Retrieves execution logs for a task run. Permissions required: bb.taskRuns.list |
+| GetTaskRunSession | [GetTaskRunSessionRequest](#bytebase-v1-GetTaskRunSessionRequest) | [TaskRunSession](#bytebase-v1-TaskRunSession) | Retrieves database session information for a running task. Permissions required: bb.taskRuns.list |
+| BatchRunTasks | [BatchRunTasksRequest](#bytebase-v1-BatchRunTasksRequest) | [BatchRunTasksResponse](#bytebase-v1-BatchRunTasksResponse) | Executes multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
+| BatchSkipTasks | [BatchSkipTasksRequest](#bytebase-v1-BatchSkipTasksRequest) | [BatchSkipTasksResponse](#bytebase-v1-BatchSkipTasksResponse) | Skips multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
+| BatchCancelTaskRuns | [BatchCancelTaskRunsRequest](#bytebase-v1-BatchCancelTaskRunsRequest) | [BatchCancelTaskRunsResponse](#bytebase-v1-BatchCancelTaskRunsResponse) | Cancels multiple running task executions. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment) |
+| PreviewTaskRunRollback | [PreviewTaskRunRollbackRequest](#bytebase-v1-PreviewTaskRunRollbackRequest) | [PreviewTaskRunRollbackResponse](#bytebase-v1-PreviewTaskRunRollbackResponse) | Generates rollback SQL for a completed task run. Permissions required: bb.taskRuns.list |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index e123ecf681..bab7c00c1d 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -257,356 +257,321 @@
<li>
- <a href="#v1%2fuser_service.proto">v1/user_service.proto</a>
+ <a href="#v1%2fissue_service.proto">v1/issue_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a>
+ <a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a>
</li>
<li>
- <a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a>
+ <a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a>
</li>
<li>
- <a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a>
+ <a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a>
+ <a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a>
+ <a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a>
+ <a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a>
+ <a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a>
+ <a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateEmailRequest"><span class="badge">M</span>UpdateEmailRequest</a>
+ <a href="#bytebase.v1.GrantRequest"><span class="badge">M</span>GrantRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a>
+ <a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</a>
</li>
<li>
- <a href="#bytebase.v1.User"><span class="badge">M</span>User</a>
+ <a href="#bytebase.v1.Issue.Approver"><span class="badge">M</span>Issue.Approver</a>
</li>
<li>
- <a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a>
+ <a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a>
</li>
<li>
- <a href="#bytebase.v1.WorkloadIdentityConfig"><span class="badge">M</span>WorkloadIdentityConfig</a>
+ <a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a>
</li>
-
<li>
- <a href="#bytebase.v1.UserType"><span class="badge">E</span>UserType</a>
+ <a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a>
</li>
<li>
- <a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType"><span class="badge">E</span>WorkloadIdentityConfig.ProviderType</a>
+ <a href="#bytebase.v1.IssueComment.PlanSpecUpdate"><span class="badge">M</span>IssueComment.PlanSpecUpdate</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a>
+ <a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2factuator_service.proto">v1/actuator_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.ActuatorInfo"><span class="badge">M</span>ActuatorInfo</a>
+ <a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ActuatorInfo.StatUser"><span class="badge">M</span>ActuatorInfo.StatUser</a>
+ <a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a>
+ <a href="#bytebase.v1.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a>
+ <a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetResourcePackageRequest"><span class="badge">M</span>GetResourcePackageRequest</a>
+ <a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ResourcePackage"><span class="badge">M</span>ResourcePackage</a>
+ <a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a>
+ <a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a>
+ <a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a>
</li>
- </ul>
- </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>
+ <a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a>
+ <a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a>
</li>
<li>
- <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>
+ <a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a>
</li>
<li>
- <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a>
+ <a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a>
</li>
<li>
- <a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a>
+ <a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a>
</li>
<li>
- <a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a>
+ <a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a>
</li>
+
<li>
- <a href="#bytebase.v1.BindingDelta.Action"><span class="badge">E</span>BindingDelta.Action</a>
+ <a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a>
</li>
-
-
</ul>
</li>
<li>
- <a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a>
+ <a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a>
+ <a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a>
</li>
<li>
- <a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a>
+ <a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a>
</li>
<li>
- <a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a>
+ <a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a>
</li>
<li>
- <a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a>
+ <a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a>
</li>
<li>
- <a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a>
+ <a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a>
</li>
<li>
- <a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a>
+ <a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a>
</li>
<li>
- <a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a>
+ <a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a>
</li>
-
<li>
- <a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a>
+ <a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.AuditLogService"><span class="badge">S</span>AuditLogService</a>
+ <a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fauth_service.proto">v1/auth_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.ExchangeTokenRequest"><span class="badge">M</span>ExchangeTokenRequest</a>
+ <a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a>
</li>
<li>
- <a href="#bytebase.v1.ExchangeTokenResponse"><span class="badge">M</span>ExchangeTokenResponse</a>
+ <a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a>
</li>
<li>
- <a href="#bytebase.v1.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a>
+ <a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a>
</li>
<li>
- <a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a>
+ <a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a>
</li>
<li>
- <a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a>
+ <a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a>
</li>
<li>
- <a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a>
+ <a href="#bytebase.v1.AppIMSetting.Teams"><span class="badge">M</span>AppIMSetting.Teams</a>
</li>
<li>
- <a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a>
+ <a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a>
</li>
<li>
- <a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a>
+ <a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a>
</li>
<li>
- <a href="#bytebase.v1.RefreshRequest"><span class="badge">M</span>RefreshRequest</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a>
</li>
<li>
- <a href="#bytebase.v1.RefreshResponse"><span class="badge">M</span>RefreshResponse</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fcel_service.proto">v1/cel_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.BatchDeparseRequest"><span class="badge">M</span>BatchDeparseRequest</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a>
</li>
<li>
- <a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a>
+ <a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a>
</li>
<li>
- <a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a>
+ <a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a>
</li>
<li>
- <a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a>
+ <a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a>
</li>
+ <li>
+ <a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a>
+ </li>
<li>
- <a href="#bytebase.v1.CelService"><span class="badge">S</span>CelService</a>
+ <a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fdatabase_catalog_service.proto">v1/database_catalog_service.proto</a>
- <ul>
+ <li>
+ <a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
+ </li>
<li>
- <a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a>
+ <a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a>
</li>
<li>
- <a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a>
+ <a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a>
+ <a href="#bytebase.v1.SettingValue"><span class="badge">M</span>SettingValue</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a>
+ <a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a>
+ <a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a>
+ <a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction"><span class="badge">M</span>WorkspaceProfileSetting.PasswordRestriction</a>
</li>
+
<li>
- <a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a>
+ <a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a>
</li>
<li>
- <a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a>
+ <a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a>
</li>
<li>
- <a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a>
+ <a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a>
+ <a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a>
</li>
+ <li>
+ <a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a>
+ </li>
<li>
- <a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a>
+ <a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a>
</li>
</ul>
@@ -614,77 +579,74 @@
<li>
- <a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a>
+ <a href="#v1%2fuser_service.proto">v1/user_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a>
+ <a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a>
+ <a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a>
+ <a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a>
+ <a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a>
+ <a href="#bytebase.v1.UpdateEmailRequest"><span class="badge">M</span>UpdateEmailRequest</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a>
+ <a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a>
+ <a href="#bytebase.v1.User"><span class="badge">M</span>User</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a>
+ <a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a>
+ <a href="#bytebase.v1.WorkloadIdentityConfig"><span class="badge">M</span>WorkloadIdentityConfig</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.InstanceRoleService"><span class="badge">S</span>InstanceRoleService</a>
+ <a href="#bytebase.v1.UserType"><span class="badge">E</span>UserType</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType"><span class="badge">E</span>WorkloadIdentityConfig.ProviderType</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a>
</li>
</ul>
@@ -692,162 +654,187 @@
<li>
- <a href="#v1%2finstance_service.proto">v1/instance_service.proto</a>
+ <a href="#v1%2factuator_service.proto">v1/actuator_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a>
+ <a href="#bytebase.v1.ActuatorInfo"><span class="badge">M</span>ActuatorInfo</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a>
+ <a href="#bytebase.v1.ActuatorInfo.StatUser"><span class="badge">M</span>ActuatorInfo.StatUser</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a>
+ <a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a>
+ <a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a>
+ <a href="#bytebase.v1.GetResourcePackageRequest"><span class="badge">M</span>GetResourcePackageRequest</a>
</li>
<li>
- <a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a>
+ <a href="#bytebase.v1.ResourcePackage"><span class="badge">M</span>ResourcePackage</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a>
+ <a href="#bytebase.v1.Restriction"><span class="badge">M</span>Restriction</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a>
+ <a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a>
</li>
- <li>
- <a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a>
- </li>
- <li>
- <a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a>
- </li>
+
<li>
- <a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a>
+ <a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fiam_policy.proto">v1/iam_policy.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a>
+ <a href="#bytebase.v1.Binding"><span class="badge">M</span>Binding</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a>
+ <a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a>
+ <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a>
+ <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a>
</li>
<li>
- <a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a>
+ <a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a>
</li>
<li>
- <a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a>
+ <a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a>
+ <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>
+
<li>
- <a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a>
+ <a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a>
</li>
<li>
- <a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a>
+ <a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a>
+ <a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a>
+ <a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a>
+ <a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a>
+ <a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a>
+ <a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a>
</li>
+
<li>
- <a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a>
+ <a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a>
+ <a href="#bytebase.v1.AuditLogService"><span class="badge">S</span>AuditLogService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fauth_service.proto">v1/auth_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a>
+ <a href="#bytebase.v1.ExchangeTokenRequest"><span class="badge">M</span>ExchangeTokenRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a>
+ <a href="#bytebase.v1.ExchangeTokenResponse"><span class="badge">M</span>ExchangeTokenResponse</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a>
+ <a href="#bytebase.v1.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a>
+ <a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a>
+ <a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a>
+ <a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a>
+ <a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a>
+ <a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a>
+ <a href="#bytebase.v1.RefreshRequest"><span class="badge">M</span>RefreshRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a>
+ <a href="#bytebase.v1.RefreshResponse"><span class="badge">M</span>RefreshResponse</a>
</li>
+
<li>
- <a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a>
+ <a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a>
</li>
</ul>
@@ -855,286 +842,338 @@
<li>
- <a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a>
+ <a href="#v1%2fcel_service.proto">v1/cel_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a>
+ <a href="#bytebase.v1.BatchDeparseRequest"><span class="badge">M</span>BatchDeparseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a>
+ <a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a>
+ <a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a>
+ <a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a>
</li>
+
+
+
<li>
- <a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a>
+ <a href="#bytebase.v1.CelService"><span class="badge">S</span>CelService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fdatabase_catalog_service.proto">v1/database_catalog_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a>
+ <a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a>
+ <a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a>
+ <a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a>
+ <a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a>
+ <a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a>
</li>
<li>
- <a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a>
+ <a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a>
</li>
<li>
- <a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a>
+ <a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a>
+ <a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a>
+ <a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a>
+ <a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a>
+ <a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a>
</li>
<li>
- <a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a>
+ <a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a>
+ <a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a>
+ <a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a>
+ <a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a>
+ <a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a>
</li>
<li>
- <a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a>
+ <a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a>
</li>
<li>
- <a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a>
+ <a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a>
+ <a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a>
+ <a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a>
+ <a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a>
+ <a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a>
+ <a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a>
+ <a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a>
+ <a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a>
+ <a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a>
+ <a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a>
</li>
+
+
+
<li>
- <a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a>
+ <a href="#bytebase.v1.InstanceRoleService"><span class="badge">S</span>InstanceRoleService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2finstance_service.proto">v1/instance_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a>
+ <a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a>
+ <a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a>
+ <a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a>
+ <a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</a>
+ <a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a>
+ <a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a>
+ <a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a>
+ <a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a>
</li>
<li>
- <a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a>
+ <a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a>
</li>
<li>
- <a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a>
+ <a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a>
</li>
<li>
- <a href="#bytebase.v1.ProcedureMetadata"><span class="badge">M</span>ProcedureMetadata</a>
+ <a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaMetadata"><span class="badge">M</span>SchemaMetadata</a>
+ <a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a>
</li>
<li>
- <a href="#bytebase.v1.SequenceMetadata"><span class="badge">M</span>SequenceMetadata</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a>
</li>
<li>
- <a href="#bytebase.v1.SpatialIndexConfig"><span class="badge">M</span>SpatialIndexConfig</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a>
</li>
<li>
- <a href="#bytebase.v1.StorageConfig"><span class="badge">M</span>StorageConfig</a>
+ <a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.StreamMetadata"><span class="badge">M</span>StreamMetadata</a>
+ <a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SyncDatabaseRequest"><span class="badge">M</span>SyncDatabaseRequest</a>
+ <a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a>
</li>
<li>
- <a href="#bytebase.v1.SyncDatabaseResponse"><span class="badge">M</span>SyncDatabaseResponse</a>
+ <a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.TableMetadata"><span class="badge">M</span>TableMetadata</a>
+ <a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a>
</li>
<li>
- <a href="#bytebase.v1.TablePartitionMetadata"><span class="badge">M</span>TablePartitionMetadata</a>
+ <a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a>
</li>
<li>
- <a href="#bytebase.v1.TaskMetadata"><span class="badge">M</span>TaskMetadata</a>
+ <a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TessellationConfig"><span class="badge">M</span>TessellationConfig</a>
+ <a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.TriggerMetadata"><span class="badge">M</span>TriggerMetadata</a>
+ <a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseRequest"><span class="badge">M</span>UpdateDatabaseRequest</a>
+ <a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ViewMetadata"><span class="badge">M</span>ViewMetadata</a>
+ <a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a>
</li>
+ <li>
+ <a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a>
+ </li>
<li>
- <a href="#bytebase.v1.Changelog.Status"><span class="badge">E</span>Changelog.Status</a>
+ <a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ChangelogView"><span class="badge">E</span>ChangelogView</a>
+ <a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ColumnMetadata.IdentityGeneration"><span class="badge">E</span>ColumnMetadata.IdentityGeneration</a>
+ <a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GenerationMetadata.Type"><span class="badge">E</span>GenerationMetadata.Type</a>
+ <a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat"><span class="badge">E</span>GetDatabaseSDLSchemaRequest.SDLFormat</a>
+ <a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a>
</li>
<li>
- <a href="#bytebase.v1.GetSchemaStringRequest.ObjectType"><span class="badge">E</span>GetSchemaStringRequest.ObjectType</a>
+ <a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a>
</li>
<li>
- <a href="#bytebase.v1.StreamMetadata.Mode"><span class="badge">E</span>StreamMetadata.Mode</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a>
</li>
<li>
- <a href="#bytebase.v1.StreamMetadata.Type"><span class="badge">E</span>StreamMetadata.Type</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a>
</li>
<li>
- <a href="#bytebase.v1.TablePartitionMetadata.Type"><span class="badge">E</span>TablePartitionMetadata.Type</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a>
</li>
<li>
- <a href="#bytebase.v1.TaskMetadata.State"><span class="badge">E</span>TaskMetadata.State</a>
+ <a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseService"><span class="badge">S</span>DatabaseService</a>
+ <a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a>
</li>
</ul>
@@ -1142,292 +1181,286 @@
<li>
- <a href="#v1%2fgroup_service.proto">v1/group_service.proto</a>
+ <a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.BatchGetGroupsRequest"><span class="badge">M</span>BatchGetGroupsRequest</a>
+ <a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchGetGroupsResponse"><span class="badge">M</span>BatchGetGroupsResponse</a>
+ <a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.CreateGroupRequest"><span class="badge">M</span>CreateGroupRequest</a>
+ <a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteGroupRequest"><span class="badge">M</span>DeleteGroupRequest</a>
+ <a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetGroupRequest"><span class="badge">M</span>GetGroupRequest</a>
+ <a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Group"><span class="badge">M</span>Group</a>
+ <a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GroupMember"><span class="badge">M</span>GroupMember</a>
+ <a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a>
</li>
<li>
- <a href="#bytebase.v1.ListGroupsRequest"><span class="badge">M</span>ListGroupsRequest</a>
+ <a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a>
</li>
<li>
- <a href="#bytebase.v1.ListGroupsResponse"><span class="badge">M</span>ListGroupsResponse</a>
+ <a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateGroupRequest"><span class="badge">M</span>UpdateGroupRequest</a>
+ <a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a>
</li>
-
<li>
- <a href="#bytebase.v1.GroupMember.Role"><span class="badge">E</span>GroupMember.Role</a>
+ <a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.GroupService"><span class="badge">S</span>GroupService</a>
+ <a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fidp_service.proto">v1/idp_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.CreateIdentityProviderRequest"><span class="badge">M</span>CreateIdentityProviderRequest</a>
+ <a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteIdentityProviderRequest"><span class="badge">M</span>DeleteIdentityProviderRequest</a>
+ <a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a>
</li>
<li>
- <a href="#bytebase.v1.FieldMapping"><span class="badge">M</span>FieldMapping</a>
+ <a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a>
</li>
<li>
- <a href="#bytebase.v1.GetIdentityProviderRequest"><span class="badge">M</span>GetIdentityProviderRequest</a>
+ <a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a>
</li>
<li>
- <a href="#bytebase.v1.IdentityProvider"><span class="badge">M</span>IdentityProvider</a>
+ <a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a>
</li>
<li>
- <a href="#bytebase.v1.IdentityProviderConfig"><span class="badge">M</span>IdentityProviderConfig</a>
+ <a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.LDAPIdentityProviderConfig"><span class="badge">M</span>LDAPIdentityProviderConfig</a>
+ <a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListIdentityProvidersRequest"><span class="badge">M</span>ListIdentityProvidersRequest</a>
+ <a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a>
</li>
<li>
- <a href="#bytebase.v1.ListIdentityProvidersResponse"><span class="badge">M</span>ListIdentityProvidersResponse</a>
+ <a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a>
</li>
<li>
- <a href="#bytebase.v1.OAuth2IdentityProviderConfig"><span class="badge">M</span>OAuth2IdentityProviderConfig</a>
+ <a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext"><span class="badge">M</span>OAuth2IdentityProviderTestRequestContext</a>
+ <a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.OIDCIdentityProviderConfig"><span class="badge">M</span>OIDCIdentityProviderConfig</a>
+ <a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext"><span class="badge">M</span>OIDCIdentityProviderTestRequestContext</a>
+ <a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.TestIdentityProviderRequest"><span class="badge">M</span>TestIdentityProviderRequest</a>
+ <a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.TestIdentityProviderResponse"><span class="badge">M</span>TestIdentityProviderResponse</a>
+ <a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry"><span class="badge">M</span>TestIdentityProviderResponse.ClaimsEntry</a>
+ <a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry"><span class="badge">M</span>TestIdentityProviderResponse.UserInfoEntry</a>
+ <a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIdentityProviderRequest"><span class="badge">M</span>UpdateIdentityProviderRequest</a>
+ <a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.IdentityProviderType"><span class="badge">E</span>IdentityProviderType</a>
+ <a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol"><span class="badge">E</span>LDAPIdentityProviderConfig.SecurityProtocol</a>
+ <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.OAuth2AuthStyle"><span class="badge">E</span>OAuth2AuthStyle</a>
+ <a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a>
</li>
+ <li>
+ <a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a>
+ </li>
+ <li>
+ <a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a>
+ </li>
<li>
- <a href="#bytebase.v1.IdentityProviderService"><span class="badge">S</span>IdentityProviderService</a>
+ <a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fissue_service.proto">v1/issue_service.proto</a>
- <ul>
+ <li>
+ <a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a>
+ </li>
<li>
- <a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a>
+ <a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a>
+ <a href="#bytebase.v1.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a>
+ <a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a>
+ <a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a>
+ <a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a>
+ <a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a>
+ <a href="#bytebase.v1.ProcedureMetadata"><span class="badge">M</span>ProcedureMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a>
+ <a href="#bytebase.v1.SchemaMetadata"><span class="badge">M</span>SchemaMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.GrantRequest"><span class="badge">M</span>GrantRequest</a>
+ <a href="#bytebase.v1.SequenceMetadata"><span class="badge">M</span>SequenceMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</a>
+ <a href="#bytebase.v1.SpatialIndexConfig"><span class="badge">M</span>SpatialIndexConfig</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Approver"><span class="badge">M</span>Issue.Approver</a>
+ <a href="#bytebase.v1.StorageConfig"><span class="badge">M</span>StorageConfig</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a>
+ <a href="#bytebase.v1.StreamMetadata"><span class="badge">M</span>StreamMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a>
+ <a href="#bytebase.v1.SyncDatabaseRequest"><span class="badge">M</span>SyncDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a>
+ <a href="#bytebase.v1.SyncDatabaseResponse"><span class="badge">M</span>SyncDatabaseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.PlanSpecUpdate"><span class="badge">M</span>IssueComment.PlanSpecUpdate</a>
+ <a href="#bytebase.v1.TableMetadata"><span class="badge">M</span>TableMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a>
+ <a href="#bytebase.v1.TablePartitionMetadata"><span class="badge">M</span>TablePartitionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a>
+ <a href="#bytebase.v1.TaskMetadata"><span class="badge">M</span>TaskMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</a>
+ <a href="#bytebase.v1.TessellationConfig"><span class="badge">M</span>TessellationConfig</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a>
+ <a href="#bytebase.v1.TriggerMetadata"><span class="badge">M</span>TriggerMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a>
+ <a href="#bytebase.v1.UpdateDatabaseRequest"><span class="badge">M</span>UpdateDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a>
+ <a href="#bytebase.v1.ViewMetadata"><span class="badge">M</span>ViewMetadata</a>
</li>
+
<li>
- <a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a>
+ <a href="#bytebase.v1.Changelog.Status"><span class="badge">E</span>Changelog.Status</a>
</li>
<li>
- <a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a>
+ <a href="#bytebase.v1.ChangelogView"><span class="badge">E</span>ChangelogView</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a>
+ <a href="#bytebase.v1.ColumnMetadata.IdentityGeneration"><span class="badge">E</span>ColumnMetadata.IdentityGeneration</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a>
+ <a href="#bytebase.v1.GenerationMetadata.Type"><span class="badge">E</span>GenerationMetadata.Type</a>
</li>
+ <li>
+ <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat"><span class="badge">E</span>GetDatabaseSDLSchemaRequest.SDLFormat</a>
+ </li>
<li>
- <a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a>
+ <a href="#bytebase.v1.GetSchemaStringRequest.ObjectType"><span class="badge">E</span>GetSchemaStringRequest.ObjectType</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a>
+ <a href="#bytebase.v1.StreamMetadata.Mode"><span class="badge">E</span>StreamMetadata.Mode</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a>
+ <a href="#bytebase.v1.StreamMetadata.Type"><span class="badge">E</span>StreamMetadata.Type</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a>
+ <a href="#bytebase.v1.TablePartitionMetadata.Type"><span class="badge">E</span>TablePartitionMetadata.Type</a>
</li>
<li>
- <a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a>
+ <a href="#bytebase.v1.TaskMetadata.State"><span class="badge">E</span>TaskMetadata.State</a>
</li>
<li>
- <a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a>
+ <a href="#bytebase.v1.DatabaseService"><span class="badge">S</span>DatabaseService</a>
</li>
</ul>
@@ -1435,62 +1468,220 @@
<li>
- <a href="#v1%2forg_policy_service.proto">v1/org_policy_service.proto</a>
+ <a href="#v1%2fgroup_service.proto">v1/group_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.CreatePolicyRequest"><span class="badge">M</span>CreatePolicyRequest</a>
+ <a href="#bytebase.v1.BatchGetGroupsRequest"><span class="badge">M</span>BatchGetGroupsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeletePolicyRequest"><span class="badge">M</span>DeletePolicyRequest</a>
+ <a href="#bytebase.v1.BatchGetGroupsResponse"><span class="badge">M</span>BatchGetGroupsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetPolicyRequest"><span class="badge">M</span>GetPolicyRequest</a>
+ <a href="#bytebase.v1.CreateGroupRequest"><span class="badge">M</span>CreateGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListPoliciesRequest"><span class="badge">M</span>ListPoliciesRequest</a>
+ <a href="#bytebase.v1.DeleteGroupRequest"><span class="badge">M</span>DeleteGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListPoliciesResponse"><span class="badge">M</span>ListPoliciesResponse</a>
+ <a href="#bytebase.v1.GetGroupRequest"><span class="badge">M</span>GetGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingExemptionPolicy"><span class="badge">M</span>MaskingExemptionPolicy</a>
+ <a href="#bytebase.v1.Group"><span class="badge">M</span>Group</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingExemptionPolicy.Exemption"><span class="badge">M</span>MaskingExemptionPolicy.Exemption</a>
+ <a href="#bytebase.v1.GroupMember"><span class="badge">M</span>GroupMember</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingRulePolicy"><span class="badge">M</span>MaskingRulePolicy</a>
+ <a href="#bytebase.v1.ListGroupsRequest"><span class="badge">M</span>ListGroupsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.MaskingRulePolicy.MaskingRule"><span class="badge">M</span>MaskingRulePolicy.MaskingRule</a>
+ <a href="#bytebase.v1.ListGroupsResponse"><span class="badge">M</span>ListGroupsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Policy"><span class="badge">M</span>Policy</a>
+ <a href="#bytebase.v1.UpdateGroupRequest"><span class="badge">M</span>UpdateGroupRequest</a>
</li>
- <li>
- <a href="#bytebase.v1.QueryDataPolicy"><span class="badge">M</span>QueryDataPolicy</a>
- </li>
<li>
- <a href="#bytebase.v1.RolloutPolicy"><span class="badge">M</span>RolloutPolicy</a>
+ <a href="#bytebase.v1.GroupMember.Role"><span class="badge">E</span>GroupMember.Role</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.TagPolicy"><span class="badge">M</span>TagPolicy</a>
+ <a href="#bytebase.v1.GroupService"><span class="badge">S</span>GroupService</a>
</li>
- <li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fidp_service.proto">v1/idp_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.CreateIdentityProviderRequest"><span class="badge">M</span>CreateIdentityProviderRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.DeleteIdentityProviderRequest"><span class="badge">M</span>DeleteIdentityProviderRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.FieldMapping"><span class="badge">M</span>FieldMapping</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.GetIdentityProviderRequest"><span class="badge">M</span>GetIdentityProviderRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.IdentityProvider"><span class="badge">M</span>IdentityProvider</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.IdentityProviderConfig"><span class="badge">M</span>IdentityProviderConfig</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.LDAPIdentityProviderConfig"><span class="badge">M</span>LDAPIdentityProviderConfig</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListIdentityProvidersRequest"><span class="badge">M</span>ListIdentityProvidersRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListIdentityProvidersResponse"><span class="badge">M</span>ListIdentityProvidersResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.OAuth2IdentityProviderConfig"><span class="badge">M</span>OAuth2IdentityProviderConfig</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext"><span class="badge">M</span>OAuth2IdentityProviderTestRequestContext</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.OIDCIdentityProviderConfig"><span class="badge">M</span>OIDCIdentityProviderConfig</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext"><span class="badge">M</span>OIDCIdentityProviderTestRequestContext</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TestIdentityProviderRequest"><span class="badge">M</span>TestIdentityProviderRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TestIdentityProviderResponse"><span class="badge">M</span>TestIdentityProviderResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry"><span class="badge">M</span>TestIdentityProviderResponse.ClaimsEntry</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry"><span class="badge">M</span>TestIdentityProviderResponse.UserInfoEntry</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateIdentityProviderRequest"><span class="badge">M</span>UpdateIdentityProviderRequest</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.IdentityProviderType"><span class="badge">E</span>IdentityProviderType</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol"><span class="badge">E</span>LDAPIdentityProviderConfig.SecurityProtocol</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.OAuth2AuthStyle"><span class="badge">E</span>OAuth2AuthStyle</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.IdentityProviderService"><span class="badge">S</span>IdentityProviderService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2forg_policy_service.proto">v1/org_policy_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.CreatePolicyRequest"><span class="badge">M</span>CreatePolicyRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.DeletePolicyRequest"><span class="badge">M</span>DeletePolicyRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.GetPolicyRequest"><span class="badge">M</span>GetPolicyRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListPoliciesRequest"><span class="badge">M</span>ListPoliciesRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListPoliciesResponse"><span class="badge">M</span>ListPoliciesResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingExemptionPolicy"><span class="badge">M</span>MaskingExemptionPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingExemptionPolicy.Exemption"><span class="badge">M</span>MaskingExemptionPolicy.Exemption</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingRulePolicy"><span class="badge">M</span>MaskingRulePolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.MaskingRulePolicy.MaskingRule"><span class="badge">M</span>MaskingRulePolicy.MaskingRule</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.Policy"><span class="badge">M</span>Policy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.QueryDataPolicy"><span class="badge">M</span>QueryDataPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.RolloutPolicy"><span class="badge">M</span>RolloutPolicy</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.TagPolicy"><span class="badge">M</span>TagPolicy</a>
+ </li>
+
+ <li>
<a href="#bytebase.v1.TagPolicy.TagsEntry"><span class="badge">M</span>TagPolicy.TagsEntry</a>
</li>
@@ -2366,327 +2557,140 @@
<li>
- <a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a>
+ <a href="#v1%2fsheet_service.proto">v1/sheet_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a>
+ <a href="#bytebase.v1.BatchCreateSheetsRequest"><span class="badge">M</span>BatchCreateSheetsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a>
+ <a href="#bytebase.v1.BatchCreateSheetsResponse"><span class="badge">M</span>BatchCreateSheetsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a>
+ <a href="#bytebase.v1.CreateSheetRequest"><span class="badge">M</span>CreateSheetRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a>
+ <a href="#bytebase.v1.GetSheetRequest"><span class="badge">M</span>GetSheetRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a>
+ <a href="#bytebase.v1.Sheet"><span class="badge">M</span>Sheet</a>
</li>
- <li>
- <a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a>
- </li>
- <li>
- <a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a>
- </li>
- <li>
- <a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a>
- </li>
<li>
- <a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a>
+ <a href="#bytebase.v1.SheetService"><span class="badge">S</span>SheetService</a>
</li>
- <li>
- <a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a>
- </li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fsubscription_service.proto">v1/subscription_service.proto</a>
+ <ul>
<li>
- <a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a>
+ <a href="#bytebase.v1.GetSubscriptionRequest"><span class="badge">M</span>GetSubscriptionRequest</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a>
+ <a href="#bytebase.v1.PlanConfig"><span class="badge">M</span>PlanConfig</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a>
+ <a href="#bytebase.v1.PlanLimitConfig"><span class="badge">M</span>PlanLimitConfig</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a>
+ <a href="#bytebase.v1.Subscription"><span class="badge">M</span>Subscription</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Teams"><span class="badge">M</span>AppIMSetting.Teams</a>
+ <a href="#bytebase.v1.UpdateSubscriptionRequest"><span class="badge">M</span>UpdateSubscriptionRequest</a>
</li>
- <li>
- <a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a>
- </li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a>
+ <a href="#bytebase.v1.PlanFeature"><span class="badge">E</span>PlanFeature</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a>
+ <a href="#bytebase.v1.PlanType"><span class="badge">E</span>PlanType</a>
</li>
- <li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a>
- </li>
- <li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a>
- </li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a>
+ <a href="#bytebase.v1.SubscriptionService"><span class="badge">S</span>SubscriptionService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fworksheet_service.proto">v1/worksheet_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a>
+ <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest"><span class="badge">M</span>BatchUpdateWorksheetOrganizerRequest</a>
</li>
<li>
- <a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a>
+ <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse"><span class="badge">M</span>BatchUpdateWorksheetOrganizerResponse</a>
</li>
<li>
- <a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a>
+ <a href="#bytebase.v1.CreateWorksheetRequest"><span class="badge">M</span>CreateWorksheetRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a>
+ <a href="#bytebase.v1.DeleteWorksheetRequest"><span class="badge">M</span>DeleteWorksheetRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a>
+ <a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a>
+ <a href="#bytebase.v1.SearchWorksheetsRequest"><span class="badge">M</span>SearchWorksheetsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a>
+ <a href="#bytebase.v1.SearchWorksheetsResponse"><span class="badge">M</span>SearchWorksheetsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
+ <a href="#bytebase.v1.UpdateWorksheetOrganizerRequest"><span class="badge">M</span>UpdateWorksheetOrganizerRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a>
+ <a href="#bytebase.v1.UpdateWorksheetRequest"><span class="badge">M</span>UpdateWorksheetRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a>
+ <a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a>
</li>
<li>
- <a href="#bytebase.v1.SettingValue"><span class="badge">M</span>SettingValue</a>
+ <a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a>
</li>
+
<li>
- <a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a>
+ <a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction"><span class="badge">M</span>WorkspaceProfileSetting.PasswordRestriction</a>
- </li>
-
-
- <li>
- <a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a>
- </li>
-
-
-
- <li>
- <a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a>
- </li>
-
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fsheet_service.proto">v1/sheet_service.proto</a>
- <ul>
-
- <li>
- <a href="#bytebase.v1.BatchCreateSheetsRequest"><span class="badge">M</span>BatchCreateSheetsRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchCreateSheetsResponse"><span class="badge">M</span>BatchCreateSheetsResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.CreateSheetRequest"><span class="badge">M</span>CreateSheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetSheetRequest"><span class="badge">M</span>GetSheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Sheet"><span class="badge">M</span>Sheet</a>
- </li>
-
-
-
-
- <li>
- <a href="#bytebase.v1.SheetService"><span class="badge">S</span>SheetService</a>
- </li>
-
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fsubscription_service.proto">v1/subscription_service.proto</a>
- <ul>
-
- <li>
- <a href="#bytebase.v1.GetSubscriptionRequest"><span class="badge">M</span>GetSubscriptionRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.PlanConfig"><span class="badge">M</span>PlanConfig</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.PlanLimitConfig"><span class="badge">M</span>PlanLimitConfig</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Subscription"><span class="badge">M</span>Subscription</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateSubscriptionRequest"><span class="badge">M</span>UpdateSubscriptionRequest</a>
- </li>
-
-
- <li>
- <a href="#bytebase.v1.PlanFeature"><span class="badge">E</span>PlanFeature</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.PlanType"><span class="badge">E</span>PlanType</a>
- </li>
-
-
-
- <li>
- <a href="#bytebase.v1.SubscriptionService"><span class="badge">S</span>SubscriptionService</a>
- </li>
-
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fworksheet_service.proto">v1/worksheet_service.proto</a>
- <ul>
-
- <li>
- <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest"><span class="badge">M</span>BatchUpdateWorksheetOrganizerRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse"><span class="badge">M</span>BatchUpdateWorksheetOrganizerResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.CreateWorksheetRequest"><span class="badge">M</span>CreateWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DeleteWorksheetRequest"><span class="badge">M</span>DeleteWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.SearchWorksheetsRequest"><span class="badge">M</span>SearchWorksheetsRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.SearchWorksheetsResponse"><span class="badge">M</span>SearchWorksheetsResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateWorksheetOrganizerRequest"><span class="badge">M</span>UpdateWorksheetOrganizerRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateWorksheetRequest"><span class="badge">M</span>UpdateWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a>
- </li>
-
-
- <li>
- <a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a>
- </li>
-
-
-
- <li>
- <a href="#bytebase.v1.WorksheetService"><span class="badge">S</span>WorksheetService</a>
+ <a href="#bytebase.v1.WorksheetService"><span class="badge">S</span>WorksheetService</a>
</li>
</ul>
@@ -3552,12 +3556,12 @@ Examples:
<div class="file-heading">
- <h2 id="v1/user_service.proto">v1/user_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/issue_service.proto">v1/issue_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</h3>
+ <h3 id="bytebase.v1.ApprovalFlow">ApprovalFlow</h3>
<p></p>
@@ -3568,11 +3572,10 @@ Examples:
<tbody>
<tr>
- <td>names</td>
+ <td>roles</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The user names to retrieve.
-Format: users/{email} </p></td>
+ <td><p>The roles required for approval in order. </p></td>
</tr>
</tbody>
@@ -3582,7 +3585,7 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</h3>
+ <h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3>
<p></p>
@@ -3593,34 +3596,24 @@ Format: users/{email} </p></td>
<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>flow</td>
+ <td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td>
+ <td></td>
+ <td><p>The approval flow definition. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</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>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The title of the approval template. </p></td>
+ </tr>
<tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The user to create. </p></td>
+ <td><p>The description of the approval template. </p></td>
</tr>
</tbody>
@@ -3630,7 +3623,7 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3>
+ <h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</h3>
<p></p>
@@ -3644,8 +3637,15 @@ Format: users/{email} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user to delete.
-Format: users/{email} </p></td>
+ <td><p>The name of the issue to add an approver.
+Format: projects/{project}/issues/{issue} </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment explaining the approval decision. </p></td>
</tr>
</tbody>
@@ -3655,7 +3655,7 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3>
+ <h3 id="bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</h3>
<p></p>
@@ -3666,85 +3666,35 @@ Format: users/{email} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user to retrieve.
-Format: users/{email} </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>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of users to return. The service may return fewer than
-this value.
-If unspecified, at most 10 users will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The parent resource shared by all issues being updated.
+Format: projects/{project}
+If the operation spans parents, a dash (-) may be accepted as a wildcard.
+We only support updating the status of databases for now. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>issues</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>repeated</td>
+ <td><p>The list of issues to update.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
<td></td>
- <td><p>Show deleted users if specified. </p></td>
+ <td><p>The new status. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>reason</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter users returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- state: check State enum for values, support &#34;==&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-
-For example:
-name == &#34;ed&#34;
-name.matches(&#34;ed&#34;)
-email == &#34;[email protected]&#34;
-email.matches(&#34;ed&#34;)
-user_type == &#34;SERVICE_ACCOUNT&#34;
-user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]
-!(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;])
-state == &#34;DELETED&#34;
-project == &#34;projects/sample-project&#34;
-You can combine filter conditions like:
-name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34;
-(name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; </p></td>
+ <td><p>The reason for the status change. </p></td>
</tr>
</tbody>
@@ -3754,7 +3704,14 @@ name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#3
- <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3>
+ <h3 id="bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3>
<p></p>
@@ -3765,18 +3722,18 @@ name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#3
<tbody>
<tr>
- <td>users</td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td>repeated</td>
- <td><p>The users from the specified request. </p></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The issue name
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>issue_comment</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
<td></td>
- <td><p>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 comment to create. </p></td>
</tr>
</tbody>
@@ -3786,7 +3743,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>
+ <h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3>
<p></p>
@@ -3797,11 +3754,18 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the deleted user.
-Format: users/{email} </p></td>
+ <td><p>The parent, which owns this collection of issues.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>issue</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td></td>
+ <td><p>The issue to create. </p></td>
</tr>
</tbody>
@@ -3811,7 +3775,7 @@ Format: users/{email} </p></td>
- <h3 id="bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</h3>
+ <h3 id="bytebase.v1.GetIssueRequest">GetIssueRequest</h3>
<p></p>
@@ -3825,16 +3789,15 @@ Format: users/{email} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user whose email to update.
-Format: users/{email}
-Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. </p></td>
+ <td><p>The name of the issue to retrieve.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>email</td>
- <td><a href="#string">string</a></td>
+ <td>force</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The new email address. </p></td>
+ <td><p>If set to true, bypass cache and fetch the latest data. </p></td>
</tr>
</tbody>
@@ -3844,7 +3807,7 @@ Note: This is the current (old) email address. The new email is specified in the
- <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</h3>
+ <h3 id="bytebase.v1.GrantRequest">GrantRequest</h3>
<p></p>
@@ -3855,50 +3818,33 @@ Note: This is the current (old) email address. The new email is specified in the
<tbody>
<tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td></td>
- <td><p>The user to update.
-
-The user&#39;s `name` field is used to identify the user to update.
-Format: users/{email} </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>role</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The requested role.
+Format: roles/EXPORTER. </p></td>
</tr>
<tr>
- <td>otp_code</td>
+ <td>user</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
- </tr>
-
- <tr>
- <td>regenerate_temp_mfa_secret</td>
- <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The 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>The user to be granted.
+Format: users/{email}. </p></td>
</tr>
<tr>
- <td>regenerate_recovery_codes</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>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>
+ <td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>expiration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</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>The duration for which the grant is valid. </p></td>
</tr>
</tbody>
@@ -3908,7 +3854,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.User">User</h3>
+ <h3 id="bytebase.v1.Issue">Issue</h3>
<p></p>
@@ -3922,108 +3868,108 @@ In this situation, `update_mask` is ignored. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user.
-Format: users/{email} </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The lifecycle state of the user account. </p></td>
+ <td><p>The name of the issue.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>email</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The email address of the user, used for login and notifications. </p></td>
+ <td><p>The title of the issue. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The display title or full name of the user. </p></td>
+ <td><p>The description of the issue. </p></td>
</tr>
<tr>
- <td>user_type</td>
- <td><a href="#bytebase.v1.UserType">UserType</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td>
<td></td>
- <td><p>The type of user account. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>password</td>
- <td><a href="#string">string</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
<td></td>
- <td><p>The password for authentication. Only used during user creation or password updates. </p></td>
+ <td><p>The status of the issue. </p></td>
</tr>
<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>
+ <td>approvers</td>
+ <td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>mfa_enabled</td>
- <td><a href="#bool">bool</a></td>
+ <td>approval_template</td>
+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
<td></td>
- <td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td>
+ <td><p>The approval template for the issue. </p></td>
</tr>
<tr>
- <td>temp_otp_secret</td>
+ <td>creator</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td>
+ <td><p>Format: users/[email protected] </p></td>
</tr>
<tr>
- <td>temp_recovery_codes</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>temp_otp_secret_created_time</td>
+ <td>update_time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>phone</td>
+ <td>plan</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Should be a valid E.164 compliant phone number.
-Could be empty. </p></td>
+ <td><p>The plan associated with the issue.
+Can be empty.
+Format: projects/{project}/plans/{plan} </p></td>
</tr>
<tr>
- <td>profile</td>
- <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td>
+ <td>grant_request</td>
+ <td><a href="#bytebase.v1.GrantRequest">GrantRequest</a></td>
<td></td>
- <td><p>User profile metadata. </p></td>
+ <td><p>Used if the issue type is GRANT_REQUEST. </p></td>
</tr>
<tr>
- <td>groups</td>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td></td>
+ <td><p>The risk level of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The groups for the user.
-Format: groups/{email} </p></td>
+ <td><p>Labels attached to the issue for categorization and filtering. </p></td>
</tr>
<tr>
- <td>workload_identity_config</td>
- <td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td>
- <td></td>
- <td><p>Workload Identity configuration (only for WORKLOAD_IDENTITY type) </p></td>
+ <td>approval_status</td>
+ <td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -4033,8 +3979,8 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.User.Profile">User.Profile</h3>
- <p></p>
+ <h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>
+ <p>Approvers and their approval status for the issue.</p>
<table class="field-table">
@@ -4044,24 +3990,97 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>last_login_time</td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</a></td>
+ <td></td>
+ <td><p>The new status. </p></td>
+ </tr>
+
+ <tr>
+ <td>principal</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IssueComment">IssueComment</h3>
+ <p>A comment on an issue.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The text content of the comment. </p></td>
+ </tr>
+
+ <tr>
+ <td>payload</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>TODO: use struct message instead. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The last time the user successfully logged in. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>last_change_password_time</td>
+ <td>update_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>
+ <td><p> </p></td>
</tr>
<tr>
- <td>source</td>
+ <td>creator</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td>
+ <td><p>Format: users/{email} </p></td>
+ </tr>
+
+ <tr>
+ <td>approval</td>
+ <td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td>
+ <td></td>
+ <td><p>Approval event. </p></td>
+ </tr>
+
+ <tr>
+ <td>issue_update</td>
+ <td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td>
+ <td></td>
+ <td><p>Issue update event. </p></td>
+ </tr>
+
+ <tr>
+ <td>plan_spec_update</td>
+ <td><a href="#bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</a></td>
+ <td></td>
+ <td><p>Plan spec update event. </p></td>
</tr>
</tbody>
@@ -4071,8 +4090,8 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3>
- <p>WorkloadIdentityConfig for API layer</p>
+ <h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>
+ <p>Approval event information.</p>
<table class="field-table">
@@ -4082,31 +4101,124 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>provider_type</td>
- <td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td>
<td></td>
- <td><p>Platform type (currently only GITHUB is supported) </p></td>
+ <td><p>The approval status. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>
+ <p>Issue update event information.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>issuer_url</td>
+ <td>from_title</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td>
+ <td>optional</td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>allowed_audiences</td>
+ <td>to_title</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_description</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_description</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_labels</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>Allowed audiences for token validation </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>subject_pattern</td>
+ <td>to_labels</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</h3>
+ <p>Plan spec update event information (tracks sheet changes to plan specs).</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>spec</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) </p></td>
+ <td><p>The spec that was updated.
+Format: projects/{project}/plans/{plan}/specs/{spec} </p></td>
+ </tr>
+
+ <tr>
+ <td>from_sheet</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The previous sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>to_sheet</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The new sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
</tbody>
@@ -4116,288 +4228,161 @@ Format: groups/{email} </p></td>
+ <h3 id="bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{projects}/issues/{issue} </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of issue comments to return. The service may return fewer than
+this value.
+If unspecified, at most 10 issue comments will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListIssueComments` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListIssueComments` must match
+the call that provided the page token. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.UserType">UserType</h3>
+ <h3 id="bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>USER_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified user type.</p></td>
- </tr>
-
- <tr>
- <td>USER</td>
- <td>1</td>
- <td><p>Regular human user account.</p></td>
- </tr>
-
- <tr>
- <td>SYSTEM_BOT</td>
- <td>2</td>
- <td><p>System-managed bot account for automated operations.</p></td>
- </tr>
-
- <tr>
- <td>SERVICE_ACCOUNT</td>
- <td>3</td>
- <td><p>Service account for API integrations.</p></td>
- </tr>
-
- <tr>
- <td>WORKLOAD_IDENTITY</td>
- <td>4</td>
- <td><p>External CI/CD workload identity.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3>
- <p>ProviderType identifies the CI/CD platform.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>PROVIDER_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GITHUB</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GITLAB</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>issue_comments</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td>repeated</td>
+ <td><p>The issue comments from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.UserService">UserService</h3>
- <p>UserService manages user accounts and authentication.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetUser</td>
- <td><a href="#bytebase.v1.GetUserRequest">GetUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Get the user.
-Any authenticated user can get the user.
-Permissions required: bb.users.get</p></td>
- </tr>
-
- <tr>
- <td>BatchGetUsers</td>
- <td><a href="#bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</a></td>
- <td><p>Get the users in batch.
-Any authenticated user can batch get users.
-Permissions required: bb.users.get</p></td>
- </tr>
-
- <tr>
- <td>GetCurrentUser</td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Get the current authenticated user.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>ListUsers</td>
- <td><a href="#bytebase.v1.ListUsersRequest">ListUsersRequest</a></td>
- <td><a href="#bytebase.v1.ListUsersResponse">ListUsersResponse</a></td>
- <td><p>List all users.
-Any authenticated user can list users.
-Permissions required: bb.users.list</p></td>
- </tr>
-
- <tr>
- <td>CreateUser</td>
- <td><a href="#bytebase.v1.CreateUserRequest">CreateUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.
-Permissions required: bb.users.create (only when Disallow Signup is enabled)</p></td>
- </tr>
-
- <tr>
- <td>UpdateUser</td>
- <td><a href="#bytebase.v1.UpdateUserRequest">UpdateUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
-Note: Email updates are not supported through this API. Use UpdateEmail instead.
-Permissions required: bb.users.update (or self)</p></td>
- </tr>
-
- <tr>
- <td>DeleteUser</td>
- <td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
-Permissions required: bb.users.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteUser</td>
- <td><a href="#bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Restores a deleted user.
-Permissions required: bb.users.undelete</p></td>
- </tr>
-
- <tr>
- <td>UpdateEmail</td>
- <td><a href="#bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</a></td>
- <td><a href="#bytebase.v1.User">User</a></td>
- <td><p>Updates a user&#39;s email address.
-Permissions required: bb.users.updateEmail</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.ListIssuesRequest">ListIssuesRequest</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>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent, which owns this collection of issues.
+Format: projects/{project} </p></td>
+ </tr>
- <tr>
- <td>GetUser</td>
- <td>GET</td>
- <td>/v1/{name=users/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of issues to return. The service may return fewer than
+this value.
+If unspecified, at most 10 issues will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
-
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListIssues` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListIssues` must match
+the call that provided the page token. </p></td>
+ </tr>
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter issues returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
+- status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values.
+- create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+- type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values.
+- labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator.
+- approval_status: issue approval status, support &#34;==&#34; operator.
+- current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
+
+For example:
+creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;]
+status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34;
+labels in [&#34;label1&#34;, &#34;label2&#34;]
+create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
+ </tr>
- <tr>
- <td>BatchGetUsers</td>
- <td>GET</td>
- <td>/v1/users:batchGet</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetCurrentUser</td>
- <td>GET</td>
- <td>/v1/users/me</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListUsers</td>
- <td>GET</td>
- <td>/v1/users</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateUser</td>
- <td>POST</td>
- <td>/v1/users</td>
- <td>user</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateUser</td>
- <td>PATCH</td>
- <td>/v1/{user.name=users/*}</td>
- <td>user</td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteUser</td>
- <td>DELETE</td>
- <td>/v1/{name=users/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UndeleteUser</td>
- <td>POST</td>
- <td>/v1/{name=users/*}:undelete</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateEmail</td>
- <td>POST</td>
- <td>/v1/{name=users/*}:updateEmail</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>query</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Query is the query statement. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/actuator_service.proto">v1/actuator_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.ActuatorInfo">ActuatorInfo</h3>
- <p>System information and configuration for the Bytebase instance.</p><p>Actuator concept is similar to the Spring Boot Actuator.</p>
+ <h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -4407,136 +4392,176 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The Bytebase server version. </p></td>
+ <td>issues</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>repeated</td>
+ <td><p>The issues from the specified request. </p></td>
</tr>
<tr>
- <td>git_commit</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The git commit hash of the build. </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
- <tr>
- <td>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>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>saas</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. </p></td>
+ <td><p>The name of the issue to add a rejection.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>demo</td>
- <td><a href="#bool">bool</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in demo mode. </p></td>
+ <td><p>The comment explaining the rejection decision. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RequestIssueRequest">RequestIssueRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>host</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The host address of the Bytebase instance. </p></td>
+ <td><p>The name of the issue to request a issue.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>port</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port number of the Bytebase instance. </p></td>
+ <td><p>The comment explaining the request. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>external_url</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td>
+ <td><p>The parent, which owns this collection of issues.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list all issues from all projects. </p></td>
</tr>
<tr>
- <td>need_admin_setup</td>
- <td><a href="#bool">bool</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>
+ <td><p>The maximum number of issues to return. The service may return fewer than
+this value.
+If unspecified, at most 10 issues will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>last_active_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The last time any API call was made, refreshed on each request. </p></td>
+ <td><p>A page token, received from a previous `SearchIssues` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchIssues` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>workspace_id</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique identifier for the workspace. </p></td>
+ <td><p>Filter is used to filter issues returned in the list.
+Check the filter field in the ListIssuesRequest message. </p></td>
</tr>
<tr>
- <td>unlicensed_features</td>
+ <td>query</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>docker</td>
- <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in Docker. </p></td>
+ <td><p>Query is the query statement. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>user_stats</td>
- <td><a href="#bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</a></td>
+ <td>issues</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
<td>repeated</td>
- <td><p>Statistics about users in the system. </p></td>
+ <td><p>The issues from the specified request. </p></td>
</tr>
<tr>
- <td>activated_instance_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The number of activated database instances. </p></td>
- </tr>
-
- <tr>
- <td>total_instance_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The total number of database instances. </p></td>
- </tr>
-
- <tr>
- <td>enable_sample</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether sample data setup is enabled. </p></td>
- </tr>
-
- <tr>
- <td>external_url_from_flag</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </p></td>
- </tr>
-
- <tr>
- <td>replica_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The number of active replicas (servers sharing the same database). </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>
@@ -4546,8 +4571,8 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>
- <p>User statistics by type and state.</p>
+ <h3 id="bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</h3>
+ <p></p>
<table class="field-table">
@@ -4557,24 +4582,33 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>user_type</td>
- <td><a href="#bytebase.v1.UserType">UserType</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of user. </p></td>
+ <td><p>The issue name
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>issue_comment</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
<td></td>
- <td><p>The state of the user. </p></td>
+ <td><p>The comment to update. </p></td>
</tr>
<tr>
- <td>count</td>
- <td><a href="#int32">int32</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The count of users matching this type and state. </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 issue comment is not found, a new issue comment will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -4584,29 +4618,8 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3>
- <p>Request message for deleting cache.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.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.UpdateIssueRequest">UpdateIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -4616,10 +4629,28 @@ Permissions required: bb.users.updateEmail</p></td>
<tbody>
<tr>
- <td>logo</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>issue</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
<td></td>
- <td><p>The branding logo. </p></td>
+ <td><p>The issue to update.
+
+The issue&#39;s `name` field is used to identify the issue to update.
+Format: projects/{project}/issues/{issue} </p></td>
+ </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 issue is not found, a new issue will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -4629,537 +4660,455 @@ Permissions required: bb.users.updateEmail</p></td>
- <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>
- <p>Request message for setting up sample data.</p>
-
-
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>
- <p>ActuatorService manages system health and operational information.</p>
+ <h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3>
+ <p>The overall approval status for the issue.</p>
<table class="enum-table">
<thead>
- <tr><td>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>
+ <td>APPROVAL_STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified approval status.</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>CHECKING</td>
+ <td>1</td>
+ <td><p>Approval checks are being evaluated.</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>PENDING</td>
+ <td>2</td>
+ <td><p>Approval is pending.</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>APPROVED</td>
+ <td>3</td>
+ <td><p>Issue has been approved.</p></td>
+ </tr>
+
+ <tr>
+ <td>REJECTED</td>
+ <td>4</td>
+ <td><p>Issue has been rejected.</p></td>
+ </tr>
+
+ <tr>
+ <td>SKIPPED</td>
+ <td>5</td>
+ <td><p>Approval was skipped.</p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
+
+ <h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3>
+ <p>The approval status of an approver.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>GetActuatorInfo</td>
- <td>GET</td>
- <td>/v1/actuator/info</td>
- <td></td>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p>Awaiting approval.</p></td>
</tr>
-
-
-
<tr>
- <td>SetupSample</td>
- <td>POST</td>
- <td>/v1/actuator:setupSample</td>
- <td></td>
+ <td>APPROVED</td>
+ <td>2</td>
+ <td><p>Approved.</p></td>
</tr>
-
-
-
<tr>
- <td>DeleteCache</td>
- <td>DELETE</td>
- <td>/v1/actuator/cache</td>
- <td></td>
+ <td>REJECTED</td>
+ <td>3</td>
+ <td><p>Rejected.</p></td>
</tr>
-
-
-
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Issue.Type">Issue.Type</h3>
+ <p>The type of issue.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>GetResourcePackage</td>
- <td>GET</td>
- <td>/v1/actuator/resources</td>
- <td></td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/iam_policy.proto">v1/iam_policy.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.Binding">Binding</h3>
- <p>Binding associates members with a role and optional conditions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>role</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The role that is assigned to the members.
-Format: roles/{role} </p></td>
- </tr>
-
- <tr>
- <td>members</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Specifies the principals requesting access for a Bytebase resource.
-For users, the member should be: user:{email}
-For groups, the member should be: group:{email} </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this binding, only used in the project IAM policy.
-If the condition evaluates to true, then this binding applies to the current request.
-If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
-
-For example:
-resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;]
-resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;]
-request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
- </tr>
-
- <tr>
- <td>parsed_expr</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
- <td></td>
- <td><p>The parsed expression of the condition. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <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>action</td>
- <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td>
- <td></td>
- <td><p>The action that was performed on a Binding. </p></td>
- </tr>
-
- <tr>
- <td>role</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Role that is assigned to `members`.
-For example, `roles/projectOwner`. </p></td>
- </tr>
-
- <tr>
- <td>member</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Follows the same format of Binding.members. </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this binding. </p></td>
- </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>resource</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>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>
- <p>IAM policy that binds members to roles.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>bindings</td>
- <td><a href="#bytebase.v1.Binding">Binding</a></td>
- <td>repeated</td>
- <td><p>Collection of binding.
-A binding binds one or more project members to a single project role. </p></td>
- </tr>
-
- <tr>
- <td>etag</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The current etag of the policy.
-If an etag is provided and does not match the current etag of the policy,
-the call will be blocked and an ABORTED error will be returned. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>
- <p>Describes changes between two IAM policies.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>binding_deltas</td>
- <td><a href="#bytebase.v1.BindingDelta">BindingDelta</a></td>
- <td>repeated</td>
- <td><p>The delta for Bindings between two policies. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>
- <p>Request message for setting an IAM policy.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>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><a href="#string">string</a></td>
- <td></td>
- <td><p>The current etag of the policy. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
- <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>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified issue type.</p></td>
</tr>
<tr>
- <td>ADD</td>
+ <td>DATABASE_CHANGE</td>
<td>1</td>
- <td><p>Add a binding.</p></td>
+ <td><p>Database schema or data change.</p></td>
</tr>
<tr>
- <td>REMOVE</td>
+ <td>GRANT_REQUEST</td>
<td>2</td>
- <td><p>Remove a binding.</p></td>
+ <td><p>Database access grant request.</p></td>
</tr>
- </tbody>
+ <tr>
+ <td>DATABASE_EXPORT</td>
+ <td>3</td>
+ <td><p>Database data export request.</p></td>
+ </tr>
+
+ </tbody>
</table>
-
-
-
+ <h3 id="bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</h3>
+ <p>Approval status values.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p>Approval pending.</p></td>
+ </tr>
+
+ <tr>
+ <td>APPROVED</td>
+ <td>2</td>
+ <td><p>Approved.</p></td>
+ </tr>
+
+ <tr>
+ <td>REJECTED</td>
+ <td>3</td>
+ <td><p>Rejected.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
+ <h3 id="bytebase.v1.IssueStatus">IssueStatus</h3>
+ <p>The status of an issue.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ISSUE_STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>OPEN</td>
+ <td>1</td>
+ <td><p>Issue is open and active.</p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>2</td>
+ <td><p>Issue is completed.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>3</td>
+ <td><p>Issue is canceled.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <div class="file-heading">
- <h2 id="v1/audit_log_service.proto">v1/audit_log_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
- <h3 id="bytebase.v1.AuditData">AuditData</h3>
- <p>Additional audit data specific to certain operations.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>policy_delta</td>
- <td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td>
- <td></td>
- <td><p>Changes to IAM policies. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h3 id="bytebase.v1.AuditLog">AuditLog</h3>
- <p>Audit log entry recording system activity or API call.</p>
+ <h3 id="bytebase.v1.IssueService">IssueService</h3>
+ <p>IssueService manages issues for tracking database changes and tasks.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetIssue</td>
+ <td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Retrieves an issue by name.
+Permissions required: bb.issues.get</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIssue</td>
+ <td><a href="#bytebase.v1.CreateIssueRequest">CreateIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Creates a new issue for database changes or tasks.
+Permissions required: bb.issues.create</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIssues</td>
+ <td><a href="#bytebase.v1.ListIssuesRequest">ListIssuesRequest</a></td>
+ <td><a href="#bytebase.v1.ListIssuesResponse">ListIssuesResponse</a></td>
+ <td><p>Lists issues in a project.
+Permissions required: bb.issues.list</p></td>
+ </tr>
+
+ <tr>
+ <td>SearchIssues</td>
+ <td><a href="#bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</a></td>
+ <td><a href="#bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</a></td>
+ <td><p>Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query.
+Permissions required: bb.issues.get</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIssue</td>
+ <td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Updates an issue&#39;s properties such as title, description, or labels.
+Permissions required: bb.issues.update</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIssueComments</td>
+ <td><a href="#bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</a></td>
+ <td><a href="#bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</a></td>
+ <td><p>Lists comments on an issue.
+Permissions required: bb.issueComments.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIssueComment</td>
+ <td><a href="#bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</a></td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td><p>Adds a comment to an issue.
+Permissions required: bb.issueComments.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIssueComment</td>
+ <td><a href="#bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</a></td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td><p>Updates an existing issue comment.
+Permissions required: bb.issueComments.update</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchUpdateIssuesStatus</td>
+ <td><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</a></td>
+ <td><p>Updates the status of multiple issues in a single operation.
+Permissions required: bb.issues.update</p></td>
+ </tr>
+
+ <tr>
+ <td>ApproveIssue</td>
+ <td><a href="#bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ <tr>
+ <td>RejectIssue</td>
+ <td><a href="#bytebase.v1.RejectIssueRequest">RejectIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ <tr>
+ <td>RequestIssue</td>
+ <td><a href="#bytebase.v1.RequestIssueRequest">RequestIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the log.
-Formats:
-- projects/{project}/auditLogs/{uid}
-- workspaces/{workspace}/auditLogs/{uid} </p></td>
- </tr>
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The timestamp when the audit log was created. </p></td>
- </tr>
+ <tr>
+ <td>GetIssue</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/issues/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>user</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The user who performed the action.
-Format: users/{email} </p></td>
- </tr>
+
- <tr>
- <td>method</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The method or action being audited.
-For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></td>
- </tr>
- <tr>
- <td>severity</td>
- <td><a href="#bytebase.v1.AuditLog.Severity">AuditLog.Severity</a></td>
- <td></td>
- <td><p>The severity level of this audit log entry. </p></td>
- </tr>
+ <tr>
+ <td>CreateIssue</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues</td>
+ <td>issue</td>
+ </tr>
- <tr>
- <td>resource</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource associated with this audit log. </p></td>
- </tr>
+
- <tr>
- <td>request</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The request payload in JSON format. </p></td>
- </tr>
- <tr>
- <td>response</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The response payload in JSON format.
-Some fields may be omitted if they are too large or contain sensitive information. </p></td>
- </tr>
+ <tr>
+ <td>ListIssues</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/issues</td>
+ <td></td>
+ </tr>
- <tr>
- <td>status</td>
- <td><a href="#google.rpc.Status">google.rpc.Status</a></td>
- <td></td>
- <td><p>The status of the operation. </p></td>
- </tr>
+
- <tr>
- <td>latency</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The duration of the operation. </p></td>
- </tr>
- <tr>
- <td>service_data</td>
- <td><a href="#google.protobuf.Any">google.protobuf.Any</a></td>
- <td></td>
- <td><p>Service-specific metadata about the request, response, and activities. </p></td>
- </tr>
+ <tr>
+ <td>SearchIssues</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues:search</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>request_metadata</td>
- <td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td>
- <td></td>
- <td><p>Metadata about the request context. </p></td>
- </tr>
+
+
+
+ <tr>
+ <td>UpdateIssue</td>
+ <td>PATCH</td>
+ <td>/v1/{issue.name=projects/*/issues/*}</td>
+ <td>issue</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListIssueComments</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/issues/*}/issueComments</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateIssueComment</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/issues/*}:comment</td>
+ <td>issue_comment</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateIssueComment</td>
+ <td>PATCH</td>
+ <td>/v1/{parent=projects/*/issues/*}:comment</td>
+ <td>issue_comment</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchUpdateIssuesStatus</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ApproveIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:approve</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>RejectIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:reject</td>
+ <td>*</td>
+ </tr>
+
+
+
+ <tr>
+ <td>RequestIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:request</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>
- <p>Request message for exporting audit logs.</p>
+ <div class="file-heading">
+ <h2 id="v1/setting_service.proto">v1/setting_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.AISetting">AISetting</h3>
+ <p></p>
<table class="field-table">
@@ -5169,54 +5118,45 @@ Some fields may be omitted if they are too large or contain sensitive informatio
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>enabled</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
+ <td>provider</td>
+ <td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td>
<td></td>
- <td><p>The filter of the log. It should be a valid CEL expression.
-Check the filter field in the SearchAuditLogsRequest message. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>order_by</td>
+ <td>endpoint</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The order by of the log.
-Only support order by create_time. The default sorting order is ascending.
-For example:
- - order_by = &#34;create_time asc&#34;
- - order_by = &#34;create_time desc&#34; </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td>api_key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The export format. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>model</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of logs to return.
-The service may return fewer than this value.
-If unspecified, at most 10 log entries will be returned.
-The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ExportAuditLogs` call.
-Provide this to retrieve the subsequent page. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5226,8 +5166,8 @@ Provide this to retrieve the subsequent page. </p></td>
- <h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>
- <p>Response message for exporting audit logs.</p>
+ <h3 id="bytebase.v1.Algorithm">Algorithm</h3>
+ <p></p>
<table class="field-table">
@@ -5237,19 +5177,31 @@ Provide this to retrieve the subsequent page. </p></td>
<tbody>
<tr>
- <td>content</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>full_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>
<td></td>
- <td><p>The exported audit log content in the requested format. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>next_page_token</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>A token to retrieve next page of log entities.
-Pass this value in the page_token field in the subsequent call
-to retrieve the next page of log entities. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>md5_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>inner_outer_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5259,8 +5211,8 @@ to retrieve the next page of log entities. </p></td>
- <h3 id="bytebase.v1.RequestMetadata">RequestMetadata</h3>
- <p>Metadata about the incoming request.</p>
+ <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>
+ <p></p>
<table class="field-table">
@@ -5270,18 +5222,11 @@ to retrieve the next page of log entities. </p></td>
<tbody>
<tr>
- <td>caller_ip</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The IP address of the request originator. </p></td>
- </tr>
-
- <tr>
- <td>caller_supplied_user_agent</td>
+ <td>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The user agent string provided by the caller.
-This is supplied by the client and is not authenticated. </p></td>
+ <td><p>substitution is the string used to replace the original value, the
+max length of the string is 16 bytes. </p></td>
</tr>
</tbody>
@@ -5291,8 +5236,8 @@ This is supplied by the client and is not authenticated. </p></td>
- <h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>
- <p>Request message for searching audit logs.</p>
+ <h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>
+ <p></p>
<table class="field-table">
@@ -5302,59 +5247,31 @@ This is supplied by the client and is not authenticated. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>prefix_len</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The filter of the log. It should be a valid CEL expression.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator.
-- severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values.
-- user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator.
-- create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
-
-For example:
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34;
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34;
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34;
- - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; </p></td>
- </tr>
-
- <tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
+ <td>suffix_len</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The order by of the log.
-Only support order by create_time. The default sorting order is ascending.
-For example:
- - order_by = &#34;create_time asc&#34;
- - order_by = &#34;create_time desc&#34; </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>
<td></td>
- <td><p>The maximum number of logs to return.
-The service may return fewer than this value.
-If unspecified, at most 10 log entries will be returned.
-The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchLogs` call.
-Provide this to retrieve the subsequent page. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5364,8 +5281,8 @@ Provide this to retrieve the subsequent page. </p></td>
- <h3 id="bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</h3>
- <p>Response message for searching audit logs.</p>
+ <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>
+ <p></p>
<table class="field-table">
@@ -5375,19 +5292,10 @@ Provide this to retrieve the subsequent page. </p></td>
<tbody>
<tr>
- <td>audit_logs</td>
- <td><a href="#bytebase.v1.AuditLog">AuditLog</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
+ <td>salt</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token to retrieve next page of log entities.
-Pass this value in the page_token field in the subsequent call
-to retrieve the next page of log entities. </p></td>
+ <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td>
</tr>
</tbody>
@@ -5397,166 +5305,32 @@ to retrieve the next page of log entities. </p></td>
-
-
- <h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>
- <p>Severity level for audit log entries.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SEVERITY_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified severity level.</p></td>
- </tr>
-
- <tr>
- <td>DEBUG</td>
- <td>1</td>
- <td><p>Debug-level information.</p></td>
- </tr>
-
- <tr>
- <td>INFO</td>
- <td>2</td>
- <td><p>Informational messages.</p></td>
- </tr>
-
- <tr>
- <td>NOTICE</td>
- <td>3</td>
- <td><p>Notable events.</p></td>
- </tr>
-
- <tr>
- <td>WARNING</td>
- <td>4</td>
- <td><p>Warning conditions.</p></td>
- </tr>
-
- <tr>
- <td>ERROR</td>
- <td>5</td>
- <td><p>Error conditions.</p></td>
- </tr>
-
- <tr>
- <td>CRITICAL</td>
- <td>6</td>
- <td><p>Critical conditions.</p></td>
- </tr>
-
- <tr>
- <td>ALERT</td>
- <td>7</td>
- <td><p>Action must be taken immediately.</p></td>
- </tr>
-
- <tr>
- <td>EMERGENCY</td>
- <td>8</td>
- <td><p>System is unusable.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AuditLogService">AuditLogService</h3>
- <p>AuditLogService manages audit logs for system activities and API calls.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SearchAuditLogs</td>
- <td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td>
- <td><a href="#bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</a></td>
- <td><p>Searches audit logs with optional filtering and pagination.
-Permissions required: bb.auditLogs.search</p></td>
- </tr>
-
- <tr>
- <td>ExportAuditLogs</td>
- <td><a href="#bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</a></td>
- <td><a href="#bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</a></td>
- <td><p>Exports audit logs in a specified format for external analysis.
-Permissions required: bb.auditLogs.export</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</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>SearchAuditLogs</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/auditLogs:search</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>SearchAuditLogs</td>
- <td>POST</td>
- <td>/v1/auditLogs:search</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ExportAuditLogs</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/auditLogs:export</td>
- <td>*</td>
- </tr>
- <tr>
- <td>ExportAuditLogs</td>
- <td>POST</td>
- <td>/v1/auditLogs:export</td>
- <td>*</td>
- </tr>
+ <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>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/auth_service.proto">v1/auth_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</h3>
+ <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3>
<p></p>
@@ -5567,18 +5341,27 @@ Permissions required: bb.auditLogs.export</p></td>
<tbody>
<tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
+ <td>start</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>External OIDC token (JWT) from CI/CD platform. </p></td>
+ <td><p>start is the start character index (0-based) of the original value, should be less than end.
+Uses character indices (not byte offsets) for display-oriented masking.
+Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). </p></td>
</tr>
<tr>
- <td>email</td>
+ <td>end</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>end is the end character index (exclusive) of the original value.
+Uses character indices (not byte offsets) for display-oriented masking. </p></td>
+ </tr>
+
+ <tr>
+ <td>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Workload Identity email for identifying which identity to authenticate as.
-Format: {name}@workload.bytebase.com </p></td>
+ <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>
</tr>
</tbody>
@@ -5588,7 +5371,7 @@ Format: {name}@workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</h3>
+ <h3 id="bytebase.v1.Announcement">Announcement</h3>
<p></p>
@@ -5599,10 +5382,24 @@ Format: {name}@workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>access_token</td>
- <td><a href="#string">string</a></td>
+ <td>level</td>
+ <td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td>
<td></td>
- <td><p>Bytebase access token. </p></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 text of announcement </p></td>
+ </tr>
+
+ <tr>
+ <td>link</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The optional link, user can follow the link to check extra details </p></td>
</tr>
</tbody>
@@ -5612,8 +5409,8 @@ Format: {name}@workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>
- <p>Context for identity provider authentication.</p>
+ <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>
+ <p></p>
<table class="field-table">
@@ -5623,17 +5420,48 @@ Format: {name}@workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>oauth2_context</td>
- <td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td>
+ <td>settings</td>
+ <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>client_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>OAuth2 authentication context. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>oidc_context</td>
- <td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>OpenID Connect authentication context. </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>
@@ -5643,7 +5471,7 @@ Format: {name}@workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.LoginRequest">LoginRequest</h3>
+ <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>
<p></p>
@@ -5654,61 +5482,83 @@ Format: {name}@workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>email</td>
+ <td>app_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>User&#39;s email address. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>app_secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>User&#39;s password for authentication. </p></td>
+ <td><p> </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>web</td>
- <td><a href="#bool">bool</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>
<td></td>
- <td><p>If true, sets access token and refresh token as HTTP-only cookies instead of
-returning the token in the response body. Use for browser-based clients. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>idp_name</td>
- <td><a href="#string">string</a></td>
+ <td>slack</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td>
<td></td>
- <td><p>The name of the identity provider.
-Format: idps/{idp} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>idp_context</td>
- <td><a href="#bytebase.v1.IdentityProviderContext">IdentityProviderContext</a></td>
+ <td>feishu</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>
<td></td>
- <td><p>The idp_context is used to get the user information from identity provider. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>otp_code</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
+ <td>wecom</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>recovery_code</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The recovery_code is used to recovery the user&#39;s identity with MFA. </p></td>
+ <td>lark</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>mfa_temp_token</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The mfa_temp_token is used to verify the user&#39;s identity by MFA. </p></td>
+ <td>dingtalk</td>
+ <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>teams</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5718,7 +5568,7 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.LoginResponse">LoginResponse</h3>
+ <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3>
<p></p>
@@ -5729,32 +5579,17 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>token</td>
+ <td>app_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Access token for authenticated requests.
-Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>mfa_temp_token</td>
+ <td>app_secret</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Temporary token for MFA verification. </p></td>
- </tr>
-
- <tr>
- <td>require_reset_password</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether user must reset password before continuing. </p></td>
- </tr>
-
- <tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p>The user from the successful login. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5764,15 +5599,32 @@ Only returned when web=false. For web=true, the token is set as an HTTP-only coo
- <h3 id="bytebase.v1.LogoutRequest">LogoutRequest</h3>
- <p>Request to logout current user session.</p>
+ <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3>
+ <p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</h3>
- <p>OAuth2 authentication context.</p>
+ <h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</h3>
+ <p></p>
<table class="field-table">
@@ -5782,10 +5634,24 @@ Only returned when web=false. For web=true, the token is set as an HTTP-only coo
<tbody>
<tr>
- <td>code</td>
+ <td>tenant_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Authorization code from OAuth2 provider. </p></td>
+ <td><p>Azure AD tenant ID (Directory ID). </p></td>
+ </tr>
+
+ <tr>
+ <td>client_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Azure AD application (client) ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Azure AD client secret. </p></td>
</tr>
</tbody>
@@ -5795,8 +5661,8 @@ Only returned when web=false. For web=true, the token is set as an HTTP-only coo
- <h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3>
- <p>OpenID Connect authentication context.</p>
+ <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>
+ <p></p>
<table class="field-table">
@@ -5806,10 +5672,24 @@ Only returned when web=false. For web=true, the token is set as an HTTP-only coo
<tbody>
<tr>
- <td>code</td>
+ <td>corp_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Authorization code from OIDC provider. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>agent_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5819,139 +5699,79 @@ Only returned when web=false. For web=true, the token is set as an HTTP-only coo
- <h3 id="bytebase.v1.RefreshRequest">RefreshRequest</h3>
- <p>Request to refresh the access token.</p>
+ <h3 id="bytebase.v1.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>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.RefreshResponse">RefreshResponse</h3>
- <p>Response from refreshing the access token.</p>
-
-
-
-
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.AuthService">AuthService</h3>
- <p>AuthService handles user authentication operations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>Login</td>
- <td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td>
- <td><a href="#bytebase.v1.LoginResponse">LoginResponse</a></td>
- <td><p>Authenticates a user and returns access tokens.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>Logout</td>
- <td><a href="#bytebase.v1.LogoutRequest">LogoutRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Logs out the current user session.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>ExchangeToken</td>
- <td><a href="#bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</a></td>
- <td><a href="#bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</a></td>
- <td><p>Exchanges an external OIDC token for a Bytebase access token.
-Used by CI/CD pipelines with Workload Identity Federation.
-Permissions required: None (validates via OIDC token)</p></td>
- </tr>
-
- <tr>
- <td>Refresh</td>
- <td><a href="#bytebase.v1.RefreshRequest">RefreshRequest</a></td>
- <td><a href="#bytebase.v1.RefreshResponse">RefreshResponse</a></td>
- <td><p>Refreshes the access token using the refresh token cookie.
-Permissions required: None (validates via refresh token cookie)</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</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>Login</td>
- <td>POST</td>
- <td>/v1/auth/login</td>
- <td>*</td>
- </tr>
-
-
-
- <tr>
- <td>Logout</td>
- <td>POST</td>
- <td>/v1/auth/logout</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ExchangeToken</td>
- <td>POST</td>
- <td>/v1/auth:exchangeToken</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td>
+ </tr>
-
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+ <tr>
+ <td>levels</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</a></td>
+ <td>repeated</td>
+ <td><p>levels is user defined level list for classification.
+The order for the level decides its priority. </p></td>
+ </tr>
- <tr>
- <td>Refresh</td>
- <td>POST</td>
- <td>/v1/auth/refresh</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>classification</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></td>
+ <td>repeated</td>
+ <td><p>classification is the id - DataClassification map.
+The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>
- <p>Request message for batch deparsing CEL expressions.</p>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3>
+ <p></p>
<table class="field-table">
@@ -5961,10 +5781,17 @@ Permissions required: None (validates via refresh token cookie)</p></td>
<tbody>
<tr>
- <td>expressions</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
- <td>repeated</td>
- <td><p>The CEL expression ASTs to deparse. </p></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5974,8 +5801,8 @@ Permissions required: None (validates via refresh token cookie)</p></td>
- <h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>
- <p>Response message for batch deparsing CEL expressions.</p>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3>
+ <p></p>
<table class="field-table">
@@ -5985,10 +5812,31 @@ Permissions required: None (validates via refresh token cookie)</p></td>
<tbody>
<tr>
- <td>expressions</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The deparsed CEL expressions as strings. </p></td>
+ <td></td>
+ <td><p>id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; 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>
@@ -5998,8 +5846,8 @@ Permissions required: None (validates via refresh token cookie)</p></td>
- <h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>
- <p>Request message for batch parsing CEL expressions.</p>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3>
+ <p></p>
<table class="field-table">
@@ -6009,10 +5857,24 @@ Permissions required: None (validates via refresh token cookie)</p></td>
<tbody>
<tr>
- <td>expressions</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The CEL expression strings to parse. </p></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>
@@ -6022,8 +5884,8 @@ Permissions required: None (validates via refresh token cookie)</p></td>
- <h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>
- <p>Response message for batch parsing CEL expressions.</p>
+ <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>
+ <p></p>
<table class="field-table">
@@ -6033,10 +5895,10 @@ Permissions required: None (validates via refresh token cookie)</p></td>
<tbody>
<tr>
- <td>expressions</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>environments</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>
<td>repeated</td>
- <td><p>The parsed CEL expressions as AST. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6046,88 +5908,8 @@ Permissions required: None (validates via refresh token cookie)</p></td>
-
-
-
-
-
-
- <h3 id="bytebase.v1.CelService">CelService</h3>
- <p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>BatchParse</td>
- <td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td>
- <td><a href="#bytebase.v1.BatchParseResponse">BatchParseResponse</a></td>
- <td><p>Parses multiple CEL expression strings into AST representations.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>BatchDeparse</td>
- <td><a href="#bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</a></td>
- <td><a href="#bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</a></td>
- <td><p>Converts multiple CEL AST representations back into expression strings.
-Permissions required: None</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>BatchParse</td>
- <td>POST</td>
- <td>/v1/cel/batchParse</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchDeparse</td>
- <td>POST</td>
- <td>/v1/cel/batchDeparse</td>
- <td>*</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/database_catalog_service.proto">v1/database_catalog_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.ColumnCatalog">ColumnCatalog</h3>
- <p>Column metadata within a table.</p>
+ <h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3>
+ <p></p>
<table class="field-table">
@@ -6140,35 +5922,39 @@ Permissions required: None</p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The column name. </p></td>
+ <td><p>The resource name of the environment.
+Format: environments/{environment}.
+Output only. </p></td>
</tr>
<tr>
- <td>semantic_type</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The semantic type describing the data purpose. </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>labels</td>
- <td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>User-defined labels for this column. </p></td>
+ <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>classification</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The data classification level for this column. </p></td>
+ <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>object_schema</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
- <td>optional</td>
- <td><p>Object schema for complex column types like JSON. </p></td>
+ <td>color</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6178,7 +5964,7 @@ Permissions required: None</p></td>
- <h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3>
+ <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>
<p></p>
@@ -6209,8 +5995,8 @@ Permissions required: None</p></td>
- <h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3>
- <p>Catalog metadata for a database including schemas, tables, and columns.</p>
+ <h3 id="bytebase.v1.GetSettingRequest">GetSettingRequest</h3>
+ <p>The request message for getting a setting.</p>
<table class="field-table">
@@ -6223,15 +6009,7 @@ Permissions required: None</p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database catalog.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
- </tr>
-
- <tr>
- <td>schemas</td>
- <td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td>
- <td>repeated</td>
- <td><p>The schemas in the database. </p></td>
+ <td><p>The resource name of the setting. </p></td>
</tr>
</tbody>
@@ -6241,8 +6019,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3>
- <p>Request message for getting a database catalog.</p>
+ <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>
+ <p>The response message for getting a setting.</p>
<table class="field-table">
@@ -6252,11 +6030,10 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>setting</td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
<td></td>
- <td><p>The name of the database catalog to retrieve.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6266,53 +6043,15 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3>
- <p>Schema definition for object-type columns.</p>
+ <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</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.ObjectSchema.Type">ObjectSchema.Type</a></td>
- <td></td>
- <td><p>The data type of this object. </p></td>
- </tr>
-
- <tr>
- <td>struct_kind</td>
- <td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td>
- <td></td>
- <td><p>Struct schema. </p></td>
- </tr>
-
- <tr>
- <td>array_kind</td>
- <td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td>
- <td></td>
- <td><p>Array schema. </p></td>
- </tr>
-
- <tr>
- <td>semantic_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The semantic type of this object. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>
- <p>Array type with element schema.</p>
+ <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3>
+ <p></p>
<table class="field-table">
@@ -6322,10 +6061,10 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>kind</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
- <td></td>
- <td><p>The schema of array elements. </p></td>
+ <td>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>
</tbody>
@@ -6335,8 +6074,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3>
- <p>Structure type with named properties.</p>
+ <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>
+ <p></p>
<table class="field-table">
@@ -6346,10 +6085,10 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>properties</td>
- <td><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td>
+ <td>types</td>
+ <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>
<td>repeated</td>
- <td><p>Properties of the struct. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6359,7 +6098,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3>
+ <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>
<p></p>
@@ -6370,19 +6109,40 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>key</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>value</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>the title of the semantic type, it should not be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>the description of the semantic type, it can be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>algorithm</td>
+ <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>icon</td>
+ <td><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>
@@ -6390,8 +6150,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3>
- <p>Schema metadata within a database.</p>
+ <h3 id="bytebase.v1.Setting">Setting</h3>
+ <p>The schema of setting.</p>
<table class="field-table">
@@ -6404,14 +6164,16 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema name. </p></td>
+ <td><p>The resource name of the setting.
+Format: settings/{setting}
+Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
</tr>
<tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td>
- <td>repeated</td>
- <td><p>The tables in the schema. </p></td>
+ <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>
@@ -6421,8 +6183,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>
- <p>Table metadata within a schema.</p>
+ <h3 id="bytebase.v1.SettingValue">SettingValue</h3>
+ <p>The data in setting value.</p>
<table class="field-table">
@@ -6432,55 +6194,52 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>app_im</td>
+ <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td>
<td></td>
- <td><p>The table name. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td>
+ <td>workspace_profile</td>
+ <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>
<td></td>
- <td><p>Regular table columns. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>object_schema</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>workspace_approval</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td>
<td></td>
- <td><p>Object schema for JSON/XML columns. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>classification</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>The data classification level for this table. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>
- <p>Column list for regular tables.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>semantic_type</td>
+ <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td>
- <td>repeated</td>
- <td><p>The columns in the table. </p></td>
+ <td>ai</td>
+ <td><a href="#bytebase.v1.AISetting">AISetting</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6490,8 +6249,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3>
- <p>Request message for updating a database catalog.</p>
+ <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>
+ <p>The request message for updating or creating a setting.</p>
<table class="field-table">
@@ -6501,21 +6260,32 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>catalog</td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td>setting</td>
+ <td><a href="#bytebase.v1.Setting">Setting</a></td>
<td></td>
- <td><p>The database catalog to update.
-
-The catalog&#39;s `name` field is used to identify the database catalog to update.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
+ <td><p>The setting to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>validate_only is a flag to indicate whether to validate the setting value,
+server would not persist the setting value if it is true. </p></td>
</tr>
<tr>
<td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the database catalog is not found, a new database catalog will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6525,135 +6295,32 @@ In this situation, `update_mask` is ignored. </p></td>
-
-
- <h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3>
- <p>Object schema data types.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>STRING</td>
- <td>1</td>
- <td><p>String type.</p></td>
- </tr>
-
- <tr>
- <td>NUMBER</td>
- <td>2</td>
- <td><p>Number type.</p></td>
- </tr>
-
- <tr>
- <td>BOOLEAN</td>
- <td>3</td>
- <td><p>Boolean type.</p></td>
- </tr>
-
- <tr>
- <td>OBJECT</td>
- <td>4</td>
- <td><p>Object/struct type.</p></td>
- </tr>
-
- <tr>
- <td>ARRAY</td>
- <td>5</td>
- <td><p>Array type.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3>
- <p>DatabaseCatalogService manages database schema metadata and classification.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetDatabaseCatalog</td>
- <td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
- <td><p>Gets the catalog metadata for a database.
-Permissions required: bb.databaseCatalogs.get</p></td>
- </tr>
-
- <tr>
- <td>UpdateDatabaseCatalog</td>
- <td><a href="#bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
- <td><p>Updates catalog metadata such as classifications and labels.
-Permissions required: bb.databaseCatalogs.update</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</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>GetDatabaseCatalog</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/catalog}</td>
- <td></td>
- </tr>
-
-
-
- <tr>
- <td>UpdateDatabaseCatalog</td>
- <td>PATCH</td>
- <td>/v1/{catalog.name=instances/*/databases/*/catalog}</td>
- <td>catalog</td>
- </tr>
+ <tr>
+ <td>rules</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/database_group_service.proto">v1/database_group_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</h3>
- <p>Request message for creating a database group.</p>
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3>
+ <p></p>
<table class="field-table">
@@ -6663,36 +6330,50 @@ Permissions required: bb.databaseCatalogs.update</p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource where this database group will be created.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>database_group</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td>template</td>
+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
<td></td>
- <td><p>The database group to create. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>database_group_id</td>
- <td><a href="#string">string</a></td>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
<td></td>
- <td><p>The ID to use for the database group, which will become the final component of
-the database group&#39;s resource name.
+ <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
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+The `source` field filters which rules apply. The `condition` field then evaluates with full context.
+
+All supported variables:
+statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
+statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
+resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
+resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values.
+statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
+resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
+request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+
+When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*)
+When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name
+When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name
+When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
+
+For examples:
+resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100
+resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; </p></td>
</tr>
<tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>source</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>
<td></td>
- <td><p>If set, validate the create request and preview the full database group response, but do not actually create it. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -6702,8 +6383,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>
- <p>A group of databases matched by expressions.</p>
+ <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3>
+ <p></p>
<table class="field-table">
@@ -6713,182 +6394,138 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>external_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database group.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>The external URL is used for sso authentication callback. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>disallow_signup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The short name used in actual databases specified by users. </p></td>
+ <td><p>Disallow self-service signup, users can only be invited by the owner. </p></td>
</tr>
<tr>
- <td>database_expr</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>require_2fa</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The condition that is associated with this database group.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations.
-resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
-resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
-resource.database_labels: the database labels. Support map access operations.
-All variables should join with &#34;&amp;&amp;&#34; condition.
-
-For example:
-resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;)
-resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
+ <td><p>Require 2FA for all users. </p></td>
</tr>
<tr>
- <td>matched_databases</td>
- <td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td>
- <td>repeated</td>
- <td><p>The list of databases that match the database group condition. </p></td>
+ <td>refresh_token_duration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration for refresh token. Default is 7 days. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3>
- <p>A database within a database group.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>name</td>
+ <td>maximum_role_expiration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The max duration for role expired. </p></td>
+ </tr>
+
+ <tr>
+ <td>domains</td>
<td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>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>The resource name of the database.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>Only user and group from the domains can be created and login. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3>
- <p>Request message for deleting a database group.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>name</td>
- <td><a href="#string">string</a></td>
+ <td>disallow_password_signin</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name of the database group to delete.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>Whether to disallow password signin. (Except workspace admins) </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3>
- <p>Request message for getting a database group.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>name</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>The name of the database group to retrieve.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
</tr>
<tr>
- <td>view</td>
- <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
+ <td>enable_audit_log_stdout</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </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.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3>
- <p>Request message for listing database 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>watermark</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to display watermark on pages.
+Requires ENTERPRISE license. </p></td>
+ </tr>
<tr>
- <td>parent</td>
+ <td>directory_sync_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource whose database groups are to be listed.
-Format: projects/{project} </p></td>
+ <td><p>The token for directory sync authentication. </p></td>
</tr>
<tr>
- <td>view</td>
- <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
+ <td>branding_logo</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
+ <td><p>The branding logo as a data URI (e.g. data:image/png;base64,...). </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3>
- <p>Response message for listing database 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>password_restriction</td>
+ <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>
+ <td></td>
+ <td><p>Password restriction settings. </p></td>
+ </tr>
<tr>
- <td>database_groups</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td>repeated</td>
- <td><p>The database groups from the specified request. </p></td>
+ <td>access_token_duration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration for access token. Default is 1 hour. </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_debug</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether debug mode is enabled. </p></td>
</tr>
</tbody>
@@ -6898,8 +6535,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>
- <p>Request message for updating a database group.</p>
+ <h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3>
+ <p></p>
<table class="field-table">
@@ -6909,266 +6546,395 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>database_group</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td>min_length</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The database group to update.
-
-The database group&#39;s `name` field is used to identify the database group to update.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
+ <td><p>min_length is the minimum length for password, should no less than 8. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>require_number</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>require_number requires the password must contains at least one number. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>require_letter</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the database group is not found, a new database group will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>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.DatabaseGroupView">DatabaseGroupView</h3>
- <p>View options for database group responses.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATABASE_GROUP_VIEW_UNSPECIFIED</td>
- <td>0</td>
- <td><p>The default / unset value.
-The API will default to the BASIC view.</p></td>
+ <tr>
+ <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></td>
+ <td><p>require_special_character requires the password must contains at least one special character. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_reset_password_for_first_login</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td>
+ </tr>
+
+ <tr>
+ <td>password_rotation</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>password_rotation requires users to reset their password after the duration. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</h3>
+ <p></p>
+ <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>DATABASE_GROUP_VIEW_BASIC</td>
+ <td>OPEN_AI</td>
<td>1</td>
- <td><p>Include basic information about the database group, but exclude the list of matched databases and unmatched databases.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DATABASE_GROUP_VIEW_FULL</td>
+ <td>CLAUDE</td>
<td>2</td>
- <td><p>Include everything.</p></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.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>MASK_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INNER</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>OUTER</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3>
- <p>DatabaseGroupService manages database groups for organizing databases by criteria.</p>
+ <h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3>
+ <p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p>
<table class="enum-table">
<thead>
- <tr><td>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>ListDatabaseGroups</td>
- <td><a href="#bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</a></td>
- <td><a href="#bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</a></td>
- <td><p>Lists database groups in a project.
-Permissions required: bb.databaseGroups.list</p></td>
+ <td>ALERT_LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>GetDatabaseGroup</td>
- <td><a href="#bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td><p>Gets a database group by name.
-Permissions required: bb.databaseGroups.get</p></td>
+ <td>INFO</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>CreateDatabaseGroup</td>
- <td><a href="#bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td><p>Creates a new database group.
-Permissions required: bb.databaseGroups.create</p></td>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>UpdateDatabaseGroup</td>
- <td><a href="#bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</a></td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td><p>Updates a database group.
-Permissions required: bb.databaseGroups.update
-When allow_missing=true, also requires: bb.databaseGroups.create</p></td>
+ <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>DeleteDatabaseGroup</td>
- <td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a database group.
-Permissions required: bb.databaseGroups.delete</p></td>
+ <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>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
+
+ <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>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>SETTING_NAME_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>ListDatabaseGroups</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/databaseGroups</td>
- <td></td>
+ <td>WORKSPACE_PROFILE</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>GetDatabaseGroup</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/databaseGroups/*}</td>
- <td></td>
+ <td>WORKSPACE_APPROVAL</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>CreateDatabaseGroup</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/databaseGroups</td>
- <td>database_group</td>
+ <td>APP_IM</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>UpdateDatabaseGroup</td>
- <td>PATCH</td>
- <td>/v1/{database_group.name=projects/*/databaseGroups/*}</td>
- <td>database_group</td>
+ <td>AI</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>DeleteDatabaseGroup</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/databaseGroups/*}</td>
- <td></td>
+ <td>DATA_CLASSIFICATION</td>
+ <td>5</td>
+ <td><p></p></td>
</tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+ <tr>
+ <td>SEMANTIC_TYPES</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ENVIRONMENT</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SOURCE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>CHANGE_DATABASE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>CREATE_DATABASE</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>EXPORT_DATA</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>REQUEST_ROLE</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
- <h3 id="bytebase.v1.InstanceRole">InstanceRole</h3>
- <p>InstanceRole is the API message for instance role.</p>
+
+
+ <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>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the role.
-Format: instances/{instance}/roles/{role}
-The role name is the unique name for the role. </p></td>
- </tr>
- <tr>
- <td>role_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The role name. It&#39;s unique within the instance. </p></td>
- </tr>
+ <tr>
+ <td>ListSettings</td>
+ <td>GET</td>
+ <td>/v1/settings</td>
+ <td></td>
+ </tr>
- <tr>
- <td>password</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The role password. </p></td>
- </tr>
+
- <tr>
- <td>connection_limit</td>
- <td><a href="#int32">int32</a></td>
- <td>optional</td>
- <td><p>The connection count limit for this role. </p></td>
- </tr>
- <tr>
- <td>valid_until</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The expiration for the role&#39;s password. </p></td>
- </tr>
+ <tr>
+ <td>GetSetting</td>
+ <td>GET</td>
+ <td>/v1/{name=settings/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>attribute</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The role attribute.
-For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html
-For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td>
- </tr>
+
+
+
+ <tr>
+ <td>UpdateSetting</td>
+ <td>PATCH</td>
+ <td>/v1/{setting.name=settings/*}</td>
+ <td>setting</td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3>
+ <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>
@@ -7179,41 +6945,35 @@ For MySQL, it&#39;s the global privileges as GRANT statements, which means it on
<tbody>
<tr>
- <td>parent</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent, which owns this collection of roles.
-Format: instances/{instance} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Not used.
-The maximum number of roles to return. The service may return fewer than
-this value.
-If unspecified, at most 10 roles will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td>repeated</td>
+ <td><p>The user names to retrieve.
+Format: users/{email} </p></td>
</tr>
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Not used.
-A page token, received from a previous `ListInstanceRoles` call.
-Provide this to retrieve the subsequent page.
+ </tbody>
+ </table>
-When paginating, all other parameters provided to `ListInstanceRoles` must match
-the call that provided the page token. </p></td>
- </tr>
+
+
+
+
+ <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>refresh</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Refresh will refresh and return the latest data. </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>
@@ -7223,7 +6983,7 @@ the call that provided the page token. </p></td>
- <h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3>
+ <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</h3>
<p></p>
@@ -7234,18 +6994,10 @@ the call that provided the page token. </p></td>
<tbody>
<tr>
- <td>roles</td>
- <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
- <td>repeated</td>
- <td><p>The roles from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</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 user to create. </p></td>
</tr>
</tbody>
@@ -7255,69 +7007,32 @@ If this field is omitted, there are no subsequent pages. </p></td>
-
-
-
-
-
-
- <h3 id="bytebase.v1.InstanceRoleService">InstanceRoleService</h3>
- <p>InstanceRoleService manages database roles within instances.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ListInstanceRoles</td>
- <td><a href="#bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</a></td>
- <td><a href="#bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</a></td>
- <td><p>Lists all database roles in an instance.
-Permissions required: bb.instanceRoles.list</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the user to delete.
+Format: users/{email} </p></td>
+ </tr>
- <tr>
- <td>ListInstanceRoles</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/roles</td>
- <td></td>
- </tr>
-
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3>
+ <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3>
<p></p>
@@ -7331,23 +7046,82 @@ Permissions required: bb.instanceRoles.list</p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance to add a data source to.
-Format: instances/{instance} </p></td>
+ <td><p>The name of the user to retrieve.
+Format: users/{email} </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>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of users to return. The service may return fewer than
+this value.
+If unspecified, at most 10 users will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Identified by data source ID.
-Only READ_ONLY data source can be added. </p></td>
+ <td><p>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>validate_only</td>
+ <td>show_deleted</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>Show deleted users if specified. </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter users returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- name: the user name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- email: the user email, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- user_type: the type, check UserType enum for values, support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- state: check State enum for values, support &#34;==&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+
+For example:
+name == &#34;ed&#34;
+name.matches(&#34;ed&#34;)
+email == &#34;[email protected]&#34;
+email.matches(&#34;ed&#34;)
+user_type == &#34;SERVICE_ACCOUNT&#34;
+user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;]
+!(user_type in [&#34;SERVICE_ACCOUNT&#34;, &#34;USER&#34;])
+state == &#34;DELETED&#34;
+project == &#34;projects/sample-project&#34;
+You can combine filter conditions like:
+name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#34;
+(name == &#34;ed&#34; || email == &#34;[email protected]&#34;) &amp;&amp; project == &#34;projects/sample-project&#34; </p></td>
</tr>
</tbody>
@@ -7357,7 +7131,7 @@ Only READ_ONLY data source can be added. </p></td>
- <h3 id="bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</h3>
+ <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3>
<p></p>
@@ -7368,11 +7142,18 @@ Only READ_ONLY data source can be added. </p></td>
<tbody>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
+ <td>users</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td>repeated</td>
- <td><p>The request message specifying the instances to sync.
-A maximum of 1000 instances can be synced in a batch. </p></td>
+ <td><p>The users from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>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>
@@ -7382,14 +7163,7 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
- <h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3>
+ <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>
<p></p>
@@ -7400,10 +7174,11 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
<tbody>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
- <td>repeated</td>
- <td><p>The request message specifying the resources to update. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the deleted user.
+Format: users/{email} </p></td>
</tr>
</tbody>
@@ -7413,7 +7188,7 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
- <h3 id="bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</h3>
+ <h3 id="bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</h3>
<p></p>
@@ -7424,10 +7199,19 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
<tbody>
<tr>
- <td>instances</td>
- <td><a href="#bytebase.v1.Instance">Instance</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 whose email to update.
+Format: users/{email}
+Note: This is the current (old) email address. The new email is specified in the &#39;email&#39; field. </p></td>
+ </tr>
+
+ <tr>
+ <td>email</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The new email address. </p></td>
</tr>
</tbody>
@@ -7437,7 +7221,7 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
- <h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3>
+ <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</h3>
<p></p>
@@ -7448,28 +7232,50 @@ A maximum of 1000 instances can be synced in a batch. </p></td>
<tbody>
<tr>
- <td>instance</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p>The instance to create. </p></td>
+ <td><p>The user to update.
+
+The user&#39;s `name` field is used to identify the user to update.
+Format: users/{email} </p></td>
</tr>
<tr>
- <td>instance_id</td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>otp_code</td>
<td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
+ </tr>
+
+ <tr>
+ <td>regenerate_temp_mfa_secret</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The ID to use for the instance, which will become the final component of
-the instance&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td><p>The 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>validate_only</td>
+ <td>regenerate_recovery_codes</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the user is not found, a new user will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -7479,7 +7285,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DataSource">DataSource</h3>
+ <h3 id="bytebase.v1.User">User</h3>
<p></p>
@@ -7490,294 +7296,194 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique identifier for this data source. </p></td>
+ <td><p>The name of the user.
+Format: users/{email} </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>The type of data source (ADMIN or READ_ONLY). </p></td>
+ <td><p>The lifecycle state of the user account. </p></td>
</tr>
<tr>
- <td>username</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The username for database authentication. </p></td>
+ <td><p>The email address of the user, used for login and notifications. </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The password for database authentication. </p></td>
+ <td><p>The display title or full name of the user. </p></td>
</tr>
<tr>
- <td>use_ssl</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Use SSL to connect to the data source. By default, we use system default SSL configuration. </p></td>
- </tr>
-
- <tr>
- <td>ssl_ca</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SSL certificate authority certificate. </p></td>
- </tr>
-
- <tr>
- <td>ssl_cert</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SSL client certificate. </p></td>
- </tr>
-
- <tr>
- <td>ssl_key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SSL client private key. </p></td>
- </tr>
-
- <tr>
- <td>verify_tls_certificate</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>verify_tls_certificate enables TLS certificate verification for SSL connections.
-Default is false (no verification) for backward compatibility.
-Set to true for secure connections (recommended for production).
-Only set to false for development or when certificates cannot be properly
-validated (e.g., self-signed certs, VPN environments). </p></td>
- </tr>
-
- <tr>
- <td>host</td>
- <td><a href="#string">string</a></td>
+ <td>user_type</td>
+ <td><a href="#bytebase.v1.UserType">UserType</a></td>
<td></td>
- <td><p>The hostname or IP address of the database server. </p></td>
+ <td><p>The type of user account. </p></td>
</tr>
<tr>
- <td>port</td>
+ <td>password</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port number of the database server. </p></td>
+ <td><p>The password for authentication. Only used during user creation or password updates. </p></td>
</tr>
<tr>
- <td>database</td>
+ <td>service_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to connect to. </p></td>
+ <td><p>The service key for service account authentication. Only used for service accounts. </p></td>
</tr>
<tr>
- <td>srv</td>
+ <td>mfa_enabled</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>srv, authentication_database and replica_set are used for MongoDB.
-srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td>
- </tr>
-
- <tr>
- <td>authentication_database</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td>
- </tr>
-
- <tr>
- <td>replica_set</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>replica_set is used for MongoDB replica set. </p></td>
- </tr>
-
- <tr>
- <td>sid</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>sid and service_name are used for Oracle. </p></td>
- </tr>
-
- <tr>
- <td>service_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>ssh_host</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Connection over SSH.
-The hostname of the SSH server agent.
-Required. </p></td>
+ <td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td>
</tr>
<tr>
- <td>ssh_port</td>
+ <td>temp_otp_secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port of the SSH server agent. It&#39;s 22 typically.
-Required. </p></td>
+ <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td>
</tr>
<tr>
- <td>ssh_user</td>
+ <td>temp_recovery_codes</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The user to login the server.
-Required. </p></td>
+ <td>repeated</td>
+ <td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td>
</tr>
<tr>
- <td>ssh_password</td>
- <td><a href="#string">string</a></td>
+ <td>temp_otp_secret_created_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The password to login the server. If it&#39;s empty string, no password is required. </p></td>
+ <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td>
</tr>
<tr>
- <td>ssh_private_key</td>
+ <td>phone</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). </p></td>
+ <td><p>Should be a valid E.164 compliant phone number.
+Could be empty. </p></td>
</tr>
<tr>
- <td>authentication_private_key</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>PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required.
-Used for authentication when connecting to the data source. </p></td>
+ <td><p>User profile metadata. </p></td>
</tr>
<tr>
- <td>authentication_private_key_passphrase</td>
+ <td>groups</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. </p></td>
- </tr>
-
- <tr>
- <td>external_secret</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>authentication_type</td>
- <td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>azure_credential</td>
- <td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>repeated</td>
+ <td><p>The groups for the user.
+Format: groups/{email} </p></td>
</tr>
<tr>
- <td>aws_credential</td>
- <td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</a></td>
+ <td>workload_identity_config</td>
+ <td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Workload Identity configuration (only for WORKLOAD_IDENTITY type) </p></td>
</tr>
- <tr>
- <td>gcp_credential</td>
- <td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.User.Profile">User.Profile</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>sasl_config</td>
- <td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td>
+ <td>last_login_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>additional_addresses</td>
- <td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td>
- <td>repeated</td>
- <td><p>additional_addresses is used for MongoDB replica set. </p></td>
+ <td><p>The last time the user successfully logged in. </p></td>
</tr>
<tr>
- <td>direct_connection</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>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td>
+ <td><p>The last time the user changed their password. </p></td>
</tr>
<tr>
- <td>region</td>
+ <td>source</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>region is the location of where the DB is, works for AWS RDS. For example, us-east-1. </p></td>
+ <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>
- <tr>
- <td>warehouse_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>warehouse_id is used by Databricks. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3>
+ <p>WorkloadIdentityConfig for API layer</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>master_name</td>
- <td><a href="#string">string</a></td>
+ <td>provider_type</td>
+ <td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td>
<td></td>
- <td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td>
+ <td><p>Platform type (currently only GITHUB is supported) </p></td>
</tr>
<tr>
- <td>master_username</td>
+ <td>issuer_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>master_username and master_password are master credentials used by redis sentinel mode. </p></td>
+ <td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td>
</tr>
<tr>
- <td>master_password</td>
+ <td>allowed_audiences</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>redis_type</td>
- <td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>repeated</td>
+ <td><p>Allowed audiences for token validation </p></td>
</tr>
<tr>
- <td>cluster</td>
+ <td>subject_pattern</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td>
- </tr>
-
- <tr>
- <td>extra_connection_parameters</td>
- <td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>
- <td>repeated</td>
- <td><p>Extra connection parameters for the database connection.
-For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td>
+ <td><p>Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) </p></td>
</tr>
</tbody>
@@ -7787,93 +7493,288 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><
- <h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3>
+
+
+ <h3 id="bytebase.v1.UserType">UserType</h3>
<p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>USER_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified user type.</p></td>
+ </tr>
+
+ <tr>
+ <td>USER</td>
+ <td>1</td>
+ <td><p>Regular human user account.</p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_BOT</td>
+ <td>2</td>
+ <td><p>System-managed bot account for automated operations.</p></td>
+ </tr>
+
+ <tr>
+ <td>SERVICE_ACCOUNT</td>
+ <td>3</td>
+ <td><p>Service account for API integrations.</p></td>
+ </tr>
+
+ <tr>
+ <td>WORKLOAD_IDENTITY</td>
+ <td>4</td>
+ <td><p>External CI/CD workload identity.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3>
+ <p>ProviderType identifies the CI/CD platform.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>PROVIDER_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>GITHUB</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>GITLAB</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UserService">UserService</h3>
+ <p>UserService manages user accounts and authentication.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetUser</td>
+ <td><a href="#bytebase.v1.GetUserRequest">GetUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Get the user.
+Any authenticated user can get the user.
+Permissions required: bb.users.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchGetUsers</td>
+ <td><a href="#bytebase.v1.BatchGetUsersRequest">BatchGetUsersRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</a></td>
+ <td><p>Get the users in batch.
+Any authenticated user can batch get users.
+Permissions required: bb.users.get</p></td>
+ </tr>
+
+ <tr>
+ <td>GetCurrentUser</td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Get the current authenticated user.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>ListUsers</td>
+ <td><a href="#bytebase.v1.ListUsersRequest">ListUsersRequest</a></td>
+ <td><a href="#bytebase.v1.ListUsersResponse">ListUsersResponse</a></td>
+ <td><p>List all users.
+Any authenticated user can list users.
+Permissions required: bb.users.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateUser</td>
+ <td><a href="#bytebase.v1.CreateUserRequest">CreateUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.
+Permissions required: bb.users.create (only when Disallow Signup is enabled)</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateUser</td>
+ <td><a href="#bytebase.v1.UpdateUserRequest">UpdateUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
+Note: Email updates are not supported through this API. Use UpdateEmail instead.
+Permissions required: bb.users.update (or self)</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteUser</td>
+ <td><a href="#bytebase.v1.DeleteUserRequest">DeleteUserRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
+Permissions required: bb.users.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>UndeleteUser</td>
+ <td><a href="#bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Restores a deleted user.
+Permissions required: bb.users.undelete</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateEmail</td>
+ <td><a href="#bytebase.v1.UpdateEmailRequest">UpdateEmailRequest</a></td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td><p>Updates a user&#39;s email address.
+Permissions required: bb.users.updateEmail</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>access_key_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>secret_access_key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>session_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>GetUser</td>
+ <td>GET</td>
+ <td>/v1/{name=users/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>role_arn</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>ARN of IAM role to assume for cross-account access.
-See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td>
- </tr>
+
- <tr>
- <td>external_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Optional external ID for additional security when assuming role.
-See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html </p></td>
- </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>BatchGetUsers</td>
+ <td>GET</td>
+ <td>/v1/users:batchGet</td>
+ <td></td>
+ </tr>
- <tr>
- <td>host</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>port</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- </tbody>
- </table>
-
+ <tr>
+ <td>GetCurrentUser</td>
+ <td>GET</td>
+ <td>/v1/users/me</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListUsers</td>
+ <td>GET</td>
+ <td>/v1/users</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateUser</td>
+ <td>POST</td>
+ <td>/v1/users</td>
+ <td>user</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateUser</td>
+ <td>PATCH</td>
+ <td>/v1/{user.name=users/*}</td>
+ <td>user</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteUser</td>
+ <td>DELETE</td>
+ <td>/v1/{name=users/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UndeleteUser</td>
+ <td>POST</td>
+ <td>/v1/{name=users/*}:undelete</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateEmail</td>
+ <td>POST</td>
+ <td>/v1/{name=users/*}:updateEmail</td>
+ <td>*</td>
+ </tr>
+
+
+ </tbody>
+ </table>
-
+
- <h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</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">
@@ -7883,184 +7784,143 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
<tbody>
<tr>
- <td>tenant_id</td>
+ <td>version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The Bytebase server version. </p></td>
</tr>
<tr>
- <td>client_id</td>
+ <td>git_commit</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The git commit hash of the build. </p></td>
</tr>
<tr>
- <td>client_secret</td>
- <td><a href="#string">string</a></td>
+ <td>readonly</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether the Bytebase instance is running in read-only mode. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
+ <td>saas</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></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>value</td>
- <td><a href="#string">string</a></td>
+ <td>demo</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether the Bytebase instance is running in demo mode. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</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>content</td>
+ <td>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The host address of the Bytebase instance. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</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>secret_type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td>
+ <td>port</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of external secret store. </p></td>
+ <td><p>The port number of the Bytebase instance. </p></td>
</tr>
<tr>
- <td>url</td>
+ <td>external_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The URL of the external secret store. </p></td>
+ <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td>
</tr>
<tr>
- <td>auth_type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td>
+ <td>need_admin_setup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The authentication method for accessing the secret store. </p></td>
+ <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>
</tr>
<tr>
- <td>app_role</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td>
+ <td>last_active_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>AppRole authentication configuration. </p></td>
+ <td><p>The last time any API call was made, refreshed on each request. </p></td>
</tr>
<tr>
- <td>token</td>
+ <td>workspace_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Token for direct authentication. </p></td>
+ <td><p>The unique identifier for the workspace. </p></td>
</tr>
<tr>
- <td>engine_name</td>
+ <td>unlicensed_features</td>
<td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>List of features that are not licensed. </p></td>
+ </tr>
+
+ <tr>
+ <td>docker</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>engine name is the name for secret engine. </p></td>
+ <td><p>Whether the Bytebase instance is running in Docker. </p></td>
</tr>
<tr>
- <td>secret_name</td>
- <td><a href="#string">string</a></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>activated_instance_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>the secret name in the engine to store the password. </p></td>
+ <td><p>The number of activated database instances. </p></td>
</tr>
<tr>
- <td>password_key_name</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 key name for the password. </p></td>
+ <td><p>The total number of database instances. </p></td>
</tr>
<tr>
- <td>skip_vault_tls_verification</td>
+ <td>enable_sample</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>TLS configuration for connecting to Vault server.
-These fields are separate from the database TLS configuration in DataSource.
-skip_vault_tls_verification disables TLS certificate verification for Vault connections.
-Default is false (verification enabled) for security.
-Only set to true for development or when certificates cannot be properly validated. </p></td>
+ <td><p>Whether sample data setup is enabled. </p></td>
</tr>
<tr>
- <td>vault_ssl_ca</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>CA certificate for Vault server verification. </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>vault_ssl_cert</td>
- <td><a href="#string">string</a></td>
+ <td>replica_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Client certificate for mutual TLS authentication with Vault. </p></td>
+ <td><p>The number of active replicas (servers sharing the same database). </p></td>
</tr>
<tr>
- <td>vault_ssl_key</td>
- <td><a href="#string">string</a></td>
+ <td>restriction</td>
+ <td><a href="#bytebase.v1.Restriction">Restriction</a></td>
<td></td>
- <td><p>Client private key for mutual TLS authentication with Vault. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -8070,8 +7930,8 @@ Only set to true for development or when certificates cannot be properly validat
- <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3>
- <p></p>
+ <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>
+ <p>User statistics by type and state.</p>
<table class="field-table">
@@ -8081,31 +7941,69 @@ Only set to true for development or when certificates cannot be properly validat
<tbody>
<tr>
- <td>role_id</td>
- <td><a href="#string">string</a></td>
+ <td>user_type</td>
+ <td><a href="#bytebase.v1.UserType">UserType</a></td>
<td></td>
- <td><p>The role ID for Vault AppRole authentication. </p></td>
+ <td><p>The type of user. </p></td>
</tr>
<tr>
- <td>secret_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the secret id for the role without ttl. </p></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
+ <td></td>
+ <td><p>The state of the user. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td>
+ <td>count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The type of secret for AppRole authentication. </p></td>
+ <td><p>The count of users matching this type and state. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3>
+ <p>Request message for deleting cache.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</h3>
+ <p>Request message for getting actuator information.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</h3>
+ <p>Request message for getting branding resources.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ResourcePackage">ResourcePackage</h3>
+ <p>Custom branding resources for the Bytebase instance.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>mount_path</td>
- <td><a href="#string">string</a></td>
+ <td>logo</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The path where the approle auth method is mounted. </p></td>
+ <td><p>The branding logo. </p></td>
</tr>
</tbody>
@@ -8115,7 +8013,7 @@ Only set to true for development or when certificates cannot be properly validat
- <h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</h3>
+ <h3 id="bytebase.v1.Restriction">Restriction</h3>
<p></p>
@@ -8126,28 +8024,24 @@ Only set to true for development or when certificates cannot be properly validat
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>disallow_signup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name of the instance to delete.
-Format: instances/{instance} </p></td>
+ <td><p>Whether self-service user signup is disabled. </p></td>
</tr>
<tr>
- <td>force</td>
+ <td>disallow_password_signin</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. </p></td>
+ <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td>
</tr>
<tr>
- <td>purge</td>
- <td><a href="#bool">bool</a></td>
+ <td>password_restriction</td>
+ <td><a href="#bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</a></td>
<td></td>
- <td><p>If set to true, permanently purge the soft-deleted instance and all related resources.
-This operation is irreversible. Following AIP-165, this should only be used for
-administrative cleanup of old soft-deleted instances.
-The instance must already be soft-deleted for this to work. </p></td>
+ <td><p>Password complexity and restriction requirements. </p></td>
</tr>
</tbody>
@@ -8157,33 +8051,131 @@ The instance must already be soft-deleted for this to work. </p></td>
- <h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>
+ <p>Request message for setting up sample data.</p>
- <table class="field-table">
+
+
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>
+ <p>ActuatorService manages system health and operational information.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetActuatorInfo</td>
+ <td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td><p>Gets system information and health status of the Bytebase instance.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>SetupSample</td>
+ <td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Sets up sample data for demonstration and testing purposes.
+Permissions required: bb.projects.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteCache</td>
+ <td><a href="#bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Clears the system cache to force data refresh.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>GetResourcePackage</td>
+ <td><a href="#bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</a></td>
+ <td><a href="#bytebase.v1.ResourcePackage">ResourcePackage</a></td>
+ <td><p>Gets custom branding resources such as logos.
+Permissions required: None</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>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>GetActuatorInfo</td>
+ <td>GET</td>
+ <td>/v1/actuator/info</td>
+ <td></td>
+ </tr>
+
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the instance to retrieve.
-Format: instances/{instance} </p></td>
- </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>
-
-
+
- <h3 id="bytebase.v1.Instance">Instance</h3>
- <p></p>
+ <div class="file-heading">
+ <h2 id="v1/iam_policy.proto">v1/iam_policy.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.Binding">Binding</h3>
+ <p>Binding associates members with a role and optional conditions.</p>
<table class="field-table">
@@ -8193,105 +8185,48 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>role</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance.
-Format: instances/{instance} </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 instance. </p></td>
+ <td><p>The role that is assigned to the members.
+Format: roles/{role} </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>members</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The display title of the instance. </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
- <td></td>
- <td><p>The database engine type. </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>engine_version</td>
- <td><a href="#string">string</a></td>
+ <td>condition</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
<td></td>
- <td><p>The version of the database engine. </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 &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
+resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
+resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
+request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
+
+For example:
+resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;]
+resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;]
+request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
</tr>
<tr>
- <td>external_link</td>
- <td><a href="#string">string</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>External URL to the database instance console. </p></td>
- </tr>
-
- <tr>
- <td>data_sources</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
- <td>repeated</td>
- <td><p>Data source configurations for connecting to the instance. </p></td>
- </tr>
-
- <tr>
- <td>environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
- </tr>
-
- <tr>
- <td>activation</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the instance is activated for use. </p></td>
- </tr>
-
- <tr>
- <td>roles</td>
- <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
- <td>repeated</td>
- <td><p>Database roles available in this instance. </p></td>
- </tr>
-
- <tr>
- <td>sync_interval</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>How often the instance is synced. </p></td>
- </tr>
-
- <tr>
- <td>sync_databases</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Enable sync for following databases.
-Default empty, means sync all schemas &amp; databases. </p></td>
- </tr>
-
- <tr>
- <td>last_sync_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last time the instance was synced. </p></td>
- </tr>
-
- <tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>Labels are key-value pairs that can be attached to the instance.
-For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } </p></td>
+ <td><p>The parsed expression of the condition. </p></td>
</tr>
</tbody>
@@ -8301,8 +8236,8 @@ For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#
- <h3 id="bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.BindingDelta">BindingDelta</h3>
+ <p>A single change to a binding.</p>
<table class="field-table">
@@ -8312,85 +8247,32 @@ For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#
<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>action</td>
+ <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The action that was performed on a Binding. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.InstanceResource">InstanceResource</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>title</td>
+ <td>role</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The display title of the instance. </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
- <td></td>
- <td><p>The database engine type. </p></td>
+ <td><p>Role that is assigned to `members`.
+For example, `roles/projectOwner`. </p></td>
</tr>
<tr>
- <td>engine_version</td>
+ <td>member</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The version of the database engine. </p></td>
- </tr>
-
- <tr>
- <td>data_sources</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
- <td>repeated</td>
- <td><p>Data source configurations for the instance. </p></td>
- </tr>
-
- <tr>
- <td>activation</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the instance is activated. </p></td>
+ <td><p>Follows the same format of Binding.members. </p></td>
</tr>
<tr>
- <td>name</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>The name of the instance.
-Format: instances/{instance} </p></td>
- </tr>
-
- <tr>
- <td>environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
+ <td><p>The condition that is associated with this binding. </p></td>
</tr>
</tbody>
@@ -8400,8 +8282,8 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
- <h3 id="bytebase.v1.KerberosConfig">KerberosConfig</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3>
+ <p>Request message for getting an IAM policy.</p>
<table class="field-table">
@@ -8411,52 +8293,12 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
<tbody>
<tr>
- <td>primary</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The primary component of the Kerberos principal. </p></td>
- </tr>
-
- <tr>
- <td>instance</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The instance component of the Kerberos principal. </p></td>
- </tr>
-
- <tr>
- <td>realm</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The Kerberos realm. </p></td>
- </tr>
-
- <tr>
- <td>keytab</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The keytab file contents for authentication. </p></td>
- </tr>
-
- <tr>
- <td>kdc_host</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The hostname of the Key Distribution Center (KDC). </p></td>
- </tr>
-
- <tr>
- <td>kdc_port</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The port of the Key Distribution Center (KDC). </p></td>
- </tr>
-
- <tr>
- <td>kdc_transport_protocol</td>
+ <td>resource</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The transport protocol for KDC communication (tcp or udp). </p></td>
+ <td><p>The name of the resource to get the IAM policy.
+Format: projects/{project}
+Format: workspaces/{workspace} </p></td>
</tr>
</tbody>
@@ -8466,8 +8308,8 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
- <h3 id="bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>
+ <p>IAM policy that binds members to roles.</p>
<table class="field-table">
@@ -8477,18 +8319,20 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the instance.
-Format: instances/{instance} </p></td>
+ <td>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>instance</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td>optional</td>
- <td><p>The target instance. We need to set this field if the target instance is not created yet. </p></td>
+ <td>etag</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The current etag of the policy.
+If an etag is provided and does not match the current etag of the policy,
+the call will be blocked and an ABORTED error will be returned. </p></td>
</tr>
</tbody>
@@ -8498,8 +8342,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>
+ <p>Describes changes between two IAM policies.</p>
<table class="field-table">
@@ -8509,10 +8353,10 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>databases</td>
- <td><a href="#string">string</a></td>
+ <td>binding_deltas</td>
+ <td><a href="#bytebase.v1.BindingDelta">BindingDelta</a></td>
<td>repeated</td>
- <td><p>All database name list in the instance. </p></td>
+ <td><p>The delta for Bindings between two policies. </p></td>
</tr>
</tbody>
@@ -8522,8 +8366,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.ListInstancesRequest">ListInstancesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>
+ <p>Request message for setting an IAM policy.</p>
<table class="field-table">
@@ -8533,84 +8377,26 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of instances to return. The service may return fewer than
-this value.
-If unspecified, at most 10 instances will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
+ <td>resource</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListInstances` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListInstances` must match
-the call that provided the page token. </p></td>
+ <td><p>The name of the resource to set the IAM policy.
+Format: projects/{project}
+Format: workspaces/{workspace} </p></td>
</tr>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
+ <td>policy</td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
<td></td>
- <td><p>Show deleted instances if specified. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>etag</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter the instance.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
-- state: the instance state, check State enum for values, support &#34;==&#34; operator.
-- engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example:
-name == &#34;sample instance&#34;
-name.matches(&#34;sample&#34;)
-resource_id == &#34;sample-instance&#34;
-resource_id.matches(&#34;sample&#34;)
-state == &#34;DELETED&#34;
-environment == &#34;environments/test&#34;
-environment == &#34;&#34; (find instances which environment is not set)
-engine == &#34;MYSQL&#34;
-engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
-!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
-host == &#34;127.0.0.1&#34;
-host.matches(&#34;127.0&#34;)
-port == &#34;54321&#34;
-port.matches(&#34;543&#34;)
-labels.org_group == &#34;infrastructure&#34;
-labels.environment in [&#34;prod&#34;, &#34;production&#34;]
-project == &#34;projects/sample-project&#34;
-You can combine filter conditions like:
-name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34;
-host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; </p></td>
- </tr>
-
- <tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The order by of instances.
-Support title, environment. The default sorting order is ascending.
-For example:
-- order_by = &#34;title&#34;
-- order_by = &#34;title desc&#34;
-- order_by = &#34;title desc, environment asc&#34; </p></td>
+ <td><p>The current etag of the policy. </p></td>
</tr>
</tbody>
@@ -8620,8 +8406,51 @@ For example:
- <h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3>
- <p></p>
+
+
+ <h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3>
+ <p>Type of action performed on a binding.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ACTION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified action.</p></td>
+ </tr>
+
+ <tr>
+ <td>ADD</td>
+ <td>1</td>
+ <td><p>Add a binding.</p></td>
+ </tr>
+
+ <tr>
+ <td>REMOVE</td>
+ <td>2</td>
+ <td><p>Remove a binding.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/audit_log_service.proto">v1/audit_log_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.AuditData">AuditData</h3>
+ <p>Additional audit data specific to certain operations.</p>
<table class="field-table">
@@ -8631,18 +8460,10 @@ For example:
<tbody>
<tr>
- <td>instances</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td>repeated</td>
- <td><p>The instances from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>policy_delta</td>
+ <td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td>
<td></td>
- <td><p>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>Changes to IAM policies. </p></td>
</tr>
</tbody>
@@ -8652,8 +8473,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.AuditLog">AuditLog</h3>
+ <p>Audit log entry recording system activity or API call.</p>
<table class="field-table">
@@ -8666,97 +8487,90 @@ If this field is omitted, there are no subsequent pages. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the instance to remove a data source from.
-Format: instances/{instance} </p></td>
+ <td><p>The name of the log.
+Formats:
+- projects/{project}/auditLogs/{uid}
+- workspaces/{workspace}/auditLogs/{uid} </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>Identified by data source ID.
-Only READ_ONLY data source can be removed. </p></td>
+ <td><p>The timestamp when the audit log was created. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SASLConfig">SASLConfig</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="#string">string</a></td>
+ <td></td>
+ <td><p>The user who performed the action.
+Format: users/{email} </p></td>
+ </tr>
<tr>
- <td>krb_config</td>
- <td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td>
+ <td>method</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Kerberos authentication configuration. </p></td>
+ <td><p>The method or action being audited.
+For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>severity</td>
+ <td><a href="#bytebase.v1.AuditLog.Severity">AuditLog.Severity</a></td>
+ <td></td>
+ <td><p>The severity level of this audit log entry. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>resource</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of instance.
-Format: instances/{instance} </p></td>
+ <td><p>The resource associated with this audit log. </p></td>
</tr>
<tr>
- <td>enable_full_sync</td>
- <td><a href="#bool">bool</a></td>
+ <td>request</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only
-the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td>
+ <td><p>The request payload in JSON format. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>databases</td>
+ <td>response</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>All database name list in the instance. </p></td>
+ <td></td>
+ <td><p>The response payload in JSON format.
+Some fields may be omitted if they are too large or contain sensitive information. </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#google.rpc.Status">google.rpc.Status</a></td>
+ <td></td>
+ <td><p>The status of the operation. </p></td>
+ </tr>
+
+ <tr>
+ <td>latency</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration of the operation. </p></td>
+ </tr>
+
+ <tr>
+ <td>service_data</td>
+ <td><a href="#google.protobuf.Any">google.protobuf.Any</a></td>
+ <td></td>
+ <td><p>Service-specific metadata about the request, response, and activities. </p></td>
+ </tr>
+
+ <tr>
+ <td>request_metadata</td>
+ <td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td>
+ <td></td>
+ <td><p>Metadata about the request context. </p></td>
</tr>
</tbody>
@@ -8766,8 +8580,8 @@ the instance metadata (such as the database list) and any newly discovered datab
- <h3 id="bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>
+ <p>Request message for exporting audit logs.</p>
<table class="field-table">
@@ -8777,22 +8591,65 @@ the instance metadata (such as the database list) and any newly discovered datab
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the deleted instance.
-Format: instances/{instance} </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The filter of the log. It should be a valid CEL expression.
+Check the filter field in the SearchAuditLogsRequest message. </p></td>
+ </tr>
+
+ <tr>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The order by of the log.
+Only support order by create_time. The default sorting order is ascending.
+For example:
+ - order_by = &#34;create_time asc&#34;
+ - order_by = &#34;create_time desc&#34; </p></td>
+ </tr>
+
+ <tr>
+ <td>format</td>
+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td></td>
+ <td><p>The export format. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of logs to return.
+The service may return fewer than this value.
+If unspecified, at most 10 log entries will be returned.
+The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ExportAuditLogs` call.
+Provide this to retrieve the subsequent page. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>
+ <p>Response message for exporting audit logs.</p>
<table class="field-table">
@@ -8802,40 +8659,51 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>content</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The name of the instance to update a data source.
-Format: instances/{instance} </p></td>
+ <td><p>The exported audit log content in the requested format. </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Identified by data source ID. </p></td>
+ <td><p>A token to retrieve next page of log entities.
+Pass this value in the page_token field in the subsequent call
+to retrieve the next page of log entities. </p></td>
</tr>
- <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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RequestMetadata">RequestMetadata</h3>
+ <p>Metadata about the incoming request.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>caller_ip</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>The IP address of the request originator. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>caller_supplied_user_agent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the data source is not found, a new data source will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The user agent string provided by the caller.
+This is supplied by the client and is not authenticated. </p></td>
</tr>
</tbody>
@@ -8845,8 +8713,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>
+ <p>Request message for searching audit logs.</p>
<table class="field-table">
@@ -8856,28 +8724,92 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>instance</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The instance to update.
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The filter of the log. It should be a valid CEL expression.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-The instance&#39;s `name` field is used to identify the instance to update.
-Format: instances/{instance} </p></td>
+Supported filter:
+- method: the API name, can be found in the docs, should start with &#34;/bytebase.v1.&#34; prefix. For example &#34;/bytebase.v1.UserService/CreateUser&#34;. Support &#34;==&#34; operator.
+- severity: support &#34;==&#34; operator, check Severity enum in AuditLog message for values.
+- user: the actor, should in &#34;users/{email}&#34; format, support &#34;==&#34; operator.
+- create_time: support &#34;&gt;=&#34; and &#34;&lt;=&#34; operator.
+
+For example:
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39;&#34;
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39;&#34;
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; user == &#39;users/[email protected]&#39;&#34;
+ - filter = &#34;method == &#39;/bytebase.v1.SQLService/Query&#39; &amp;&amp; severity == &#39;ERROR&#39; &amp;&amp; create_time &lt;= &#39;2021-01-01T00:00:00Z&#39; &amp;&amp; create_time &gt;= &#39;2020-01-01T00:00:00Z&#39;&#34; </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The order by of the log.
+Only support order by create_time. The default sorting order is ascending.
+For example:
+ - order_by = &#34;create_time asc&#34;
+ - order_by = &#34;create_time desc&#34; </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>If set to true, and the instance is not found, a new instance will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The maximum number of logs to return.
+The service may return fewer than this value.
+If unspecified, at most 10 log entries will be returned.
+The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `SearchLogs` call.
+Provide this to retrieve the subsequent page. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</h3>
+ <p>Response message for searching audit logs.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>audit_logs</td>
+ <td><a href="#bytebase.v1.AuditLog">AuditLog</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token to retrieve next page of log entities.
+Pass this value in the page_token field in the subsequent call
+to retrieve the next page of log entities. </p></td>
</tr>
</tbody>
@@ -8889,8 +8821,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3>
- <p></p>
+ <h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>
+ <p>Severity level for audit log entries.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -8898,196 +8830,57 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>AUTHENTICATION_UNSPECIFIED</td>
+ <td>SEVERITY_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified severity level.</p></td>
</tr>
<tr>
- <td>PASSWORD</td>
+ <td>DEBUG</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Debug-level information.</p></td>
</tr>
<tr>
- <td>GOOGLE_CLOUD_SQL_IAM</td>
+ <td>INFO</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Informational messages.</p></td>
</tr>
<tr>
- <td>AWS_RDS_IAM</td>
+ <td>NOTICE</td>
<td>3</td>
- <td><p></p></td>
+ <td><p>Notable events.</p></td>
</tr>
<tr>
- <td>AZURE_IAM</td>
+ <td>WARNING</td>
<td>4</td>
- <td><p></p></td>
+ <td><p>Warning conditions.</p></td>
</tr>
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSource.RedisType">DataSource.RedisType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>REDIS_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>ERROR</td>
+ <td>5</td>
+ <td><p>Error conditions.</p></td>
</tr>
<tr>
- <td>STANDALONE</td>
- <td>1</td>
- <td><p></p></td>
+ <td>CRITICAL</td>
+ <td>6</td>
+ <td><p>Critical conditions.</p></td>
</tr>
<tr>
- <td>SENTINEL</td>
- <td>2</td>
- <td><p></p></td>
+ <td>ALERT</td>
+ <td>7</td>
+ <td><p>Action must be taken immediately.</p></td>
</tr>
<tr>
- <td>CLUSTER</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SECRET_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified secret type.</p></td>
- </tr>
-
- <tr>
- <td>PLAIN</td>
- <td>1</td>
- <td><p>Plain text secret.</p></td>
- </tr>
-
- <tr>
- <td>ENVIRONMENT</td>
- <td>2</td>
- <td><p>Secret from environment variable.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>AUTH_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified authentication type.</p></td>
- </tr>
-
- <tr>
- <td>TOKEN</td>
- <td>1</td>
- <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td>
- </tr>
-
- <tr>
- <td>VAULT_APP_ROLE</td>
- <td>2</td>
- <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/approle</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SECRET_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified secret type.</p></td>
- </tr>
-
- <tr>
- <td>VAULT_KV_V2</td>
- <td>1</td>
- <td><p>ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2</p></td>
- </tr>
-
- <tr>
- <td>AWS_SECRETS_MANAGER</td>
- <td>2</td>
- <td><p>ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</p></td>
- </tr>
-
- <tr>
- <td>GCP_SECRET_MANAGER</td>
- <td>3</td>
- <td><p>ref: https://cloud.google.com/secret-manager/docs</p></td>
- </tr>
-
- <tr>
- <td>AZURE_KEY_VAULT</td>
- <td>4</td>
- <td><p>ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceType">DataSourceType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATA_SOURCE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified data source type.</p></td>
- </tr>
-
- <tr>
- <td>ADMIN</td>
- <td>1</td>
- <td><p>Admin data source with write permissions.</p></td>
- </tr>
-
- <tr>
- <td>READ_ONLY</td>
- <td>2</td>
- <td><p>Read-only data source for query operations.</p></td>
+ <td>EMERGENCY</td>
+ <td>8</td>
+ <td><p>System is unusable.</p></td>
</tr>
</tbody>
@@ -9097,8 +8890,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.InstanceService">InstanceService</h3>
- <p>InstanceService manages database instances and their connections.</p>
+ <h3 id="bytebase.v1.AuditLogService">AuditLogService</h3>
+ <p>AuditLogService manages audit logs for system activities and API calls.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -9106,107 +8899,19 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>GetInstance</td>
- <td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Gets a database instance by name.
-Permissions required: bb.instances.get</p></td>
- </tr>
-
- <tr>
- <td>ListInstances</td>
- <td><a href="#bytebase.v1.ListInstancesRequest">ListInstancesRequest</a></td>
- <td><a href="#bytebase.v1.ListInstancesResponse">ListInstancesResponse</a></td>
- <td><p>Lists all database instances.
-Permissions required: bb.instances.list</p></td>
- </tr>
-
- <tr>
- <td>CreateInstance</td>
- <td><a href="#bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Creates a new database instance.
-Permissions required: bb.instances.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateInstance</td>
- <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Updates a database instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>DeleteInstance</td>
- <td><a href="#bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes or soft-deletes a database instance.
-Permissions required: bb.instances.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteInstance</td>
- <td><a href="#bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Restores a soft-deleted database instance.
-Permissions required: bb.instances.undelete</p></td>
- </tr>
-
- <tr>
- <td>SyncInstance</td>
- <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
- <td><a href="#bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</a></td>
- <td><p>Syncs database schemas and metadata from an instance.
-Permissions required: bb.instances.sync</p></td>
- </tr>
-
- <tr>
- <td>ListInstanceDatabase</td>
- <td><a href="#bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</a></td>
- <td><a href="#bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</a></td>
- <td><p>Lists all databases within an instance without creating them.
-Permissions required: bb.instances.get</p></td>
- </tr>
-
- <tr>
- <td>BatchSyncInstances</td>
- <td><a href="#bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</a></td>
- <td><a href="#bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</a></td>
- <td><p>Syncs multiple instances in a single request.
-Permissions required: bb.instances.sync</p></td>
- </tr>
-
- <tr>
- <td>BatchUpdateInstances</td>
- <td><a href="#bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</a></td>
- <td><p>Updates multiple instances in a single request.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>AddDataSource</td>
- <td><a href="#bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Adds a read-only data source to an instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>RemoveDataSource</td>
- <td><a href="#bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Removes a read-only data source from an instance.
-Permissions required: bb.instances.update</p></td>
+ <td>SearchAuditLogs</td>
+ <td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td>
+ <td><a href="#bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</a></td>
+ <td><p>Searches audit logs with optional filtering and pagination.
+Permissions required: bb.auditLogs.search</p></td>
</tr>
<tr>
- <td>UpdateDataSource</td>
- <td><a href="#bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Updates a data source configuration.
-Permissions required: bb.instances.update</p></td>
+ <td>ExportAuditLogs</td>
+ <td><a href="#bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</a></td>
+ <td><a href="#bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</a></td>
+ <td><p>Exports audit logs in a specified format for external analysis.
+Permissions required: bb.auditLogs.export</p></td>
</tr>
</tbody>
@@ -9230,133 +8935,37 @@ Permissions required: bb.instances.update</p></td>
<tr>
- <td>GetInstance</td>
- <td>GET</td>
- <td>/v1/{name=instances/*}</td>
- <td></td>
+ <td>SearchAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/auditLogs:search</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>SearchAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/auditLogs:search</td>
+ <td>*</td>
</tr>
<tr>
- <td>ListInstances</td>
- <td>GET</td>
- <td>/v1/instances</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateInstance</td>
- <td>POST</td>
- <td>/v1/instances</td>
- <td>instance</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateInstance</td>
- <td>PATCH</td>
- <td>/v1/{instance.name=instances/*}</td>
- <td>instance</td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteInstance</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UndeleteInstance</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:undelete</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>SyncInstance</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:sync</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListInstanceDatabase</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:databases</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchSyncInstances</td>
- <td>POST</td>
- <td>/v1/instances:batchSync</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchUpdateInstances</td>
- <td>POST</td>
- <td>/v1/instances:batchUpdate</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>AddDataSource</td>
+ <td>ExportAuditLogs</td>
<td>POST</td>
- <td>/v1/{name=instances/*}:addDataSource</td>
+ <td>/v1/{parent=projects/*}/auditLogs:export</td>
<td>*</td>
</tr>
-
-
-
<tr>
- <td>RemoveDataSource</td>
+ <td>ExportAuditLogs</td>
<td>POST</td>
- <td>/v1/{name=instances/*}:removeDataSource</td>
+ <td>/v1/auditLogs:export</td>
<td>*</td>
</tr>
-
-
- <tr>
- <td>UpdateDataSource</td>
- <td>PATCH</td>
- <td>/v1/{name=instances/*}:updateDataSource</td>
- <td>data_source</td>
- </tr>
-
-
</tbody>
</table>
@@ -9364,12 +8973,12 @@ Permissions required: bb.instances.update</p></td>
<div class="file-heading">
- <h2 id="v1/database_service.proto">v1/database_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/auth_service.proto">v1/auth_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</h3>
+ <h3 id="bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</h3>
<p></p>
@@ -9380,20 +8989,18 @@ Permissions required: bb.instances.update</p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being retrieved.
-- projects/{project}: batch get databases in a project;
-- instances/{instances}: batch get databases in a instance;
-Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
+ <td><p>External OIDC token (JWT) from CI/CD platform. </p></td>
</tr>
<tr>
- <td>names</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of database names to retrieve. </p></td>
+ <td></td>
+ <td><p>Workload Identity email for identifying which identity to authenticate as.
+Format: {name}@workload.bytebase.com </p></td>
</tr>
</tbody>
@@ -9403,7 +9010,7 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
- <h3 id="bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</h3>
+ <h3 id="bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</h3>
<p></p>
@@ -9414,10 +9021,10 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
<tbody>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>The databases from the specified request. </p></td>
+ <td>access_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Bytebase access token. </p></td>
</tr>
</tbody>
@@ -9427,8 +9034,8 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
- <h3 id="bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>
+ <p>Context for identity provider authentication.</p>
<table class="field-table">
@@ -9438,19 +9045,17 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>oauth2_context</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being updated.
-Format: instances/{instance}
-If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></td>
+ <td><p>OAuth2 authentication context. </p></td>
</tr>
<tr>
- <td>names</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of database names to sync. </p></td>
+ <td>oidc_context</td>
+ <td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td>
+ <td></td>
+ <td><p>OpenID Connect authentication context. </p></td>
</tr>
</tbody>
@@ -9460,14 +9065,7 @@ If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></
- <h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3>
+ <h3 id="bytebase.v1.LoginRequest">LoginRequest</h3>
<p></p>
@@ -9478,45 +9076,61 @@ If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></
<tbody>
<tr>
- <td>parent</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being updated.
-Format: instances/{instance}
-If the operation spans parents, a dash (-) may be accepted as a wildcard.
-We only support updating the project of databases for now. </p></td>
+ <td><p>User&#39;s email address. </p></td>
</tr>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
- <td>repeated</td>
- <td><p>The request message specifying the resources to update.
-A maximum of 1000 databases can be modified in a batch. </p></td>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>User&#39;s password for authentication. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>web</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If true, sets access token and refresh token as HTTP-only cookies instead of
+returning the token in the response body. Use for browser-based clients. </p></td>
+ </tr>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>Databases updated. </p></td>
+ <td>idp_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the identity provider.
+Format: idps/{idp} </p></td>
+ </tr>
+
+ <tr>
+ <td>idp_context</td>
+ <td><a href="#bytebase.v1.IdentityProviderContext">IdentityProviderContext</a></td>
+ <td></td>
+ <td><p>The idp_context is used to get the user information from identity provider. </p></td>
+ </tr>
+
+ <tr>
+ <td>otp_code</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The otp_code is used to verify the user&#39;s identity by MFA. </p></td>
+ </tr>
+
+ <tr>
+ <td>recovery_code</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The recovery_code is used to recovery the user&#39;s identity with MFA. </p></td>
+ </tr>
+
+ <tr>
+ <td>mfa_temp_token</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The mfa_temp_token is used to verify the user&#39;s identity by MFA. </p></td>
</tr>
</tbody>
@@ -9526,8 +9140,8 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
- <h3 id="bytebase.v1.BoundingBox">BoundingBox</h3>
- <p>BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.</p>
+ <h3 id="bytebase.v1.LoginResponse">LoginResponse</h3>
+ <p></p>
<table class="field-table">
@@ -9537,31 +9151,32 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
<tbody>
<tr>
- <td>xmin</td>
- <td><a href="#double">double</a></td>
+ <td>token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Minimum X coordinate </p></td>
+ <td><p>Access token for authenticated requests.
+Only returned when web=false. For web=true, the token is set as an HTTP-only cookie. </p></td>
</tr>
<tr>
- <td>ymin</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Minimum Y coordinate </p></td>
+ <td>mfa_temp_token</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Temporary token for MFA verification. </p></td>
</tr>
<tr>
- <td>xmax</td>
- <td><a href="#double">double</a></td>
+ <td>require_reset_password</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Maximum X coordinate </p></td>
+ <td><p>Whether user must reset password before continuing. </p></td>
</tr>
<tr>
- <td>ymax</td>
- <td><a href="#double">double</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p>Maximum Y coordinate </p></td>
+ <td><p>The user from the successful login. </p></td>
</tr>
</tbody>
@@ -9571,8 +9186,15 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
- <h3 id="bytebase.v1.Changelog">Changelog</h3>
- <p></p>
+ <h3 id="bytebase.v1.LogoutRequest">LogoutRequest</h3>
+ <p>Request to logout current user session.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</h3>
+ <p>OAuth2 authentication context.</p>
<table class="field-table">
@@ -9582,53 +9204,189 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>code</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </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>Authorization code from OAuth2 provider. </p></td>
</tr>
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3>
+ <p>OpenID Connect authentication context.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>schema</td>
+ <td>code</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Authorization code from OIDC provider. </p></td>
</tr>
- <tr>
- <td>schema_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RefreshRequest">RefreshRequest</h3>
+ <p>Request to refresh the access token.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.RefreshResponse">RefreshResponse</h3>
+ <p>Response from refreshing the access token.</p>
+
+
+
+
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.AuthService">AuthService</h3>
+ <p>AuthService handles user authentication operations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>Login</td>
+ <td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td>
+ <td><a href="#bytebase.v1.LoginResponse">LoginResponse</a></td>
+ <td><p>Authenticates a user and returns access tokens.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>Logout</td>
+ <td><a href="#bytebase.v1.LogoutRequest">LogoutRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Logs out the current user session.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>ExchangeToken</td>
+ <td><a href="#bytebase.v1.ExchangeTokenRequest">ExchangeTokenRequest</a></td>
+ <td><a href="#bytebase.v1.ExchangeTokenResponse">ExchangeTokenResponse</a></td>
+ <td><p>Exchanges an external OIDC token for a Bytebase access token.
+Used by CI/CD pipelines with Workload Identity Federation.
+Permissions required: None (validates via OIDC token)</p></td>
+ </tr>
+
+ <tr>
+ <td>Refresh</td>
+ <td><a href="#bytebase.v1.RefreshRequest">RefreshRequest</a></td>
+ <td><a href="#bytebase.v1.RefreshResponse">RefreshResponse</a></td>
+ <td><p>Refreshes the access token using the refresh token cookie.
+Permissions required: None (validates via refresh token cookie)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <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>task_run</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
- </tr>
+
+ <tr>
+ <td>Login</td>
+ <td>POST</td>
+ <td>/v1/auth/login</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>Logout</td>
+ <td>POST</td>
+ <td>/v1/auth/logout</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ExchangeToken</td>
+ <td>POST</td>
+ <td>/v1/auth:exchangeToken</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>Refresh</td>
+ <td>POST</td>
+ <td>/v1/auth/refresh</td>
+ <td>*</td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>
+ <p>Request message for batch deparsing CEL expressions.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>plan_title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The title of the plan associated with this changelog&#39;s task run.
-This field is populated by deriving the plan from task_run for display purposes. </p></td>
+ <td>expressions</td>
+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>repeated</td>
+ <td><p>The CEL expression ASTs to deparse. </p></td>
</tr>
</tbody>
@@ -9638,8 +9396,8 @@ This field is populated by deriving the plan from task_run for display purposes.
- <h3 id="bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</h3>
- <p>CheckConstraintMetadata is the metadata for check constraints.</p>
+ <h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>
+ <p>Response message for batch deparsing CEL expressions.</p>
<table class="field-table">
@@ -9649,17 +9407,10 @@ This field is populated by deriving the plan from task_run for display purposes.
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a check constraint. </p></td>
- </tr>
-
- <tr>
- <td>expression</td>
+ <td>expressions</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The expression is the expression of a check constraint. </p></td>
+ <td>repeated</td>
+ <td><p>The deparsed CEL expressions as strings. </p></td>
</tr>
</tbody>
@@ -9669,8 +9420,8 @@ This field is populated by deriving the plan from task_run for display purposes.
- <h3 id="bytebase.v1.ColumnMetadata">ColumnMetadata</h3>
- <p>ColumnMetadata is the metadata for columns.</p>
+ <h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>
+ <p>Request message for batch parsing CEL expressions.</p>
<table class="field-table">
@@ -9680,144 +9431,197 @@ This field is populated by deriving the plan from task_run for display purposes.
<tbody>
<tr>
- <td>name</td>
+ <td>expressions</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a column. </p></td>
+ <td>repeated</td>
+ <td><p>The CEL expression strings to parse. </p></td>
</tr>
- <tr>
- <td>position</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The position is the position in columns. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>
+ <p>Response message for batch parsing CEL expressions.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>has_default</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>expressions</td>
+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>repeated</td>
+ <td><p>The parsed CEL expressions as AST. </p></td>
</tr>
- <tr>
- <td>default</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The default value of column. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.CelService">CelService</h3>
+ <p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>BatchParse</td>
+ <td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td>
+ <td><a href="#bytebase.v1.BatchParseResponse">BatchParseResponse</a></td>
+ <td><p>Parses multiple CEL expression strings into AST representations.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchDeparse</td>
+ <td><a href="#bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</a></td>
+ <td><a href="#bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</a></td>
+ <td><p>Converts multiple CEL AST representations back into expression strings.
+Permissions required: None</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
- <tr>
- <td>default_on_null</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Oracle specific metadata.
-The default_on_null is the default on null of a column. </p></td>
- </tr>
- <tr>
- <td>on_update</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The on_update is the on update action of a column.
-For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with
-CURRENT_TIMESTAMP as on update value. </p></td>
- </tr>
+ <tr>
+ <td>BatchParse</td>
+ <td>POST</td>
+ <td>/v1/cel/batchParse</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>nullable</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The nullable is the nullable of a column. </p></td>
- </tr>
+
- <tr>
- <td>type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The type is the type of a column. </p></td>
- </tr>
- <tr>
- <td>character_set</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The character_set is the character_set of a column. </p></td>
- </tr>
+ <tr>
+ <td>BatchDeparse</td>
+ <td>POST</td>
+ <td>/v1/cel/batchDeparse</td>
+ <td>*</td>
+ </tr>
+
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/database_catalog_service.proto">v1/database_catalog_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.ColumnCatalog">ColumnCatalog</h3>
+ <p>Column metadata within a table.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>collation</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The collation is the collation of a column. </p></td>
+ <td><p>The column name. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>semantic_type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of a column. </p></td>
+ <td><p>The semantic type describing the data purpose. </p></td>
</tr>
<tr>
- <td>generation</td>
- <td><a href="#bytebase.v1.GenerationMetadata">GenerationMetadata</a></td>
- <td></td>
- <td><p>The generation is the generation of a column. </p></td>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>User-defined labels for this column. </p></td>
</tr>
<tr>
- <td>is_identity</td>
- <td><a href="#bool">bool</a></td>
+ <td>classification</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The data classification level for this column. </p></td>
</tr>
<tr>
- <td>identity_generation</td>
- <td><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td>
- <td></td>
- <td><p>The identity_generation is for identity columns, PG only. </p></td>
+ <td>object_schema</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>optional</td>
+ <td><p>Object schema for complex column types like JSON. </p></td>
</tr>
- <tr>
- <td>identity_seed</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The identity_seed is for identity columns, MSSQL only. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>identity_increment</td>
- <td><a href="#int64">int64</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The identity_increment is for identity columns, MSSQL only. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>default_constraint_name</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The default_constraint_name is the name of the default constraint, MSSQL only.
-In MSSQL, default values are implemented as named constraints. When modifying or
-dropping a column&#39;s default value, you must reference the constraint by name.
-This field stores the actual constraint name from the database.
-
-Example: A column definition like:
- CREATE TABLE employees (
- status NVARCHAR(20) DEFAULT &#39;active&#39;
- )
-
-Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39;
-or a user-defined name if specified:
- ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
-
-To modify the default, you must first drop the existing constraint by name:
- ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760
- ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
-
-This field is populated when syncing from the database. When empty (e.g., when parsing
-from SQL files), the system cannot automatically drop the constraint. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -9827,8 +9631,8 @@ from SQL files), the system cannot automatically drop the constraint. </p></td>
- <h3 id="bytebase.v1.Database">Database</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3>
+ <p>Catalog metadata for a database including schemas, tables, and columns.</p>
<table class="field-table">
@@ -9841,78 +9645,15 @@ from SQL files), the system cannot automatically drop the constraint. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database.
-Format: instances/{instance}/databases/{database}
-{database} is the database name in the instance. </p></td>
+ <td><p>The name of the database catalog.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The existence of a database. </p></td>
- </tr>
-
- <tr>
- <td>successful_sync_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The latest synchronization time. </p></td>
- </tr>
-
- <tr>
- <td>project</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The project for a database.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The release that was last applied to this database.
-Format: projects/{project}/releases/{release_id}
-Example: projects/my-project/releases/release_20260115-RC00 </p></td>
- </tr>
-
- <tr>
- <td>environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
- </tr>
-
- <tr>
- <td>effective_environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The effective environment based on environment tag above and environment
-tag on the instance. Inheritance follows
-https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
- </tr>
-
- <tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</a></td>
+ <td>schemas</td>
+ <td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td>
<td>repeated</td>
- <td><p>Labels will be used for deployment and policy control. </p></td>
- </tr>
-
- <tr>
- <td>instance_resource</td>
- <td><a href="#bytebase.v1.InstanceResource">InstanceResource</a></td>
- <td></td>
- <td><p>The instance resource. </p></td>
- </tr>
-
- <tr>
- <td>backup_available</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The database is available for DML prior backup. </p></td>
+ <td><p>The schemas in the database. </p></td>
</tr>
</tbody>
@@ -9922,8 +9663,8 @@ https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
- <h3 id="bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3>
+ <p>Request message for getting a database catalog.</p>
<table class="field-table">
@@ -9933,17 +9674,11 @@ https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>value</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database catalog to retrieve.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
</tr>
</tbody>
@@ -9953,8 +9688,8 @@ https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
- <h3 id="bytebase.v1.DatabaseMetadata">DatabaseMetadata</h3>
- <p>DatabaseMetadata is the metadata for databases.</p>
+ <h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3>
+ <p>Schema definition for object-type columns.</p>
<table class="field-table">
@@ -9964,54 +9699,31 @@ https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The database metadata name.
-
-Format: instances/{instance}/databases/{database}/metadata </p></td>
- </tr>
-
- <tr>
- <td>schemas</td>
- <td><a href="#bytebase.v1.SchemaMetadata">SchemaMetadata</a></td>
- <td>repeated</td>
- <td><p>The schemas is the list of schemas in a database. </p></td>
- </tr>
-
- <tr>
- <td>character_set</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</a></td>
<td></td>
- <td><p>The character_set is the character set of a database. </p></td>
+ <td><p>The data type of this object. </p></td>
</tr>
<tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
+ <td>struct_kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td>
<td></td>
- <td><p>The collation is the collation of a database. </p></td>
- </tr>
-
- <tr>
- <td>extensions</td>
- <td><a href="#bytebase.v1.ExtensionMetadata">ExtensionMetadata</a></td>
- <td>repeated</td>
- <td><p>The extensions is the list of extensions in a database. </p></td>
+ <td><p>Struct schema. </p></td>
</tr>
<tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
+ <td>array_kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td>
<td></td>
- <td><p>The owner of the database. </p></td>
+ <td><p>Array schema. </p></td>
</tr>
<tr>
- <td>search_path</td>
+ <td>semantic_type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The search_path is the search path of a PostgreSQL database. </p></td>
+ <td><p>The semantic type of this object. </p></td>
</tr>
</tbody>
@@ -10021,8 +9733,8 @@ Format: instances/{instance}/databases/{database}/metadata </p></td>
- <h3 id="bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</h3>
- <p>DatabaseSDLSchema contains the schema in SDL format.</p>
+ <h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>
+ <p>Array type with element schema.</p>
<table class="field-table">
@@ -10032,23 +9744,10 @@ Format: instances/{instance}/databases/{database}/metadata </p></td>
<tbody>
<tr>
- <td>schema</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The SDL schema content.
-- For SINGLE_FILE format: contains the complete SDL schema as a text string.
-- For MULTI_FILE format: contains the ZIP archive as binary data. </p></td>
- </tr>
-
- <tr>
- <td>content_type</td>
- <td><a href="#string">string</a></td>
+ <td>kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>The MIME type of the schema content.
-Indicates how the client should interpret the schema field.
-Examples:
-- &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format
-- &#34;application/zip&#34; for MULTI_FILE format </p></td>
+ <td><p>The schema of array elements. </p></td>
</tr>
</tbody>
@@ -10058,8 +9757,8 @@ Examples:
- <h3 id="bytebase.v1.DatabaseSchema">DatabaseSchema</h3>
- <p>DatabaseSchema is the metadata for databases.</p>
+ <h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3>
+ <p>Structure type with named properties.</p>
<table class="field-table">
@@ -10069,10 +9768,10 @@ Examples:
<tbody>
<tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema dump from database. </p></td>
+ <td>properties</td>
+ <td><a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</a></td>
+ <td>repeated</td>
+ <td><p>Properties of the struct. </p></td>
</tr>
</tbody>
@@ -10082,8 +9781,8 @@ Examples:
- <h3 id="bytebase.v1.DependencyColumn">DependencyColumn</h3>
- <p>DependencyColumn is the metadata for dependency columns.</p>
+ <h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3>
+ <p></p>
<table class="field-table">
@@ -10093,24 +9792,17 @@ Examples:
<tbody>
<tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema is the schema of a reference column. </p></td>
- </tr>
-
- <tr>
- <td>table</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The table is the table of a reference column. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>column</td>
- <td><a href="#string">string</a></td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>The column is the name of a reference column. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -10120,8 +9812,8 @@ Examples:
- <h3 id="bytebase.v1.DependencyTable">DependencyTable</h3>
- <p></p>
+ <h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3>
+ <p>Schema metadata within a database.</p>
<table class="field-table">
@@ -10131,17 +9823,17 @@ Examples:
<tbody>
<tr>
- <td>schema</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema is the schema of a reference table. </p></td>
+ <td><p>The schema name. </p></td>
</tr>
<tr>
- <td>table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The table is the name of a reference table. </p></td>
+ <td>tables</td>
+ <td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td>
+ <td>repeated</td>
+ <td><p>The tables in the schema. </p></td>
</tr>
</tbody>
@@ -10151,8 +9843,8 @@ Examples:
- <h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>
+ <p>Table metadata within a schema.</p>
<table class="field-table">
@@ -10165,26 +9857,28 @@ Examples:
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database or changelog.
-Format:
-database: instances/{instance}/databases/{database}
-changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
+ <td><p>The table name. </p></td>
</tr>
<tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td>
<td></td>
- <td><p>The target schema. </p></td>
+ <td><p>Regular table columns. </p></td>
</tr>
<tr>
- <td>changelog</td>
+ <td>object_schema</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td></td>
+ <td><p>Object schema for JSON/XML columns. </p></td>
+ </tr>
+
+ <tr>
+ <td>classification</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the changelog
-Format:
-instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
+ <td><p>The data classification level for this table. </p></td>
</tr>
</tbody>
@@ -10194,8 +9888,8 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>
+ <p>Column list for regular tables.</p>
<table class="field-table">
@@ -10205,10 +9899,10 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>diff</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td>
+ <td>repeated</td>
+ <td><p>The columns in the table. </p></td>
</tr>
</tbody>
@@ -10218,8 +9912,8 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.DimensionConstraint">DimensionConstraint</h3>
- <p>DimensionConstraint defines constraints for a spatial dimension.</p>
+ <h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3>
+ <p>Request message for updating a database catalog.</p>
<table class="field-table">
@@ -10229,31 +9923,21 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>dimension</td>
- <td><a href="#string">string</a></td>
+ <td>catalog</td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
<td></td>
- <td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td>
+ <td><p>The database catalog to update.
+
+The catalog&#39;s `name` field is used to identify the database catalog to update.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
</tr>
<tr>
- <td>min_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Minimum value for this dimension </p></td>
- </tr>
-
- <tr>
- <td>max_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Maximum value for this dimension </p></td>
- </tr>
-
- <tr>
- <td>tolerance</td>
- <td><a href="#double">double</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Tolerance for this dimension </p></td>
+ <td><p>If set to true, and the database catalog is not found, a new database catalog will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -10263,53 +9947,135 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.DimensionalConfig">DimensionalConfig</h3>
- <p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>
+
+
+ <h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3>
+ <p>Object schema data types.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>STRING</td>
+ <td>1</td>
+ <td><p>String type.</p></td>
+ </tr>
+
+ <tr>
+ <td>NUMBER</td>
+ <td>2</td>
+ <td><p>Number type.</p></td>
+ </tr>
+
+ <tr>
+ <td>BOOLEAN</td>
+ <td>3</td>
+ <td><p>Boolean type.</p></td>
+ </tr>
+
+ <tr>
+ <td>OBJECT</td>
+ <td>4</td>
+ <td><p>Object/struct type.</p></td>
+ </tr>
+
+ <tr>
+ <td>ARRAY</td>
+ <td>5</td>
+ <td><p>Array type.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3>
+ <p>DatabaseCatalogService manages database schema metadata and classification.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetDatabaseCatalog</td>
+ <td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td><p>Gets the catalog metadata for a database.
+Permissions required: bb.databaseCatalogs.get</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateDatabaseCatalog</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td><p>Updates catalog metadata such as classifications and labels.
+Permissions required: bb.databaseCatalogs.update</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <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>dimensions</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Number of dimensions (2-4, default 2) </p></td>
- </tr>
- <tr>
- <td>data_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td>
- </tr>
+ <tr>
+ <td>GetDatabaseCatalog</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/catalog}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>srid</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Spatial reference system identifier (SRID) </p></td>
- </tr>
+
- <tr>
- <td>constraints</td>
- <td><a href="#bytebase.v1.DimensionConstraint">DimensionConstraint</a></td>
- <td>repeated</td>
- <td><p>Coordinate system constraints </p></td>
- </tr>
+ <tr>
+ <td>UpdateDatabaseCatalog</td>
+ <td>PATCH</td>
+ <td>/v1/{catalog.name=instances/*/databases/*/catalog}</td>
+ <td>catalog</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</h3>
- <p></p>
+ <div class="file-heading">
+ <h2 id="v1/database_group_service.proto">v1/database_group_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</h3>
+ <p>Request message for creating a database group.</p>
<table class="field-table">
@@ -10319,31 +10085,36 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of a type. </p></td>
+ <td><p>The parent resource where this database group will be created.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>values</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The enum values of a type. </p></td>
+ <td>database_group</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td></td>
+ <td><p>The database group to create. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>database_group_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment describing the enum type. </p></td>
+ <td><p>The ID to use for the database group, which will become the final component of
+the database group&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
+ <td>validate_only</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether to skip this enum type during schema dump operations. </p></td>
+ <td><p>If set, validate the create request and preview the full database group response, but do not actually create it. </p></td>
</tr>
</tbody>
@@ -10353,8 +10124,8 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.EventMetadata">EventMetadata</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>
+ <p>A group of databases matched by expressions.</p>
<table class="field-table">
@@ -10367,49 +10138,41 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the event. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schedule of the event. </p></td>
- </tr>
-
- <tr>
- <td>time_zone</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The time zone of the event. </p></td>
- </tr>
-
- <tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SQL mode setting for the event. </p></td>
+ <td><p>The name of the database group.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
- <td>character_set_client</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The character set used by the client creating the event. </p></td>
+ <td><p>The short name used in actual databases specified by users. </p></td>
</tr>
<tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
+ <td>database_expr</td>
+ <td><a href="#google.type.Expr">google.type.Expr</a></td>
<td></td>
- <td><p>The collation used for the connection when creating the event. </p></td>
+ <td><p>The condition that is associated with this database group.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Support variables:
+resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations.
+resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
+resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
+resource.database_labels: the database labels. Support map access operations.
+All variables should join with &#34;&amp;&amp;&#34; condition.
+
+For example:
+resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;)
+resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of an event. </p></td>
+ <td>matched_databases</td>
+ <td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td>
+ <td>repeated</td>
+ <td><p>The list of databases that match the database group condition. </p></td>
</tr>
</tbody>
@@ -10419,8 +10182,8 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.ExtensionMetadata">ExtensionMetadata</h3>
- <p>ExtensionMetadata is the metadata for extensions.</p>
+ <h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3>
+ <p>A database within a database group.</p>
<table class="field-table">
@@ -10433,29 +10196,8 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of an extension. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema is the extension that is installed to. But the extension usage
-is not limited to the schema. </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version is the version of an extension. </p></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The description is the description of an extension. </p></td>
+ <td><p>The resource name of the database.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
</tbody>
@@ -10465,8 +10207,8 @@ is not limited to the schema. </p></td>
- <h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3>
+ <p>Request message for deleting a database group.</p>
<table class="field-table">
@@ -10479,28 +10221,8 @@ is not limited to the schema. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a external table. </p></td>
- </tr>
-
- <tr>
- <td>external_server_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The external_server_name is the name of the external server. </p></td>
- </tr>
-
- <tr>
- <td>external_database_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The external_database_name is the name of the external database. </p></td>
- </tr>
-
- <tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a foreign table. </p></td>
+ <td><p>The name of the database group to delete.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
</tbody>
@@ -10510,8 +10232,8 @@ is not limited to the schema. </p></td>
- <h3 id="bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</h3>
- <p>ForeignKeyMetadata is the metadata for foreign keys.</p>
+ <h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3>
+ <p>Request message for getting a database group.</p>
<table class="field-table">
@@ -10524,59 +10246,15 @@ is not limited to the schema. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>columns</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The columns are the ordered referencing columns of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>referenced_schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The referenced_schema is the referenced schema name of a foreign key.
-It is an empty string for databases without such concept such as MySQL. </p></td>
- </tr>
-
- <tr>
- <td>referenced_table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The referenced_table is the referenced table name of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>referenced_columns</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>on_delete</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The on_delete is the on delete action of a foreign key. </p></td>
- </tr>
-
- <tr>
- <td>on_update</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The on_update is the on update action of a foreign key. </p></td>
+ <td><p>The name of the database group to retrieve.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
- <td>match_type</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
<td></td>
- <td><p>The match_type is the match type of a foreign key.
-The match_type is the PostgreSQL specific field.
-It&#39;s empty string for other databases. </p></td>
+ <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
</tr>
</tbody>
@@ -10586,8 +10264,8 @@ It&#39;s empty string for other databases. </p></td>
- <h3 id="bytebase.v1.FunctionMetadata">FunctionMetadata</h3>
- <p>FunctionMetadata is the metadata for functions.</p>
+ <h3 id="bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3>
+ <p>Request message for listing database groups.</p>
<table class="field-table">
@@ -10597,75 +10275,18 @@ It&#39;s empty string for other databases. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a function. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition is the definition of a function. </p></td>
- </tr>
-
- <tr>
- <td>signature</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The signature is the name with the number and type of input arguments the
-function takes. </p></td>
- </tr>
-
- <tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>MySQL specific metadata. </p></td>
- </tr>
-
- <tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>database_collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>dependency_tables</td>
- <td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>
- <td>repeated</td>
- <td><p>The dependency_tables is the list of dependency tables of a function.
-For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. </p></td>
+ <td><p>The parent resource whose database groups are to be listed.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
</tr>
</tbody>
@@ -10675,8 +10296,8 @@ For PostgreSQL, it&#39;s the list of tables that the function depends on the ret
- <h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3>
+ <p>Response message for listing database groups.</p>
<table class="field-table">
@@ -10686,17 +10307,10 @@ For PostgreSQL, it&#39;s the list of tables that the function depends on the ret
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>expression</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>database_groups</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td>repeated</td>
+ <td><p>The database groups from the specified request. </p></td>
</tr>
</tbody>
@@ -10706,8 +10320,8 @@ For PostgreSQL, it&#39;s the list of tables that the function depends on the ret
- <h3 id="bytebase.v1.GetChangelogRequest">GetChangelogRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>
+ <p>Request message for updating a database group.</p>
<table class="field-table">
@@ -10717,18 +10331,28 @@ For PostgreSQL, it&#39;s the list of tables that the function depends on the ret
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>database_group</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
<td></td>
- <td><p>The name of the changelog to retrieve.
-Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
+ <td><p>The database group to update.
+
+The database group&#39;s `name` field is used to identify the database group to update.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
- <td>view</td>
- <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the database group is not found, a new database group will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -10738,88 +10362,173 @@ Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></t
- <h3 id="bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve metadata.
-Format: instances/{instance}/databases/{database}/metadata </p></td>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter databases returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-Supported filter:
-- schema: the schema name, support &#34;==&#34; operator.
-- table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-
-For example:
-schema == &#34;schema-a&#34;
-table == &#34;table-a&#34;
-table.matches(&#34;table-a&#34;)
-schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;)
-The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;.
-The column masking level will only be returned when a table filter is used. </p></td>
- </tr>
-
- <tr>
- <td>limit</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Limit the response size of returned table metadata per schema.
-For example, if the database has 3 schemas, and each schema has 100 tables,
-if limit is 20, then only 20 tables will be returned for each schema, total 60 tables.
-Default 0, means no limit. </p></td>
- </tr>
-
- </tbody>
- </table>
+
+ <h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3>
+ <p>View options for database group responses.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>DATABASE_GROUP_VIEW_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>The default / unset value.
+The API will default to the BASIC view.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_GROUP_VIEW_BASIC</td>
+ <td>1</td>
+ <td><p>Include basic information about the database group, but exclude the list of matched databases and unmatched databases.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_GROUP_VIEW_FULL</td>
+ <td>2</td>
+ <td><p>Include everything.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
+
-
- <h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3>
+ <p>DatabaseGroupService manages database groups for organizing databases by criteria.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ListDatabaseGroups</td>
+ <td><a href="#bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</a></td>
+ <td><a href="#bytebase.v1.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</a></td>
+ <td><p>Lists database groups in a project.
+Permissions required: bb.databaseGroups.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetDatabaseGroup</td>
+ <td><a href="#bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td><p>Gets a database group by name.
+Permissions required: bb.databaseGroups.get</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateDatabaseGroup</td>
+ <td><a href="#bytebase.v1.CreateDatabaseGroupRequest">CreateDatabaseGroupRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td><p>Creates a new database group.
+Permissions required: bb.databaseGroups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateDatabaseGroup</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
+ <td><p>Updates a database group.
+Permissions required: bb.databaseGroups.update
+When allow_missing=true, also requires: bb.databaseGroups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteDatabaseGroup</td>
+ <td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a database group.
+Permissions required: bb.databaseGroups.delete</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
+ <tr>
+ <td>ListDatabaseGroups</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetDatabaseGroup</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateDatabaseGroup</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td>database_group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateDatabaseGroup</td>
+ <td>PATCH</td>
+ <td>/v1/{database_group.name=projects/*/databaseGroups/*}</td>
+ <td>database_group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteDatabaseGroup</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <td></td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</h3>
- <p></p>
+ <div class="file-heading">
+ <h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.InstanceRole">InstanceRole</h3>
+ <p>InstanceRole is the API message for instance role.</p>
<table class="field-table">
@@ -10832,40 +10541,46 @@ Format: instances/{instance}/databases/{database} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to retrieve SDL schema.
-Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
+ <td><p>The name of the role.
+Format: instances/{instance}/roles/{role}
+The role name is the unique name for the role. </p></td>
</tr>
<tr>
- <td>format</td>
- <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td>
+ <td>role_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The format of the SDL schema output. </p></td>
+ <td><p>The role name. It&#39;s unique within the instance. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</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>password</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The role password. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>connection_limit</td>
+ <td><a href="#int32">int32</a></td>
+ <td>optional</td>
+ <td><p>The connection count limit for this role. </p></td>
+ </tr>
+
+ <tr>
+ <td>valid_until</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve schema.
-Format: instances/{instance}/databases/{database}/schema </p></td>
+ <td>optional</td>
+ <td><p>The expiration for the role&#39;s password. </p></td>
+ </tr>
+
+ <tr>
+ <td>attribute</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The role attribute.
+For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html
+For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td>
</tr>
</tbody>
@@ -10875,7 +10590,7 @@ Format: instances/{instance}/databases/{database}/schema </p></td>
- <h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3>
+ <h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3>
<p></p>
@@ -10886,40 +10601,41 @@ Format: instances/{instance}/databases/{database}/schema </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The parent, which owns this collection of roles.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>It&#39;s empty for DATABASE. </p></td>
+ <td><p>Not used.
+The maximum number of roles to return. The service may return fewer than
+this value.
+If unspecified, at most 10 roles will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>object</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>It&#39;s empty for DATABASE and SCHEMA. </p></td>
+ <td><p>Not used.
+A page token, received from a previous `ListInstanceRoles` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListInstanceRoles` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
+ <td>refresh</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.
-Also the schema and object are empty. </p></td>
+ <td><p>Refresh will refresh and return the latest data. </p></td>
</tr>
</tbody>
@@ -10929,7 +10645,7 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3>
+ <h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3>
<p></p>
@@ -10940,10 +10656,18 @@ Also the schema and object are empty. </p></td>
<tbody>
<tr>
- <td>schema_string</td>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
+ <td>repeated</td>
+ <td><p>The roles from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>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>
@@ -10953,39 +10677,70 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.GridLevel">GridLevel</h3>
- <p>GridLevel defines a tessellation grid level with its density.</p>
+
+
+
+
+
+
+ <h3 id="bytebase.v1.InstanceRoleService">InstanceRoleService</h3>
+ <p>InstanceRoleService manages database roles within instances.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ListInstanceRoles</td>
+ <td><a href="#bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</a></td>
+ <td><a href="#bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</a></td>
+ <td><p>Lists all database roles in an instance.
+Permissions required: bb.instanceRoles.list</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <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>level</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Grid level number (1-4 for SQL Server) </p></td>
- </tr>
- <tr>
- <td>density</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Grid density (LOW, MEDIUM, HIGH) </p></td>
- </tr>
+ <tr>
+ <td>ListInstanceRoles</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/roles</td>
+ <td></td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3>
- <p>IndexMetadata is the metadata for indexes.</p>
+ <div class="file-heading">
+ <h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3>
+ <p></p>
<table class="field-table">
@@ -10998,123 +10753,48 @@ Also the schema and object are empty. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of an index. </p></td>
- </tr>
-
- <tr>
- <td>expressions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The expressions are the ordered columns or expressions of an index.
-This could refer to a column or an expression. </p></td>
- </tr>
-
- <tr>
- <td>key_length</td>
- <td><a href="#int64">int64</a></td>
- <td>repeated</td>
- <td><p>The key_lengths are the ordered key lengths of an index.
-If the key length is not specified, it&#39;s -1. </p></td>
- </tr>
-
- <tr>
- <td>descending</td>
- <td><a href="#bool">bool</a></td>
- <td>repeated</td>
- <td><p>The descending is the ordered descending of an index. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The type is the type of an index. </p></td>
- </tr>
-
- <tr>
- <td>unique</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The unique is whether the index is unique. </p></td>
- </tr>
-
- <tr>
- <td>primary</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The primary is whether the index is a primary key index. </p></td>
- </tr>
-
- <tr>
- <td>visible</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The visible is whether the index is visible. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of an index. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition of an index. </p></td>
- </tr>
-
- <tr>
- <td>parent_index_schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema name of the parent index. </p></td>
- </tr>
-
- <tr>
- <td>parent_index_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The index name of the parent index. </p></td>
+ <td><p>The name of the instance to add a data source to.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>granularity</td>
- <td><a href="#int64">int64</a></td>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
<td></td>
- <td><p>The number of granules in the block. It&#39;s a ClickHouse specific field. </p></td>
+ <td><p>Identified by data source ID.
+Only READ_ONLY data source can be added. </p></td>
</tr>
<tr>
- <td>is_constraint</td>
+ <td>validate_only</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>It&#39;s a PostgreSQL specific field.
-The unique constraint and unique index are not the same thing in PostgreSQL. </p></td>
- </tr>
-
- <tr>
- <td>spatial_config</td>
- <td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</a></td>
- <td></td>
- <td><p>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
</tr>
- <tr>
- <td>opclass_names</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.html
-Name of the operator class for each column. (PostgreSQL specific). </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</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>opclass_defaults</td>
- <td><a href="#bool">bool</a></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
<td>repeated</td>
- <td><p>True if the operator class is the default. (PostgreSQL specific). </p></td>
+ <td><p>The request message specifying the instances to sync.
+A maximum of 1000 instances can be synced in a batch. </p></td>
</tr>
</tbody>
@@ -11124,7 +10804,14 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td>
- <h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</h3>
+ <h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3>
<p></p>
@@ -11135,55 +10822,10 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent of the changelogs.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of changelogs to return. The service may return fewer
-than this value. If unspecified, at most 10 changelogs will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A page token, received from the previous call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided must match
-the call that provided the page token. </p></td>
- </tr>
-
- <tr>
- <td>view</td>
- <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter changelogs returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values.
-- create_time: the changelog create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-
-Example:
-status == &#34;DONE&#34;
-status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34;
-create_time &gt;= &#34;2024-01-01T00:00:00Z&#34; &amp;&amp; create_time &lt;= &#34;2024-01-02T00:00:00Z&#34; </p></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the resources to update. </p></td>
</tr>
</tbody>
@@ -11193,7 +10835,7 @@ create_time &gt;= &#34;2024-01-01T00:00:00Z&#34; &amp;&amp; create_time &lt;= &#
- <h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3>
+ <h3 id="bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</h3>
<p></p>
@@ -11204,18 +10846,10 @@ create_time &gt;= &#34;2024-01-01T00:00:00Z&#34; &amp;&amp; create_time &lt;= &#
<tbody>
<tr>
- <td>changelogs</td>
- <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
+ <td>instances</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
<td>repeated</td>
- <td><p>The list of changelogs. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>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>
@@ -11225,7 +10859,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3>
+ <h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3>
<p></p>
@@ -11236,89 +10870,28 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>- projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission.
-- workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission.
-- instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of databases to return. The service may return fewer
-than this value.
-If unspecified, at most 10 databases will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListDatabases` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListDatabases` must
-match the call that provided the page token. </p></td>
+ <td><p>The instance to create. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>instance_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter databases returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
-- name: the database name, support &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
-- engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator.
-- table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example:
-environment == &#34;environments/{environment resource id}&#34;
-environment == &#34;&#34; (find databases which environment is not set)
-project == &#34;projects/{project resource id}&#34;
-instance == &#34;instances/{instance resource id}&#34;
-name.matches(&#34;database name&#34;)
-engine == &#34;MYSQL&#34;
-engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
-!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
-exclude_unassigned == true
-table == &#34;sample&#34;
-table.matches(&#34;sam&#34;)
-labels.environment == &#34;production&#34;
-labels.region == &#34;asia&#34;
-labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+ <td><p>The ID to use for the instance, which will become the final component of
+the instance&#39;s resource name.
-You can combine filter conditions like:
-environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) </p></td>
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
+ <td>validate_only</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Show deleted database if specified. </p></td>
- </tr>
-
- <tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The order by of databases.
-Support name, project, instance. The default sorting order is ascending.
-For example:
-- order_by = &#34;name&#34; - order by name ascending
-- order_by = &#34;name desc&#34;
-- order_by = &#34;name desc, project asc&#34; </p></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
</tr>
</tbody>
@@ -11328,7 +10901,7 @@ For example:
- <h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3>
+ <h3 id="bytebase.v1.DataSource">DataSource</h3>
<p></p>
@@ -11339,329 +10912,294 @@ For example:
<tbody>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>The databases from the specified request. </p></td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The unique identifier for this data source. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.DataSourceType">DataSourceType</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 type of data source (ADMIN or READ_ONLY). </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</h3>
- <p>MaterializedViewMetadata is the metadata for materialized views.</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>username</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a materialized view. </p></td>
+ <td><p>The username for database authentication. </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>password</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition is the definition of a materialized view. </p></td>
+ <td><p>The password for database authentication. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>use_ssl</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment is the comment of a materialized view. </p></td>
+ <td><p>Use SSL to connect to the data source. By default, we use system default SSL configuration. </p></td>
</tr>
<tr>
- <td>dependency_columns</td>
- <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
- <td>repeated</td>
- <td><p>The dependency_columns is the list of dependency columns of a materialized
-view. </p></td>
+ <td>ssl_ca</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SSL certificate authority certificate. </p></td>
</tr>
<tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
+ <td>ssl_cert</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SSL client certificate. </p></td>
</tr>
<tr>
- <td>indexes</td>
- <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
- <td>repeated</td>
- <td><p>The indexes is the list of indexes in a table. </p></td>
+ <td>ssl_key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SSL client private key. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
+ <td>verify_tls_certificate</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>verify_tls_certificate enables TLS certificate verification for SSL connections.
+Default is false (no verification) for backward compatibility.
+Set to true for secure connections (recommended for production).
+Only set to false for development or when certificates cannot be properly
+validated (e.g., self-signed certs, VPN environments). </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PackageMetadata">PackageMetadata</h3>
- <p>PackageMetadata is the metadata for packages.</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>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a package. </p></td>
+ <td><p>The hostname or IP address of the database server. </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition is the definition of a package. </p></td>
+ <td><p>The port number of the database server. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ProcedureMetadata">ProcedureMetadata</h3>
- <p>ProcedureMetadata is the metadata for procedures.</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>database</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a procedure. </p></td>
+ <td><p>The name of the database to connect to. </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>srv</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>srv, authentication_database and replica_set are used for MongoDB.
+srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td>
+ </tr>
+
+ <tr>
+ <td>authentication_database</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition is the definition of a procedure. </p></td>
+ <td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td>
</tr>
<tr>
- <td>signature</td>
+ <td>replica_set</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The signature is the name with the number and type of input arguments the
-procedure takes. </p></td>
+ <td><p>replica_set is used for MongoDB replica set. </p></td>
</tr>
<tr>
- <td>character_set_client</td>
+ <td>sid</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>MySQL specific metadata. </p></td>
+ <td><p>sid and service_name are used for Oracle. </p></td>
</tr>
<tr>
- <td>collation_connection</td>
+ <td>service_name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>database_collation</td>
+ <td>ssh_host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Connection over SSH.
+The hostname of the SSH server agent.
+Required. </p></td>
</tr>
<tr>
- <td>sql_mode</td>
+ <td>ssh_port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The port of the SSH server agent. It&#39;s 22 typically.
+Required. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>ssh_user</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of a procedure. </p></td>
+ <td><p>The user to login the server.
+Required. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>ssh_password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The password to login the server. If it&#39;s empty string, no password is required. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SchemaMetadata">SchemaMetadata</h3>
- <p>SchemaMetadata is the metadata for schemas.</p><p>This is the concept of schema in Postgres, but it's a no-op for MySQL.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>ssh_private_key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The private key to login the server. If it&#39;s empty string, we will use the system default private key from os.Getenv(&#34;SSH_AUTH_SOCK&#34;). </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>authentication_private_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the schema name.
-It is an empty string for databases without such concept such as MySQL. </p></td>
+ <td><p>PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required.
+Used for authentication when connecting to the data source. </p></td>
</tr>
<tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td>
- <td>repeated</td>
- <td><p>The tables is the list of tables in a schema. </p></td>
+ <td>authentication_private_key_passphrase</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Passphrase for the encrypted PKCS#8 private key. Only used when the private key is encrypted. </p></td>
</tr>
<tr>
- <td>external_tables</td>
- <td><a href="#bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</a></td>
- <td>repeated</td>
- <td><p>The external_tables is the list of external tables in a schema. </p></td>
+ <td>external_secret</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>views</td>
- <td><a href="#bytebase.v1.ViewMetadata">ViewMetadata</a></td>
- <td>repeated</td>
- <td><p>The views is the list of views in a schema. </p></td>
+ <td>authentication_type</td>
+ <td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>functions</td>
- <td><a href="#bytebase.v1.FunctionMetadata">FunctionMetadata</a></td>
- <td>repeated</td>
- <td><p>The functions is the list of functions in a schema. </p></td>
+ <td>azure_credential</td>
+ <td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>procedures</td>
- <td><a href="#bytebase.v1.ProcedureMetadata">ProcedureMetadata</a></td>
- <td>repeated</td>
- <td><p>The procedures is the list of procedures in a schema. </p></td>
+ <td>aws_credential</td>
+ <td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>streams</td>
- <td><a href="#bytebase.v1.StreamMetadata">StreamMetadata</a></td>
- <td>repeated</td>
- <td><p>The streams is the list of streams in a schema, currently, only used for
-Snowflake. </p></td>
+ <td>gcp_credential</td>
+ <td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>tasks</td>
- <td><a href="#bytebase.v1.TaskMetadata">TaskMetadata</a></td>
- <td>repeated</td>
- <td><p>The routines is the list of routines in a schema, currently, only used for
-Snowflake. </p></td>
+ <td>sasl_config</td>
+ <td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>materialized_views</td>
- <td><a href="#bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</a></td>
+ <td>additional_addresses</td>
+ <td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td>
<td>repeated</td>
- <td><p>The materialized_views is the list of materialized views in a schema. </p></td>
+ <td><p>additional_addresses is used for MongoDB replica set. </p></td>
</tr>
<tr>
- <td>packages</td>
- <td><a href="#bytebase.v1.PackageMetadata">PackageMetadata</a></td>
- <td>repeated</td>
- <td><p>The packages is the list of packages in a schema. </p></td>
+ <td>direct_connection</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td>
</tr>
<tr>
- <td>owner</td>
+ <td>region</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The owner of the schema. </p></td>
+ <td><p>region is the location of where the DB is, works for AWS RDS. For example, us-east-1. </p></td>
</tr>
<tr>
- <td>sequences</td>
- <td><a href="#bytebase.v1.SequenceMetadata">SequenceMetadata</a></td>
- <td>repeated</td>
- <td><p>The sequences is the list of sequences in a schema, sorted by name. </p></td>
+ <td>warehouse_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>warehouse_id is used by Databricks. </p></td>
</tr>
<tr>
- <td>events</td>
- <td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td>
- <td>repeated</td>
- <td><p>The events is the list of scheduled events in a schema. </p></td>
+ <td>master_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td>
</tr>
<tr>
- <td>enum_types</td>
- <td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td>
- <td>repeated</td>
- <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td>
+ <td>master_username</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>master_username and master_password are master credentials used by redis sentinel mode. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>master_password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to skip this schema during schema dump operations. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>redis_type</td>
+ <td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>cluster</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of a schema. </p></td>
+ <td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td>
+ </tr>
+
+ <tr>
+ <td>extra_connection_parameters</td>
+ <td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>
+ <td>repeated</td>
+ <td><p>Extra connection parameters for the database connection.
+For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td>
</tr>
</tbody>
@@ -11671,7 +11209,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</h3>
+ <h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3>
<p></p>
@@ -11682,94 +11220,109 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>data_type</td>
+ <td>access_key_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The data type of a sequence. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>start</td>
+ <td>secret_access_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The start value of a sequence. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>min_value</td>
+ <td>session_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The minimum value of a sequence. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>max_value</td>
+ <td>role_arn</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum value of a sequence. </p></td>
+ <td><p>ARN of IAM role to assume for cross-account access.
+See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html </p></td>
</tr>
<tr>
- <td>increment</td>
+ <td>external_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Increment value of a sequence. </p></td>
+ <td><p>Optional external ID for additional security when assuming role.
+See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html </p></td>
</tr>
- <tr>
- <td>cycle</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Cycle is whether the sequence cycles. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>cache_size</td>
+ <td>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Cache size of a sequence. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>last_value</td>
+ <td>port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Last value of a sequence. </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>owner_table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner table of the sequence. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>owner_column</td>
+ <td>tenant_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The owner column of the sequence. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>client_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment describing the sequence. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to skip this sequence during schema dump operations. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -11779,8 +11332,8 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</h3>
- <p>SpatialIndexConfig defines the spatial index configuration for spatial databases.</p>
+ <h3 id="bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3>
+ <p></p>
<table class="field-table">
@@ -11790,31 +11343,17 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>method</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) </p></td>
- </tr>
-
- <tr>
- <td>tessellation</td>
- <td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td>
- <td></td>
- <td><p>Tessellation configuration for grid-based spatial indexes </p></td>
- </tr>
-
- <tr>
- <td>storage</td>
- <td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td>
- <td></td>
- <td><p>Storage and performance configuration </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>dimensional</td>
- <td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Dimensional configuration </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -11824,8 +11363,8 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.StorageConfig">StorageConfig</h3>
- <p>StorageConfig defines storage and performance parameters for spatial indexes.</p>
+ <h3 id="bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</h3>
+ <p></p>
<table class="field-table">
@@ -11835,101 +11374,115 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>fillfactor</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Fill factor percentage (1-100) </p></td>
- </tr>
-
- <tr>
- <td>buffering</td>
+ <td>content</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Buffering mode for PostgreSQL (auto, on, off) </p></td>
+ <td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</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>tablespace</td>
- <td><a href="#string">string</a></td>
+ <td>secret_type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td>
<td></td>
- <td><p>Tablespace configuration for Oracle </p></td>
+ <td><p>The type of external secret store. </p></td>
</tr>
<tr>
- <td>work_tablespace</td>
+ <td>url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The URL of the external secret store. </p></td>
</tr>
<tr>
- <td>sdo_level</td>
- <td><a href="#int32">int32</a></td>
+ <td>auth_type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The authentication method for accessing the secret store. </p></td>
</tr>
<tr>
- <td>commit_interval</td>
- <td><a href="#int32">int32</a></td>
+ <td>app_role</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>AppRole authentication configuration. </p></td>
</tr>
<tr>
- <td>pad_index</td>
- <td><a href="#bool">bool</a></td>
+ <td>token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>SQL Server specific parameters </p></td>
+ <td><p>Token for direct authentication. </p></td>
</tr>
<tr>
- <td>sort_in_tempdb</td>
+ <td>engine_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>ON, OFF </p></td>
+ <td><p>engine name is the name for secret engine. </p></td>
</tr>
<tr>
- <td>drop_existing</td>
- <td><a href="#bool">bool</a></td>
+ <td>secret_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>the secret name in the engine to store the password. </p></td>
</tr>
<tr>
- <td>online</td>
- <td><a href="#bool">bool</a></td>
+ <td>password_key_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>the key name for the password. </p></td>
</tr>
<tr>
- <td>allow_row_locks</td>
+ <td>skip_vault_tls_verification</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>TLS configuration for connecting to Vault server.
+These fields are separate from the database TLS configuration in DataSource.
+skip_vault_tls_verification disables TLS certificate verification for Vault connections.
+Default is false (verification enabled) for security.
+Only set to true for development or when certificates cannot be properly validated. </p></td>
</tr>
<tr>
- <td>allow_page_locks</td>
- <td><a href="#bool">bool</a></td>
+ <td>vault_ssl_ca</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>CA certificate for Vault server verification. </p></td>
</tr>
<tr>
- <td>maxdop</td>
- <td><a href="#int32">int32</a></td>
+ <td>vault_ssl_cert</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Client certificate for mutual TLS authentication with Vault. </p></td>
</tr>
<tr>
- <td>data_compression</td>
+ <td>vault_ssl_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>NONE, ROW, PAGE </p></td>
+ <td><p>Client private key for mutual TLS authentication with Vault. </p></td>
</tr>
</tbody>
@@ -11939,7 +11492,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.StreamMetadata">StreamMetadata</h3>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3>
<p></p>
@@ -11950,59 +11503,73 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>role_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a stream. </p></td>
+ <td><p>The role ID for Vault AppRole authentication. </p></td>
</tr>
<tr>
- <td>table_name</td>
+ <td>secret_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The table_name is the name of the table/view that the stream is created on. </p></td>
+ <td><p>the secret id for the role without ttl. </p></td>
</tr>
<tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td>
<td></td>
- <td><p>The owner of the stream. </p></td>
+ <td><p>The type of secret for AppRole authentication. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>mount_path</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment of the stream. </p></td>
+ <td><p>The path where the approle auth method is mounted. </p></td>
</tr>
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td>
- <td></td>
- <td><p>The type of the stream. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</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>stale</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td>
+ <td><p>The name of the instance to delete.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>mode</td>
- <td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td>
+ <td>force</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The mode of the stream. </p></td>
+ <td><p>If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. </p></td>
</tr>
<tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
+ <td>purge</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The definition of the stream. </p></td>
+ <td><p>If set to true, permanently purge the soft-deleted instance and all related resources.
+This operation is irreversible. Following AIP-165, this should only be used for
+administrative cleanup of old soft-deleted instances.
+The instance must already be soft-deleted for this to work. </p></td>
</tr>
</tbody>
@@ -12012,7 +11579,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3>
+ <h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3>
<p></p>
@@ -12026,8 +11593,8 @@ Snowflake. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to sync.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The name of the instance to retrieve.
+Format: instances/{instance} </p></td>
</tr>
</tbody>
@@ -12037,17 +11604,10 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3>
+ <h3 id="bytebase.v1.Instance">Instance</h3>
<p></p>
-
-
-
- <h3 id="bytebase.v1.TableMetadata">TableMetadata</h3>
- <p>TableMetadata is the metadata for tables.</p>
-
-
<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
@@ -12058,149 +11618,133 @@ Format: instances/{instance}/databases/{database} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a table. </p></td>
- </tr>
-
- <tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
- </tr>
-
- <tr>
- <td>indexes</td>
- <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
- <td>repeated</td>
- <td><p>The indexes is the list of indexes in a table. </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The engine is the engine of a table. </p></td>
+ <td><p>The name of the instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>collation</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 collation is the collation of a table. </p></td>
+ <td><p>The lifecycle state of the instance. </p></td>
</tr>
<tr>
- <td>charset</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The character set of table. </p></td>
+ <td><p>The display title of the instance. </p></td>
</tr>
<tr>
- <td>row_count</td>
- <td><a href="#int64">int64</a></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
<td></td>
- <td><p>The row_count is the estimated number of rows of a table. </p></td>
+ <td><p>The database engine type. </p></td>
</tr>
<tr>
- <td>data_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>engine_version</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The data_size is the estimated data size of a table. </p></td>
+ <td><p>The version of the database engine. </p></td>
</tr>
<tr>
- <td>index_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>external_link</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The index_size is the estimated index size of a table. </p></td>
+ <td><p>External URL to the database instance console. </p></td>
</tr>
<tr>
- <td>data_free</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The data_free is the estimated free data size of a table. </p></td>
+ <td>data_sources</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>repeated</td>
+ <td><p>Data source configurations for connecting to the instance. </p></td>
</tr>
<tr>
- <td>create_options</td>
+ <td>environment</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The create_options is the create option of a table. </p></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>activation</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment is the comment of a table. </p></td>
+ <td><p>Whether the instance is activated for use. </p></td>
</tr>
<tr>
- <td>foreign_keys</td>
- <td><a href="#bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</a></td>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
<td>repeated</td>
- <td><p>The foreign_keys is the list of foreign keys in a table. </p></td>
+ <td><p>Database roles available in this instance. </p></td>
</tr>
<tr>
- <td>partitions</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
- <td>repeated</td>
- <td><p>The partitions is the list of partitions in a table. </p></td>
+ <td>sync_interval</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>How often the instance is synced. </p></td>
</tr>
<tr>
- <td>check_constraints</td>
- <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>sync_databases</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The check_constraints is the list of check constraints in a table. </p></td>
+ <td><p>Enable sync for following databases.
+Default empty, means sync all schemas &amp; databases. </p></td>
</tr>
<tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
+ <td>last_sync_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The owner of the table. </p></td>
- </tr>
-
- <tr>
- <td>sorting_keys</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.
-Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by </p></td>
+ <td><p>The last time the instance was synced. </p></td>
</tr>
<tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</a></td>
<td>repeated</td>
- <td><p>The triggers is the list of triggers associated with the table. </p></td>
+ <td><p>Labels are key-value pairs that can be attached to the instance.
+For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } </p></td>
</tr>
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this table during schema dump operations. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Instance.LabelsEntry">Instance.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>sharding_info</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>primary_key_type</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes
-CLUSTERED or NONCLUSTERED. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -12210,8 +11754,8 @@ CLUSTERED or NONCLUSTERED. </p></td>
- <h3 id="bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</h3>
- <p>TablePartitionMetadata is the metadata for table partitions.</p>
+ <h3 id="bytebase.v1.InstanceResource">InstanceResource</h3>
+ <p></p>
<table class="field-table">
@@ -12221,78 +11765,54 @@ CLUSTERED or NONCLUSTERED. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a table partition. </p></td>
+ <td><p>The display title of the instance. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
<td></td>
- <td><p>The type of a table partition. </p></td>
+ <td><p>The database engine type. </p></td>
</tr>
<tr>
- <td>expression</td>
+ <td>engine_version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The expression is the expression of a table partition.
-For PostgreSQL, the expression is the text of {FOR VALUES
-partition_bound_spec}, see
-https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL,
-the expression is the `expr` or `column_list` of the following syntax.
-PARTITION BY
- { [LINEAR] HASH(expr)
- | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list)
- | RANGE{(expr) | COLUMNS(column_list)}
- | LIST{(expr) | COLUMNS(column_list)} }. </p></td>
+ <td><p>The version of the database engine. </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The value is the value of a table partition.
-For MySQL, the value is for RANGE and LIST partition types,
-- For a RANGE partition, it contains the value set in the partition&#39;s
-VALUES LESS THAN clause, which can be either an integer or MAXVALUE.
-- For a LIST partition, this column contains the values defined in the
-partition&#39;s VALUES IN clause, which is a list of comma-separated integer
-values.
-- For others, it&#39;s an empty string. </p></td>
+ <td>data_sources</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>repeated</td>
+ <td><p>Data source configurations for the instance. </p></td>
</tr>
<tr>
- <td>use_default</td>
- <td><a href="#string">string</a></td>
+ <td>activation</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The use_default is whether the users use the default partition, it stores
-the different value for different database engines. For MySQL, it&#39;s [INT]
-type, 0 means not use default partition, otherwise, it&#39;s equals to number
-in syntax [SUB]PARTITION {number}. </p></td>
- </tr>
-
- <tr>
- <td>subpartitions</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
- <td>repeated</td>
- <td><p>The subpartitions is the list of subpartitions in a table partition. </p></td>
+ <td><p>Whether the instance is activated. </p></td>
</tr>
<tr>
- <td>indexes</td>
- <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</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 instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>check_constraints</td>
- <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
</tr>
</tbody>
@@ -12302,7 +11822,7 @@ in syntax [SUB]PARTITION {number}. </p></td>
- <h3 id="bytebase.v1.TaskMetadata">TaskMetadata</h3>
+ <h3 id="bytebase.v1.KerberosConfig">KerberosConfig</h3>
<p></p>
@@ -12313,74 +11833,84 @@ in syntax [SUB]PARTITION {number}. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>primary</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a task. </p></td>
+ <td><p>The primary component of the Kerberos principal. </p></td>
</tr>
<tr>
- <td>id</td>
+ <td>instance</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The id is the snowflake-generated id of a task.
-Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
+ <td><p>The instance component of the Kerberos principal. </p></td>
</tr>
<tr>
- <td>owner</td>
+ <td>realm</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The owner of the task. </p></td>
+ <td><p>The Kerberos realm. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>keytab</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The comment of the task. </p></td>
+ <td><p>The keytab file contents for authentication. </p></td>
</tr>
<tr>
- <td>warehouse</td>
+ <td>kdc_host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The warehouse of the task. </p></td>
+ <td><p>The hostname of the Key Distribution Center (KDC). </p></td>
</tr>
<tr>
- <td>schedule</td>
+ <td>kdc_port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schedule interval of the task. </p></td>
+ <td><p>The port of the Key Distribution Center (KDC). </p></td>
</tr>
<tr>
- <td>predecessors</td>
+ <td>kdc_transport_protocol</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The predecessor tasks of the task. </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.TaskMetadata.State">TaskMetadata.State</a></td>
<td></td>
- <td><p>The state of the task. </p></td>
+ <td><p>The transport protocol for KDC communication (tcp or udp). </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</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>condition</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The condition of the task. </p></td>
+ <td><p>The name of the instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition of the task. </p></td>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>optional</td>
+ <td><p>The target instance. We need to set this field if the target instance is not created yet. </p></td>
</tr>
</tbody>
@@ -12390,8 +11920,8 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
- <h3 id="bytebase.v1.TessellationConfig">TessellationConfig</h3>
- <p>TessellationConfig defines tessellation parameters for spatial indexes.</p>
+ <h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3>
+ <p></p>
<table class="field-table">
@@ -12401,31 +11931,10 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
<tbody>
<tr>
- <td>scheme</td>
+ <td>databases</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) </p></td>
- </tr>
-
- <tr>
- <td>grid_levels</td>
- <td><a href="#bytebase.v1.GridLevel">GridLevel</a></td>
<td>repeated</td>
- <td><p>Grid levels and densities for multi-level tessellation </p></td>
- </tr>
-
- <tr>
- <td>cells_per_object</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Number of cells per object (1-8192 for SQL Server) </p></td>
- </tr>
-
- <tr>
- <td>bounding_box</td>
- <td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td>
- <td></td>
- <td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td>
+ <td><p>All database name list in the instance. </p></td>
</tr>
</tbody>
@@ -12435,7 +11944,7 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
- <h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3>
+ <h3 id="bytebase.v1.ListInstancesRequest">ListInstancesRequest</h3>
<p></p>
@@ -12446,67 +11955,116 @@ Example: 01ad32a0-1bb6-5e93-0000-000000000001 </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 name of the trigger. </p></td>
+ <td><p>The maximum number of instances to return. The service may return fewer than
+this value.
+If unspecified, at most 10 instances will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>event</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The event is the event of the trigger, such as INSERT, UPDATE, DELETE,
-TRUNCATE. </p></td>
+ <td><p>A page token, received from a previous `ListInstances` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListInstances` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>timing</td>
- <td><a href="#string">string</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td>
+ <td><p>Show deleted instances if specified. </p></td>
</tr>
<tr>
- <td>body</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The body is the body of the trigger. </p></td>
+ <td><p>Filter the instance.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
+- state: the instance state, check State enum for values, support &#34;==&#34; operator.
+- engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example:
+name == &#34;sample instance&#34;
+name.matches(&#34;sample&#34;)
+resource_id == &#34;sample-instance&#34;
+resource_id.matches(&#34;sample&#34;)
+state == &#34;DELETED&#34;
+environment == &#34;environments/test&#34;
+environment == &#34;&#34; (find instances which environment is not set)
+engine == &#34;MYSQL&#34;
+engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
+!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
+host == &#34;127.0.0.1&#34;
+host.matches(&#34;127.0&#34;)
+port == &#34;54321&#34;
+port.matches(&#34;543&#34;)
+labels.org_group == &#34;infrastructure&#34;
+labels.environment in [&#34;prod&#34;, &#34;production&#34;]
+project == &#34;projects/sample-project&#34;
+You can combine filter conditions like:
+name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34;
+host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; </p></td>
</tr>
<tr>
- <td>sql_mode</td>
+ <td>order_by</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SQL mode setting for the trigger. </p></td>
+ <td><p>The order by of instances.
+Support title, environment. The default sorting order is ascending.
+For example:
+- order_by = &#34;title&#34;
+- order_by = &#34;title desc&#34;
+- order_by = &#34;title desc, environment asc&#34; </p></td>
</tr>
- <tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The character set used by the client creating the trigger. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The collation used for the connection when creating the trigger. </p></td>
+ <td>instances</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>repeated</td>
+ <td><p>The instances from the specified request. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment describing the trigger. </p></td>
- </tr>
-
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this trigger during schema dump operations. </p></td>
+ <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>
@@ -12516,7 +12074,7 @@ TRUNCATE. </p></td>
- <h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3>
+ <h3 id="bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</h3>
<p></p>
@@ -12527,28 +12085,43 @@ TRUNCATE. </p></td>
<tbody>
<tr>
- <td>database</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The database to update.
-
-The database&#39;s `name` field is used to identify the database to update.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The name of the instance to remove a data source from.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>Identified by data source ID.
+Only READ_ONLY data source can be removed. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SASLConfig">SASLConfig</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>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>krb_config</td>
+ <td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td>
<td></td>
- <td><p>If set to true, and the database is not found, a new database will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Kerberos authentication configuration. </p></td>
</tr>
</tbody>
@@ -12558,8 +12131,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.ViewMetadata">ViewMetadata</h3>
- <p>ViewMetadata is the metadata for views.</p>
+ <h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3>
+ <p></p>
<table class="field-table">
@@ -12572,49 +12145,161 @@ In this situation, `update_mask` is ignored. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a view. </p></td>
+ <td><p>The name of instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
+ <td>enable_full_sync</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The definition is the definition of a view. </p></td>
+ <td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only
+the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td>
</tr>
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of a view. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>dependency_columns</td>
- <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>databases</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The dependency_columns is the list of dependency columns of a view. </p></td>
+ <td><p>All database name list in the instance. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</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>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the deleted instance.
+Format: instances/{instance} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</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 instance to update a data source.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
- <td>repeated</td>
- <td><p>The triggers is the list of triggers in a view. </p></td>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td></td>
+ <td><p>Identified by data source ID. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>validate_only</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the data source is not found, a new data source will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</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>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td></td>
+ <td><p>The instance to update.
+
+The instance&#39;s `name` field is used to identify the instance to update.
+Format: instances/{instance} </p></td>
+ </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 instance is not found, a new instance will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -12626,7 +12311,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3>
+ <h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -12635,33 +12320,39 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>STATUS_UNSPECIFIED</td>
+ <td>AUTHENTICATION_UNSPECIFIED</td>
<td>0</td>
<td><p></p></td>
</tr>
<tr>
- <td>PENDING</td>
+ <td>PASSWORD</td>
<td>1</td>
<td><p></p></td>
</tr>
<tr>
- <td>DONE</td>
+ <td>GOOGLE_CLOUD_SQL_IAM</td>
<td>2</td>
<td><p></p></td>
</tr>
<tr>
- <td>FAILED</td>
+ <td>AWS_RDS_IAM</td>
<td>3</td>
<td><p></p></td>
</tr>
+ <tr>
+ <td>AZURE_IAM</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
</tbody>
</table>
- <h3 id="bytebase.v1.ChangelogView">ChangelogView</h3>
+ <h3 id="bytebase.v1.DataSource.RedisType">DataSource.RedisType</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -12670,28 +12361,33 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>CHANGELOG_VIEW_UNSPECIFIED</td>
+ <td>REDIS_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>The default / unset value.
-The API will default to the BASIC view.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>CHANGELOG_VIEW_BASIC</td>
+ <td>STANDALONE</td>
<td>1</td>
<td><p></p></td>
</tr>
<tr>
- <td>CHANGELOG_VIEW_FULL</td>
+ <td>SENTINEL</td>
<td>2</td>
<td><p></p></td>
</tr>
+ <tr>
+ <td>CLUSTER</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
</tbody>
</table>
- <h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -12700,27 +12396,27 @@ The API will default to the BASIC view.</p></td>
<tbody>
<tr>
- <td>IDENTITY_GENERATION_UNSPECIFIED</td>
+ <td>SECRET_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified secret type.</p></td>
</tr>
<tr>
- <td>ALWAYS</td>
+ <td>PLAIN</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Plain text secret.</p></td>
</tr>
<tr>
- <td>BY_DEFAULT</td>
+ <td>ENVIRONMENT</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Secret from environment variable.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -12729,28 +12425,28 @@ The API will default to the BASIC view.</p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>AUTH_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified authentication type.</p></td>
</tr>
<tr>
- <td>VIRTUAL</td>
+ <td>TOKEN</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td>
</tr>
<tr>
- <td>STORED</td>
+ <td>VAULT_APP_ROLE</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/approle</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</h3>
- <p>SDLFormat specifies the output format for SDL schema.</p>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -12758,28 +12454,39 @@ The API will default to the BASIC view.</p></td>
<tbody>
<tr>
- <td>SDL_FORMAT_UNSPECIFIED</td>
+ <td>SECRET_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified format. Defaults to SINGLE_FILE.</p></td>
+ <td><p>Unspecified secret type.</p></td>
</tr>
<tr>
- <td>SINGLE_FILE</td>
+ <td>VAULT_KV_V2</td>
<td>1</td>
- <td><p>Single file format: returns the complete SDL schema as a single file.</p></td>
+ <td><p>ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2</p></td>
</tr>
<tr>
- <td>MULTI_FILE</td>
+ <td>AWS_SECRETS_MANAGER</td>
<td>2</td>
- <td><p>Multi-file format: returns the SDL schema as a ZIP archive containing
-multiple files organized by schema objects (tables, views, functions, etc.).</p></td>
+ <td><p>ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</p></td>
+ </tr>
+
+ <tr>
+ <td>GCP_SECRET_MANAGER</td>
+ <td>3</td>
+ <td><p>ref: https://cloud.google.com/secret-manager/docs</p></td>
+ </tr>
+
+ <tr>
+ <td>AZURE_KEY_VAULT</td>
+ <td>4</td>
+ <td><p>ref: https://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</h3>
+ <h3 id="bytebase.v1.DataSourceType">DataSourceType</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -12788,423 +12495,256 @@ multiple files organized by schema objects (tables, views, functions, etc.).</p>
<tbody>
<tr>
- <td>OBJECT_TYPE_UNSPECIFIED</td>
+ <td>DATA_SOURCE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified data source type.</p></td>
</tr>
<tr>
- <td>DATABASE</td>
+ <td>ADMIN</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Admin data source with write permissions.</p></td>
</tr>
<tr>
- <td>SCHEMA</td>
+ <td>READ_ONLY</td>
<td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>VIEW</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>MATERIALIZED_VIEW</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FUNCTION</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PROCEDURE</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SEQUENCE</td>
- <td>8</td>
- <td><p></p></td>
+ <td><p>Read-only data source for query operations.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</h3>
- <p></p>
+
+
+
+
+ <h3 id="bytebase.v1.InstanceService">InstanceService</h3>
+ <p>InstanceService manages database instances and their connections.</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>MODE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>GetInstance</td>
+ <td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Gets a database instance by name.
+Permissions required: bb.instances.get</p></td>
</tr>
<tr>
- <td>DEFAULT</td>
- <td>1</td>
- <td><p></p></td>
+ <td>ListInstances</td>
+ <td><a href="#bytebase.v1.ListInstancesRequest">ListInstancesRequest</a></td>
+ <td><a href="#bytebase.v1.ListInstancesResponse">ListInstancesResponse</a></td>
+ <td><p>Lists all database instances.
+Permissions required: bb.instances.list</p></td>
</tr>
<tr>
- <td>APPEND_ONLY</td>
- <td>2</td>
- <td><p></p></td>
+ <td>CreateInstance</td>
+ <td><a href="#bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Creates a new database instance.
+Permissions required: bb.instances.create</p></td>
</tr>
<tr>
- <td>INSERT_ONLY</td>
- <td>3</td>
- <td><p></p></td>
+ <td>UpdateInstance</td>
+ <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Updates a database instance.
+Permissions required: bb.instances.update</p></td>
</tr>
- </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>DeleteInstance</td>
+ <td><a href="#bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes or soft-deletes a database instance.
+Permissions required: bb.instances.delete</p></td>
+ </tr>
<tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>UndeleteInstance</td>
+ <td><a href="#bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Restores a soft-deleted database instance.
+Permissions required: bb.instances.undelete</p></td>
</tr>
<tr>
- <td>DELTA</td>
- <td>1</td>
- <td><p></p></td>
+ <td>SyncInstance</td>
+ <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
+ <td><a href="#bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</a></td>
+ <td><p>Syncs database schemas and metadata from an instance.
+Permissions required: bb.instances.sync</p></td>
</tr>
- </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>ListInstanceDatabase</td>
+ <td><a href="#bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</a></td>
+ <td><a href="#bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</a></td>
+ <td><p>Lists all databases within an instance without creating them.
+Permissions required: bb.instances.get</p></td>
+ </tr>
<tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>BatchSyncInstances</td>
+ <td><a href="#bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</a></td>
+ <td><p>Syncs multiple instances in a single request.
+Permissions required: bb.instances.sync</p></td>
</tr>
<tr>
- <td>RANGE</td>
- <td>1</td>
- <td><p></p></td>
+ <td>BatchUpdateInstances</td>
+ <td><a href="#bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</a></td>
+ <td><p>Updates multiple instances in a single request.
+Permissions required: bb.instances.update</p></td>
</tr>
<tr>
- <td>RANGE_COLUMNS</td>
- <td>2</td>
- <td><p></p></td>
+ <td>AddDataSource</td>
+ <td><a href="#bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Adds a read-only data source to an instance.
+Permissions required: bb.instances.update</p></td>
</tr>
<tr>
- <td>LIST</td>
- <td>3</td>
- <td><p></p></td>
+ <td>RemoveDataSource</td>
+ <td><a href="#bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Removes a read-only data source from an instance.
+Permissions required: bb.instances.update</p></td>
</tr>
<tr>
- <td>LIST_COLUMNS</td>
- <td>4</td>
- <td><p></p></td>
+ <td>UpdateDataSource</td>
+ <td><a href="#bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</a></td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td><p>Updates a data source configuration.
+Permissions required: bb.instances.update</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>HASH</td>
- <td>5</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>LINEAR_HASH</td>
- <td>6</td>
- <td><p></p></td>
+ <td>GetInstance</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>KEY</td>
- <td>7</td>
- <td><p></p></td>
+ <td>ListInstances</td>
+ <td>GET</td>
+ <td>/v1/instances</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>LINEAR_KEY</td>
- <td>8</td>
- <td><p></p></td>
+ <td>CreateInstance</td>
+ <td>POST</td>
+ <td>/v1/instances</td>
+ <td>instance</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>UpdateInstance</td>
+ <td>PATCH</td>
+ <td>/v1/{instance.name=instances/*}</td>
+ <td>instance</td>
+ </tr>
+
+
+
<tr>
- <td>STATE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>DeleteInstance</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>STARTED</td>
- <td>1</td>
- <td><p></p></td>
+ <td>UndeleteInstance</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:undelete</td>
+ <td>*</td>
</tr>
+
+
+
<tr>
- <td>SUSPENDED</td>
- <td>2</td>
- <td><p></p></td>
+ <td>SyncInstance</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:sync</td>
+ <td>*</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>
+ <td>ListInstanceDatabase</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:databases</td>
+ <td>*</td>
</tr>
<tr>
- <td>UpdateDatabase</td>
- <td>PATCH</td>
- <td>/v1/{database.name=instances/*/databases/*}</td>
- <td>database</td>
+ <td>BatchSyncInstances</td>
+ <td>POST</td>
+ <td>/v1/instances:batchSync</td>
+ <td>*</td>
</tr>
<tr>
- <td>BatchUpdateDatabases</td>
+ <td>BatchUpdateInstances</td>
<td>POST</td>
- <td>/v1/{parent=instances/*}/databases:batchUpdate</td>
+ <td>/v1/instances:batchUpdate</td>
<td>*</td>
</tr>
@@ -13212,9 +12752,9 @@ Permissions required: bb.databases.getSchema</p></td>
<tr>
- <td>SyncDatabase</td>
+ <td>AddDataSource</td>
<td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:sync</td>
+ <td>/v1/{name=instances/*}:addDataSource</td>
<td>*</td>
</tr>
@@ -13222,9 +12762,9 @@ Permissions required: bb.databases.getSchema</p></td>
<tr>
- <td>BatchSyncDatabases</td>
+ <td>RemoveDataSource</td>
<td>POST</td>
- <td>/v1/{parent=instances/*}/databases:batchSync</td>
+ <td>/v1/{name=instances/*}:removeDataSource</td>
<td>*</td>
</tr>
@@ -13232,94 +12772,61 @@ Permissions required: bb.databases.getSchema</p></td>
<tr>
- <td>GetDatabaseMetadata</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/metadata}</td>
- <td></td>
+ <td>UpdateDataSource</td>
+ <td>PATCH</td>
+ <td>/v1/{name=instances/*}:updateDataSource</td>
+ <td>data_source</td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/database_service.proto">v1/database_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource shared by all databases being retrieved.
+- projects/{project}: batch get databases in a project;
+- instances/{instances}: batch get databases in a instance;
+Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
+ </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>
+ <tr>
+ <td>names</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The list of database names to retrieve. </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.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>
- <p>Request message for batch getting groups.</p>
+ <h3 id="bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -13329,11 +12836,10 @@ Permissions required: bb.databases.getSchema</p></td>
<tbody>
<tr>
- <td>names</td>
- <td><a href="#string">string</a></td>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
<td>repeated</td>
- <td><p>The group names to retrieve.
-Format: groups/{email} </p></td>
+ <td><p>The databases from the specified request. </p></td>
</tr>
</tbody>
@@ -13343,8 +12849,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.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -13354,10 +12860,19 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>groups</td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource shared by all databases being updated.
+Format: instances/{instance}
+If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></td>
+ </tr>
+
+ <tr>
+ <td>names</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The groups from the specified request. </p></td>
+ <td><p>The list of database names to sync. </p></td>
</tr>
</tbody>
@@ -13367,8 +12882,15 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3>
- <p>Request message for creating a group.</p>
+ <h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -13378,18 +12900,21 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>group</td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The group to create. </p></td>
+ <td><p>The parent resource shared by all databases being updated.
+Format: instances/{instance}
+If the operation spans parents, a dash (-) may be accepted as a wildcard.
+We only support updating the project of databases for now. </p></td>
</tr>
<tr>
- <td>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&#39;s resource name. </p></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the resources to update.
+A maximum of 1000 databases can be modified in a batch. </p></td>
</tr>
</tbody>
@@ -13399,8 +12924,8 @@ of the group&#39;s resource name. </p></td>
- <h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>
- <p>Request message for deleting a group.</p>
+ <h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -13410,11 +12935,10 @@ of the group&#39;s resource name. </p></td>
<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>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>repeated</td>
+ <td><p>Databases updated. </p></td>
</tr>
</tbody>
@@ -13424,8 +12948,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.BoundingBox">BoundingBox</h3>
+ <p>BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.</p>
<table class="field-table">
@@ -13435,11 +12959,31 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>xmin</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>The name of the group to retrieve.
-Format: groups/{email} </p></td>
+ <td><p>Minimum X coordinate </p></td>
+ </tr>
+
+ <tr>
+ <td>ymin</td>
+ <td><a href="#double">double</a></td>
+ <td></td>
+ <td><p>Minimum Y coordinate </p></td>
+ </tr>
+
+ <tr>
+ <td>xmax</td>
+ <td><a href="#double">double</a></td>
+ <td></td>
+ <td><p>Maximum X coordinate </p></td>
+ </tr>
+
+ <tr>
+ <td>ymax</td>
+ <td><a href="#double">double</a></td>
+ <td></td>
+ <td><p>Maximum Y coordinate </p></td>
</tr>
</tbody>
@@ -13449,8 +12993,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.Changelog">Changelog</h3>
+ <p></p>
<table class="field-table">
@@ -13463,43 +13007,50 @@ Format: groups/{email} </p></td>
<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>
+ <td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The display title of the group. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the group. </p></td>
+ <td><p> </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>schema_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>source</td>
+ <td>task_run</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The source system where the group originated (e.g., Entra ID for SCIM sync). </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
<tr>
- <td>email</td>
+ <td>plan_title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique email for the group. </p></td>
+ <td><p>The title of the plan associated with this changelog&#39;s task run.
+This field is populated by deriving the plan from task_run for display purposes. </p></td>
</tr>
</tbody>
@@ -13509,8 +13060,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.CheckConstraintMetadata">CheckConstraintMetadata</h3>
+ <p>CheckConstraintMetadata is the metadata for check constraints.</p>
<table class="field-table">
@@ -13520,19 +13071,17 @@ Format: groups/{group}, the group should be email or uuid. </p></td>
<tbody>
<tr>
- <td>member</td>
+ <td>name</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><p>The name is the name of a check constraint. </p></td>
</tr>
<tr>
- <td>role</td>
- <td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td>
+ <td>expression</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The member&#39;s role in the group. </p></td>
+ <td><p>The expression is the expression of a check constraint. </p></td>
</tr>
</tbody>
@@ -13542,8 +13091,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.ColumnMetadata">ColumnMetadata</h3>
+ <p>ColumnMetadata is the metadata for columns.</p>
<table class="field-table">
@@ -13553,46 +13102,144 @@ Format: users/[email protected] </p></td>
<tbody>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>name</td>
+ <td><a href="#string">string</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>
+ <td><p>The name is the name of a column. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>position</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListGroups` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListGroups` must match
-the call that provided the page token. </p></td>
+ <td><p>The position is the position in columns. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>has_default</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>default</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>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
+ <td><p>The default value of column. </p></td>
+ </tr>
+
+ <tr>
+ <td>default_on_null</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Oracle specific metadata.
+The default_on_null is the default on null of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>on_update</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The on_update is the on update action of a column.
+For MySQL like databases, it&#39;s only supported for TIMESTAMP columns with
+CURRENT_TIMESTAMP as on update value. </p></td>
+ </tr>
+
+ <tr>
+ <td>nullable</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>The nullable is the nullable of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The type is the type of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character_set is the character_set of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>generation</td>
+ <td><a href="#bytebase.v1.GenerationMetadata">GenerationMetadata</a></td>
+ <td></td>
+ <td><p>The generation is the generation of a column. </p></td>
+ </tr>
+
+ <tr>
+ <td>is_identity</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>identity_generation</td>
+ <td><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td>
+ <td></td>
+ <td><p>The identity_generation is for identity columns, PG only. </p></td>
+ </tr>
+
+ <tr>
+ <td>identity_seed</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The identity_seed is for identity columns, MSSQL only. </p></td>
+ </tr>
+
+ <tr>
+ <td>identity_increment</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The identity_increment is for identity columns, MSSQL only. </p></td>
+ </tr>
+
+ <tr>
+ <td>default_constraint_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The default_constraint_name is the name of the default constraint, MSSQL only.
+In MSSQL, default values are implemented as named constraints. When modifying or
+dropping a column&#39;s default value, you must reference the constraint by name.
+This field stores the actual constraint name from the database.
-Supported filter:
-- title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+Example: A column definition like:
+ CREATE TABLE employees (
+ status NVARCHAR(20) DEFAULT &#39;active&#39;
+ )
-For example:
-title == &#34;dba&#34;
-email == &#34;[email protected]&#34;
-title.matches(&#34;dba&#34;)
-email.matches(&#34;dba&#34;)
-project == &#34;projects/sample-project&#34;
-You can combine filter conditions like:
-title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) </p></td>
+Will create a constraint with an auto-generated name like &#39;DF__employees__statu__3B75D760&#39;
+or a user-defined name if specified:
+ ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;active&#39; FOR status
+
+To modify the default, you must first drop the existing constraint by name:
+ ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760
+ ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT &#39;inactive&#39; FOR status
+
+This field is populated when syncing from the database. When empty (e.g., when parsing
+from SQL files), the system cannot automatically drop the constraint. </p></td>
</tr>
</tbody>
@@ -13602,8 +13249,8 @@ title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) </p></td>
- <h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3>
- <p>Response message for listing groups.</p>
+ <h3 id="bytebase.v1.Database">Database</h3>
+ <p></p>
<table class="field-table">
@@ -13613,18 +13260,81 @@ title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) </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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database.
+Format: instances/{instance}/databases/{database}
+{database} is the database name in the instance. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
+ <td></td>
+ <td><p>The existence of a database. </p></td>
+ </tr>
+
+ <tr>
+ <td>successful_sync_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The latest synchronization time. </p></td>
+ </tr>
+
+ <tr>
+ <td>project</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>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 project for a database.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>release</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The release that was last applied to this database.
+Format: projects/{project}/releases/{release_id}
+Example: projects/my-project/releases/release_20260115-RC00 </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>effective_environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The effective environment based on environment tag above and environment
+tag on the instance. Inheritance follows
+https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels will be used for deployment and policy control. </p></td>
+ </tr>
+
+ <tr>
+ <td>instance_resource</td>
+ <td><a href="#bytebase.v1.InstanceResource">InstanceResource</a></td>
+ <td></td>
+ <td><p>The instance resource. </p></td>
+ </tr>
+
+ <tr>
+ <td>backup_available</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>The database is available for DML prior backup. </p></td>
</tr>
</tbody>
@@ -13634,8 +13344,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.Database.LabelsEntry">Database.LabelsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -13645,28 +13355,17 @@ 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></td>
- <td><p>The group to update.
-
-The group&#39;s `name` field is used to identify the group to update.
-Format: groups/{email} </p></td>
- </tr>
-
- <tr>
- <td>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 group is not found, a new group will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -13676,190 +13375,76 @@ 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>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ROLE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified role.</p></td>
- </tr>
-
- <tr>
- <td>OWNER</td>
- <td>1</td>
- <td><p>Group owner.</p></td>
- </tr>
-
- <tr>
- <td>MEMBER</td>
- <td>2</td>
- <td><p>Group member.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GroupService">GroupService</h3>
- <p>GroupService manages user groups for organizing users and permissions.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetGroup</td>
- <td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td><p>Gets a group by name.
-Permissions required: bb.groups.get</p></td>
- </tr>
-
- <tr>
- <td>BatchGetGroups</td>
- <td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</a></td>
- <td><p>Gets multiple groups in a single request.
-Permissions required: bb.groups.get</p></td>
- </tr>
-
- <tr>
- <td>ListGroups</td>
- <td><a href="#bytebase.v1.ListGroupsRequest">ListGroupsRequest</a></td>
- <td><a href="#bytebase.v1.ListGroupsResponse">ListGroupsResponse</a></td>
- <td><p>Lists all groups in the workspace.
-Permissions required: bb.groups.list</p></td>
- </tr>
-
- <tr>
- <td>CreateGroup</td>
- <td><a href="#bytebase.v1.CreateGroupRequest">CreateGroupRequest</a></td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td><p>Creates a new group.
-Permissions required: bb.groups.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateGroup</td>
- <td><a href="#bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</a></td>
- <td><a href="#bytebase.v1.Group">Group</a></td>
- <td><p>Updates a group. Group owners or users with bb.groups.update permission can update.
-Permissions required: bb.groups.update OR caller is group owner
-When allow_missing=true, also requires: bb.groups.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteGroup</td>
- <td><a href="#bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a group. Group owners or users with bb.groups.delete permission can delete.
-Permissions required: bb.groups.delete OR caller is group owner</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.DatabaseMetadata">DatabaseMetadata</h3>
+ <p>DatabaseMetadata is the metadata for databases.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
-
- <tr>
- <td>GetGroup</td>
- <td>GET</td>
- <td>/v1/{name=groups/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchGetGroups</td>
- <td>GET</td>
- <td>/v1/groups:batchGet</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListGroups</td>
- <td>GET</td>
- <td>/v1/groups</td>
- <td></td>
- </tr>
-
-
-
- <tr>
- <td>CreateGroup</td>
- <td>POST</td>
- <td>/v1/groups</td>
- <td>group</td>
- </tr>
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The database metadata name.
+
+Format: instances/{instance}/databases/{database}/metadata </p></td>
+ </tr>
-
+ <tr>
+ <td>schemas</td>
+ <td><a href="#bytebase.v1.SchemaMetadata">SchemaMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The schemas is the list of schemas in a database. </p></td>
+ </tr>
+ <tr>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character_set is the character set of a database. </p></td>
+ </tr>
- <tr>
- <td>UpdateGroup</td>
- <td>PATCH</td>
- <td>/v1/{group.name=groups/*}</td>
- <td>group</td>
- </tr>
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a database. </p></td>
+ </tr>
-
+ <tr>
+ <td>extensions</td>
+ <td><a href="#bytebase.v1.ExtensionMetadata">ExtensionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The extensions is the list of extensions in a database. </p></td>
+ </tr>
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the database. </p></td>
+ </tr>
- <tr>
- <td>DeleteGroup</td>
- <td>DELETE</td>
- <td>/v1/{name=groups/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>search_path</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The search_path is the search path of a PostgreSQL database. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <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>
+ <h3 id="bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</h3>
+ <p>DatabaseSDLSchema contains the schema in SDL format.</p>
<table class="field-table">
@@ -13869,28 +13454,23 @@ 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>schema</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The identity provider to create. </p></td>
+ <td><p>The SDL schema content.
+- For SINGLE_FILE format: contains the complete SDL schema as a text string.
+- For MULTI_FILE format: contains the ZIP archive as binary data. </p></td>
</tr>
<tr>
- <td>identity_provider_id</td>
+ <td>content_type</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&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
- </tr>
-
- <tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, the request will be validated without actually creating the identity provider. </p></td>
+ <td><p>The MIME type of the schema content.
+Indicates how the client should interpret the schema field.
+Examples:
+- &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format
+- &#34;application/zip&#34; for MULTI_FILE format </p></td>
</tr>
</tbody>
@@ -13900,8 +13480,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseSchema">DatabaseSchema</h3>
+ <p>DatabaseSchema is the metadata for databases.</p>
<table class="field-table">
@@ -13911,11 +13491,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the identity provider to delete.
-Format: idps/{identity_provider} </p></td>
+ <td><p>The schema dump from database. </p></td>
</tr>
</tbody>
@@ -13925,8 +13504,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.DependencyColumn">DependencyColumn</h3>
+ <p>DependencyColumn is the metadata for dependency columns.</p>
<table class="field-table">
@@ -13936,32 +13515,24 @@ Format: idps/{identity_provider} </p></td>
<tbody>
<tr>
- <td>identifier</td>
+ <td>schema</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>
+ <td><p>The schema is the schema of a reference column. </p></td>
</tr>
<tr>
- <td>display_name</td>
+ <td>table</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>
+ <td><p>The table is the table of a reference column. </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>column</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 column is the name of a reference column. </p></td>
</tr>
</tbody>
@@ -13971,7 +13542,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.DependencyTable">DependencyTable</h3>
<p></p>
@@ -13982,11 +13553,17 @@ Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-gr
<tbody>
<tr>
- <td>name</td>
+ <td>schema</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 schema is the schema of a reference table. </p></td>
+ </tr>
+
+ <tr>
+ <td>table</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The table is the name of a reference table. </p></td>
</tr>
</tbody>
@@ -13996,7 +13573,7 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.IdentityProvider">IdentityProvider</h3>
+ <h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3>
<p></p>
@@ -14010,36 +13587,26 @@ Format: idps/{idp} </p></td>
<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>
+ <td><p>The name of the database or changelog.
+Format:
+database: instances/{instance}/databases/{database}
+changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The display title of the identity provider. </p></td>
+ <td><p>The target schema. </p></td>
</tr>
<tr>
- <td>domain</td>
+ <td>changelog</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>
+ <td><p>The resource name of the changelog
+Format:
+instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
</tbody>
@@ -14049,7 +13616,7 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</h3>
+ <h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3>
<p></p>
@@ -14060,24 +13627,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>diff</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>LDAP protocol configuration. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -14087,8 +13640,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.DimensionConstraint">DimensionConstraint</h3>
+ <p>DimensionConstraint defines constraints for a spatial dimension.</p>
<table class="field-table">
@@ -14098,72 +13651,76 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>host</td>
+ <td>dimension</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Host is the hostname or IP address of the LDAP server, e.g.,
-&#34;ldap.example.com&#34;. </p></td>
+ <td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td>
</tr>
<tr>
- <td>port</td>
- <td><a href="#int32">int32</a></td>
+ <td>min_value</td>
+ <td><a href="#double">double</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>
+ <td><p>Minimum value for this dimension </p></td>
</tr>
<tr>
- <td>skip_tls_verify</td>
- <td><a href="#bool">bool</a></td>
+ <td>max_value</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>SkipTLSVerify controls whether to skip TLS certificate verification. </p></td>
+ <td><p>Maximum value for this dimension </p></td>
</tr>
<tr>
- <td>bind_dn</td>
- <td><a href="#string">string</a></td>
+ <td>tolerance</td>
+ <td><a href="#double">double</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><p>Tolerance for this dimension </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.DimensionalConfig">DimensionalConfig</h3>
+ <p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>base_dn</td>
- <td><a href="#string">string</a></td>
+ <td>dimensions</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. </p></td>
+ <td><p>Number of dimensions (2-4, default 2) </p></td>
</tr>
<tr>
- <td>user_filter</td>
+ <td>data_type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. </p></td>
+ <td><p>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td>
</tr>
<tr>
- <td>security_protocol</td>
- <td><a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</a></td>
+ <td>srid</td>
+ <td><a href="#int32">int32</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>Spatial reference system identifier (SRID) </p></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>
+ <td>constraints</td>
+ <td><a href="#bytebase.v1.DimensionConstraint">DimensionConstraint</a></td>
+ <td>repeated</td>
+ <td><p>Coordinate system constraints </p></td>
</tr>
</tbody>
@@ -14173,14 +13730,7 @@ server. </p></td>
- <h3 id="bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</h3>
+ <h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</h3>
<p></p>
@@ -14191,10 +13741,31 @@ server. </p></td>
<tbody>
<tr>
- <td>identity_providers</td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of a type. </p></td>
+ </tr>
+
+ <tr>
+ <td>values</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The identity providers from the specified request. </p></td>
+ <td><p>The enum values of a type. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment describing the enum type. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this enum type during schema dump operations. </p></td>
</tr>
</tbody>
@@ -14204,8 +13775,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.EventMetadata">EventMetadata</h3>
+ <p></p>
<table class="field-table">
@@ -14215,66 +13786,52 @@ 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 event. </p></td>
</tr>
<tr>
- <td>token_url</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The token endpoint URL for exchanging authorization code. </p></td>
+ <td><p>The schedule of the event. </p></td>
</tr>
<tr>
- <td>user_info_url</td>
+ <td>time_zone</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The user information endpoint URL. </p></td>
+ <td><p>The time zone of the event. </p></td>
</tr>
<tr>
- <td>client_id</td>
+ <td>sql_mode</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The OAuth2 client identifier. </p></td>
+ <td><p>The SQL mode setting for the event. </p></td>
</tr>
<tr>
- <td>client_secret</td>
+ <td>character_set_client</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The OAuth2 client secret for authentication. </p></td>
+ <td><p>The character set used by the client creating the event. </p></td>
</tr>
<tr>
- <td>scopes</td>
+ <td>collation_connection</td>
<td><a href="#string">string</a></td>
- <td>repeated</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>
+ <td><p>The collation used for the connection when creating the event. </p></td>
</tr>
<tr>
- <td>auth_style</td>
- <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The authentication style for client credentials. </p></td>
+ <td><p>The comment is the comment of an event. </p></td>
</tr>
</tbody>
@@ -14284,8 +13841,8 @@ server. </p></td>
- <h3 id="bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</h3>
- <p></p>
+ <h3 id="bytebase.v1.ExtensionMetadata">ExtensionMetadata</h3>
+ <p>ExtensionMetadata is the metadata for extensions.</p>
<table class="field-table">
@@ -14295,21 +13852,43 @@ server. </p></td>
<tbody>
<tr>
- <td>code</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Authorize code from website. </p></td>
+ <td><p>The name is the name of an extension. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema is the extension that is installed to. But the extension usage
+is not limited to the schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The version is the version of an extension. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The description is the description of an extension. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3>
- <p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p>
+ <h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3>
+ <p></p>
<table class="field-table">
@@ -14319,61 +13898,107 @@ server. </p></td>
<tbody>
<tr>
- <td>issuer</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The OIDC issuer URL for the identity provider. </p></td>
+ <td><p>The name is the name of a external table. </p></td>
</tr>
<tr>
- <td>client_id</td>
+ <td>external_server_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The OIDC client identifier. </p></td>
+ <td><p>The external_server_name is the name of the external server. </p></td>
</tr>
<tr>
- <td>client_secret</td>
+ <td>external_database_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The OIDC client secret for authentication. </p></td>
+ <td><p>The external_database_name is the name of the external database. </p></td>
</tr>
<tr>
- <td>scopes</td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a foreign table. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</h3>
+ <p>ForeignKeyMetadata is the metadata for foreign keys.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>columns</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The scopes that the OIDC provider supports.
-Should be fetched from the well-known configuration file of the OIDC provider. </p></td>
+ <td><p>The columns are the ordered referencing columns of a foreign key. </p></td>
</tr>
<tr>
- <td>field_mapping</td>
- <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
+ <td>referenced_schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Mapping configuration for user attributes from OIDC claims. </p></td>
+ <td><p>The referenced_schema is the referenced schema name of a foreign key.
+It is an empty string for databases without such concept such as MySQL. </p></td>
</tr>
<tr>
- <td>skip_tls_verify</td>
- <td><a href="#bool">bool</a></td>
+ <td>referenced_table</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to skip TLS certificate verification. </p></td>
+ <td><p>The referenced_table is the referenced table name of a foreign key. </p></td>
</tr>
<tr>
- <td>auth_style</td>
- <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
+ <td>referenced_columns</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>on_delete</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The authentication style for client credentials. </p></td>
+ <td><p>The on_delete is the on delete action of a foreign key. </p></td>
</tr>
<tr>
- <td>auth_endpoint</td>
+ <td>on_update</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>The on_update is the on update action of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>match_type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The match_type is the match type of a foreign key.
+The match_type is the PostgreSQL specific field.
+It&#39;s empty string for other databases. </p></td>
</tr>
</tbody>
@@ -14383,8 +14008,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.FunctionMetadata">FunctionMetadata</h3>
+ <p>FunctionMetadata is the metadata for functions.</p>
<table class="field-table">
@@ -14394,79 +14019,75 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
<tbody>
<tr>
- <td>code</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Authorize code from OIDC provider. </p></td>
+ <td><p>The name is the name of a function. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a function. </p></td>
+ </tr>
<tr>
- <td>identity_provider</td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td>signature</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The identity provider to test connection including uncreated. </p></td>
+ <td><p>The signature is the name with the number and type of input arguments the
+function takes. </p></td>
</tr>
<tr>
- <td>oauth2_context</td>
- <td><a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</a></td>
+ <td>character_set_client</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>MySQL specific metadata. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation_connection</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>oidc_context</td>
- <td><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</a></td>
+ <td>database_collation</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>OIDC authentication context for test connection. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>sql_mode</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>claims</td>
- <td><a href="#bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</a></td>
- <td>repeated</td>
- <td><p>The map of claims returned by the identity provider. </p></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>user_info</td>
- <td><a href="#bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</a></td>
+ <td>dependency_tables</td>
+ <td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>
<td>repeated</td>
- <td><p>The matched user info from the claims. </p></td>
+ <td><p>The dependency_tables is the list of dependency tables of a function.
+For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -14476,7 +14097,7 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
- <h3 id="bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</h3>
+ <h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3>
<p></p>
@@ -14487,14 +14108,14 @@ 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>type</td>
+ <td><a href="#bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>expression</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
@@ -14507,7 +14128,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.GetChangelogRequest">GetChangelogRequest</h3>
<p></p>
@@ -14518,15 +14139,16 @@ Should be fetched from the well-known configuration file of the OIDC provider. <
<tbody>
<tr>
- <td>key</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the changelog to retrieve.
+Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -14538,7 +14160,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.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3>
<p></p>
@@ -14549,28 +14171,41 @@ 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>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The identity provider to update.
-
-The identity provider&#39;s `name` field is used to identify the identity provider to update.
-Format: idps/{identity_provider} </p></td>
+ <td><p>The name of the database to retrieve metadata.
+Format: instances/{instance}/databases/{database}/metadata </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
- </tr>
-
+ <td><p>Filter is used to filter databases returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- schema: the schema name, support &#34;==&#34; operator.
+- table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
+
+For example:
+schema == &#34;schema-a&#34;
+table == &#34;table-a&#34;
+table.matches(&#34;table-a&#34;)
+schema == &#34;schema-a&#34; &amp;&amp; table.matches(&#34;sample&#34;)
+The filter used to search table with wildcard &#34;sample&#34; in the schema &#34;schemas/schema-a&#34;.
+The column masking level will only be returned when a table filter is used. </p></td>
+ </tr>
+
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>limit</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>If set to true, and the identity provider is not found, a new identity provider will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Limit the response size of returned table metadata per schema.
+For example, if the database has 3 schemas, and each schema has 100 tables,
+if limit is 20, then only 20 tables will be returned for each schema, total 60 tables.
+Default 0, means no limit. </p></td>
</tr>
</tbody>
@@ -14580,269 +14215,79 @@ In this situation, `update_mask` is ignored. </p></td>
-
-
- <h3 id="bytebase.v1.IdentityProviderType">IdentityProviderType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified identity provider type.</p></td>
- </tr>
-
- <tr>
- <td>OAUTH2</td>
- <td>1</td>
- <td><p>OAuth 2.0 authentication protocol.</p></td>
- </tr>
-
- <tr>
- <td>OIDC</td>
- <td>2</td>
- <td><p>OpenID Connect authentication protocol.</p></td>
- </tr>
-
- <tr>
- <td>LDAP</td>
- <td>3</td>
- <td><p>LDAP directory service authentication.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SECURITY_PROTOCOL_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>START_TLS</td>
- <td>1</td>
- <td><p>StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS.</p></td>
- </tr>
-
- <tr>
- <td>LDAPS</td>
- <td>2</td>
- <td><p>LDAPS is the security protocol that uses TLS from the beginning.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</h3>
+ <h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>IN_PARAMS</td>
- <td>1</td>
- <td><p>IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body
-as application/x-www-form-urlencoded parameters.</p></td>
- </tr>
-
- <tr>
- <td>IN_HEADER</td>
- <td>2</td>
- <td><p>IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.
-This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to retrieve.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.IdentityProviderService">IdentityProviderService</h3>
- <p>IdentityProviderService manages external identity providers for SSO authentication.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetIdentityProvider</td>
- <td><a href="#bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td><p>Gets an identity provider by name.
-Permissions required: bb.identityProviders.get</p></td>
- </tr>
-
- <tr>
- <td>ListIdentityProviders</td>
- <td><a href="#bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</a></td>
- <td><a href="#bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</a></td>
- <td><p>Lists all configured identity providers (public endpoint for login page).
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>CreateIdentityProvider</td>
- <td><a href="#bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td><p>Creates a new identity provider.
-Permissions required: bb.identityProviders.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateIdentityProvider</td>
- <td><a href="#bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
- <td><p>Updates an identity provider.
-Permissions required: bb.identityProviders.update
-When allow_missing=true, also requires: bb.identityProviders.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteIdentityProvider</td>
- <td><a href="#bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes an identity provider.
-Permissions required: bb.identityProviders.delete</p></td>
- </tr>
-
- <tr>
- <td>TestIdentityProvider</td>
- <td><a href="#bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</a></td>
- <td><a href="#bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</a></td>
- <td><p>Tests the connection and configuration of an identity provider.
-Permissions required: bb.identityProviders.update</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to retrieve SDL schema.
+Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
+ </tr>
- <tr>
- <td>GetIdentityProvider</td>
- <td>GET</td>
- <td>/v1/{name=idps/*}</td>
- <td></td>
- </tr>
-
-
+ <tr>
+ <td>format</td>
+ <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td>
+ <td></td>
+ <td><p>The format of the SDL schema output. </p></td>
+ </tr>
-
- <tr>
- <td>ListIdentityProviders</td>
- <td>GET</td>
- <td>/v1/idps</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateIdentityProvider</td>
- <td>POST</td>
- <td>/v1/idps</td>
- <td>identity_provider</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateIdentityProvider</td>
- <td>PATCH</td>
- <td>/v1/{identity_provider.name=idps/*}</td>
- <td>identity_provider</td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteIdentityProvider</td>
- <td>DELETE</td>
- <td>/v1/{name=idps/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>TestIdentityProvider</td>
- <td>POST</td>
- <td>/v1/idps/*:test</td>
- <td>*</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/issue_service.proto">v1/issue_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.ApprovalFlow">ApprovalFlow</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>roles</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The roles required for approval in order. </p></td>
+ <td></td>
+ <td><p>The name of the database to retrieve schema.
+Format: instances/{instance}/databases/{database}/schema </p></td>
</tr>
</tbody>
@@ -14852,7 +14297,7 @@ Permissions required: bb.identityProviders.update</p></td>
- <h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3>
+ <h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3>
<p></p>
@@ -14863,56 +14308,40 @@ Permissions required: bb.identityProviders.update</p></td>
<tbody>
<tr>
- <td>flow</td>
- <td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The approval flow definition. </p></td>
+ <td><p>The name of the database.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</a></td>
<td></td>
- <td><p>The title of the approval template. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the approval template. </p></td>
+ <td><p>It&#39;s empty for DATABASE. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</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>object</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue to add an approver.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>It&#39;s empty for DATABASE and SCHEMA. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
<td></td>
- <td><p>The comment explaining the approval decision. </p></td>
+ <td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.
+Also the schema and object are empty. </p></td>
</tr>
</tbody>
@@ -14922,7 +14351,7 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</h3>
+ <h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3>
<p></p>
@@ -14933,35 +14362,10 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource shared by all issues being updated.
-Format: projects/{project}
-If the operation spans parents, a dash (-) may be accepted as a wildcard.
-We only support updating the status of databases for now. </p></td>
- </tr>
-
- <tr>
- <td>issues</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of issues to update.
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td></td>
- <td><p>The new status. </p></td>
- </tr>
-
- <tr>
- <td>reason</td>
+ <td>schema_string</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The reason for the status change. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -14971,15 +14375,8 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.GridLevel">GridLevel</h3>
+ <p>GridLevel defines a tessellation grid level with its density.</p>
<table class="field-table">
@@ -14989,18 +14386,17 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>level</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The issue name
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>Grid level number (1-4 for SQL Server) </p></td>
</tr>
<tr>
- <td>issue_comment</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td>density</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment to create. </p></td>
+ <td><p>Grid density (LOW, MEDIUM, HIGH) </p></td>
</tr>
</tbody>
@@ -15010,8 +14406,8 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3>
+ <p>IndexMetadata is the metadata for indexes.</p>
<table class="field-table">
@@ -15021,222 +14417,195 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of issues.
-Format: projects/{project} </p></td>
+ <td><p>The name is the name of an index. </p></td>
</tr>
<tr>
- <td>issue</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td></td>
- <td><p>The issue to create. </p></td>
+ <td>expressions</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The expressions are the ordered columns or expressions of an index.
+This could refer to a column or an expression. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetIssueRequest">GetIssueRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the issue to retrieve.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td>key_length</td>
+ <td><a href="#int64">int64</a></td>
+ <td>repeated</td>
+ <td><p>The key_lengths are the ordered key lengths of an index.
+If the key length is not specified, it&#39;s -1. </p></td>
</tr>
<tr>
- <td>force</td>
+ <td>descending</td>
<td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, bypass cache and fetch the latest data. </p></td>
+ <td>repeated</td>
+ <td><p>The descending is the ordered descending of an index. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GrantRequest">GrantRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>role</td>
+ <td>type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The requested role.
-Format: roles/EXPORTER. </p></td>
+ <td><p>The type is the type of an index. </p></td>
</tr>
<tr>
- <td>user</td>
- <td><a href="#string">string</a></td>
+ <td>unique</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The user to be granted.
-Format: users/{email}. </p></td>
+ <td><p>The unique is whether the index is unique. </p></td>
</tr>
<tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>primary</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td>
+ <td><p>The primary is whether the index is a primary key index. </p></td>
</tr>
<tr>
- <td>expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>visible</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The duration for which the grant is valid. </p></td>
+ <td><p>The visible is whether the index is visible. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Issue">Issue</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The comment is the comment of an index. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the issue. </p></td>
+ <td><p>The definition of an index. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>parent_index_schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the issue. </p></td>
+ <td><p>The schema name of the parent index. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td>
+ <td>parent_index_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The index name of the parent index. </p></td>
</tr>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td>granularity</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The status of the issue. </p></td>
+ <td><p>The number of granules in the block. It&#39;s a ClickHouse specific field. </p></td>
</tr>
<tr>
- <td>approvers</td>
- <td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>is_constraint</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>It&#39;s a PostgreSQL specific field.
+The unique constraint and unique index are not the same thing in PostgreSQL. </p></td>
</tr>
<tr>
- <td>approval_template</td>
- <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
+ <td>spatial_config</td>
+ <td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</a></td>
<td></td>
- <td><p>The approval template for the issue. </p></td>
+ <td><p>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td>
</tr>
<tr>
- <td>creator</td>
+ <td>opclass_names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected] </p></td>
+ <td>repeated</td>
+ <td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.html
+Name of the operator class for each column. (PostgreSQL specific). </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>opclass_defaults</td>
+ <td><a href="#bool">bool</a></td>
+ <td>repeated</td>
+ <td><p>True if the operator class is the default. (PostgreSQL specific). </p></td>
</tr>
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</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>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The plan associated with the issue.
-Can be empty.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td><p>The parent of the changelogs.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>grant_request</td>
- <td><a href="#bytebase.v1.GrantRequest">GrantRequest</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Used if the issue type is GRANT_REQUEST. </p></td>
+ <td><p>The maximum number of changelogs to return. The service may return fewer
+than this value. If unspecified, at most 10 changelogs will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The risk level of the issue. </p></td>
+ <td><p>A page token, received from the previous call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>labels</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Labels attached to the issue for categorization and filtering. </p></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>approval_status</td>
- <td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Filter is used to filter changelogs returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- status: the changelog status, support &#34;==&#34; operation. check Changelog.Status for available values.
+- create_time: the changelog create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+
+Example:
+status == &#34;DONE&#34;
+status == &#34;FAILED&#34; &amp;&amp; type == &#34;SDL&#34;
+create_time &gt;= &#34;2024-01-01T00:00:00Z&#34; &amp;&amp; create_time &lt;= &#34;2024-01-02T00:00:00Z&#34; </p></td>
</tr>
</tbody>
@@ -15246,8 +14615,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>
- <p>Approvers and their approval status for the issue.</p>
+ <h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3>
+ <p></p>
<table class="field-table">
@@ -15257,17 +14626,18 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</a></td>
- <td></td>
- <td><p>The new status. </p></td>
+ <td>changelogs</td>
+ <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
+ <td>repeated</td>
+ <td><p>The list of changelogs. </p></td>
</tr>
<tr>
- <td>principal</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/[email protected] </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>
@@ -15277,8 +14647,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment">IssueComment</h3>
- <p>A comment on an issue.</p>
+ <h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -15288,66 +14658,89 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td>
+ <td><p>- projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission.
+- workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission.
+- instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The text content of the comment. </p></td>
+ <td><p>The maximum number of databases to return. The service may return fewer
+than this value.
+If unspecified, at most 10 databases will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>payload</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>TODO: use struct message instead. </p></td>
+ <td><p>A page token, received from a previous `ListDatabases` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListDatabases` must
+match the call that provided the page token. </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Filter is used to filter databases returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
+- name: the database name, support &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
+- engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator.
+- table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example:
+environment == &#34;environments/{environment resource id}&#34;
+environment == &#34;&#34; (find databases which environment is not set)
+project == &#34;projects/{project resource id}&#34;
+instance == &#34;instances/{instance resource id}&#34;
+name.matches(&#34;database name&#34;)
+engine == &#34;MYSQL&#34;
+engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
+!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
+exclude_unassigned == true
+table == &#34;sample&#34;
+table.matches(&#34;sam&#34;)
+labels.environment == &#34;production&#34;
+labels.region == &#34;asia&#34;
+labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+
+You can combine filter conditions like:
+environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) </p></td>
</tr>
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Show deleted database if specified. </p></td>
</tr>
<tr>
- <td>creator</td>
+ <td>order_by</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/{email} </p></td>
- </tr>
-
- <tr>
- <td>approval</td>
- <td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td>
- <td></td>
- <td><p>Approval event. </p></td>
- </tr>
-
- <tr>
- <td>issue_update</td>
- <td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td>
- <td></td>
- <td><p>Issue update event. </p></td>
- </tr>
-
- <tr>
- <td>plan_spec_update</td>
- <td><a href="#bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</a></td>
- <td></td>
- <td><p>Plan spec update event. </p></td>
+ <td><p>The order by of databases.
+Support name, project, instance. The default sorting order is ascending.
+For example:
+- order_by = &#34;name&#34; - order by name ascending
+- order_by = &#34;name desc&#34;
+- order_by = &#34;name desc, project asc&#34; </p></td>
</tr>
</tbody>
@@ -15357,8 +14750,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>
- <p>Approval event information.</p>
+ <h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -15368,10 +14761,18 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>repeated</td>
+ <td><p>The databases from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The approval status. </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>
@@ -15381,8 +14782,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>
- <p>Issue update event information.</p>
+ <h3 id="bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</h3>
+ <p>MaterializedViewMetadata is the metadata for materialized views.</p>
<table class="field-table">
@@ -15392,58 +14793,52 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>from_title</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>to_title</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>The name is the name of a materialized view. </p></td>
</tr>
<tr>
- <td>from_description</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>The definition is the definition of a materialized view. </p></td>
</tr>
<tr>
- <td>to_description</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>The comment is the comment of a materialized view. </p></td>
</tr>
<tr>
- <td>from_status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td>dependency_columns</td>
+ <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_columns is the list of dependency columns of a materialized
+view. </p></td>
</tr>
<tr>
- <td>to_status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
</tr>
<tr>
- <td>from_labels</td>
- <td><a href="#string">string</a></td>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>The indexes is the list of indexes in a table. </p></td>
</tr>
<tr>
- <td>to_labels</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
@@ -15454,8 +14849,8 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.IssueComment.PlanSpecUpdate">IssueComment.PlanSpecUpdate</h3>
- <p>Plan spec update event information (tracks sheet changes to plan specs).</p>
+ <h3 id="bytebase.v1.PackageMetadata">PackageMetadata</h3>
+ <p>PackageMetadata is the metadata for packages.</p>
<table class="field-table">
@@ -15465,27 +14860,17 @@ Format: projects/{project}/plans/{plan} </p></td>
<tbody>
<tr>
- <td>spec</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The spec that was updated.
-Format: projects/{project}/plans/{plan}/specs/{spec} </p></td>
- </tr>
-
- <tr>
- <td>from_sheet</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The previous sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>The name is the name of a package. </p></td>
</tr>
<tr>
- <td>to_sheet</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The new sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td></td>
+ <td><p>The definition is the definition of a package. </p></td>
</tr>
</tbody>
@@ -15495,8 +14880,8 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ProcedureMetadata">ProcedureMetadata</h3>
+ <p>ProcedureMetadata is the metadata for procedures.</p>
<table class="field-table">
@@ -15506,139 +14891,67 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{projects}/issues/{issue} </p></td>
+ <td><p>The name is the name of a procedure. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of issue comments to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issue comments will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The definition is the definition of a procedure. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>signature</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListIssueComments` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListIssueComments` must match
-the call that provided the page token. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>issue_comments</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td>repeated</td>
- <td><p>The issue comments from the specified request. </p></td>
+ <td><p>The signature is the name with the number and type of input arguments the
+procedure takes. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>character_set_client</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>MySQL specific metadata. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListIssuesRequest">ListIssuesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>parent</td>
+ <td>collation_connection</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of issues.
-Format: projects/{project} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>database_collation</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of issues to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issues will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>sql_mode</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListIssues` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListIssues` must match
-the call that provided the page token. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter issues returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- creator: issue creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
-- status: the issue status, support &#34;==&#34; and &#34;in&#34; operator, check the IssueStatus enum for the values.
-- create_time: issue create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-- type: the issue type, support &#34;==&#34; and &#34;in&#34; operator, check the Type enum in the Issue message for the values.
-- labels: the issue labels, support &#34;==&#34; and &#34;in&#34; operator.
-- approval_status: issue approval status, support &#34;==&#34; operator.
-- current_approver: the issue approver, should in &#34;users/{email} format&#34;, support &#34;==&#34; operator.
-
-For example:
-creator == &#34;users/[email protected]&#34; &amp;&amp; status in [&#34;OPEN&#34;, &#34;DONE&#34;]
-status == &#34;CANCELED&#34; &amp;&amp; type == &#34;DATABASE_CHANGE&#34;
-labels in [&#34;label1&#34;, &#34;label2&#34;]
-create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
+ <td><p>The comment is the comment of a procedure. </p></td>
</tr>
<tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Query is the query statement. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -15648,8 +14961,8 @@ create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
- <h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.SchemaMetadata">SchemaMetadata</h3>
+ <p>SchemaMetadata is the metadata for schemas.</p><p>This is the concept of schema in Postgres, but it's a no-op for MySQL.</p>
<table class="field-table">
@@ -15659,50 +14972,118 @@ create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; </p></td>
<tbody>
<tr>
- <td>issues</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td>repeated</td>
- <td><p>The issues from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
+ <td>name</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 name is the schema name.
+It is an empty string for databases without such concept such as MySQL. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>tables</td>
+ <td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The tables is the list of tables in a schema. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>external_tables</td>
+ <td><a href="#bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The external_tables is the list of external tables in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>views</td>
+ <td><a href="#bytebase.v1.ViewMetadata">ViewMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The views is the list of views in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>functions</td>
+ <td><a href="#bytebase.v1.FunctionMetadata">FunctionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The functions is the list of functions in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>procedures</td>
+ <td><a href="#bytebase.v1.ProcedureMetadata">ProcedureMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The procedures is the list of procedures in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>streams</td>
+ <td><a href="#bytebase.v1.StreamMetadata">StreamMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The streams is the list of streams in a schema, currently, only used for
+Snowflake. </p></td>
+ </tr>
+
+ <tr>
+ <td>tasks</td>
+ <td><a href="#bytebase.v1.TaskMetadata">TaskMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The routines is the list of routines in a schema, currently, only used for
+Snowflake. </p></td>
+ </tr>
+
+ <tr>
+ <td>materialized_views</td>
+ <td><a href="#bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The materialized_views is the list of materialized views in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>packages</td>
+ <td><a href="#bytebase.v1.PackageMetadata">PackageMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The packages is the list of packages in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue to add a rejection.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The owner of the schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>sequences</td>
+ <td><a href="#bytebase.v1.SequenceMetadata">SequenceMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The sequences is the list of sequences in a schema, sorted by name. </p></td>
+ </tr>
+
+ <tr>
+ <td>events</td>
+ <td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The events is the list of scheduled events in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>enum_types</td>
+ <td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this schema during schema dump operations. </p></td>
</tr>
<tr>
<td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment explaining the rejection decision. </p></td>
+ <td><p>The comment is the comment of a schema. </p></td>
</tr>
</tbody>
@@ -15712,7 +15093,7 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.RequestIssueRequest">RequestIssueRequest</h3>
+ <h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</h3>
<p></p>
@@ -15726,109 +15107,91 @@ Format: projects/{project}/issues/{issue} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the issue to request a issue.
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>The name of a sequence. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>data_type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment explaining the request. </p></td>
+ <td><p>The data type of a sequence. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>start</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The start value of a sequence. </p></td>
+ </tr>
<tr>
- <td>parent</td>
+ <td>min_value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of issues.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list all issues from all projects. </p></td>
+ <td><p>The minimum value of a sequence. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>max_value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of issues to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issues will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The maximum value of a sequence. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>increment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchIssues` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchIssues` must match
-the call that provided the page token. </p></td>
+ <td><p>Increment value of a sequence. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>cycle</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Cycle is whether the sequence cycles. </p></td>
+ </tr>
+
+ <tr>
+ <td>cache_size</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter issues returned in the list.
-Check the filter field in the ListIssuesRequest message. </p></td>
+ <td><p>Cache size of a sequence. </p></td>
</tr>
<tr>
- <td>query</td>
+ <td>last_value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Query is the query statement. </p></td>
+ <td><p>Last value of a sequence. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>owner_table</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner table of the sequence. </p></td>
+ </tr>
<tr>
- <td>issues</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td>repeated</td>
- <td><p>The issues from the specified request. </p></td>
+ <td>owner_column</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner column of the sequence. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>comment</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 comment describing the sequence. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this sequence during schema dump operations. </p></td>
</tr>
</tbody>
@@ -15838,8 +15201,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</h3>
+ <p>SpatialIndexConfig defines the spatial index configuration for spatial databases.</p>
<table class="field-table">
@@ -15849,33 +15212,31 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>method</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The issue name
-Format: projects/{project}/issues/{issue} </p></td>
+ <td><p>Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) </p></td>
</tr>
<tr>
- <td>issue_comment</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td>tessellation</td>
+ <td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td>
<td></td>
- <td><p>The comment to update. </p></td>
+ <td><p>Tessellation configuration for grid-based spatial indexes </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>storage</td>
+ <td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>Storage and performance configuration </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>dimensional</td>
+ <td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td>
<td></td>
- <td><p>If set to true, and the issue comment is not found, a new issue comment will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Dimensional configuration </p></td>
</tr>
</tbody>
@@ -15885,8 +15246,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.StorageConfig">StorageConfig</h3>
+ <p>StorageConfig defines storage and performance parameters for spatial indexes.</p>
<table class="field-table">
@@ -15896,28 +15257,174 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>issue</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>fillfactor</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The issue to update.
+ <td><p>Fill factor percentage (1-100) </p></td>
+ </tr>
+
+ <tr>
+ <td>buffering</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Buffering mode for PostgreSQL (auto, on, off) </p></td>
+ </tr>
+
+ <tr>
+ <td>tablespace</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Tablespace configuration for Oracle </p></td>
+ </tr>
+
+ <tr>
+ <td>work_tablespace</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>sdo_level</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>commit_interval</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>pad_index</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>SQL Server specific parameters </p></td>
+ </tr>
+
+ <tr>
+ <td>sort_in_tempdb</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>ON, OFF </p></td>
+ </tr>
+
+ <tr>
+ <td>drop_existing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>online</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_row_locks</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_page_locks</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>maxdop</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>data_compression</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>NONE, ROW, PAGE </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-The issue&#39;s `name` field is used to identify the issue to update.
-Format: projects/{project}/issues/{issue} </p></td>
+
+
+
+
+ <h3 id="bytebase.v1.StreamMetadata">StreamMetadata</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a stream. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>table_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The table_name is the name of the table/view that the stream is created on. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td>
+ <td></td>
+ <td><p>The type of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>stale</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the issue is not found, a new issue will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td>
+ </tr>
+
+ <tr>
+ <td>mode</td>
+ <td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td>
+ <td></td>
+ <td><p>The mode of the stream. </p></td>
+ </tr>
+
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition of the stream. </p></td>
</tr>
</tbody>
@@ -15927,455 +15434,206 @@ In this situation, `update_mask` is ignored. </p></td>
+ <h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to sync.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3>
- <p>The overall approval status for the issue.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>APPROVAL_STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified approval status.</p></td>
- </tr>
-
- <tr>
- <td>CHECKING</td>
- <td>1</td>
- <td><p>Approval checks are being evaluated.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>2</td>
- <td><p>Approval is pending.</p></td>
- </tr>
-
- <tr>
- <td>APPROVED</td>
- <td>3</td>
- <td><p>Issue has been approved.</p></td>
- </tr>
-
- <tr>
- <td>REJECTED</td>
- <td>4</td>
- <td><p>Issue has been rejected.</p></td>
- </tr>
-
- <tr>
- <td>SKIPPED</td>
- <td>5</td>
- <td><p>Approval was skipped.</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3>
+ <p></p>
+
+
+
+
- <h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3>
- <p>The approval status of an approver.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p>Awaiting approval.</p></td>
- </tr>
-
- <tr>
- <td>APPROVED</td>
- <td>2</td>
- <td><p>Approved.</p></td>
- </tr>
-
- <tr>
- <td>REJECTED</td>
- <td>3</td>
- <td><p>Rejected.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Issue.Type">Issue.Type</h3>
- <p>The type of issue.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified issue type.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_CHANGE</td>
- <td>1</td>
- <td><p>Database schema or data change.</p></td>
- </tr>
-
- <tr>
- <td>GRANT_REQUEST</td>
- <td>2</td>
- <td><p>Database access grant request.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_EXPORT</td>
- <td>3</td>
- <td><p>Database data export request.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</h3>
- <p>Approval status values.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p>Approval pending.</p></td>
- </tr>
-
- <tr>
- <td>APPROVED</td>
- <td>2</td>
- <td><p>Approved.</p></td>
- </tr>
-
- <tr>
- <td>REJECTED</td>
- <td>3</td>
- <td><p>Rejected.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.IssueStatus">IssueStatus</h3>
- <p>The status of an issue.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ISSUE_STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>OPEN</td>
- <td>1</td>
- <td><p>Issue is open and active.</p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>2</td>
- <td><p>Issue is completed.</p></td>
- </tr>
-
- <tr>
- <td>CANCELED</td>
- <td>3</td>
- <td><p>Issue is canceled.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.IssueService">IssueService</h3>
- <p>IssueService manages issues for tracking database changes and tasks.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetIssue</td>
- <td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Retrieves an issue by name.
-Permissions required: bb.issues.get</p></td>
- </tr>
-
- <tr>
- <td>CreateIssue</td>
- <td><a href="#bytebase.v1.CreateIssueRequest">CreateIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Creates a new issue for database changes or tasks.
-Permissions required: bb.issues.create</p></td>
- </tr>
-
- <tr>
- <td>ListIssues</td>
- <td><a href="#bytebase.v1.ListIssuesRequest">ListIssuesRequest</a></td>
- <td><a href="#bytebase.v1.ListIssuesResponse">ListIssuesResponse</a></td>
- <td><p>Lists issues in a project.
-Permissions required: bb.issues.list</p></td>
- </tr>
-
- <tr>
- <td>SearchIssues</td>
- <td><a href="#bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</a></td>
- <td><a href="#bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</a></td>
- <td><p>Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query.
-Permissions required: bb.issues.get</p></td>
- </tr>
-
- <tr>
- <td>UpdateIssue</td>
- <td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Updates an issue&#39;s properties such as title, description, or labels.
-Permissions required: bb.issues.update</p></td>
- </tr>
-
- <tr>
- <td>ListIssueComments</td>
- <td><a href="#bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</a></td>
- <td><a href="#bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</a></td>
- <td><p>Lists comments on an issue.
-Permissions required: bb.issueComments.list</p></td>
- </tr>
-
- <tr>
- <td>CreateIssueComment</td>
- <td><a href="#bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</a></td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td><p>Adds a comment to an issue.
-Permissions required: bb.issueComments.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateIssueComment</td>
- <td><a href="#bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</a></td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td><p>Updates an existing issue comment.
-Permissions required: bb.issueComments.update</p></td>
- </tr>
-
- <tr>
- <td>BatchUpdateIssuesStatus</td>
- <td><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</a></td>
- <td><p>Updates the status of multiple issues in a single operation.
-Permissions required: bb.issues.update</p></td>
- </tr>
-
- <tr>
- <td>ApproveIssue</td>
- <td><a href="#bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
-Permissions required: None (determined by approval flow)</p></td>
- </tr>
-
- <tr>
- <td>RejectIssue</td>
- <td><a href="#bytebase.v1.RejectIssueRequest">RejectIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
-Permissions required: None (determined by approval flow)</p></td>
- </tr>
-
- <tr>
- <td>RequestIssue</td>
- <td><a href="#bytebase.v1.RequestIssueRequest">RequestIssueRequest</a></td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td><p>Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
-Permissions required: None (determined by approval flow)</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.TableMetadata">TableMetadata</h3>
+ <p>TableMetadata is the metadata for tables.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a table. </p></td>
+ </tr>
- <tr>
- <td>GetIssue</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/issues/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateIssue</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues</td>
- <td>issue</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListIssues</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/issues</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>SearchIssues</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues:search</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateIssue</td>
- <td>PATCH</td>
- <td>/v1/{issue.name=projects/*/issues/*}</td>
- <td>issue</td>
- </tr>
-
-
-
+ <tr>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
+ </tr>
- <tr>
- <td>ListIssueComments</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*/issues/*}/issueComments</td>
- <td></td>
- </tr>
+ <tr>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The indexes is the list of indexes in a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>engine</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The engine is the engine of a table. </p></td>
+ </tr>
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a table. </p></td>
+ </tr>
- <tr>
- <td>CreateIssueComment</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/issues/*}:comment</td>
- <td>issue_comment</td>
- </tr>
+ <tr>
+ <td>charset</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character set of table. </p></td>
+ </tr>
-
+ <tr>
+ <td>row_count</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The row_count is the estimated number of rows of a table. </p></td>
+ </tr>
+ <tr>
+ <td>data_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The data_size is the estimated data size of a table. </p></td>
+ </tr>
- <tr>
- <td>UpdateIssueComment</td>
- <td>PATCH</td>
- <td>/v1/{parent=projects/*/issues/*}:comment</td>
- <td>issue_comment</td>
- </tr>
+ <tr>
+ <td>index_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The index_size is the estimated index size of a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>data_free</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The data_free is the estimated free data size of a table. </p></td>
+ </tr>
+ <tr>
+ <td>create_options</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The create_options is the create option of a table. </p></td>
+ </tr>
- <tr>
- <td>BatchUpdateIssuesStatus</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>foreign_keys</td>
+ <td><a href="#bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The foreign_keys is the list of foreign keys in a table. </p></td>
+ </tr>
+ <tr>
+ <td>partitions</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The partitions is the list of partitions in a table. </p></td>
+ </tr>
- <tr>
- <td>ApproveIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:approve</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>check_constraints</td>
+ <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The check_constraints is the list of check constraints in a table. </p></td>
+ </tr>
-
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the table. </p></td>
+ </tr>
+ <tr>
+ <td>sorting_keys</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The sorting_keys is a tuple of column names or arbitrary expressions. ClickHouse specific field.
+Reference: https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#order_by </p></td>
+ </tr>
- <tr>
- <td>RejectIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:reject</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The triggers is the list of triggers associated with the table. </p></td>
+ </tr>
-
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this table during schema dump operations. </p></td>
+ </tr>
+ <tr>
+ <td>sharding_info</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td>
+ </tr>
- <tr>
- <td>RequestIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:request</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>primary_key_type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes
+CLUSTERED or NONCLUSTERED. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <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.CreatePolicyRequest">CreatePolicyRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</h3>
+ <p>TablePartitionMetadata is the metadata for table partitions.</p>
<table class="field-table">
@@ -16385,28 +15643,78 @@ Permissions required: None (determined by approval flow)</p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource where this instance will be created.
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
+ <td><p>The name is the name of a table partition. </p></td>
</tr>
<tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td>
<td></td>
- <td><p>The policy to create. </p></td>
+ <td><p>The type of a table partition. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
+ <td>expression</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of policy to create. </p></td>
+ <td><p>The expression is the expression of a table partition.
+For PostgreSQL, the expression is the text of {FOR VALUES
+partition_bound_spec}, see
+https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL,
+the expression is the `expr` or `column_list` of the following syntax.
+PARTITION BY
+ { [LINEAR] HASH(expr)
+ | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list)
+ | RANGE{(expr) | COLUMNS(column_list)}
+ | LIST{(expr) | COLUMNS(column_list)} }. </p></td>
+ </tr>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The value is the value of a table partition.
+For MySQL, the value is for RANGE and LIST partition types,
+- For a RANGE partition, it contains the value set in the partition&#39;s
+VALUES LESS THAN clause, which can be either an integer or MAXVALUE.
+- For a LIST partition, this column contains the values defined in the
+partition&#39;s VALUES IN clause, which is a list of comma-separated integer
+values.
+- For others, it&#39;s an empty string. </p></td>
+ </tr>
+
+ <tr>
+ <td>use_default</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The use_default is whether the users use the default partition, it stores
+the different value for different database engines. For MySQL, it&#39;s [INT]
+type, 0 means not use default partition, otherwise, it&#39;s equals to number
+in syntax [SUB]PARTITION {number}. </p></td>
+ </tr>
+
+ <tr>
+ <td>subpartitions</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The subpartitions is the list of subpartitions in a table partition. </p></td>
+ </tr>
+
+ <tr>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>check_constraints</td>
+ <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -16416,7 +15724,7 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
- <h3 id="bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</h3>
+ <h3 id="bytebase.v1.TaskMetadata">TaskMetadata</h3>
<p></p>
@@ -16430,12 +15738,71 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The policy&#39;s `name` field is used to identify the instance to update.
-Format: {resource name}/policies/{policy type}
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
+ <td><p>The name is the name of a task. </p></td>
+ </tr>
+
+ <tr>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The id is the snowflake-generated id of a task.
+Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
+ </tr>
+
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>warehouse</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The warehouse of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>schedule</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schedule interval of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>predecessors</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The predecessor tasks of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>state</td>
+ <td><a href="#bytebase.v1.TaskMetadata.State">TaskMetadata.State</a></td>
+ <td></td>
+ <td><p>The state of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>condition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The condition of the task. </p></td>
+ </tr>
+
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition of the task. </p></td>
</tr>
</tbody>
@@ -16445,8 +15812,8 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
- <h3 id="bytebase.v1.GetPolicyRequest">GetPolicyRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.TessellationConfig">TessellationConfig</h3>
+ <p>TessellationConfig defines tessellation parameters for spatial indexes.</p>
<table class="field-table">
@@ -16456,11 +15823,31 @@ Database resource name: instances/instance-id/databases/database-name. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>scheme</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><p>Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) </p></td>
+ </tr>
+
+ <tr>
+ <td>grid_levels</td>
+ <td><a href="#bytebase.v1.GridLevel">GridLevel</a></td>
+ <td>repeated</td>
+ <td><p>Grid levels and densities for multi-level tessellation </p></td>
+ </tr>
+
+ <tr>
+ <td>cells_per_object</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Number of cells per object (1-8192 for SQL Server) </p></td>
+ </tr>
+
+ <tr>
+ <td>bounding_box</td>
+ <td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td>
+ <td></td>
+ <td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td>
</tr>
</tbody>
@@ -16470,7 +15857,7 @@ Format: {resource type}/{resource id}/policies/{policy type} </p></td>
- <h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3>
+ <h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3>
<p></p>
@@ -16481,25 +15868,67 @@ Format: {resource type}/{resource id}/policies/{policy type} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of policies.
-Format: {resource type}/{resource id} </p></td>
+ <td><p>The name is the name of the trigger. </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>
+ <td>event</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The event is the event of the trigger, such as INSERT, UPDATE, DELETE,
+TRUNCATE. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
+ <td>timing</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td>
+ </tr>
+
+ <tr>
+ <td>body</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The body is the body of the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_mode</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SQL mode setting for the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <td>character_set_client</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character set used by the client creating the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation_connection</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation used for the connection when creating the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment describing the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Show deleted policies if specified. </p></td>
+ <td><p>Whether to skip this trigger during schema dump operations. </p></td>
</tr>
</tbody>
@@ -16509,7 +15938,7 @@ Format: {resource type}/{resource id} </p></td>
- <h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3>
+ <h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3>
<p></p>
@@ -16520,10 +15949,28 @@ Format: {resource type}/{resource id} </p></td>
<tbody>
<tr>
- <td>policies</td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td>repeated</td>
- <td><p>The policies from the specified request. </p></td>
+ <td>database</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td></td>
+ <td><p>The database to update.
+
+The database&#39;s `name` field is used to identify the database to update.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the database is not found, a new database will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -16533,8 +15980,8 @@ Format: {resource type}/{resource id} </p></td>
- <h3 id="bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</h3>
- <p>MaskingExemptionPolicy is the allowlist of users who can access sensitive data.</p>
+ <h3 id="bytebase.v1.ViewMetadata">ViewMetadata</h3>
+ <p>ViewMetadata is the metadata for views.</p>
<table class="field-table">
@@ -16544,234 +15991,52 @@ Format: {resource type}/{resource id} </p></td>
<tbody>
<tr>
- <td>exemptions</td>
- <td><a href="#bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</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>members</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Specifies the principals who are exempt from masking.
-For users, the member should be: user:{email}
-For groups, the member should be: group:{email} </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this exception policy instance.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-If the condition is empty, means the user can access all databases without expiration.
-
-Support variables:
-resource.instance_id: the instance resource id. Only support &#34;==&#34; operation.
-resource.database_name: the database name. Only support &#34;==&#34; operation.
-resource.schema_name: the schema name. Only support &#34;==&#34; operation.
-resource.table_name: the table name. Only support &#34;==&#34; operation.
-resource.column_name: the column name. Only support &#34;==&#34; operation.
-request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`
-All variables should join with &#34;&amp;&amp;&#34; condition.
-
-For example:
-resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;)
-resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <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.MaskingRulePolicy.MaskingRule">MaskingRulePolicy.MaskingRule</h3>
- <p>A rule that defines when and how to mask 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>id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A unique identifier for the rule in UUID format. </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition for the masking rule.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.environment_id: the environment resource id.
-resource.project_id: the project resource id.
-resource.instance_id: the instance resource id.
-resource.database_name: the database name.
-resource.table_name: the table name.
-resource.column_name: the column name.
-resource.classification_level: the classification level.
-
-Each variable support following operations:
-==: the value equals the target.
-!=: the value not equals the target.
-in: the value matches one of the targets.
-!(in): the value not matches any of the targets.
-
-For example:
-resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34;
-resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;]
-resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;])
-resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) </p></td>
+ <td><p>The name is the name of a view. </p></td>
</tr>
<tr>
- <td>semantic_type</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). </p></td>
+ <td><p>The definition is the definition of a view. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Policy">Policy</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>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the policy.
-Format: {resource name}/policies/{policy type}
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
- </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>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
- <td></td>
- <td><p>The type of policy. </p></td>
- </tr>
-
- <tr>
- <td>rollout_policy</td>
- <td><a href="#bytebase.v1.RolloutPolicy">RolloutPolicy</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>masking_rule_policy</td>
- <td><a href="#bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The comment is the comment of a view. </p></td>
</tr>
<tr>
- <td>masking_exemption_policy</td>
- <td><a href="#bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>dependency_columns</td>
+ <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_columns is the list of dependency columns of a view. </p></td>
</tr>
<tr>
- <td>tag_policy</td>
- <td><a href="#bytebase.v1.TagPolicy">TagPolicy</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
</tr>
<tr>
- <td>query_data_policy</td>
- <td><a href="#bytebase.v1.QueryDataPolicy">QueryDataPolicy</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The triggers is the list of triggers in a view. </p></td>
</tr>
<tr>
- <td>enforce</td>
+ <td>skip_dump</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether the policy is enforced. </p></td>
- </tr>
-
- <tr>
- <td>resource_type</td>
- <td><a href="#bytebase.v1.PolicyResourceType">PolicyResourceType</a></td>
- <td></td>
- <td><p>The resource type for the policy. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -16781,218 +16046,10 @@ 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>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>timeout</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The query timeout duration. </p></td>
- </tr>
-
- <tr>
- <td>disable_export</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Disable data export in the SQL editor. </p></td>
- </tr>
-
- <tr>
- <td>maximum_result_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The maximum result size limit in bytes.
-The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. </p></td>
- </tr>
-
- <tr>
- <td>maximum_result_rows</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of rows to return.
-The default value is -1, means no limit. </p></td>
- </tr>
-
- <tr>
- <td>disable_copy_data</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Disable copying query results. </p></td>
- </tr>
-
- <tr>
- <td>admin_data_source_restriction</td>
- <td><a href="#bytebase.v1.QueryDataPolicy.Restriction">QueryDataPolicy.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>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>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3>
- <p>Rollout policy configuration.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>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>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TagPolicy">TagPolicy</h3>
- <p>Policy for tagging resources with metadata.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>tags</td>
- <td><a href="#bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td>
- <td>repeated</td>
- <td><p>tags is the key - value map for resources.
-for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h3 id="bytebase.v1.UpdatePolicyRequest">UpdatePolicyRequest</h3>
+ <h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.Policy">Policy</a></td>
- <td></td>
- <td><p>The policy to update.
-
-The policy&#39;s `name` field is used to identify the instance to update.
-Format: {resource name}/policies/{policy type}
-Workspace resource name: &#34;&#34;.
-Environment resource name: environments/environment-id.
-Instance resource name: instances/instance-id.
-Database resource name: instances/instance-id/databases/database-name. </p></td>
- </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 policy is not found, a new policy will be created.
-In this situation, `update_mask` is ignored. </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>
@@ -17000,34 +16057,34 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>RESOURCE_TYPE_UNSPECIFIED</td>
+ <td>STATUS_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified resource type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>WORKSPACE</td>
+ <td>PENDING</td>
<td>1</td>
- <td><p>Workspace-level policy.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ENVIRONMENT</td>
+ <td>DONE</td>
<td>2</td>
- <td><p>Environment-level policy.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>PROJECT</td>
+ <td>FAILED</td>
<td>3</td>
- <td><p>Project-level policy.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.PolicyType">PolicyType</h3>
- <p>The type of organizational policy.</p>
+ <h3 id="bytebase.v1.ChangelogView">ChangelogView</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -17035,46 +16092,58 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>POLICY_TYPE_UNSPECIFIED</td>
+ <td>CHANGELOG_VIEW_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified policy type.</p></td>
+ <td><p>The default / unset value.
+The API will default to the BASIC view.</p></td>
</tr>
<tr>
- <td>MASKING_RULE</td>
+ <td>CHANGELOG_VIEW_BASIC</td>
<td>1</td>
- <td><p>Data masking rule policy.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>MASKING_EXEMPTION</td>
+ <td>CHANGELOG_VIEW_FULL</td>
<td>2</td>
- <td><p>Data masking exemption policy.</p></td>
+ <td><p></p></td>
</tr>
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>ROLLOUT_POLICY</td>
- <td>3</td>
- <td><p>Rollout deployment policy.</p></td>
+ <td>IDENTITY_GENERATION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>TAG</td>
- <td>4</td>
- <td><p>Resource tag policy.</p></td>
+ <td>ALWAYS</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DATA_QUERY</td>
- <td>6</td>
- <td><p>Query data access policy.</p></td>
+ <td>BY_DEFAULT</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.QueryDataPolicy.Restriction">QueryDataPolicy.Restriction</h3>
- <p>Restriction level for admin data source access.</p>
+ <h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -17082,300 +16151,597 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>RESTRICTION_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified restriction.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>FALLBACK</td>
+ <td>VIRTUAL</td>
<td>1</td>
- <td><p>Allow querying admin data sources when there is no read-only data source.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DISALLOW</td>
+ <td>STORED</td>
<td>2</td>
- <td><p>Disallow querying admin data sources.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h3 id="bytebase.v1.OrgPolicyService">OrgPolicyService</h3>
- <p>OrgPolicyService manages organizational policies at various resource levels.</p>
+ <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</h3>
+ <p>SDLFormat specifies the output format for SDL schema.</p>
<table class="enum-table">
<thead>
- <tr><td>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>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>
+ <td>SDL_FORMAT_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified format. Defaults to SINGLE_FILE.</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>
+ <td>SINGLE_FILE</td>
+ <td>1</td>
+ <td><p>Single file format: returns the complete SDL schema as a single file.</p></td>
</tr>
<tr>
- <td>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>
+ <td>MULTI_FILE</td>
+ <td>2</td>
+ <td><p>Multi-file format: returns the SDL schema as a ZIP archive containing
+multiple files organized by schema objects (tables, views, functions, etc.).</p></td>
</tr>
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<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>
+ <td>OBJECT_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></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>
+ <td>DATABASE</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>SCHEMA</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=policies/*}</td>
- <td></td>
+ <td>TABLE</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/policies/*}</td>
- <td></td>
+ <td>VIEW</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=environments/*/policies/*}</td>
- <td></td>
+ <td>MATERIALIZED_VIEW</td>
+ <td>5</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/policies/*}</td>
- <td></td>
+ <td>FUNCTION</td>
+ <td>6</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>GetPolicy</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/policies/*}</td>
- <td></td>
+ <td>PROCEDURE</td>
+ <td>7</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/policies</td>
- <td></td>
+ <td>SEQUENCE</td>
+ <td>8</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>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/policies</td>
- <td></td>
+ <td>MODE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=environments/*}/policies</td>
- <td></td>
+ <td>DEFAULT</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/policies</td>
- <td></td>
+ <td>APPEND_ONLY</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>ListPolicies</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*/databases/*}/policies</td>
- <td></td>
+ <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>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/policies</td>
- <td>policy</td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/policies</td>
- <td>policy</td>
+ <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>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=environments/*}/policies</td>
- <td>policy</td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*}/policies</td>
- <td>policy</td>
+ <td>RANGE</td>
+ <td>1</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>CreatePolicy</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*/databases/*}/policies</td>
- <td>policy</td>
+ <td>RANGE_COLUMNS</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=policies/*}</td>
- <td>policy</td>
+ <td>LIST</td>
+ <td>3</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=projects/*/policies/*}</td>
- <td>policy</td>
+ <td>LIST_COLUMNS</td>
+ <td>4</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=environments/*/policies/*}</td>
- <td>policy</td>
+ <td>HASH</td>
+ <td>5</td>
+ <td><p></p></td>
</tr>
-
+
<tr>
- <td>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=instances/*/policies/*}</td>
- <td>policy</td>
+ <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>UpdatePolicy</td>
- <td>PATCH</td>
- <td>/v1/{policy.name=instances/*/databases/*/policies/*}</td>
- <td>policy</td>
+ <td>GetDatabase</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*}</td>
+ <td></td>
</tr>
<tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=policies/*}</td>
+ <td>BatchGetDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databases:batchGet</td>
<td></td>
</tr>
<tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/policies/*}</td>
+ <td>BatchGetDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/databases:batchGet</td>
<td></td>
</tr>
+
+
+
<tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=environments/*/policies/*}</td>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databases</td>
<td></td>
</tr>
<tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*/policies/*}</td>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/databases</td>
<td></td>
</tr>
<tr>
- <td>DeletePolicy</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*/databases/*/policies/*}</td>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=workspaces/*}/databases</td>
<td></td>
</tr>
- </tbody>
- </table>
+
+
+ <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/sql_service.proto">v1/sql_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/group_service.proto">v1/group_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.AICompletionRequest">AICompletionRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</h3>
+ <p>Request message for batch getting groups.</p>
<table class="field-table">
@@ -17385,10 +16751,11 @@ Permissions required: bb.policies.delete</p></td>
<tbody>
<tr>
- <td>messages</td>
- <td><a href="#bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</a></td>
+ <td>names</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>The group names to retrieve.
+Format: groups/{email} </p></td>
</tr>
</tbody>
@@ -17398,8 +16765,8 @@ Permissions required: bb.policies.delete</p></td>
- <h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</h3>
+ <p>Response message for batch getting groups.</p>
<table class="field-table">
@@ -17409,17 +16776,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></td>
- <td><p> </p></td>
+ <td>groups</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>repeated</td>
+ <td><p>The groups from the specified request. </p></td>
</tr>
</tbody>
@@ -17429,8 +16789,8 @@ Permissions required: bb.policies.delete</p></td>
- <h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.CreateGroupRequest">CreateGroupRequest</h3>
+ <p>Request message for creating a group.</p>
<table class="field-table">
@@ -17440,35 +16800,18 @@ Permissions required: bb.policies.delete</p></td>
<tbody>
<tr>
- <td>candidates</td>
- <td><a href="#bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</a></td>
- <td>repeated</td>
- <td><p>candidates is used for results with multiple choices and candidates. Used
-for OpenAI and Gemini. </p></td>
+ <td>group</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td></td>
+ <td><p>The group to create. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</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>content</td>
- <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</a></td>
+ <td>group_email</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The email to use for the group, which will become the final component
+of the group&#39;s resource name. </p></td>
</tr>
</tbody>
@@ -17478,8 +16821,8 @@ for OpenAI and Gemini. </p></td>
- <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</h3>
+ <p>Request message for deleting a group.</p>
<table class="field-table">
@@ -17489,10 +16832,11 @@ 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>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>
@@ -17502,8 +16846,8 @@ for OpenAI and Gemini. </p></td>
- <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetGroupRequest">GetGroupRequest</h3>
+ <p>Request message for getting a group.</p>
<table class="field-table">
@@ -17513,10 +16857,11 @@ for OpenAI and Gemini. </p></td>
<tbody>
<tr>
- <td>text</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the group to retrieve.
+Format: groups/{email} </p></td>
</tr>
</tbody>
@@ -17526,8 +16871,8 @@ for OpenAI and Gemini. </p></td>
- <h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.Group">Group</h3>
+ <p>A group of users within the workspace.</p>
<table class="field-table">
@@ -17540,38 +16885,43 @@ for OpenAI and Gemini. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the instance name to execute the query against.
-Format: instances/{instance}/databases/{databaseName} </p></td>
+ <td><p>The name of the group to retrieve.
+Format: groups/{group}, the group should be email or uuid. </p></td>
</tr>
<tr>
- <td>statement</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SQL statement to execute. </p></td>
+ <td><p>The display title of the group. </p></td>
</tr>
<tr>
- <td>limit</td>
- <td><a href="#int32">int32</a></td>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of rows to return. </p></td>
+ <td><p>The description of the group. </p></td>
</tr>
<tr>
- <td>schema</td>
+ <td>members</td>
+ <td><a href="#bytebase.v1.GroupMember">GroupMember</a></td>
+ <td>repeated</td>
+ <td><p>The members of the group. </p></td>
+ </tr>
+
+ <tr>
+ <td>source</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></td>
+ <td><p>The source system where the group originated (e.g., Entra ID for SCIM sync). </p></td>
</tr>
<tr>
- <td>container</td>
+ <td>email</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>The unique email for the group. </p></td>
</tr>
</tbody>
@@ -17581,8 +16931,8 @@ CosmosDB only. </p></td>
- <h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.GroupMember">GroupMember</h3>
+ <p>A member of a group with a role.</p>
<table class="field-table">
@@ -17592,77 +16942,19 @@ CosmosDB only. </p></td>
<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>status</td>
- <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
- <td></td>
- <td><p>The advice level. </p></td>
- </tr>
-
- <tr>
- <td>code</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The advice code. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The advice title. </p></td>
- </tr>
-
- <tr>
- <td>content</td>
+ <td>member</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>
+ <td><p>Member is the principal who belong to this group.
+
+Format: users/[email protected] </p></td>
</tr>
<tr>
- <td>rule_type</td>
- <td><a href="#bytebase.v1.Advice.RuleType">Advice.RuleType</a></td>
+ <td>role</td>
+ <td><a href="#bytebase.v1.GroupMember.Role">GroupMember.Role</a></td>
<td></td>
- <td><p>The type of linting rule that generated this advice. </p></td>
+ <td><p>The member&#39;s role in the group. </p></td>
</tr>
</tbody>
@@ -17672,8 +16964,8 @@ TODO: use range instead </p></td>
- <h3 id="bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListGroupsRequest">ListGroupsRequest</h3>
+ <p>Request message for listing groups.</p>
<table class="field-table">
@@ -17683,24 +16975,46 @@ TODO: use range instead </p></td>
<tbody>
<tr>
- <td>source_metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The metadata of the source schema. </p></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>target_metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The metadata of the target schema. </p></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>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The database engine of the schema. </p></td>
+ <td><p>Filter is used to filter groups returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- title: the group title, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- email: the group email, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+
+For example:
+title == &#34;dba&#34;
+email == &#34;[email protected]&#34;
+title.matches(&#34;dba&#34;)
+email.matches(&#34;dba&#34;)
+project == &#34;projects/sample-project&#34;
+You can combine filter conditions like:
+title.matches(&#34;dba&#34;) || email.matches(&#34;dba&#34;) </p></td>
</tr>
</tbody>
@@ -17710,8 +17024,8 @@ TODO: use range instead </p></td>
- <h3 id="bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListGroupsResponse">ListGroupsResponse</h3>
+ <p>Response message for listing groups.</p>
<table class="field-table">
@@ -17721,10 +17035,18 @@ TODO: use range instead </p></td>
<tbody>
<tr>
- <td>diff</td>
+ <td>groups</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td>repeated</td>
+ <td><p>The groups from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The diff of the metadata. </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>
@@ -17734,8 +17056,8 @@ TODO: use range instead </p></td>
- <h3 id="bytebase.v1.ExportRequest">ExportRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</h3>
+ <p>Request message for updating a group.</p>
<table class="field-table">
@@ -17745,68 +17067,28 @@ 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>group</td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
<td></td>
- <td><p>The maximum number of rows to return. </p></td>
+ <td><p>The group to update.
+
+The group&#39;s `name` field is used to identify the group to update.
+Format: groups/{email} </p></td>
</tr>
<tr>
- <td>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The export format. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>admin</td>
+ <td>allow_missing</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><a href="#string">string</a></td>
- <td></td>
- <td><p>The id of data source.
-It is used for querying admin data source even if the instance has
-read-only data sources. Or it can be used to query a specific read-only
-data source. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The default schema to search objects. Equals to the current schema in
-Oracle and search path in Postgres. </p></td>
+ <td><p>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>
@@ -17816,97 +17098,189 @@ Oracle and search path in Postgres. </p></td>
- <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>content</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The export file content. </p></td>
- </tr>
-
- </tbody>
- </table>
-
+
+ <h3 id="bytebase.v1.GroupMember.Role">GroupMember.Role</h3>
+ <p>The role of a group member.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ROLE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified role.</p></td>
+ </tr>
+
+ <tr>
+ <td>OWNER</td>
+ <td>1</td>
+ <td><p>Group owner.</p></td>
+ </tr>
+
+ <tr>
+ <td>MEMBER</td>
+ <td>2</td>
+ <td><p>Group member.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <h3 id="bytebase.v1.MaskingReason">MaskingReason</h3>
- <p></p>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
+ <h3 id="bytebase.v1.GroupService">GroupService</h3>
+ <p>GroupService manages user groups for organizing users and permissions.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetGroup</td>
+ <td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td><p>Gets a group by name.
+Permissions required: bb.groups.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchGetGroups</td>
+ <td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</a></td>
+ <td><p>Gets multiple groups in a single request.
+Permissions required: bb.groups.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListGroups</td>
+ <td><a href="#bytebase.v1.ListGroupsRequest">ListGroupsRequest</a></td>
+ <td><a href="#bytebase.v1.ListGroupsResponse">ListGroupsResponse</a></td>
+ <td><p>Lists all groups in the workspace.
+Permissions required: bb.groups.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateGroup</td>
+ <td><a href="#bytebase.v1.CreateGroupRequest">CreateGroupRequest</a></td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td><p>Creates a new group.
+Permissions required: bb.groups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateGroup</td>
+ <td><a href="#bytebase.v1.UpdateGroupRequest">UpdateGroupRequest</a></td>
+ <td><a href="#bytebase.v1.Group">Group</a></td>
+ <td><p>Updates a group. Group owners or users with bb.groups.update permission can update.
+Permissions required: bb.groups.update OR caller is group owner
+When allow_missing=true, also requires: bb.groups.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteGroup</td>
+ <td><a href="#bytebase.v1.DeleteGroupRequest">DeleteGroupRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a group. Group owners or users with bb.groups.delete permission can delete.
+Permissions required: bb.groups.delete OR caller is group owner</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
- <tr>
- <td>semantic_type_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). </p></td>
- </tr>
- <tr>
- <td>semantic_type_title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Human-readable semantic type title. </p></td>
- </tr>
+ <tr>
+ <td>GetGroup</td>
+ <td>GET</td>
+ <td>/v1/{name=groups/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>masking_rule_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The masking rule ID that matched (if applicable). </p></td>
- </tr>
+
- <tr>
- <td>algorithm</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The masking algorithm used. </p></td>
- </tr>
- <tr>
- <td>context</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). </p></td>
- </tr>
+ <tr>
+ <td>BatchGetGroups</td>
+ <td>GET</td>
+ <td>/v1/groups:batchGet</td>
+ <td></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>
+ <tr>
+ <td>ListGroups</td>
+ <td>GET</td>
+ <td>/v1/groups</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateGroup</td>
+ <td>POST</td>
+ <td>/v1/groups</td>
+ <td>group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateGroup</td>
+ <td>PATCH</td>
+ <td>/v1/{group.name=groups/*}</td>
+ <td>group</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteGroup</td>
+ <td>DELETE</td>
+ <td>/v1/{name=groups/*}</td>
+ <td></td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.QueryHistory">QueryHistory</h3>
+ <div class="file-heading">
+ <h2 id="v1/idp_service.proto">v1/idp_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateIdentityProviderRequest">CreateIdentityProviderRequest</h3>
<p></p>
@@ -17917,61 +17291,28 @@ 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><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
+ <td>identity_provider</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The identity provider to create. </p></td>
</tr>
<tr>
- <td>error</td>
+ <td>identity_provider_id</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>
+ <td><p>The ID to use for the identity provider, which will become the final component of
+the identity provider&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.QueryHistory.Type">QueryHistory.Type</a></td>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>If set to true, the request will be validated without actually creating the identity provider. </p></td>
</tr>
</tbody>
@@ -17981,7 +17322,7 @@ Format: instances/{instance}/databases/{databaseName} </p></td>
- <h3 id="bytebase.v1.QueryOption">QueryOption</h3>
+ <h3 id="bytebase.v1.DeleteIdentityProviderRequest">DeleteIdentityProviderRequest</h3>
<p></p>
@@ -17992,17 +17333,11 @@ 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>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the identity provider to delete.
+Format: idps/{identity_provider} </p></td>
</tr>
</tbody>
@@ -18012,8 +17347,8 @@ Format: instances/{instance}/databases/{databaseName} </p></td>
- <h3 id="bytebase.v1.QueryRequest">QueryRequest</h3>
- <p></p>
+ <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">
@@ -18023,65 +17358,32 @@ Format: instances/{instance}/databases/{databaseName} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>identifier</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>
+ <td><p>Identifier is the field name of the unique identifier in 3rd-party idp user info. Required. </p></td>
</tr>
<tr>
- <td>statement</td>
+ <td>display_name</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>
+ <td><p>DisplayName is the field name of display name in 3rd-party idp user info. Optional. </p></td>
</tr>
<tr>
- <td>data_source_id</td>
+ <td>phone</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>Phone is the field name of primary phone in 3rd-party idp user info. Optional. </p></td>
</tr>
<tr>
- <td>schema</td>
+ <td>groups</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>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>
@@ -18091,7 +17393,7 @@ CosmosDB only. </p></td>
- <h3 id="bytebase.v1.QueryResponse">QueryResponse</h3>
+ <h3 id="bytebase.v1.GetIdentityProviderRequest">GetIdentityProviderRequest</h3>
<p></p>
@@ -18102,10 +17404,11 @@ CosmosDB only. </p></td>
<tbody>
<tr>
- <td>results</td>
- <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
- <td>repeated</td>
- <td><p>The query results. </p></td>
+ <td>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>
</tbody>
@@ -18115,7 +17418,7 @@ CosmosDB only. </p></td>
- <h3 id="bytebase.v1.QueryResult">QueryResult</h3>
+ <h3 id="bytebase.v1.IdentityProvider">IdentityProvider</h3>
<p></p>
@@ -18126,89 +17429,39 @@ CosmosDB only. </p></td>
<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>column_type_names</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Column types of the query result.
-The types come from the Golang SQL driver. </p></td>
- </tr>
-
- <tr>
- <td>rows</td>
- <td><a href="#bytebase.v1.QueryRow">QueryRow</a></td>
- <td>repeated</td>
- <td><p>Rows of the query result. </p></td>
- </tr>
-
- <tr>
- <td>rows_count</td>
- <td><a href="#int64">int64</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the identity provider.
+Format: idps/{idp} </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>
- </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>
+ <td><p>The display title of the identity provider. </p></td>
</tr>
<tr>
- <td>statement</td>
+ <td>domain</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The query statement for the result. </p></td>
- </tr>
-
- <tr>
- <td>postgres_error</td>
- <td><a href="#bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The domain for email matching when using this identity provider. </p></td>
</tr>
<tr>
- <td>syntax_error</td>
- <td><a href="#bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.IdentityProviderType">IdentityProviderType</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The type of identity provider protocol. </p></td>
</tr>
<tr>
- <td>permission_denied</td>
- <td><a href="#bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</a></td>
+ <td>config</td>
+ <td><a href="#bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>messages</td>
- <td><a href="#bytebase.v1.QueryResult.Message">QueryResult.Message</a></td>
- <td>repeated</td>
- <td><p>Informational or debug messages returned by the database engine during query execution.
-Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. </p></td>
- </tr>
-
- <tr>
- <td>masked</td>
- <td><a href="#bytebase.v1.MaskingReason">MaskingReason</a></td>
- <td>repeated</td>
- <td><p>Masking reasons for each column (empty for non-masked columns). </p></td>
+ <td><p>The configuration details for the identity provider. </p></td>
</tr>
</tbody>
@@ -18218,7 +17471,7 @@ Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39
- <h3 id="bytebase.v1.QueryResult.Message">QueryResult.Message</h3>
+ <h3 id="bytebase.v1.IdentityProviderConfig">IdentityProviderConfig</h3>
<p></p>
@@ -18229,53 +17482,24 @@ Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39
<tbody>
<tr>
- <td>level</td>
- <td><a href="#bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</a></td>
+ <td>oauth2_config</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>OAuth2 protocol configuration. </p></td>
</tr>
<tr>
- <td>content</td>
- <td><a href="#string">string</a></td>
+ <td>oidc_config</td>
+ <td><a href="#bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</a></td>
<td></td>
- <td><p> </p></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>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>
+ <td><p>OIDC protocol configuration. </p></td>
</tr>
<tr>
- <td>command_type</td>
- <td><a href="#bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</a></td>
+ <td>ldap_config</td>
+ <td><a href="#bytebase.v1.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</a></td>
<td></td>
- <td><p>Disallowed command_type. </p></td>
+ <td><p>LDAP protocol configuration. </p></td>
</tr>
</tbody>
@@ -18285,8 +17509,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.LDAPIdentityProviderConfig">LDAPIdentityProviderConfig</h3>
+ <p>LDAPIdentityProviderConfig is the structure for LDAP identity provider config.</p>
<table class="field-table">
@@ -18296,146 +17520,183 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
<tbody>
<tr>
- <td>severity</td>
+ <td>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Host is the hostname or IP address of the LDAP server, e.g.,
+&#34;ldap.example.com&#34;. </p></td>
</tr>
<tr>
- <td>code</td>
- <td><a href="#string">string</a></td>
+ <td>port</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></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>message</td>
- <td><a href="#string">string</a></td>
+ <td>skip_tls_verify</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>SkipTLSVerify controls whether to skip TLS certificate verification. </p></td>
</tr>
<tr>
- <td>detail</td>
+ <td>bind_dn</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></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>hint</td>
+ <td>bind_password</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>position</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>BindPassword is the password of the user to bind as a service account. </p></td>
</tr>
<tr>
- <td>internal_position</td>
- <td><a href="#int32">int32</a></td>
+ <td>base_dn</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>BaseDN is the base DN to search for users, e.g., &#34;ou=users,dc=example,dc=com&#34;. </p></td>
</tr>
<tr>
- <td>internal_query</td>
+ <td>user_filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>UserFilter is the filter to search for users, e.g., &#34;(uid=%s)&#34;. </p></td>
</tr>
<tr>
- <td>where</td>
- <td><a href="#string">string</a></td>
+ <td>security_protocol</td>
+ <td><a href="#bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>SecurityProtocol is the security protocol to be used for establishing
+connections with the LDAP server. </p></td>
</tr>
<tr>
- <td>schema_name</td>
- <td><a href="#string">string</a></td>
+ <td>field_mapping</td>
+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>FieldMapping is the mapping of the user attributes returned by the LDAP
+server. </p></td>
</tr>
- <tr>
- <td>table_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListIdentityProvidersRequest">ListIdentityProvidersRequest</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListIdentityProvidersResponse">ListIdentityProvidersResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>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>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.OAuth2IdentityProviderConfig">OAuth2IdentityProviderConfig</h3>
+ <p>OAuth2IdentityProviderConfig is the structure for OAuth2 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>column_name</td>
+ <td>auth_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The authorization endpoint URL for OAuth2 flow. </p></td>
</tr>
<tr>
- <td>data_type_name</td>
+ <td>token_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The token endpoint URL for exchanging authorization code. </p></td>
</tr>
<tr>
- <td>constraint_name</td>
+ <td>user_info_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The user information endpoint URL. </p></td>
</tr>
<tr>
- <td>file</td>
+ <td>client_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The OAuth2 client identifier. </p></td>
</tr>
<tr>
- <td>line</td>
- <td><a href="#int32">int32</a></td>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The OAuth2 client secret for authentication. </p></td>
</tr>
<tr>
- <td>routine</td>
+ <td>scopes</td>
<td><a href="#string">string</a></td>
+ <td>repeated</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> </p></td>
+ <td><p>Mapping configuration for user attributes from OAuth2 response. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</h3>
- <p>Syntax error with position information for editor highlighting</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>auth_style</td>
+ <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
<td></td>
- <td><p>Position information for highlighting in editor </p></td>
+ <td><p>The authentication style for client credentials. </p></td>
</tr>
</tbody>
@@ -18445,7 +17706,7 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
- <h3 id="bytebase.v1.QueryRow">QueryRow</h3>
+ <h3 id="bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</h3>
<p></p>
@@ -18456,10 +17717,10 @@ 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>code</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Authorize code from website. </p></td>
</tr>
</tbody>
@@ -18469,8 +17730,8 @@ instances/{instance}/databases/{database}/schemas/{schema}/tables/{table} </p></
- <h3 id="bytebase.v1.RowValue">RowValue</h3>
- <p></p>
+ <h3 id="bytebase.v1.OIDCIdentityProviderConfig">OIDCIdentityProviderConfig</h3>
+ <p>OIDCIdentityProviderConfig is the structure for OIDC identity provider config.</p>
<table class="field-table">
@@ -18480,98 +17741,85 @@ 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>issuer</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The OIDC issuer URL for the identity provider. </p></td>
</tr>
<tr>
- <td>bool_value</td>
- <td><a href="#bool">bool</a></td>
+ <td>client_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The OIDC client identifier. </p></td>
</tr>
<tr>
- <td>bytes_value</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The OIDC client secret for authentication. </p></td>
</tr>
<tr>
- <td>double_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>float_value</td>
- <td><a href="#float">float</a></td>
+ <td>field_mapping</td>
+ <td><a href="#bytebase.v1.FieldMapping">FieldMapping</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Mapping configuration for user attributes from OIDC claims. </p></td>
</tr>
<tr>
- <td>int32_value</td>
- <td><a href="#int32">int32</a></td>
+ <td>skip_tls_verify</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether to skip TLS certificate verification. </p></td>
</tr>
<tr>
- <td>int64_value</td>
- <td><a href="#int64">int64</a></td>
+ <td>auth_style</td>
+ <td><a href="#bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The authentication style for client credentials. </p></td>
</tr>
<tr>
- <td>string_value</td>
+ <td>auth_endpoint</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>
+ <td><p>The authorization endpoint of the OIDC provider.
+Should be fetched from the well-known configuration file of the OIDC provider. </p></td>
</tr>
- <tr>
- <td>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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>timestamp_tz_value</td>
- <td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</a></td>
+ <td>code</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>timestamp_tz_value is used for the timestamptz data type, which
-accurately represents the timestamp with location information. </p></td>
+ <td><p>Authorize code from OIDC provider. </p></td>
</tr>
</tbody>
@@ -18581,7 +17829,7 @@ accurately represents the timestamp with location information. </p></td>
- <h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3>
+ <h3 id="bytebase.v1.TestIdentityProviderRequest">TestIdentityProviderRequest</h3>
<p></p>
@@ -18592,17 +17840,24 @@ 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>identity_provider</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td></td>
+ <td><p>The identity provider to test connection including uncreated. </p></td>
+ </tr>
+
+ <tr>
+ <td>oauth2_context</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderTestRequestContext">OAuth2IdentityProviderTestRequestContext</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>accuracy</td>
- <td><a href="#int32">int32</a></td>
+ <td>oidc_context</td>
+ <td><a href="#bytebase.v1.OIDCIdentityProviderTestRequestContext">OIDCIdentityProviderTestRequestContext</a></td>
<td></td>
- <td><p>The accuracy is the number of digits after the decimal point. </p></td>
+ <td><p>OIDC authentication context for test connection. </p></td>
</tr>
</tbody>
@@ -18612,7 +17867,7 @@ accurately represents the timestamp with location information. </p></td>
- <h3 id="bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</h3>
+ <h3 id="bytebase.v1.TestIdentityProviderResponse">TestIdentityProviderResponse</h3>
<p></p>
@@ -18623,34 +17878,46 @@ accurately represents the timestamp with location information. </p></td>
<tbody>
<tr>
- <td>google_timestamp</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>zone</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;,
-&#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We
-retrieve the time zone information from the timestamptz field in the
-database. A timestamp is in UTC or epoch time, and with zone info, we can
-convert it to a local time string. Zone and offset are returned by
-time.Time.Zone() </p></td>
+ <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>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TestIdentityProviderResponse.ClaimsEntry">TestIdentityProviderResponse.ClaimsEntry</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>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The offset is in seconds east of UTC </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>accuracy</td>
- <td><a href="#int32">int32</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -18662,7 +17929,7 @@ time.Time.Zone() </p></td>
- <h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3>
+ <h3 id="bytebase.v1.TestIdentityProviderResponse.UserInfoEntry">TestIdentityProviderResponse.UserInfoEntry</h3>
<p></p>
@@ -18673,45 +17940,17 @@ time.Time.Zone() </p></td>
<tbody>
<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.
-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 `ListQueryHistory` call.
-Provide this to retrieve the subsequent page. </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 the filter to apply on the search query history
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator.
-- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
-- type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator.
-- statement: the SQL statement, support &#34;.matches()&#34; operator.
-
-For example:
-project == &#34;projects/{project}&#34;
-database == &#34;instances/{instance}/databases/{database}&#34;
-instance == &#34;instances/{instance}&#34;
-type == &#34;QUERY&#34;
-type == &#34;EXPORT&#34;
-statement.matches(&#34;select&#34;)
-type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -18721,7 +17960,7 @@ type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
- <h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</h3>
+ <h3 id="bytebase.v1.UpdateIdentityProviderRequest">UpdateIdentityProviderRequest</h3>
<p></p>
@@ -18732,19 +17971,28 @@ type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
<tbody>
<tr>
- <td>query_histories</td>
- <td><a href="#bytebase.v1.QueryHistory">QueryHistory</a></td>
- <td>repeated</td>
- <td><p>The list of history. </p></td>
+ <td>identity_provider</td>
+ <td><a href="#bytebase.v1.IdentityProvider">IdentityProvider</a></td>
+ <td></td>
+ <td><p>The identity provider to update.
+
+The identity provider&#39;s `name` field is used to identify the identity provider to update.
+Format: idps/{identity_provider} </p></td>
</tr>
<tr>
- <td>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 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>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 identity provider is not found, a new identity provider will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -18756,8 +18004,8 @@ Pass this value in the page_token field in the subsequent call to
- <h3 id="bytebase.v1.Advice.Level">Advice.Level</h3>
- <p>Level represents the severity level of the advice.</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>
@@ -18765,34 +18013,34 @@ Pass this value in the page_token field in the subsequent call to
<tbody>
<tr>
- <td>ADVICE_LEVEL_UNSPECIFIED</td>
+ <td>IDENTITY_PROVIDER_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified advice level.</p></td>
+ <td><p>Unspecified identity provider type.</p></td>
</tr>
<tr>
- <td>SUCCESS</td>
+ <td>OAUTH2</td>
<td>1</td>
- <td><p>Success status indicating the check passed without issues.</p></td>
+ <td><p>OAuth 2.0 authentication protocol.</p></td>
</tr>
<tr>
- <td>WARNING</td>
+ <td>OIDC</td>
<td>2</td>
- <td><p>Warning status indicating potential issues that should be reviewed.</p></td>
+ <td><p>OpenID Connect authentication protocol.</p></td>
</tr>
<tr>
- <td>ERROR</td>
+ <td>LDAP</td>
<td>3</td>
- <td><p>Error status indicating critical issues that must be addressed.</p></td>
+ <td><p>LDAP directory service authentication.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.Advice.RuleType">Advice.RuleType</h3>
- <p>RuleType indicates the source of the linting rule.</p>
+ <h3 id="bytebase.v1.LDAPIdentityProviderConfig.SecurityProtocol">LDAPIdentityProviderConfig.SecurityProtocol</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -18800,29 +18048,27 @@ Pass this value in the page_token field in the subsequent call to
<tbody>
<tr>
- <td>RULE_TYPE_UNSPECIFIED</td>
+ <td>SECURITY_PROTOCOL_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified rule type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>PARSER_BASED</td>
+ <td>START_TLS</td>
<td>1</td>
- <td><p>Parser-based rule enforced by the built-in SQL parser.
-These are non-configurable, mandatory checks for schema health.</p></td>
+ <td><p>StartTLS is the security protocol that starts with an unencrypted connection and then upgrades to TLS.</p></td>
</tr>
<tr>
- <td>AI_POWERED</td>
+ <td>LDAPS</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>
+ <td><p>LDAPS is the security protocol that uses TLS from the beginning.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.QueryHistory.Type">QueryHistory.Type</h3>
+ <h3 id="bytebase.v1.OAuth2AuthStyle">OAuth2AuthStyle</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -18831,266 +18077,123 @@ These are custom, flexible checks powered by AI models.</p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>OAUTH2_AUTH_STYLE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified query history type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>QUERY</td>
+ <td>IN_PARAMS</td>
<td>1</td>
- <td><p>Query execution for data retrieval.</p></td>
+ <td><p>IN_PARAMS sends the &#34;client_id&#34; and &#34;client_secret&#34; in the POST body
+as application/x-www-form-urlencoded parameters.</p></td>
</tr>
<tr>
- <td>EXPORT</td>
+ <td>IN_HEADER</td>
<td>2</td>
- <td><p>Data export operation to file.</p></td>
+ <td><p>IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.
+This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</h3>
- <p></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>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>MSSQL_EXPLAIN_FORMAT_UNSPECIFIED</td>
- <td>0</td>
- <td><p>defaults to SHOWPLAN_ALL</p></td>
+ <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>MSSQL_EXPLAIN_FORMAT_ALL</td>
- <td>1</td>
- <td><p>SHOWPLAN_ALL</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>MSSQL_EXPLAIN_FORMAT_XML</td>
- <td>2</td>
- <td><p>SHOWPLAN_XML</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>
- </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>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>SINGLE_NODE</td>
- <td>1</td>
- <td><p>Execute Redis commands on a single node in the cluster.</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>ALL_NODES</td>
- <td>2</td>
- <td><p>Execute Redis commands on all nodes in the cluster for cluster-wide operations.</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>
</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>
-
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>LEVEL_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified message level.</p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</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.SQLService">SQLService</h3>
- <p>SQLService executes SQL queries and manages query operations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>Query</td>
- <td><a href="#bytebase.v1.QueryRequest">QueryRequest</a></td>
- <td><a href="#bytebase.v1.QueryResponse">QueryResponse</a></td>
- <td><p>Executes a read-only SQL query against a database.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>AdminExecute</td>
- <td><a href="#bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</a> stream</td>
- <td><a href="#bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</a> stream</td>
- <td><p>Executes SQL with admin privileges via streaming connection.
-Permissions required: bb.sql.admin</p></td>
- </tr>
-
- <tr>
- <td>SearchQueryHistories</td>
- <td><a href="#bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</a></td>
- <td><a href="#bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</a></td>
- <td><p>SearchQueryHistories searches query histories for the caller.
-Permissions required: None (only returns caller&#39;s own query histories)</p></td>
- </tr>
-
- <tr>
- <td>Export</td>
- <td><a href="#bytebase.v1.ExportRequest">ExportRequest</a></td>
- <td><a href="#bytebase.v1.ExportResponse">ExportResponse</a></td>
- <td><p>Exports query results to a file format.
-Permissions required: bb.databases.get</p></td>
- </tr>
-
- <tr>
- <td>DiffMetadata</td>
- <td><a href="#bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</a></td>
- <td><a href="#bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</a></td>
- <td><p>Computes schema differences between two database metadata.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>AICompletion</td>
- <td><a href="#bytebase.v1.AICompletionRequest">AICompletionRequest</a></td>
- <td><a href="#bytebase.v1.AICompletionResponse">AICompletionResponse</a></td>
- <td><p>Provides AI-powered SQL completion and generation.
-Permissions required: None (authenticated users only, requires AI to be enabled)</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
+ </thead>
+ <tbody>
<tr>
- <td>Query</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:query</td>
- <td>*</td>
+ <td>GetIdentityProvider</td>
+ <td>GET</td>
+ <td>/v1/{name=idps/*}</td>
+ <td></td>
</tr>
<tr>
- <td>AdminExecute</td>
+ <td>ListIdentityProviders</td>
<td>GET</td>
- <td>/v1:adminExecute</td>
+ <td>/v1/idps</td>
<td></td>
</tr>
@@ -19098,53 +18201,39 @@ Permissions required: None (authenticated users only, requires AI to be enabled)
<tr>
- <td>SearchQueryHistories</td>
+ <td>CreateIdentityProvider</td>
<td>POST</td>
- <td>/v1/queryHistories:search</td>
- <td>*</td>
+ <td>/v1/idps</td>
+ <td>identity_provider</td>
</tr>
<tr>
- <td>Export</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:export</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>Export</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/rollouts/*}:export</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>Export</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/rollouts/*/stages/*}:export</td>
- <td>*</td>
+ <td>UpdateIdentityProvider</td>
+ <td>PATCH</td>
+ <td>/v1/{identity_provider.name=idps/*}</td>
+ <td>identity_provider</td>
</tr>
<tr>
- <td>DiffMetadata</td>
- <td>POST</td>
- <td>/v1/schemaDesign:diffMetadata</td>
- <td>*</td>
+ <td>DeleteIdentityProvider</td>
+ <td>DELETE</td>
+ <td>/v1/{name=idps/*}</td>
+ <td></td>
</tr>
<tr>
- <td>AICompletion</td>
+ <td>TestIdentityProvider</td>
<td>POST</td>
- <td>/v1/sql/aiCompletion</td>
+ <td>/v1/idps/*:test</td>
<td>*</td>
</tr>
@@ -19156,12 +18245,12 @@ 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/org_policy_service.proto">v1/org_policy_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</h3>
+ <h3 id="bytebase.v1.CreatePolicyRequest">CreatePolicyRequest</h3>
<p></p>
@@ -19172,50 +18261,28 @@ Permissions required: None (authenticated users only, requires AI to be enabled)
<tbody>
<tr>
- <td>name</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the plan check run to cancel.
-Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
+ <td><p>The parent resource where this instance will be created.
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</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>policy</td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
<td></td>
- <td><p>The parent project where this plan will be created.
-Format: projects/{project} </p></td>
+ <td><p>The policy to create. </p></td>
</tr>
<tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
<td></td>
- <td><p>The plan to create. </p></td>
+ <td><p>The type of policy to create. </p></td>
</tr>
</tbody>
@@ -19225,7 +18292,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</h3>
+ <h3 id="bytebase.v1.DeletePolicyRequest">DeletePolicyRequest</h3>
<p></p>
@@ -19239,8 +18306,12 @@ Format: projects/{project} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the plan check run to retrieve.
-Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
+ <td><p>The policy&#39;s `name` field is used to identify the instance to update.
+Format: {resource name}/policies/{policy type}
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
</tbody>
@@ -19250,7 +18321,7 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
- <h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3>
+ <h3 id="bytebase.v1.GetPolicyRequest">GetPolicyRequest</h3>
<p></p>
@@ -19264,8 +18335,8 @@ Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the plan to retrieve.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td><p>The name of the policy to retrieve.
+Format: {resource type}/{resource id}/policies/{policy type} </p></td>
</tr>
</tbody>
@@ -19275,7 +18346,7 @@ Format: projects/{project}/plans/{plan} </p></td>
- <h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3>
+ <h3 id="bytebase.v1.ListPoliciesRequest">ListPoliciesRequest</h3>
<p></p>
@@ -19289,55 +18360,22 @@ Format: projects/{project}/plans/{plan} </p></td>
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of plans.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list all plans from all projects. </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></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 parent, which owns this collection of policies.
+Format: {resource type}/{resource id} </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 `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>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>filter</td>
- <td><a href="#string">string</a></td>
+ <td>show_deleted</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 &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
-- create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-- has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
-- has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
-- title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match.
-- spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;.
-- state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
-
-For example:
-creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
-has_rollout == false &amp;&amp; has_issue == true
-title == &#34;My Plan&#34;
-title.matches(&#34;database migration&#34;)
-spec_type == &#34;change_database_config&#34;
-state == &#34;ACTIVE&#34; </p></td>
+ <td><p>Show deleted policies if specified. </p></td>
</tr>
</tbody>
@@ -19347,7 +18385,7 @@ state == &#34;ACTIVE&#34; </p></td>
- <h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3>
+ <h3 id="bytebase.v1.ListPoliciesResponse">ListPoliciesResponse</h3>
<p></p>
@@ -19358,18 +18396,10 @@ state == &#34;ACTIVE&#34; </p></td>
<tbody>
<tr>
- <td>plans</td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td>policies</td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
<td>repeated</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>
+ <td><p>The policies from the specified request. </p></td>
</tr>
</tbody>
@@ -19379,8 +18409,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Plan">Plan</h3>
- <p></p>
+ <h3 id="bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</h3>
+ <p>MaskingExemptionPolicy is the allowlist of users who can access sensitive data.</p>
<table class="field-table">
@@ -19390,91 +18420,12 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>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>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>exemptions</td>
+ <td><a href="#bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</a></td>
<td>repeated</td>
- <td><p>The deployment specs for the plan. </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
<td><p> </p></td>
</tr>
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>plan_check_run_status_count</td>
- <td><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</a></td>
- <td>repeated</td>
- <td><p>The status count of the latest plan check runs.
-Keys are:
-- SUCCESS
-- WARNING
-- ERROR
-- RUNNING </p></td>
- </tr>
-
- <tr>
- <td>has_rollout</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the plan has started the rollout. </p></td>
- </tr>
-
</tbody>
</table>
@@ -19482,7 +18433,7 @@ Keys are:
- <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3>
+ <h3 id="bytebase.v1.MaskingExemptionPolicy.Exemption">MaskingExemptionPolicy.Exemption</h3>
<p></p>
@@ -19493,49 +18444,34 @@ Keys are:
<tbody>
<tr>
- <td>targets</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The list of targets.
-Multi-database format: [instances/{instance-id}/databases/{database-name}].
-Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. </p></td>
- </tr>
-
- <tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
+ <td>members</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the release.
-Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- <tr>
- <td>ghost_flags</td>
- <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</a></td>
<td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>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>
+ <td><p>Specifies the principals who are exempt from masking.
+For users, the member should be: user:{email}
+For groups, the member should be: group:{email} </p></td>
</tr>
<tr>
- <td>enable_ghost</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 to use gh-ost for online schema migration. </p></td>
+ <td><p>The condition that is associated with this exception policy instance.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+If the condition is empty, means the user can access all databases without expiration.
+
+Support variables:
+resource.instance_id: the instance resource id. Only support &#34;==&#34; operation.
+resource.database_name: the database name. Only support &#34;==&#34; operation.
+resource.schema_name: the schema name. Only support &#34;==&#34; operation.
+resource.table_name: the table name. Only support &#34;==&#34; operation.
+resource.column_name: the column name. Only support &#34;==&#34; operation.
+request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`
+All variables should join with &#34;&amp;&amp;&#34; condition.
+
+For example:
+resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; request.time &lt; timestamp(&#34;2025-04-30T11:10:39.000Z&#34;)
+resource.instance_id == &#34;local&#34; &amp;&amp; resource.database_name == &#34;employee&#34; </p></td>
</tr>
</tbody>
@@ -19545,8 +18481,8 @@ Format: projects/{project}/releases/{release} </p></td>
- <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.MaskingRulePolicy">MaskingRulePolicy</h3>
+ <p>Policy for configuring data masking rules.</p>
<table class="field-table">
@@ -19556,17 +18492,10 @@ 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>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>
@@ -19576,8 +18505,8 @@ Format: projects/{project}/releases/{release} </p></td>
- <h3 id="bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</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">
@@ -19587,62 +18516,138 @@ Format: projects/{project}/releases/{release} </p></td>
<tbody>
<tr>
- <td>target</td>
+ <td>id</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>A unique identifier for the rule in UUID format. </p></td>
</tr>
<tr>
- <td>database</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>The name of the database to create. </p></td>
+ <td><p>The condition for the masking rule.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Support variables:
+resource.environment_id: the environment resource id.
+resource.project_id: the project resource id.
+resource.instance_id: the instance resource id.
+resource.database_name: the database name.
+resource.table_name: the table name.
+resource.column_name: the column name.
+resource.classification_level: the classification level.
+
+Each variable support following operations:
+==: the value equals the target.
+!=: the value not equals the target.
+in: the value matches one of the targets.
+!(in): the value not matches any of the targets.
+
+For example:
+resource.environment_id == &#34;test&#34; &amp;&amp; resource.project_id == &#34;sample-project&#34;
+resource.instance_id == &#34;sample-instance&#34; &amp;&amp; resource.database_name == &#34;employee&#34; &amp;&amp; resource.table_name in [&#34;table1&#34;, &#34;table2&#34;]
+resource.environment_id != &#34;test&#34; || !(resource.project_id in [&#34;poject1&#34;, &#34;prject2&#34;])
+resource.instance_id == &#34;sample-instance&#34; &amp;&amp; (resource.database_name == &#34;db1&#34; || resource.database_name == &#34;db2&#34;) </p></td>
</tr>
<tr>
- <td>table</td>
+ <td>semantic_type</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 semantic type of data to mask (e.g., &#34;SSN&#34;, &#34;EMAIL&#34;). </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Policy">Policy</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>character_set</td>
+ <td>name</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 name of the policy.
+Format: {resource name}/policies/{policy type}
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
<tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
+ <td>inherit_from_parent</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>collation is the collation of the database. </p></td>
+ <td><p>Whether this policy inherits from its parent resource. </p></td>
</tr>
<tr>
- <td>cluster</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PolicyType">PolicyType</a></td>
<td></td>
- <td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. </p></td>
+ <td><p>The type of policy. </p></td>
</tr>
<tr>
- <td>owner</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>owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>environment</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 environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>masking_exemption_policy</td>
+ <td><a href="#bytebase.v1.MaskingExemptionPolicy">MaskingExemptionPolicy</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>tag_policy</td>
+ <td><a href="#bytebase.v1.TagPolicy">TagPolicy</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>query_data_policy</td>
+ <td><a href="#bytebase.v1.QueryDataPolicy">QueryDataPolicy</a></td>
+ <td></td>
+ <td><p> </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>
+ </tr>
+
+ <tr>
+ <td>resource_type</td>
+ <td><a href="#bytebase.v1.PolicyResourceType">PolicyResourceType</a></td>
+ <td></td>
+ <td><p>The resource type for the policy. </p></td>
</tr>
</tbody>
@@ -19652,8 +18657,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.QueryDataPolicy">QueryDataPolicy</h3>
+ <p>QueryDataPolicy is the policy configuration for querying data.</p>
<table class="field-table">
@@ -19663,35 +18668,61 @@ 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>
+ <td>timeout</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The query timeout duration. </p></td>
</tr>
<tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
+ <td>disable_export</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The resource name of the sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>Disable data export in the SQL editor. </p></td>
</tr>
<tr>
- <td>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td>maximum_result_size</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The format of the exported file. </p></td>
+ <td><p>The maximum result size limit in bytes.
+The default value is 100MB, we will use the default value if the setting not exists, or the limit &lt;= 0. </p></td>
</tr>
<tr>
- <td>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>maximum_result_rows</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of rows to return.
+The default value is -1, means no limit. </p></td>
+ </tr>
+
+ <tr>
+ <td>disable_copy_data</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Disable copying query results. </p></td>
+ </tr>
+
+ <tr>
+ <td>admin_data_source_restriction</td>
+ <td><a href="#bytebase.v1.QueryDataPolicy.Restriction">QueryDataPolicy.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>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>
@@ -19701,8 +18732,8 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
- <h3 id="bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.RolloutPolicy">RolloutPolicy</h3>
+ <p>Rollout policy configuration.</p>
<table class="field-table">
@@ -19712,17 +18743,17 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
+ <td>automatic</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Whether rollout is automatic without manual approval. </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>
</tbody>
@@ -19732,8 +18763,8 @@ Leave it empty if no needs to encrypt the zip file. </p></td>
- <h3 id="bytebase.v1.Plan.Spec">Plan.Spec</h3>
- <p></p>
+ <h3 id="bytebase.v1.TagPolicy">TagPolicy</h3>
+ <p>Policy for tagging resources with metadata.</p>
<table class="field-table">
@@ -19743,29 +18774,40 @@ 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>
+ <td>tags</td>
+ <td><a href="#bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td>
+ <td>repeated</td>
+ <td><p>tags is the key - value map for resources.
+for example, the environment resource can have the sql review config tag, like &#34;bb.tag.review_config&#34;: &#34;reviewConfigs/{review config resource id}&#34; </p></td>
</tr>
- <tr>
- <td>create_database_config</td>
- <td><a href="#bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TagPolicy.TagsEntry">TagPolicy.TagsEntry</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>change_database_config</td>
- <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</a></td>
+ <td>key</td>
+ <td><a href="#string">string</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>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -19777,7 +18819,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.UpdatePolicyRequest">UpdatePolicyRequest</h3>
<p></p>
@@ -19788,242 +18830,17 @@ 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>policy</td>
+ <td><a href="#bytebase.v1.Policy">Policy</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
- </tr>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td>
- <td></td>
- <td><p> </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>error</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>error is set if the Status is FAILED. </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>content</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>code</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Target identification for consolidated results.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sql_summary_report</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sql_review_report</td>
- <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
- <td></td>
- <td><p>Position of the SQL statement. </p></td>
- </tr>
-
- <tr>
- <td>end_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>statement_types</td>
- <td><a href="#bytebase.v1.StatementType">StatementType</a></td>
- <td>repeated</td>
- <td><p>statement_types are the types of statements that are found in the sql. </p></td>
- </tr>
-
- <tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The plan to run plan checks.
-Format: projects/{project}/plans/{plan} </p></td>
- </tr>
-
- <tr>
- <td>spec_id</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The UUID of the specific spec to run plan checks for.
-This should match the spec.id field in Plan.Spec.
-If not set, all specs in the plan will be used. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.Plan">Plan</a></td>
- <td></td>
- <td><p>The plan to update.
+ <td><p>The policy to update.
-The plan&#39;s `name` field is used to identify the plan to update.
-Format: projects/{project}/plans/{plan} </p></td>
+The policy&#39;s `name` field is used to identify the instance to update.
+Format: {resource name}/policies/{policy type}
+Workspace resource name: &#34;&#34;.
+Environment resource name: environments/environment-id.
+Instance resource name: instances/instance-id.
+Database resource name: instances/instance-id/databases/database-name. </p></td>
</tr>
<tr>
@@ -20037,7 +18854,7 @@ Format: projects/{project}/plans/{plan} </p></td>
<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.
+ <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>
@@ -20050,8 +18867,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</h3>
- <p></p>
+ <h3 id="bytebase.v1.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>
@@ -20059,34 +18876,34 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>RESOURCE_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified resource type.</p></td>
</tr>
<tr>
- <td>STATEMENT_ADVISE</td>
+ <td>WORKSPACE</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Workspace-level policy.</p></td>
</tr>
<tr>
- <td>STATEMENT_SUMMARY_REPORT</td>
+ <td>ENVIRONMENT</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Environment-level policy.</p></td>
</tr>
<tr>
- <td>GHOST_SYNC</td>
+ <td>PROJECT</td>
<td>3</td>
- <td><p></p></td>
+ <td><p>Project-level policy.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</h3>
- <p></p>
+ <h3 id="bytebase.v1.PolicyType">PolicyType</h3>
+ <p>The type of organizational policy.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -20094,105 +18911,123 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>STATUS_UNSPECIFIED</td>
+ <td>POLICY_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified policy type.</p></td>
</tr>
<tr>
- <td>RUNNING</td>
+ <td>MASKING_RULE</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Data masking rule policy.</p></td>
</tr>
<tr>
- <td>DONE</td>
+ <td>MASKING_EXEMPTION</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Data masking exemption policy.</p></td>
</tr>
<tr>
- <td>FAILED</td>
+ <td>ROLLOUT_POLICY</td>
<td>3</td>
- <td><p></p></td>
+ <td><p>Rollout deployment policy.</p></td>
</tr>
<tr>
- <td>CANCELED</td>
+ <td>TAG</td>
<td>4</td>
- <td><p></p></td>
+ <td><p>Resource tag policy.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATA_QUERY</td>
+ <td>6</td>
+ <td><p>Query data access policy.</p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h3 id="bytebase.v1.PlanService">PlanService</h3>
- <p>PlanService manages deployment plans for database changes.</p>
+ <h3 id="bytebase.v1.QueryDataPolicy.Restriction">QueryDataPolicy.Restriction</h3>
+ <p>Restriction level for admin data source access.</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>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>RESTRICTION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified restriction.</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>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>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>DISALLOW</td>
+ <td>2</td>
+ <td><p>Disallow querying admin data sources.</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>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>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>GetPlanCheckRun</td>
- <td><a href="#bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</a></td>
- <td><a href="#bytebase.v1.PlanCheckRun">PlanCheckRun</a></td>
- <td><p>Gets the plan check run for a deployment plan.
-Permissions required: bb.planCheckRuns.get</p></td>
+ <td>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>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>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>CancelPlanCheckRun</td>
- <td><a href="#bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</a></td>
- <td><a href="#bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</a></td>
- <td><p>Cancels the plan check run for a deployment plan.
-Permissions required: bb.planCheckRuns.run</p></td>
+ <td>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>
@@ -20216,49 +19051,75 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>GetPlan</td>
+ <td>GetPolicy</td>
<td>GET</td>
- <td>/v1/{name=projects/*/plans/*}</td>
+ <td>/v1/{name=policies/*}</td>
<td></td>
</tr>
-
-
-
<tr>
- <td>ListPlans</td>
+ <td>GetPolicy</td>
<td>GET</td>
- <td>/v1/{parent=projects/*}/plans</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>CreatePlan</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/plans</td>
- <td>plan</td>
+ <td>GetPolicy</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/policies/*}</td>
+ <td></td>
</tr>
<tr>
- <td>UpdatePlan</td>
- <td>PATCH</td>
- <td>/v1/{plan.name=projects/*/plans/*}</td>
- <td>plan</td>
+ <td>ListPolicies</td>
+ <td>GET</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>GetPlanCheckRun</td>
+ <td>ListPolicies</td>
<td>GET</td>
- <td>/v1/{name=projects/*/plans/*/planCheckRun}</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>
@@ -20266,75 +19127,130 @@ Permissions required: bb.planCheckRuns.run</p></td>
<tr>
- <td>RunPlanChecks</td>
+ <td>CreatePolicy</td>
<td>POST</td>
- <td>/v1/{name=projects/*/plans/*}:runPlanChecks</td>
- <td>*</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>CancelPlanCheckRun</td>
+ <td>CreatePolicy</td>
<td>POST</td>
- <td>/v1/{name=projects/*/plans/*/planCheckRun}:cancel</td>
- <td>*</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>
- </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>
- <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>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>
- </tr>
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=projects/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=environments/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=instances/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+ <tr>
+ <td>UpdatePolicy</td>
+ <td>PATCH</td>
+ <td>/v1/{policy.name=instances/*/databases/*/policies/*}</td>
+ <td>policy</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeletePolicy</td>
+ <td>DELETE</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>DeletePolicy</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*/databases/*/policies/*}</td>
+ <td></td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>
+ <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>
@@ -20345,23 +19261,10 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>names</td>
- <td><a href="#string">string</a></td>
+ <td>messages</td>
+ <td><a href="#bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</a></td>
<td>repeated</td>
- <td><p>The names of the projects to delete.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>purge</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, permanently purge the soft-deleted projects and all related resources.
-This operation is irreversible. Following AIP-165, this should only be used for
-administrative cleanup of old soft-deleted projects.
-All projects must already be soft-deleted for this to work.
-When purge=true, all databases will be moved to the default project before deletion.
-When purge=false (soft delete/archive), the projects and their databases/issues remain unchanged. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -20371,7 +19274,7 @@ When purge=false (soft delete/archive), the projects and their databases/issues
- <h3 id="bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</h3>
+ <h3 id="bytebase.v1.AICompletionRequest.Message">AICompletionRequest.Message</h3>
<p></p>
@@ -20382,11 +19285,17 @@ When purge=false (soft delete/archive), the projects and their databases/issues
<tbody>
<tr>
- <td>names</td>
+ <td>role</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The names of projects to retrieve.
-Format: projects/{project} </p></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -20396,7 +19305,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</h3>
+ <h3 id="bytebase.v1.AICompletionResponse">AICompletionResponse</h3>
<p></p>
@@ -20407,10 +19316,11 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>candidates</td>
+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</a></td>
<td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
+ <td><p>candidates is used for results with multiple choices and candidates. Used
+for OpenAI and Gemini. </p></td>
</tr>
</tbody>
@@ -20420,7 +19330,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3>
+ <h3 id="bytebase.v1.AICompletionResponse.Candidate">AICompletionResponse.Candidate</h3>
<p></p>
@@ -20431,21 +19341,10 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>project</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td></td>
- <td><p>The project to create. </p></td>
- </tr>
-
- <tr>
- <td>project_id</td>
- <td><a href="#string">string</a></td>
+ <td>content</td>
+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</a></td>
<td></td>
- <td><p>The ID to use for the project, which will become the final component of
-the project&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -20455,7 +19354,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3>
+ <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content">AICompletionResponse.Candidate.Content</h3>
<p></p>
@@ -20466,23 +19365,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the project to delete.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>purge</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>If set to true, permanently purge the soft-deleted project and all related resources.
-This operation is irreversible. Following AIP-165, this should only be used for
-administrative cleanup of old soft-deleted projects.
-The project must already be soft-deleted for this to work.
-When purge=true, all databases will be moved to the default project before deletion.
-When purge=false (soft delete/archive), the project and its databases/issues remain unchanged. </p></td>
+ <td>parts</td>
+ <td><a href="#bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</a></td>
+ <td>repeated</td>
+ <td><p>parts is used for a result content with multiple parts. </p></td>
</tr>
</tbody>
@@ -20492,7 +19378,7 @@ When purge=false (soft delete/archive), the project and its databases/issues rem
- <h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</h3>
+ <h3 id="bytebase.v1.AICompletionResponse.Candidate.Content.Part">AICompletionResponse.Candidate.Content.Part</h3>
<p></p>
@@ -20503,11 +19389,10 @@ When purge=false (soft delete/archive), the project and its databases/issues rem
<tbody>
<tr>
- <td>name</td>
+ <td>text</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to retrieve.
-Format: projects/{project} </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -20517,8 +19402,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.Label">Label</h3>
- <p>A label for categorizing and organizing issues.</p>
+ <h3 id="bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</h3>
+ <p></p>
<table class="field-table">
@@ -20528,24 +19413,41 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>value</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The label value/name. </p></td>
+ <td><p>The name is the instance name to execute the query against.
+Format: instances/{instance}/databases/{databaseName} </p></td>
</tr>
<tr>
- <td>color</td>
+ <td>statement</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The color code for the label (e.g., hex color). </p></td>
+ <td><p>The SQL statement to execute. </p></td>
</tr>
<tr>
- <td>group</td>
- <td><a href="#string">string</a></td>
+ <td>limit</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The group this label belongs to. </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>
@@ -20555,7 +19457,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</h3>
+ <h3 id="bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</h3>
<p></p>
@@ -20566,94 +19468,20 @@ 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>
+ <td>results</td>
+ <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
+ <td>repeated</td>
+ <td><p>The query results. </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 `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>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter the project.
-Check filter for SearchProjectsRequest for details.
-Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). </p></td>
- </tr>
-
- <tr>
- <td>order_by</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The order by of projects.
-Support title. The default sorting order is ascending.
-For example:
-- order_by = &#34;title&#34;
-- order_by = &#34;title desc&#34;
-- order_by = &#34;title asc&#34; </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
- </tr>
-
- </tbody>
- </table>
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.Project">Project</h3>
+ <h3 id="bytebase.v1.Advice">Advice</h3>
<p></p>
@@ -20664,148 +19492,197 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
<td></td>
- <td><p>The name of the project.
-Format: projects/{project} </p></td>
+ <td><p>The advice level. </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>code</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The lifecycle state of the project. </p></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 title or name of a project. It&#39;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>The advice title. </p></td>
</tr>
<tr>
- <td>data_classification_config_id</td>
+ <td>content</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The data classification configuration ID for the project. </p></td>
+ <td><p>The advice content. </p></td>
</tr>
<tr>
- <td>issue_labels</td>
- <td><a href="#bytebase.v1.Label">Label</a></td>
- <td>repeated</td>
- <td><p>Labels available for tagging issues in this project. </p></td>
+ <td>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>force_issue_labels</td>
- <td><a href="#bool">bool</a></td>
+ <td>end_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
<td></td>
- <td><p>Force issue labels to be used when creating an issue. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>enforce_issue_title</td>
- <td><a href="#bool">bool</a></td>
+ <td>rule_type</td>
+ <td><a href="#bytebase.v1.Advice.RuleType">Advice.RuleType</a></td>
<td></td>
- <td><p>Enforce issue title to be created by user instead of generated by Bytebase. </p></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>auto_enable_backup</td>
- <td><a href="#bool">bool</a></td>
+ <td>source_metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
<td></td>
- <td><p>Whether to automatically enable backup for database changes. </p></td>
+ <td><p>The metadata of the source schema. </p></td>
</tr>
<tr>
- <td>skip_backup_errors</td>
- <td><a href="#bool">bool</a></td>
+ <td>target_metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
<td></td>
- <td><p>Whether to skip backup errors and continue with data migration. </p></td>
+ <td><p>The metadata of the target schema. </p></td>
</tr>
<tr>
- <td>postgres_database_tenant_mode</td>
- <td><a href="#bool">bool</a></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
<td></td>
- <td><p>Whether to enable database tenant mode for PostgreSQL.
-If enabled, issues will include &#34;set role &lt;db_owner&gt;&#34; statement. </p></td>
+ <td><p>The 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>allow_self_approval</td>
- <td><a href="#bool">bool</a></td>
+ <td>diff</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to allow issue creators to self-approve their own issues. </p></td>
+ <td><p>The diff of the metadata. </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>execution_retry_policy</td>
- <td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Execution retry policy for task runs. </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>ci_sampling_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of database rows to sample during CI data validation.
-Without specification, sampling is disabled, resulting in full validation. </p></td>
+ <td><p>The SQL statement to execute. </p></td>
</tr>
<tr>
- <td>parallel_tasks_per_rollout</td>
+ <td>limit</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td>
+ <td><p>The maximum number of rows to return. </p></td>
</tr>
<tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>Labels are key-value pairs that can be attached to the project.
-For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } </p></td>
+ <td>format</td>
+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td></td>
+ <td><p>The export format. </p></td>
</tr>
<tr>
- <td>enforce_sql_review</td>
+ <td>admin</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>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>require_issue_approval</td>
- <td><a href="#bool">bool</a></td>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to require issue approval before rollout. </p></td>
+ <td><p>The zip password provide by users. </p></td>
</tr>
<tr>
- <td>require_plan_check_no_error</td>
- <td><a href="#bool">bool</a></td>
+ <td>data_source_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to require plan check to have no error before rollout. </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_request_role</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </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>
@@ -20815,8 +19692,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.ExportResponse">ExportResponse</h3>
+ <p></p>
<table class="field-table">
@@ -20826,10 +19703,10 @@ 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>content</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The maximum number of retries for lock timeout errors. </p></td>
+ <td><p>The export file content. </p></td>
</tr>
</tbody>
@@ -20839,7 +19716,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
- <h3 id="bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</h3>
+ <h3 id="bytebase.v1.MaskingReason">MaskingReason</h3>
<p></p>
@@ -20850,41 +19727,52 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
<tbody>
<tr>
- <td>key</td>
+ <td>semantic_type_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The semantic type that triggered masking (e.g., &#34;SSN&#34;, &#34;email&#34;, &#34;phone&#34;). </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>semantic_type_title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Human-readable semantic type title. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</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>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>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>algorithm</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The webhook to remove. Identified by its url. </p></td>
+ <td><p>The masking algorithm used. </p></td>
+ </tr>
+
+ <tr>
+ <td>context</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Additional context (e.g., &#34;Matched global rule: PII Protection&#34;). </p></td>
+ </tr>
+
+ <tr>
+ <td>classification_level</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Whether masking was due to classification level. </p></td>
+ </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>
@@ -20894,7 +19782,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.QueryHistory">QueryHistory</h3>
<p></p>
@@ -20905,73 +19793,61 @@ 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>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Show deleted projects if specified. </p></td>
+ <td><p>The name for the query history.
+Format: queryHistories/{uid} </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>database</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter the project.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- name: the project name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator.
-- state: check the State enum for the values, support &#34;==&#34; operator.
-- labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example:
-name == &#34;project name&#34;
-name.matches(&#34;project name&#34;)
-resource_id == &#34;project id&#34;
-resource_id.matches(&#34;project id&#34;)
-exclude_default == true
-state == &#34;DELETED&#34;
-labels.environment == &#34;production&#34;
-labels.tier == &#34;critical&#34;
-labels.environment in [&#34;staging&#34;, &#34;prod&#34;]
-You can combine filter conditions like:
-name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;)
-name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34;
-labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; </p></td>
+ <td><p>The database name to execute the query.
+Format: instances/{instance}/databases/{databaseName} </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of projects to return. The service may return fewer than
-this value.
-If unspecified, at most 10 projects will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>statement</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchProjects` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `SearchProjects` must match
-the call that provided the page token. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>order_by</td>
+ <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>The order by of projects.
-Support title. The default sorting order is ascending.
-For example:
-- order_by = &#34;title&#34;
-- order_by = &#34;title desc&#34;
-- order_by = &#34;title asc&#34; </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.QueryHistory.Type">QueryHistory.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -20981,7 +19857,7 @@ For example:
- <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>
+ <h3 id="bytebase.v1.QueryOption">QueryOption</h3>
<p></p>
@@ -20992,18 +19868,17 @@ For example:
<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>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>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>mssql_explain_format</td>
+ <td><a href="#bytebase.v1.QueryOption.MSSQLExplainFormat">QueryOption.MSSQLExplainFormat</a></td>
<td></td>
- <td><p>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>
@@ -21013,7 +19888,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>
+ <h3 id="bytebase.v1.QueryRequest">QueryRequest</h3>
<p></p>
@@ -21024,42 +19899,65 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>project</td>
+ <td>name</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>The name is the instance name to execute the query against.
+Format: instances/{instance}/databases/{databaseName} </p></td>
</tr>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The webhook to test. Identified by its url. </p></td>
+ <td><p>The SQL statement to execute. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>error</td>
+ <td>data_source_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>The id of data source.
+It is used for querying admin data source even if the instance has
+read-only data sources. Or it can be used to query a specific read-only
+data source. </p></td>
+ </tr>
+
+ <tr>
+ <td>explain</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Explain the statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The default schema to search objects. Equals to the current schema in
+Oracle and search path in Postgres. </p></td>
+ </tr>
+
+ <tr>
+ <td>query_option</td>
+ <td><a href="#bytebase.v1.QueryOption">QueryOption</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>container</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Container is the container name to execute the query against, used for
+CosmosDB only. </p></td>
</tr>
</tbody>
@@ -21069,7 +19967,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>
+ <h3 id="bytebase.v1.QueryResponse">QueryResponse</h3>
<p></p>
@@ -21080,11 +19978,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>results</td>
+ <td><a href="#bytebase.v1.QueryResult">QueryResult</a></td>
+ <td>repeated</td>
+ <td><p>The query results. </p></td>
</tr>
</tbody>
@@ -21094,7 +19991,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>
+ <h3 id="bytebase.v1.QueryResult">QueryResult</h3>
<p></p>
@@ -21105,28 +20002,89 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>project</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td></td>
- <td><p>The project to update.
-
-The project&#39;s `name` field is used to identify the project to update.
-Format: projects/{project} </p></td>
+ <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>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to update. </p></td>
+ <td>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>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <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>rows_count</td>
+ <td><a href="#int64">int64</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> </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The error message if the query failed. </p></td>
+ </tr>
+
+ <tr>
+ <td>latency</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The time it takes to execute the query. </p></td>
+ </tr>
+
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The query statement for the result. </p></td>
+ </tr>
+
+ <tr>
+ <td>postgres_error</td>
+ <td><a href="#bytebase.v1.QueryResult.PostgresError">QueryResult.PostgresError</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>syntax_error</td>
+ <td><a href="#bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>permission_denied</td>
+ <td><a href="#bytebase.v1.QueryResult.PermissionDenied">QueryResult.PermissionDenied</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>messages</td>
+ <td><a href="#bytebase.v1.QueryResult.Message">QueryResult.Message</a></td>
+ <td>repeated</td>
+ <td><p>Informational or debug messages returned by the database engine during query execution.
+Examples include PostgreSQL&#39;s RAISE NOTICE, MSSQL&#39;s PRINT, or Oracle&#39;s DBMS_OUTPUT.PUT_LINE. </p></td>
+ </tr>
+
+ <tr>
+ <td>masked</td>
+ <td><a href="#bytebase.v1.MaskingReason">MaskingReason</a></td>
+ <td>repeated</td>
+ <td><p>Masking reasons for each column (empty for non-masked columns). </p></td>
</tr>
</tbody>
@@ -21136,7 +20094,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3>
+ <h3 id="bytebase.v1.QueryResult.Message">QueryResult.Message</h3>
<p></p>
@@ -21147,25 +20105,53 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>level</td>
+ <td><a href="#bytebase.v1.QueryResult.Message.Level">QueryResult.Message.Level</a></td>
<td></td>
- <td><p>The webhook to modify. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>content</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>
+
+ </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>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>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>command_type</td>
+ <td><a href="#bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</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>Disallowed command_type. </p></td>
</tr>
</tbody>
@@ -21175,8 +20161,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.Webhook">Webhook</h3>
- <p></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>
<table class="field-table">
@@ -21186,56 +20172,122 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>severity</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>
+ <td><p> </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.WebhookType">WebhookType</a></td>
+ <td>code</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Webhook integration type.
-type is the type of the webhook. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>message</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>title is the title of the webhook. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>url</td>
+ <td>detail</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>
+ <td><p> </p></td>
</tr>
<tr>
- <td>direct_message</td>
- <td><a href="#bool">bool</a></td>
+ <td>hint</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>if direct_message is set, the notification is sent directly
-to the persons and url will be ignored.
-IM integration setting should be set for this function to work. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>notification_types</td>
- <td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>
- <td>repeated</td>
- <td><p>notification_types is the list of activities types that the webhook is interested in.
-Bytebase will only send notifications to the webhook if the activity type is in the list.
-It should not be empty, and should be a subset of the following:
-- ISSUE_CREATED
-- ISSUE_APPROVAL_REQUESTED
-- ISSUE_SENT_BACK
-- PIPELINE_FAILED
-- PIPELINE_COMPLETED </p></td>
+ <td>position</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></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>schema_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>table_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>column_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>data_type_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>constraint_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>file</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <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>
</tbody>
@@ -21245,411 +20297,157 @@ It should not be empty, and should be a subset of the following:
+ <h3 id="bytebase.v1.QueryResult.SyntaxError">QueryResult.SyntaxError</h3>
+ <p>Syntax error with position information for editor highlighting</p>
-
- <h3 id="bytebase.v1.Activity.Type">Activity.Type</h3>
- <p>Activity type enumeration.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_CREATED</td>
- <td>10</td>
- <td><p>ISSUE_CREATED represents a new issue creation event.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_APPROVAL_REQUESTED</td>
- <td>11</td>
- <td><p>ISSUE_APPROVAL_REQUESTED represents an approval request event.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_SENT_BACK</td>
- <td>12</td>
- <td><p>ISSUE_SENT_BACK represents an issue being sent back by an approver.</p></td>
- </tr>
-
- <tr>
- <td>PIPELINE_FAILED</td>
- <td>13</td>
- <td><p>PIPELINE_FAILED represents a pipeline failure event.</p></td>
- </tr>
-
- <tr>
- <td>PIPELINE_COMPLETED</td>
- <td>14</td>
- <td><p>PIPELINE_COMPLETED represents a pipeline completion event.</p></td>
- </tr>
-
- </tbody>
- </table>
-
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p>Position information for highlighting in editor </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
+
+
- <h3 id="bytebase.v1.ProjectService">ProjectService</h3>
- <p>ProjectService manages projects that group databases and changes.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetProject</td>
- <td><a href="#bytebase.v1.GetProjectRequest">GetProjectRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>GetProject retrieves a project by name.
-Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method.
-Permissions required: bb.projects.get</p></td>
- </tr>
-
- <tr>
- <td>BatchGetProjects</td>
- <td><a href="#bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</a></td>
- <td><p>BatchGetProjects retrieves multiple projects by their names.
-Permissions required: bb.projects.get</p></td>
- </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&#39;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>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.QueryRow">QueryRow</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>values</td>
+ <td><a href="#bytebase.v1.RowValue">RowValue</a></td>
+ <td>repeated</td>
+ <td><p>Row values of the query result. </p></td>
+ </tr>
- <tr>
- <td>GetProject</td>
- <td>GET</td>
- <td>/v1/{name=projects/*}</td>
- <td></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RowValue">RowValue</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
-
+ <tr>
+ <td>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>BatchGetProjects</td>
- <td>GET</td>
- <td>/v1/projects:batchGet</td>
- <td></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>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>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>RemoveWebhook</td>
- <td>POST</td>
- <td>/v1/{webhook.name=projects/*/webhooks/*}:removeWebhook</td>
- <td>*</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>TestWebhook</td>
- <td>POST</td>
- <td>/v1/{project=projects/*}:testWebhook</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>string_value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/release_service.proto">v1/release_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>uint32_value</td>
+ <td><a href="#uint32">uint32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>uint64_value</td>
+ <td><a href="#uint64">uint64</a></td>
<td></td>
- <td><p>Format: projects/{project} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>release</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td>value_value</td>
+ <td><a href="#google.protobuf.Value">google.protobuf.Value</a></td>
<td></td>
- <td><p>The release to check. </p></td>
+ <td><p>value_value is used for Spanner and TUPLE ARRAY MAP in Clickhouse only. </p></td>
</tr>
<tr>
- <td>targets</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The targets to dry-run the release.
-Can be database or databaseGroup.
-Format:
-projects/{project}/databaseGroups/{databaseGroup}
-instances/{instance}/databases/{database} </p></td>
+ <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>custom_rules</td>
- <td><a href="#string">string</a></td>
+ <td>timestamp_tz_value</td>
+ <td><a href="#bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</a></td>
<td></td>
- <td><p>Custom linting rules in natural language for AI-powered validation.
-Each rule should be a clear statement describing the desired schema constraint.
-Example: &#34;All tables must have a primary key&#34;
-Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
+ <td><p>timestamp_tz_value is used for the timestamptz data type, which
+accurately represents the timestamp with location information. </p></td>
</tr>
</tbody>
@@ -21659,7 +20457,7 @@ Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
- <h3 id="bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</h3>
+ <h3 id="bytebase.v1.RowValue.Timestamp">RowValue.Timestamp</h3>
<p></p>
@@ -21670,24 +20468,17 @@ Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
<tbody>
<tr>
- <td>results</td>
- <td><a href="#bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</a></td>
- <td>repeated</td>
- <td><p>The check results for each file and target combination. </p></td>
- </tr>
-
- <tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
+ <td>google_timestamp</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The total affected rows across all checks. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td>accuracy</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The aggregated risk level of the check. </p></td>
+ <td><p>The accuracy is the number of digits after the decimal point. </p></td>
</tr>
</tbody>
@@ -21697,8 +20488,8 @@ Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
- <h3 id="bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</h3>
- <p>Check result for a single release file on a target database.</p>
+ <h3 id="bytebase.v1.RowValue.TimestampTZ">RowValue.TimestampTZ</h3>
+ <p></p>
<table class="field-table">
@@ -21708,175 +20499,36 @@ Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
<tbody>
<tr>
- <td>file</td>
- <td><a href="#string">string</a></td>
+ <td>google_timestamp</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The file path that is being checked. </p></td>
- </tr>
-
- <tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The target that the check is performed on.
-Should be a database. Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>advices</td>
- <td><a href="#bytebase.v1.Advice">Advice</a></td>
- <td>repeated</td>
- <td><p>The list of advice for the file and the target. </p></td>
- </tr>
-
- <tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>The count of affected rows of the statement on the target. </p></td>
- </tr>
-
- <tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
- <td></td>
- <td><p>The risk level of the statement on the target. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td></td>
- <td><p>The release to create. </p></td>
- </tr>
-
- <tr>
- <td>train</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Train for iteration tracking (template rendered without {iteration}).
-Used to group releases and determine the next iteration number. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
+ <td>zone</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the release to delete.
-Format: projects/{project}/releases/{release} </p></td>
+ <td><p>Zone is the time zone abbreviations in timezone database such as &#34;PDT&#34;,
+&#34;PST&#34;. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones We
+retrieve the time zone information from the timestamptz field in the
+database. A timestamp is in UTC or epoch time, and with zone info, we can
+convert it to a local time string. Zone and offset are returned by
+time.Time.Zone() </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetReleaseRequest">GetReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>offset</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Format: projects/{project}/releases/{release} </p></td>
+ <td><p>The offset is in seconds east of UTC </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListReleaseCategoriesRequest">ListReleaseCategoriesRequest</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>accuracy</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Format: projects/{project} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListReleaseCategoriesResponse">ListReleaseCategoriesResponse</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>categories</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The unique category values in the project. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -21886,7 +20538,7 @@ Format: projects/{project}/releases/{release} </p></td>
- <h3 id="bytebase.v1.ListReleasesRequest">ListReleasesRequest</h3>
+ <h3 id="bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</h3>
<p></p>
@@ -21896,19 +20548,13 @@ Format: projects/{project}/releases/{release} </p></td>
</thead>
<tbody>
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project} </p></td>
- </tr>
-
<tr>
<td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of releases to return. The service may return fewer than this value.
-If unspecified, at most 10 releases will be returned.
+ <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>
@@ -21916,32 +20562,32 @@ 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 `ListReleases` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListReleases` must match
-the call that provided the page token. </p></td>
- </tr>
-
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted releases if specified. </p></td>
+ <td><p>A page token, received from a previous `ListQueryHistory` call.
+Provide this to retrieve the subsequent page. </p></td>
</tr>
<tr>
<td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter releases returned in the list.
+ <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 filters:
-- category: release category, support &#34;==&#34; operator.
+Supported filter:
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- database: the database full name in &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator.
+- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
+- type: the type, should be &#34;QUERY&#34; or &#34;EXPORT&#34;, support &#34;==&#34; operator.
+- statement: the SQL statement, support &#34;.matches()&#34; operator.
For example:
-category == &#34;webapp&#34; </p></td>
+project == &#34;projects/{project}&#34;
+database == &#34;instances/{instance}/databases/{database}&#34;
+instance == &#34;instances/{instance}&#34;
+type == &#34;QUERY&#34;
+type == &#34;EXPORT&#34;
+statement.matches(&#34;select&#34;)
+type == &#34;QUERY&#34; &amp;&amp; statement.matches(&#34;select&#34;) </p></td>
</tr>
</tbody>
@@ -21951,7 +20597,7 @@ category == &#34;webapp&#34; </p></td>
- <h3 id="bytebase.v1.ListReleasesResponse">ListReleasesResponse</h3>
+ <h3 id="bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</h3>
<p></p>
@@ -21962,18 +20608,19 @@ category == &#34;webapp&#34; </p></td>
<tbody>
<tr>
- <td>releases</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td>query_histories</td>
+ <td><a href="#bytebase.v1.QueryHistory">QueryHistory</a></td>
<td>repeated</td>
- <td><p>The releases from the specified request. </p></td>
+ <td><p>The list of history. </p></td>
</tr>
<tr>
<td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>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>
@@ -21983,234 +20630,10 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Release">Release</h3>
- <p></p>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- <tr>
- <td>category</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Category extracted from release name (e.g., &#34;webapp&#34;, &#34;analytics&#34;).
-Set by Bytebase action during release creation. </p></td>
- </tr>
-
- <tr>
- <td>files</td>
- <td><a href="#bytebase.v1.Release.File">Release.File</a></td>
- <td>repeated</td>
- <td><p>The SQL files included in the release. </p></td>
- </tr>
-
- <tr>
- <td>vcs_source</td>
- <td><a href="#bytebase.v1.Release.VCSSource">Release.VCSSource</a></td>
- <td></td>
- <td><p>The version control source of the release. </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The lifecycle state of the release. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Release.Type">Release.Type</a></td>
- <td></td>
- <td><p>The type of schema change for all files in this release. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Release.File">Release.File</h3>
- <p>A SQL file in a release.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>path</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The path of the file. e.g., `2.2/V0001_create_table.sql`. </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version identifier for the file. </p></td>
- </tr>
-
- <tr>
- <td>enable_ghost</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to use gh-ost for online schema migration. </p></td>
- </tr>
-
- <tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>For inputs, we must either use `sheet` or `statement`.
-For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
-
-The sheet that holds the content.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The raw SQL statement content. </p></td>
- </tr>
-
- <tr>
- <td>sheet_sha256</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SHA256 hash value of the sheet content or the statement. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Release.VCSSource">Release.VCSSource</h3>
- <p>Version control system source information.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>vcs_type</td>
- <td><a href="#bytebase.v1.VCSType">VCSType</a></td>
- <td></td>
- <td><p>The type of VCS. </p></td>
- </tr>
-
- <tr>
- <td>url</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The url link to the e.g., GitHub commit or pull request. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the deleted release.
-Format: projects/{project}/releases/{release} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>release</td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td></td>
- <td><p>The release to update. </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to be updated. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
- <h3 id="bytebase.v1.Release.Type">Release.Type</h3>
- <p>The type of schema change.</p>
+ <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>
@@ -22218,263 +20641,403 @@ Format: projects/{project}/releases/{release} </p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>ADVICE_LEVEL_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified type.</p></td>
+ <td><p>Unspecified advice level.</p></td>
</tr>
<tr>
- <td>VERSIONED</td>
+ <td>SUCCESS</td>
<td>1</td>
- <td><p>Versioned schema migration.</p></td>
+ <td><p>Success status indicating the check passed without issues.</p></td>
</tr>
<tr>
- <td>DECLARATIVE</td>
+ <td>WARNING</td>
<td>2</td>
- <td><p>Declarative schema definition.</p></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.ReleaseService">ReleaseService</h3>
- <p>ReleaseService manages releases for coordinating deployments.</p>
+ <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>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>GetRelease</td>
- <td><a href="#bytebase.v1.GetReleaseRequest">GetReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Retrieves a release by name.
-Permissions required: bb.releases.get</p></td>
+ <td>RULE_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified rule type.</p></td>
</tr>
<tr>
- <td>ListReleases</td>
- <td><a href="#bytebase.v1.ListReleasesRequest">ListReleasesRequest</a></td>
- <td><a href="#bytebase.v1.ListReleasesResponse">ListReleasesResponse</a></td>
- <td><p>Lists releases in a project.
-Permissions required: bb.releases.list</p></td>
+ <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>CreateRelease</td>
- <td><a href="#bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Creates a new release with SQL files.
-Permissions required: bb.releases.create</p></td>
+ <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>
- <tr>
- <td>UpdateRelease</td>
- <td><a href="#bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Updates an existing release.
-Permissions required: bb.releases.update
-When allow_missing=true, also requires: bb.releases.create</p></td>
+ </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>DeleteRelease</td>
- <td><a href="#bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a release.
-Permissions required: bb.releases.delete</p></td>
+ <td>QUERY</td>
+ <td>1</td>
+ <td><p>Query execution for data retrieval.</p></td>
</tr>
<tr>
- <td>UndeleteRelease</td>
- <td><a href="#bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</a></td>
- <td><a href="#bytebase.v1.Release">Release</a></td>
- <td><p>Restores a deleted release.
-Permissions required: bb.releases.undelete</p></td>
+ <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>CheckRelease</td>
- <td><a href="#bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</a></td>
- <td><a href="#bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</a></td>
- <td><p>Validates a release by dry-running checks on target databases.
-Permissions required: bb.releases.check</p></td>
+ <td>MSSQL_EXPLAIN_FORMAT_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>defaults to SHOWPLAN_ALL</p></td>
</tr>
<tr>
- <td>ListReleaseCategories</td>
- <td><a href="#bytebase.v1.ListReleaseCategoriesRequest">ListReleaseCategoriesRequest</a></td>
- <td><a href="#bytebase.v1.ListReleaseCategoriesResponse">ListReleaseCategoriesResponse</a></td>
- <td><p>Lists all unique categories in a project.
-Permissions required: bb.releases.list</p></td>
+ <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>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
+
+ <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>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>REDIS_RUN_COMMANDS_ON_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>UNSPECIFIED defaults to SINGLE_NODE.</p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>GetRelease</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/releases/*}</td>
- <td></td>
+ <td>SINGLE_NODE</td>
+ <td>1</td>
+ <td><p>Execute Redis commands on a single node in the cluster.</p></td>
</tr>
-
-
-
<tr>
- <td>ListReleases</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/releases</td>
- <td></td>
+ <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>CreateRelease</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/releases</td>
- <td>release</td>
+ <td>LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified message level.</p></td>
</tr>
-
-
-
<tr>
- <td>UpdateRelease</td>
- <td>PATCH</td>
- <td>/v1/{release.name=projects/*/releases/*}</td>
- <td>release</td>
+ <td>INFO</td>
+ <td>1</td>
+ <td><p>Informational message.</p></td>
</tr>
-
-
-
<tr>
- <td>DeleteRelease</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/releases/*}</td>
- <td></td>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p>Warning message indicating potential issues.</p></td>
</tr>
-
-
-
<tr>
- <td>UndeleteRelease</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/releases/*}:undelete</td>
- <td></td>
+ <td>DEBUG</td>
+ <td>3</td>
+ <td><p>Debug message for development and troubleshooting.</p></td>
</tr>
-
-
-
<tr>
- <td>CheckRelease</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/releases:check</td>
- <td>*</td>
+ <td>LOG</td>
+ <td>4</td>
+ <td><p>General log message.</p></td>
</tr>
-
-
-
<tr>
- <td>ListReleaseCategories</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/releases:listCategories</td>
- <td></td>
+ <td>NOTICE</td>
+ <td>5</td>
+ <td><p>Notice message for important information.</p></td>
</tr>
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/review_config_service.proto">v1/review_config_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
+ <tr>
+ <td>EXCEPTION</td>
+ <td>6</td>
+ <td><p>Exception message indicating error conditions.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</h3>
+ <h3 id="bytebase.v1.QueryResult.PermissionDenied.CommandType">QueryResult.PermissionDenied.CommandType</h3>
<p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>COMMAND_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DDL</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DML</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NON_READ_ONLY</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>review_config</td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td></td>
- <td><p>The SQL review config to create. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+
-
- <h3 id="bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.SQLService">SQLService</h3>
+ <p>SQLService executes SQL queries and manages query operations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>Query</td>
+ <td><a href="#bytebase.v1.QueryRequest">QueryRequest</a></td>
+ <td><a href="#bytebase.v1.QueryResponse">QueryResponse</a></td>
+ <td><p>Executes a read-only SQL query against a database.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>AdminExecute</td>
+ <td><a href="#bytebase.v1.AdminExecuteRequest">AdminExecuteRequest</a> stream</td>
+ <td><a href="#bytebase.v1.AdminExecuteResponse">AdminExecuteResponse</a> stream</td>
+ <td><p>Executes SQL with admin privileges via streaming connection.
+Permissions required: bb.sql.admin</p></td>
+ </tr>
+
+ <tr>
+ <td>SearchQueryHistories</td>
+ <td><a href="#bytebase.v1.SearchQueryHistoriesRequest">SearchQueryHistoriesRequest</a></td>
+ <td><a href="#bytebase.v1.SearchQueryHistoriesResponse">SearchQueryHistoriesResponse</a></td>
+ <td><p>SearchQueryHistories searches query histories for the caller.
+Permissions required: None (only returns caller&#39;s own query histories)</p></td>
+ </tr>
+
+ <tr>
+ <td>Export</td>
+ <td><a href="#bytebase.v1.ExportRequest">ExportRequest</a></td>
+ <td><a href="#bytebase.v1.ExportResponse">ExportResponse</a></td>
+ <td><p>Exports query results to a file format.
+Permissions required: bb.databases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>DiffMetadata</td>
+ <td><a href="#bytebase.v1.DiffMetadataRequest">DiffMetadataRequest</a></td>
+ <td><a href="#bytebase.v1.DiffMetadataResponse">DiffMetadataResponse</a></td>
+ <td><p>Computes schema differences between two database metadata.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>AICompletion</td>
+ <td><a href="#bytebase.v1.AICompletionRequest">AICompletionRequest</a></td>
+ <td><a href="#bytebase.v1.AICompletionResponse">AICompletionResponse</a></td>
+ <td><p>Provides AI-powered SQL completion and generation.
+Permissions required: None (authenticated users only, requires AI to be enabled)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the SQL review config to delete.
-Format: reviewConfigs/{reviewConfig} </p></td>
- </tr>
+ <tr>
+ <td>Query</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*}:query</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>AdminExecute</td>
+ <td>GET</td>
+ <td>/v1:adminExecute</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>SearchQueryHistories</td>
+ <td>POST</td>
+ <td>/v1/queryHistories:search</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>Export</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*/databases/*}:export</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>Export</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/rollouts/*}:export</td>
+ <td>*</td>
+ </tr>
+
+ <tr>
+ <td>Export</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/rollouts/*/stages/*}:export</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DiffMetadata</td>
+ <td>POST</td>
+ <td>/v1/schemaDesign:diffMetadata</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>AICompletion</td>
+ <td>POST</td>
+ <td>/v1/sql/aiCompletion</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</h3>
+ <div class="file-heading">
+ <h2 id="v1/plan_service.proto">v1/plan_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</h3>
<p></p>
@@ -22488,8 +21051,8 @@ Format: reviewConfigs/{reviewConfig} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the SQL review config to retrieve.
-Format: reviewConfigs/{reviewConfig} </p></td>
+ <td><p>The name of the plan check run to cancel.
+Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
</tr>
</tbody>
@@ -22499,14 +21062,14 @@ Format: reviewConfigs/{reviewConfig} </p></td>
- <h3 id="bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</h3>
+ <h3 id="bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</h3>
<p></p>
- <h3 id="bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</h3>
+ <h3 id="bytebase.v1.CreatePlanRequest">CreatePlanRequest</h3>
<p></p>
@@ -22517,10 +21080,18 @@ Format: reviewConfigs/{reviewConfig} </p></td>
<tbody>
<tr>
- <td>review_configs</td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td>repeated</td>
- <td><p>The SQL review configs from the specified request. </p></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></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>
@@ -22530,7 +21101,7 @@ Format: reviewConfigs/{reviewConfig} </p></td>
- <h3 id="bytebase.v1.ReviewConfig">ReviewConfig</h3>
+ <h3 id="bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</h3>
<p></p>
@@ -22544,37 +21115,33 @@ Format: reviewConfigs/{reviewConfig} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the SQL review config.
-Format: reviewConfigs/{reviewConfig} </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The title of the review configuration. </p></td>
- </tr>
-
- <tr>
- <td>enabled</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the review configuration is enabled. </p></td>
+ <td><p>The name of the plan check run to retrieve.
+Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
</tr>
- <tr>
- <td>rules</td>
- <td><a href="#bytebase.v1.SQLReviewRule">SQLReviewRule</a></td>
- <td>repeated</td>
- <td><p>The SQL review rules to enforce. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetPlanRequest">GetPlanRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>resources</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Resources using the config.
-Format: {resource}/{resource id}, e.g., environments/test. </p></td>
+ <td></td>
+ <td><p>The name of the plan to retrieve.
+Format: projects/{project}/plans/{plan} </p></td>
</tr>
</tbody>
@@ -22584,8 +21151,8 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- <h3 id="bytebase.v1.SQLReviewRule">SQLReviewRule</h3>
- <p>SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p>
+ <h3 id="bytebase.v1.ListPlansRequest">ListPlansRequest</h3>
+ <p></p>
<table class="field-table">
@@ -22595,66 +21162,58 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of SQL review rule. </p></td>
+ <td><p>The parent, which owns this collection of plans.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list all plans from all projects. </p></td>
</tr>
<tr>
- <td>level</td>
- <td><a href="#bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The severity level of the rule. </p></td>
- </tr>
-
- <tr>
- <td>naming_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>number_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>string_array_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>comment_convention_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>string_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>naming_case_payload</td>
- <td><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A page token, received from a previous `ListPlans` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListPlans` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The database engine this rule applies to. </p></td>
+ <td><p>Filter is used to filter plans returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- creator: the plan creator full name in &#34;users/{email or id}&#34; format, support &#34;==&#34; operator.
+- create_time: the plan create time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+- has_rollout: whether the plan has rollout, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
+- has_issue: the plan has issue or not, support &#34;==&#34; operator, the value should be &#34;true&#34; or &#34;false&#34;.
+- title: the plan title, support &#34;==&#34; operator for exact match and &#34;.matches()&#34; operator for case-insensitive substring match.
+- spec_type: the plan spec config type, support &#34;==&#34; operator, the value should be &#34;create_database_config&#34;, &#34;change_database_config&#34;, or &#34;export_data_config&#34;.
+- state: the plan state, support &#34;==&#34; operator, the value should be &#34;ACTIVE&#34; or &#34;DELETED&#34;.
+
+For example:
+creator == &#34;users/[email protected]&#34; &amp;&amp; create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
+has_rollout == false &amp;&amp; has_issue == true
+title == &#34;My Plan&#34;
+title.matches(&#34;database migration&#34;)
+spec_type == &#34;change_database_config&#34;
+state == &#34;ACTIVE&#34; </p></td>
</tr>
</tbody>
@@ -22664,7 +21223,7 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- <h3 id="bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3>
+ <h3 id="bytebase.v1.ListPlansResponse">ListPlansResponse</h3>
<p></p>
@@ -22675,17 +21234,18 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
<tbody>
<tr>
- <td>required</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>plans</td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td>repeated</td>
+ <td><p>The plans from the specified request. </p></td>
</tr>
<tr>
- <td>max_length</td>
- <td><a href="#int32">int32</a></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>
@@ -22695,7 +21255,7 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- <h3 id="bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3>
+ <h3 id="bytebase.v1.Plan">Plan</h3>
<p></p>
@@ -22706,67 +21266,91 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
<tbody>
<tr>
- <td>upper</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the plan.
+`plan` is a system generated ID.
+Format: projects/{project}/plans/{plan} </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3>
- <p>Payload message types for SQL review rules</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>max_length</td>
- <td><a href="#int32">int32</a></td>
+ <td>issue</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The issue associated with the plan.
+Can be empty.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>format</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The title of the plan. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The description of the plan. </p></td>
+ </tr>
<tr>
- <td>number</td>
- <td><a href="#int32">int32</a></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>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>plan_check_run_status_count</td>
+ <td><a href="#bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</a></td>
+ <td>repeated</td>
+ <td><p>The status count of the latest plan check runs.
+Keys are:
+- SUCCESS
+- WARNING
+- ERROR
+- RUNNING </p></td>
+ </tr>
+
+ <tr>
+ <td>has_rollout</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether the plan has started the rollout. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -22774,7 +21358,7 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- <h3 id="bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3>
+ <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig">Plan.ChangeDatabaseConfig</h3>
<p></p>
@@ -22785,12 +21369,51 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
<tbody>
<tr>
- <td>list</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>The resource name of the sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>release</td>
<td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The resource name of the release.
+Format: projects/{project}/releases/{release} </p></td>
+ </tr>
+
+ <tr>
+ <td>ghost_flags</td>
+ <td><a href="#bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</a></td>
<td>repeated</td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>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>
@@ -22798,7 +21421,7 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- <h3 id="bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3>
+ <h3 id="bytebase.v1.Plan.ChangeDatabaseConfig.GhostFlagsEntry">Plan.ChangeDatabaseConfig.GhostFlagsEntry</h3>
<p></p>
@@ -22808,6 +21431,13 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
</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>
@@ -22822,7 +21452,7 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
- <h3 id="bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</h3>
+ <h3 id="bytebase.v1.Plan.CreateDatabaseConfig">Plan.CreateDatabaseConfig</h3>
<p></p>
@@ -22833,27 +21463,111 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
<tbody>
<tr>
- <td>review_config</td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td></td>
- <td><p>The SQL review config to update.
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The resource name of the instance on which the database is created.
+Format: instances/{instance} </p></td>
+ </tr>
+
+ <tr>
+ <td>database</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to create. </p></td>
+ </tr>
+
+ <tr>
+ <td>table</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>
+ </tr>
+
+ <tr>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>character_set is the character set of the database. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>collation is the collation of the database. </p></td>
+ </tr>
+
+ <tr>
+ <td>cluster</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>cluster is the cluster of the database. This is only applicable to ClickHouse for &#34;ON CLUSTER &lt;&lt;cluster&gt;&gt;&#34;. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>owner is the owner of the database. This is only applicable to Postgres for &#34;WITH OWNER &lt;&lt;owner&gt;&gt;&#34;. </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-The name field is used to identify the SQL review config to update. </p></td>
+
+
+
+
+ <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>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>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The resource name of the sheet.
+Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>format</td>
+ <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
<td></td>
- <td><p>If set to true, and the config is not found, a new config will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The format of the exported file. </p></td>
+ </tr>
+
+ <tr>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The zip password provide by users.
+Leave it empty if no needs to encrypt the zip file. </p></td>
</tr>
</tbody>
@@ -22863,842 +21577,1200 @@ In this situation, `update_mask` is ignored. </p></td>
+ <h3 id="bytebase.v1.Plan.PlanCheckRunStatusCountEntry">Plan.PlanCheckRunStatusCountEntry</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="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</h3>
- <p>The severity level for SQL review rules.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>LEVEL_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified level.</p></td>
- </tr>
-
- <tr>
- <td>ERROR</td>
- <td>1</td>
- <td><p>Rule violation is an error.</p></td>
- </tr>
-
- <tr>
- <td>WARNING</td>
- <td>2</td>
- <td><p>Rule violation is a warning.</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.Plan.Spec">Plan.Spec</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>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>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</h3>
+ <h3 id="bytebase.v1.PlanCheckRun">PlanCheckRun</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>ENGINE_MYSQL_USE_INNODB</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_FULLY_QUALIFIED</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_TABLE</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_COLUMN</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_INDEX_PK</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_INDEX_UK</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_INDEX_FK</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_INDEX_IDX</td>
- <td>8</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_COLUMN_AUTO_INCREMENT</td>
- <td>9</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_TABLE_NO_KEYWORD</td>
- <td>10</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_IDENTIFIER_NO_KEYWORD</td>
- <td>11</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>NAMING_IDENTIFIER_CASE</td>
- <td>12</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_SELECT_NO_SELECT_ALL</td>
- <td>13</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_WHERE_REQUIRE_SELECT</td>
- <td>14</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_WHERE_REQUIRE_UPDATE_DELETE</td>
- <td>15</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE</td>
- <td>16</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_ON_DEL_CASCADE</td>
- <td>17</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_RM_TBL_CASCADE</td>
- <td>18</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_COMMIT</td>
- <td>19</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_LIMIT</td>
- <td>20</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_ORDER_BY</td>
- <td>21</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_MERGE_ALTER_TABLE</td>
- <td>22</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_INSERT_ROW_LIMIT</td>
- <td>23</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_INSERT_MUST_SPECIFY_COLUMN</td>
- <td>24</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND</td>
- <td>25</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_AFFECTED_ROW_LIMIT</td>
- <td>26</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DML_DRY_RUN</td>
- <td>27</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT</td>
- <td>28</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_ADD_CHECK_NOT_VALID</td>
- <td>29</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_ADD_FOREIGN_KEY_NOT_VALID</td>
- <td>30</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_ADD_NOT_NULL</td>
- <td>31</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_SELECT_FULL_TABLE_SCAN</td>
- <td>32</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_CREATE_SPECIFY_SCHEMA</td>
- <td>33</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_CHECK_SET_ROLE_VARIABLE</td>
- <td>34</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_USING_FILESORT</td>
- <td>35</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_USING_TEMPORARY</td>
- <td>36</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_WHERE_NO_EQUAL_NULL</td>
- <td>37</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS</td>
- <td>38</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_QUERY_MINIMUM_PLAN_LEVEL</td>
- <td>39</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT</td>
- <td>40</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_MAXIMUM_LIMIT_VALUE</td>
- <td>41</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_MAXIMUM_JOIN_TABLE_COUNT</td>
- <td>42</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION</td>
- <td>43</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_JOIN_STRICT_COLUMN_ATTRS</td>
- <td>44</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_NON_TRANSACTIONAL</td>
- <td>45</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_ADD_COLUMN_WITHOUT_POSITION</td>
- <td>46</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_OFFLINE_DDL</td>
- <td>47</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_DISALLOW_CROSS_DB_QUERIES</td>
- <td>48</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_MAX_EXECUTION_TIME</td>
- <td>49</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_REQUIRE_ALGORITHM_OPTION</td>
- <td>50</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_REQUIRE_LOCK_OPTION</td>
- <td>51</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STATEMENT_OBJECT_OWNER_CHECK</td>
- <td>52</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_REQUIRE_PK</td>
- <td>53</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_NO_FOREIGN_KEY</td>
- <td>54</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_DROP_NAMING_CONVENTION</td>
- <td>55</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_COMMENT</td>
- <td>56</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_DISALLOW_PARTITION</td>
- <td>57</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_DISALLOW_TRIGGER</td>
- <td>58</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_NO_DUPLICATE_INDEX</td>
- <td>59</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_TEXT_FIELDS_TOTAL_LENGTH</td>
- <td>60</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_DISALLOW_SET_CHARSET</td>
- <td>61</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_DISALLOW_DDL</td>
- <td>62</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_DISALLOW_DML</td>
- <td>63</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_LIMIT_SIZE</td>
- <td>64</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_REQUIRE_CHARSET</td>
- <td>65</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE_REQUIRE_COLLATION</td>
- <td>66</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_REQUIRED</td>
- <td>67</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_NO_NULL</td>
- <td>68</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_DISALLOW_CHANGE_TYPE</td>
- <td>69</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_SET_DEFAULT_FOR_NOT_NULL</td>
- <td>70</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_DISALLOW_CHANGE</td>
- <td>71</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_DISALLOW_CHANGING_ORDER</td>
- <td>72</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_DISALLOW_DROP</td>
- <td>73</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_DISALLOW_DROP_IN_INDEX</td>
- <td>74</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_COMMENT</td>
- <td>75</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_AUTO_INCREMENT_MUST_INTEGER</td>
- <td>76</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_TYPE_DISALLOW_LIST</td>
- <td>77</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_DISALLOW_SET_CHARSET</td>
- <td>78</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_MAXIMUM_CHARACTER_LENGTH</td>
- <td>79</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_MAXIMUM_VARCHAR_LENGTH</td>
- <td>80</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_AUTO_INCREMENT_INITIAL_VALUE</td>
- <td>81</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_AUTO_INCREMENT_MUST_UNSIGNED</td>
- <td>82</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>COLUMN_CURRENT_TIME_COUNT_LIMIT</td>
- <td>83</td>
- <td><p></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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/plans/{plan}/planCheckRun </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</a></td>
+ <td></td>
+ <td><p> </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>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>error is set if the Status is FAILED. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result">PlanCheckRun.Result</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Advice.Level">Advice.Level</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>code</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Target identification for consolidated results.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_summary_report</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_review_report</td>
+ <td><a href="#bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result.SqlReviewReport">PlanCheckRun.Result.SqlReviewReport</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p>Position of the SQL statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>end_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result.SqlSummaryReport">PlanCheckRun.Result.SqlSummaryReport</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>statement_types</td>
+ <td><a href="#bytebase.v1.StatementType">StatementType</a></td>
+ <td>repeated</td>
+ <td><p>statement_types are the types of statements that are found in the sql. </p></td>
+ </tr>
+
+ <tr>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The plan to run plan checks.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>spec_id</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The UUID of the specific spec to run plan checks for.
+This should match the spec.id field in Plan.Spec.
+If not set, all specs in the plan will be used. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdatePlanRequest">UpdatePlanRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>plan</td>
+ <td><a href="#bytebase.v1.Plan">Plan</a></td>
+ <td></td>
+ <td><p>The plan to update.
+
+The plan&#39;s `name` field is used to identify the plan to update.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the plan is not found, a new plan will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanCheckRun.Result.Type">PlanCheckRun.Result.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>COLUMN_REQUIRE_DEFAULT</td>
- <td>84</td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
<td><p></p></td>
</tr>
<tr>
- <td>COLUMN_DEFAULT_DISALLOW_VOLATILE</td>
- <td>85</td>
+ <td>STATEMENT_ADVISE</td>
+ <td>1</td>
<td><p></p></td>
</tr>
<tr>
- <td>COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT</td>
- <td>86</td>
+ <td>STATEMENT_SUMMARY_REPORT</td>
+ <td>2</td>
<td><p></p></td>
</tr>
<tr>
- <td>COLUMN_REQUIRE_CHARSET</td>
- <td>87</td>
+ <td>GHOST_SYNC</td>
+ <td>3</td>
<td><p></p></td>
</tr>
- <tr>
- <td>COLUMN_REQUIRE_COLLATION</td>
- <td>88</td>
- <td><p></p></td>
- </tr>
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.PlanCheckRun.Status">PlanCheckRun.Status</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>SCHEMA_BACKWARD_COMPATIBILITY</td>
- <td>89</td>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
<td><p></p></td>
</tr>
<tr>
- <td>DATABASE_DROP_EMPTY_DATABASE</td>
- <td>90</td>
+ <td>RUNNING</td>
+ <td>1</td>
<td><p></p></td>
</tr>
<tr>
- <td>INDEX_NO_DUPLICATE_COLUMN</td>
- <td>91</td>
+ <td>DONE</td>
+ <td>2</td>
<td><p></p></td>
</tr>
<tr>
- <td>INDEX_KEY_NUMBER_LIMIT</td>
- <td>92</td>
+ <td>FAILED</td>
+ <td>3</td>
<td><p></p></td>
</tr>
<tr>
- <td>INDEX_PK_TYPE_LIMIT</td>
- <td>93</td>
+ <td>CANCELED</td>
+ <td>4</td>
<td><p></p></td>
</tr>
- <tr>
- <td>INDEX_TYPE_NO_BLOB</td>
- <td>94</td>
- <td><p></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>INDEX_TOTAL_NUMBER_LIMIT</td>
- <td>95</td>
- <td><p></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>INDEX_PRIMARY_KEY_TYPE_ALLOWLIST</td>
- <td>96</td>
- <td><p></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>INDEX_CREATE_CONCURRENTLY</td>
- <td>97</td>
- <td><p></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>INDEX_TYPE_ALLOW_LIST</td>
- <td>98</td>
- <td><p></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>INDEX_NOT_REDUNDANT</td>
- <td>99</td>
- <td><p></p></td>
+ <td>GetPlanCheckRun</td>
+ <td><a href="#bytebase.v1.GetPlanCheckRunRequest">GetPlanCheckRunRequest</a></td>
+ <td><a href="#bytebase.v1.PlanCheckRun">PlanCheckRun</a></td>
+ <td><p>Gets the plan check run for a deployment plan.
+Permissions required: bb.planCheckRuns.get</p></td>
</tr>
<tr>
- <td>SYSTEM_CHARSET_ALLOWLIST</td>
- <td>100</td>
- <td><p></p></td>
+ <td>RunPlanChecks</td>
+ <td><a href="#bytebase.v1.RunPlanChecksRequest">RunPlanChecksRequest</a></td>
+ <td><a href="#bytebase.v1.RunPlanChecksResponse">RunPlanChecksResponse</a></td>
+ <td><p>Executes validation checks on a deployment plan.
+Permissions required: bb.planCheckRuns.run</p></td>
</tr>
<tr>
- <td>SYSTEM_COLLATION_ALLOWLIST</td>
- <td>101</td>
- <td><p></p></td>
+ <td>CancelPlanCheckRun</td>
+ <td><a href="#bytebase.v1.CancelPlanCheckRunRequest">CancelPlanCheckRunRequest</a></td>
+ <td><a href="#bytebase.v1.CancelPlanCheckRunResponse">CancelPlanCheckRunResponse</a></td>
+ <td><p>Cancels the plan check run for a deployment plan.
+Permissions required: bb.planCheckRuns.run</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>SYSTEM_COMMENT_LENGTH</td>
- <td>102</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>SYSTEM_PROCEDURE_DISALLOW_CREATE</td>
- <td>103</td>
- <td><p></p></td>
+ <td>GetPlan</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>SYSTEM_EVENT_DISALLOW_CREATE</td>
- <td>104</td>
- <td><p></p></td>
+ <td>ListPlans</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/plans</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>SYSTEM_VIEW_DISALLOW_CREATE</td>
- <td>105</td>
- <td><p></p></td>
+ <td>CreatePlan</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/plans</td>
+ <td>plan</td>
</tr>
+
+
+
<tr>
- <td>SYSTEM_FUNCTION_DISALLOW_CREATE</td>
- <td>106</td>
- <td><p></p></td>
+ <td>UpdatePlan</td>
+ <td>PATCH</td>
+ <td>/v1/{plan.name=projects/*/plans/*}</td>
+ <td>plan</td>
</tr>
+
+
+
<tr>
- <td>SYSTEM_FUNCTION_DISALLOWED_LIST</td>
- <td>107</td>
- <td><p></p></td>
+ <td>GetPlanCheckRun</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*/planCheckRun}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>ADVICE_ONLINE_MIGRATION</td>
- <td>108</td>
- <td><p></p></td>
+ <td>RunPlanChecks</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/plans/*}:runPlanChecks</td>
+ <td>*</td>
</tr>
+
+
+
<tr>
- <td>BUILTIN_PRIOR_BACKUP_CHECK</td>
- <td>109</td>
- <td><p></p></td>
+ <td>CancelPlanCheckRun</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/plans/*/planCheckRun}:cancel</td>
+ <td>*</td>
</tr>
+
- </tbody>
- </table>
+ </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>
+ <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>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>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>names</td>
+ <td><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>purge</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, permanently purge the soft-deleted projects and all related resources.
+This operation is irreversible. Following AIP-165, this should only be used for
+administrative cleanup of old soft-deleted projects.
+All projects must already be soft-deleted for this to work.
+When purge=true, all databases will be moved to the default project before deletion.
+When purge=false (soft delete/archive), the projects and their databases/issues remain unchanged. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</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 names of projects to retrieve.
+Format: projects/{project} </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>repeated</td>
+ <td><p>The projects from the specified request. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</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>project</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td></td>
+ <td><p>The project to create. </p></td>
+ </tr>
+
+ <tr>
+ <td>project_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The ID to use for the project, which will become the final component of
+the project&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <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 project to delete.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>purge</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, permanently purge the soft-deleted project and all related resources.
+This operation is irreversible. Following AIP-165, this should only be used for
+administrative cleanup of old soft-deleted projects.
+The project must already be soft-deleted for this to work.
+When purge=true, all databases will be moved to the default project before deletion.
+When purge=false (soft delete/archive), the project and its databases/issues remain unchanged. </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></td>
+ <td><p>The name of the project to retrieve.
+Format: projects/{project} </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></td>
+ <td><p>The label value/name. </p></td>
+ </tr>
+
+ <tr>
+ <td>color</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The color code for the label (e.g., hex color). </p></td>
+ </tr>
+
+ <tr>
+ <td>group</td>
+ <td><a href="#string">string</a></td>
+ <td></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>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><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>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter the project.
+Check filter for SearchProjectsRequest for details.
+Supports filtering by name, resource_id, state, and labels (e.g., labels.environment == &#34;production&#34;). </p></td>
+ </tr>
+
+ <tr>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The order by of projects.
+Support title. The default sorting order is ascending.
+For example:
+- order_by = &#34;title&#34;
+- order_by = &#34;title desc&#34;
+- order_by = &#34;title asc&#34; </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.ReviewConfigService">ReviewConfigService</h3>
- <p>ReviewConfigService manages approval flow configurations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>CreateReviewConfig</td>
- <td><a href="#bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</a></td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td><p>Creates a new SQL review configuration.
-Permissions required: bb.reviewConfigs.create</p></td>
- </tr>
-
- <tr>
- <td>ListReviewConfigs</td>
- <td><a href="#bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</a></td>
- <td><a href="#bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</a></td>
- <td><p>Lists all SQL review configurations.
-Permissions required: bb.reviewConfigs.list</p></td>
- </tr>
-
- <tr>
- <td>GetReviewConfig</td>
- <td><a href="#bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</a></td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td><p>Retrieves a SQL review configuration by name.
-Permissions required: bb.reviewConfigs.get</p></td>
- </tr>
-
- <tr>
- <td>UpdateReviewConfig</td>
- <td><a href="#bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</a></td>
- <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
- <td><p>Updates a SQL review configuration.
-Permissions required: bb.reviewConfigs.update
-When allow_missing=true, also requires: bb.reviewConfigs.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteReviewConfig</td>
- <td><a href="#bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a SQL review configuration.
-Permissions required: bb.reviewConfigs.delete</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3>
+ <p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>repeated</td>
+ <td><p>The projects from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+
+
+
+ <h3 id="bytebase.v1.Project">Project</h3>
+ <p></p>
+
+
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the project.
+Format: projects/{project} </p></td>
+ </tr>
- <tr>
- <td>CreateReviewConfig</td>
- <td>POST</td>
- <td>/v1/reviewConfigs</td>
- <td>review_config</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>
+ </tr>
-
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The title or name of a project. It&#39;s not unique within the workspace. </p></td>
+ </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>
+ </tr>
+
+ <tr>
+ <td>data_classification_config_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The data classification configuration ID for the project. </p></td>
+ </tr>
+
+ <tr>
+ <td>issue_labels</td>
+ <td><a href="#bytebase.v1.Label">Label</a></td>
+ <td>repeated</td>
+ <td><p>Labels available for tagging issues in this project. </p></td>
+ </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>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 &#34;set role &lt;db_owner&gt;&#34; statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_self_approval</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to allow issue creators to self-approve their own issues. </p></td>
+ </tr>
+
+ <tr>
+ <td>execution_retry_policy</td>
+ <td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td>
+ <td></td>
+ <td><p>Execution retry policy for task runs. </p></td>
+ </tr>
+
+ <tr>
+ <td>ci_sampling_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of database rows to sample during CI data validation.
+Without specification, sampling is disabled, resulting in full validation. </p></td>
+ </tr>
+ <tr>
+ <td>parallel_tasks_per_rollout</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td>
+ </tr>
- <tr>
- <td>ListReviewConfigs</td>
- <td>GET</td>
- <td>/v1/reviewConfigs</td>
- <td></td>
- </tr>
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels are key-value pairs that can be attached to the project.
+For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } </p></td>
+ </tr>
-
+ <tr>
+ <td>enforce_sql_review</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enforce SQL review checks to pass before issue creation.
+If enabled, issues cannot be created when SQL review finds errors. </p></td>
+ </tr>
+ <tr>
+ <td>require_issue_approval</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to require issue approval before rollout. </p></td>
+ </tr>
- <tr>
- <td>GetReviewConfig</td>
- <td>GET</td>
- <td>/v1/{name=reviewConfigs/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>require_plan_check_no_error</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to require plan check to have no error before rollout. </p></td>
+ </tr>
-
+ <tr>
+ <td>allow_request_role</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>
+ <p>Execution retry policy configuration.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>UpdateReviewConfig</td>
- <td>PATCH</td>
- <td>/v1/{review_config.name=reviewConfigs/*}</td>
- <td>review_config</td>
- </tr>
+ <tr>
+ <td>maximum_retries</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of retries for lock timeout errors. </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><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>DeleteReviewConfig</td>
- <td>DELETE</td>
- <td>/v1/{name=reviewConfigs/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
</tbody>
</table>
+
+
-
- <div class="file-heading">
- <h2 id="v1/revision_service.proto">v1/revision_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+ <h3 id="bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td></td>
+ <td><p>The webhook to remove. Identified by its url. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</h3>
+ <h3 id="bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</h3>
<p></p>
@@ -23709,19 +22781,73 @@ Permissions required: bb.reviewConfigs.delete</p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Show deleted projects if specified. </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all revisions being created.
-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 &#34;==&#34; and &#34;.matches()&#34; operator.
+- resource_id: the project id, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- exclude_default: if not include the default project, should be &#34;true&#34; or &#34;false&#34;, support &#34;==&#34; operator.
+- state: check the State enum for the values, support &#34;==&#34; operator.
+- labels.{key}: the project label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example:
+name == &#34;project name&#34;
+name.matches(&#34;project name&#34;)
+resource_id == &#34;project id&#34;
+resource_id.matches(&#34;project id&#34;)
+exclude_default == true
+state == &#34;DELETED&#34;
+labels.environment == &#34;production&#34;
+labels.tier == &#34;critical&#34;
+labels.environment in [&#34;staging&#34;, &#34;prod&#34;]
+You can combine filter conditions like:
+name == &#34;project name&#34; &amp;&amp; resource_id.matches(&#34;project id&#34;)
+name.matches(&#34;project name&#34;) || resource_id == &#34;project id&#34;
+labels.environment == &#34;production&#34; &amp;&amp; labels.tier == &#34;critical&#34; </p></td>
</tr>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</a></td>
- <td>repeated</td>
- <td><p>The request message specifying the revisions to create.
-A maximum of 100 revisions can be created in a batch. </p></td>
+ <td>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><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>
+ </tr>
+
+ <tr>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The order by of projects.
+Support title. The default sorting order is ascending.
+For example:
+- order_by = &#34;title&#34;
+- order_by = &#34;title desc&#34;
+- order_by = &#34;title asc&#34; </p></td>
</tr>
</tbody>
@@ -23731,7 +22857,7 @@ A maximum of 100 revisions can be created in a batch. </p></td>
- <h3 id="bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</h3>
+ <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>
<p></p>
@@ -23742,10 +22868,18 @@ A maximum of 100 revisions can be created in a batch. </p></td>
<tbody>
<tr>
- <td>revisions</td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
<td>repeated</td>
- <td><p>The created revisions. </p></td>
+ <td><p>The projects from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -23755,7 +22889,7 @@ A maximum of 100 revisions can be created in a batch. </p></td>
- <h3 id="bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</h3>
+ <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>
<p></p>
@@ -23766,17 +22900,18 @@ A maximum of 100 revisions can be created in a batch. </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>project</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>The name of the project which owns the webhook to test.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>revision</td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
<td></td>
- <td><p>The revision to create. </p></td>
+ <td><p>The webhook to test. Identified by its url. </p></td>
</tr>
</tbody>
@@ -23786,7 +22921,7 @@ A maximum of 100 revisions can be created in a batch. </p></td>
- <h3 id="bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</h3>
+ <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>
<p></p>
@@ -23797,11 +22932,10 @@ A maximum of 100 revisions can be created in a batch. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the revision to delete.
-Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ <td><p>The result of the test, empty if the test is successful. </p></td>
</tr>
</tbody>
@@ -23811,7 +22945,7 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
- <h3 id="bytebase.v1.GetRevisionRequest">GetRevisionRequest</h3>
+ <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>
<p></p>
@@ -23825,8 +22959,8 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the revision.
-Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
+ <td><p>The name of the deleted project.
+Format: projects/{project} </p></td>
</tr>
</tbody>
@@ -23836,7 +22970,7 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
- <h3 id="bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</h3>
+ <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>
<p></p>
@@ -23847,38 +22981,28 @@ Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent of the revisions.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>project</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
<td></td>
- <td><p>The maximum number of revisions to return. The service may return fewer
-than this value. If unspecified, at most 10 revisions will be returned. The
-maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The project to update.
+
+The project&#39;s `name` field is used to identify the project to update.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>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 `ListRevisions` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRevisions` must
-match the call that provided the page token. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether to include deleted revisions in the results. </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>
@@ -23888,7 +23012,7 @@ match the call that provided the page token. </p></td>
- <h3 id="bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</h3>
+ <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3>
<p></p>
@@ -23899,18 +23023,25 @@ match the call that provided the page token. </p></td>
<tbody>
<tr>
- <td>revisions</td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
- <td>repeated</td>
- <td><p>The revisions 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>
@@ -23920,7 +23051,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Revision">Revision</h3>
+ <h3 id="bytebase.v1.Webhook">Webhook</h3>
<p></p>
@@ -23934,83 +23065,53 @@ If this field is omitted, there are no subsequent pages. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
- </tr>
-
- <tr>
- <td>release</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release}
-Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>deleter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected]
-Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>delete_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>Can be empty. </p></td>
- </tr>
-
- <tr>
- <td>file</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/releases/{release}/files/{id}
-Can be empty. </p></td>
+ <td><p>name is the name of the webhook, generated by the server.
+format: projects/{project}/webhooks/{webhook} </p></td>
</tr>
<tr>
- <td>version</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 schema version string for this revision. </p></td>
+ <td><p>Webhook integration type.
+type is the type of the webhook. </p></td>
</tr>
<tr>
- <td>sheet</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The sheet that holds the content.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>title is the title of the webhook. </p></td>
</tr>
<tr>
- <td>sheet_sha256</td>
+ <td>url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SHA256 hash value of the sheet. </p></td>
+ <td><p>url is the url of the webhook, should be unique within the project. </p></td>
</tr>
<tr>
- <td>task_run</td>
- <td><a href="#string">string</a></td>
+ <td>direct_message</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The task run associated with the revision.
-Can be empty.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>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>type</td>
- <td><a href="#bytebase.v1.Revision.Type">Revision.Type</a></td>
- <td></td>
- <td><p>The type of the revision. </p></td>
+ <td>notification_types</td>
+ <td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>
+ <td>repeated</td>
+ <td><p>notification_types is the list of activities types that the webhook is interested in.
+Bytebase will only send notifications to the webhook if the activity type is in the list.
+It should not be empty, and should be a subset of the following:
+- ISSUE_CREATED
+- ISSUE_APPROVAL_REQUESTED
+- ISSUE_SENT_BACK
+- PIPELINE_FAILED
+- PIPELINE_COMPLETED </p></td>
</tr>
</tbody>
@@ -24022,8 +23123,8 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task
- <h3 id="bytebase.v1.Revision.Type">Revision.Type</h3>
- <p>The type of schema revision.</p>
+ <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>
@@ -24031,68 +23132,175 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_CREATED</td>
+ <td>10</td>
+ <td><p>ISSUE_CREATED represents a new issue creation event.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_APPROVAL_REQUESTED</td>
+ <td>11</td>
+ <td><p>ISSUE_APPROVAL_REQUESTED represents an approval request event.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_SENT_BACK</td>
+ <td>12</td>
+ <td><p>ISSUE_SENT_BACK represents an issue being sent back by an approver.</p></td>
+ </tr>
+
+ <tr>
+ <td>PIPELINE_FAILED</td>
+ <td>13</td>
+ <td><p>PIPELINE_FAILED represents a pipeline failure event.</p></td>
+ </tr>
+
+ <tr>
+ <td>PIPELINE_COMPLETED</td>
+ <td>14</td>
+ <td><p>PIPELINE_COMPLETED represents a pipeline completion event.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ProjectService">ProjectService</h3>
+ <p>ProjectService manages projects that group databases and changes.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetProject</td>
+ <td><a href="#bytebase.v1.GetProjectRequest">GetProjectRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>GetProject retrieves a project by name.
+Users with &#34;bb.projects.get&#34; permission on the workspace or the project owner can access this method.
+Permissions required: bb.projects.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchGetProjects</td>
+ <td><a href="#bytebase.v1.BatchGetProjectsRequest">BatchGetProjectsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetProjectsResponse">BatchGetProjectsResponse</a></td>
+ <td><p>BatchGetProjects retrieves multiple projects by their names.
+Permissions required: bb.projects.get</p></td>
+ </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&#39;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>VERSIONED</td>
- <td>1</td>
- <td><p>Versioned schema migration.</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>DECLARATIVE</td>
- <td>2</td>
- <td><p>Declarative schema definition.</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>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RevisionService">RevisionService</h3>
- <p>RevisionService manages schema revision history.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>ListRevisions</td>
- <td><a href="#bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</a></td>
- <td><a href="#bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</a></td>
- <td><p>Lists schema revisions for a database.
-Permissions required: bb.revisions.list</p></td>
+ <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>GetRevision</td>
- <td><a href="#bytebase.v1.GetRevisionRequest">GetRevisionRequest</a></td>
- <td><a href="#bytebase.v1.Revision">Revision</a></td>
- <td><p>Retrieves a schema revision by name.
-Permissions required: bb.revisions.get</p></td>
+ <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>BatchCreateRevisions</td>
- <td><a href="#bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</a></td>
- <td><a href="#bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</a></td>
- <td><p>Creates multiple schema revisions in a single operation.
-Permissions required: bb.revisions.create</p></td>
+ <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>DeleteRevision</td>
- <td><a href="#bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a schema revision.
-Permissions required: bb.revisions.delete</p></td>
+ <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>
@@ -24116,9 +23324,9 @@ Permissions required: bb.revisions.delete</p></td>
<tr>
- <td>ListRevisions</td>
+ <td>GetProject</td>
<td>GET</td>
- <td>/v1/{parent=instances/*/databases/*}/revisions</td>
+ <td>/v1/{name=projects/*}</td>
<td></td>
</tr>
@@ -24126,9 +23334,9 @@ Permissions required: bb.revisions.delete</p></td>
<tr>
- <td>GetRevision</td>
+ <td>BatchGetProjects</td>
<td>GET</td>
- <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
+ <td>/v1/projects:batchGet</td>
<td></td>
</tr>
@@ -24136,9 +23344,19 @@ Permissions required: bb.revisions.delete</p></td>
<tr>
- <td>BatchCreateRevisions</td>
+ <td>ListProjects</td>
+ <td>GET</td>
+ <td>/v1/projects</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>SearchProjects</td>
<td>POST</td>
- <td>/v1/{parent=instances/*/databases/*}/revisions:batchCreate</td>
+ <td>/v1/projects:search</td>
<td>*</td>
</tr>
@@ -24146,13 +23364,113 @@ Permissions required: bb.revisions.delete</p></td>
<tr>
- <td>DeleteRevision</td>
+ <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=instances/*/databases/*/revisions/*}</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>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>
@@ -24160,12 +23478,12 @@ Permissions required: bb.revisions.delete</p></td>
<div class="file-heading">
- <h2 id="v1/role_service.proto">v1/role_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/release_service.proto">v1/release_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CreateRoleRequest">CreateRoleRequest</h3>
+ <h3 id="bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</h3>
<p></p>
@@ -24176,46 +23494,38 @@ Permissions required: bb.revisions.delete</p></td>
<tbody>
<tr>
- <td>role</td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The role to create. </p></td>
+ <td><p>Format: projects/{project} </p></td>
</tr>
<tr>
- <td>role_id</td>
- <td><a href="#string">string</a></td>
+ <td>release</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td></td>
- <td><p>The ID to use for the role, which will become the final component
-of the role&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][A-Z][0-9]/. </p></td>
+ <td><p>The release to check. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>targets</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The targets to dry-run the release.
+Can be database or databaseGroup.
+Format:
+projects/{project}/databaseGroups/{databaseGroup}
+instances/{instance}/databases/{database} </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>custom_rules</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the role to delete.
-Format: roles/{role} </p></td>
+ <td><p>Custom linting rules in natural language for AI-powered validation.
+Each rule should be a clear statement describing the desired schema constraint.
+Example: &#34;All tables must have a primary key&#34;
+Example: &#34;VARCHAR columns should specify a maximum length&#34; </p></td>
</tr>
</tbody>
@@ -24225,7 +23535,7 @@ Format: roles/{role} </p></td>
- <h3 id="bytebase.v1.GetRoleRequest">GetRoleRequest</h3>
+ <h3 id="bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</h3>
<p></p>
@@ -24236,42 +23546,24 @@ Format: roles/{role} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the role to retrieve.
-Format: roles/{role} </p></td>
+ <td>results</td>
+ <td><a href="#bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</a></td>
+ <td>repeated</td>
+ <td><p>The check results for each file and target combination. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListRolesRequest">ListRolesRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListRolesResponse">ListRolesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The total affected rows across all checks. </p></td>
+ </tr>
<tr>
- <td>roles</td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td>repeated</td>
- <td><p>The roles from the specified request. </p></td>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td></td>
+ <td><p>The aggregated risk level of the check. </p></td>
</tr>
</tbody>
@@ -24281,8 +23573,8 @@ Format: roles/{role} </p></td>
- <h3 id="bytebase.v1.Role">Role</h3>
- <p>Role defines a set of permissions that can be assigned to users.</p>
+ <h3 id="bytebase.v1.CheckReleaseResponse.CheckResult">CheckReleaseResponse.CheckResult</h3>
+ <p>Check result for a single release file on a target database.</p>
<table class="field-table">
@@ -24292,38 +23584,39 @@ Format: roles/{role} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>file</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Resource name. Format: roles/{role} </p></td>
+ <td><p>The file path that is being checked. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>target</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Human-readable title. </p></td>
+ <td><p>The target that the check is performed on.
+Should be a database. Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Optional description of the role. </p></td>
+ <td>advices</td>
+ <td><a href="#bytebase.v1.Advice">Advice</a></td>
+ <td>repeated</td>
+ <td><p>The list of advice for the file and the target. </p></td>
</tr>
<tr>
- <td>permissions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>List of permission identifiers granted by this role. </p></td>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The count of affected rows of the statement on the target. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Role.Type">Role.Type</a></td>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
<td></td>
- <td><p>Role type indicating if it&#39;s built-in or custom. </p></td>
+ <td><p>The risk level of the statement on the target. </p></td>
</tr>
</tbody>
@@ -24333,7 +23626,7 @@ Format: roles/{role} </p></td>
- <h3 id="bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</h3>
+ <h3 id="bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</h3>
<p></p>
@@ -24344,25 +23637,25 @@ Format: roles/{role} </p></td>
<tbody>
<tr>
- <td>role</td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The role to update. </p></td>
+ <td><p>Format: projects/{project} </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>release</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The release to create. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>train</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the role is not found, a new role will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>Train for iteration tracking (template rendered without {iteration}).
+Used to group releases and determine the next iteration number. </p></td>
</tr>
</tbody>
@@ -24372,171 +23665,32 @@ In this situation, `update_mask` is ignored. </p></td>
-
-
- <h3 id="bytebase.v1.Role.Type">Role.Type</h3>
+ <h3 id="bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</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>BUILT_IN</td>
- <td>1</td>
- <td><p>System-defined role that cannot be modified.</p></td>
- </tr>
-
- <tr>
- <td>CUSTOM</td>
- <td>2</td>
- <td><p>User-defined role that can be modified.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.RoleService">RoleService</h3>
- <p>RoleService manages workspace roles and permissions.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ListRoles</td>
- <td><a href="#bytebase.v1.ListRolesRequest">ListRolesRequest</a></td>
- <td><a href="#bytebase.v1.ListRolesResponse">ListRolesResponse</a></td>
- <td><p>Lists roles in the workspace.
-Permissions required: bb.roles.list</p></td>
- </tr>
-
- <tr>
- <td>GetRole</td>
- <td><a href="#bytebase.v1.GetRoleRequest">GetRoleRequest</a></td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td><p>Retrieves a role by name.
-Permissions required: bb.roles.get</p></td>
- </tr>
-
- <tr>
- <td>CreateRole</td>
- <td><a href="#bytebase.v1.CreateRoleRequest">CreateRoleRequest</a></td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td><p>Creates a new custom role.
-Permissions required: bb.roles.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateRole</td>
- <td><a href="#bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</a></td>
- <td><a href="#bytebase.v1.Role">Role</a></td>
- <td><p>Updates a role&#39;s properties.
-Permissions required: bb.roles.update
-When allow_missing=true, also requires: bb.roles.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteRole</td>
- <td><a href="#bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a custom role.
-Permissions required: bb.roles.delete</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>ListRoles</td>
- <td>GET</td>
- <td>/v1/roles</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetRole</td>
- <td>GET</td>
- <td>/v1/{name=roles/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateRole</td>
- <td>POST</td>
- <td>/v1/roles</td>
- <td>role</td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateRole</td>
- <td>PATCH</td>
- <td>/v1/{role.name=roles/*}</td>
- <td>role</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>DeleteRole</td>
- <td>DELETE</td>
- <td>/v1/{name=roles/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the release to delete.
+Format: projects/{project}/releases/{release} </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/rollout_service.proto">v1/rollout_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</h3>
+ <h3 id="bytebase.v1.GetReleaseRequest">GetReleaseRequest</h3>
<p></p>
@@ -24547,20 +23701,34 @@ Permissions required: bb.roles.delete</p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The task name for the taskRuns.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
-Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. </p></td>
+ <td><p>Format: projects/{project}/releases/{release} </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListReleaseCategoriesRequest">ListReleaseCategoriesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>task_runs</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The taskRuns to cancel.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td></td>
+ <td><p>Format: projects/{project} </p></td>
</tr>
</tbody>
@@ -24570,14 +23738,31 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task
- <h3 id="bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</h3>
+ <h3 id="bytebase.v1.ListReleaseCategoriesResponse">ListReleaseCategoriesResponse</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>categories</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The unique category values in the project. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</h3>
+ <h3 id="bytebase.v1.ListReleasesRequest">ListReleasesRequest</h3>
<p></p>
@@ -24591,23 +23776,48 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/task
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The stage name for the tasks.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
+ <td><p>Format: projects/{project} </p></td>
</tr>
<tr>
- <td>tasks</td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of releases to return. The service may return fewer than this value.
+If unspecified, at most 10 releases will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The tasks to run.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ <td></td>
+ <td><p>A page token, received from a previous `ListReleases` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListReleases` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>run_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The task run should run after run_time. </p></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Show deleted releases if specified. </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Filter is used to filter releases returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- category: release category, support &#34;==&#34; operator.
+
+For example:
+category == &#34;webapp&#34; </p></td>
</tr>
</tbody>
@@ -24617,14 +23827,39 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p>
- <h3 id="bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</h3>
+ <h3 id="bytebase.v1.ListReleasesResponse">ListReleasesResponse</h3>
<p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>releases</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td>repeated</td>
+ <td><p>The releases from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</h3>
+ <h3 id="bytebase.v1.Release">Release</h3>
<p></p>
@@ -24635,26 +23870,123 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The stage name for the tasks.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
+ <td><p>Format: projects/{project}/releases/{release} </p></td>
+ </tr>
+
+ <tr>
+ <td>category</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Category extracted from release name (e.g., &#34;webapp&#34;, &#34;analytics&#34;).
+Set by Bytebase action during release creation. </p></td>
+ </tr>
+
+ <tr>
+ <td>files</td>
+ <td><a href="#bytebase.v1.Release.File">Release.File</a></td>
+ <td>repeated</td>
+ <td><p>The SQL files included in the release. </p></td>
+ </tr>
+
+ <tr>
+ <td>vcs_source</td>
+ <td><a href="#bytebase.v1.Release.VCSSource">Release.VCSSource</a></td>
+ <td></td>
+ <td><p>The version control source of the release. </p></td>
+ </tr>
+
+ <tr>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
+ <td></td>
+ <td><p>The lifecycle state of the release. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Release.Type">Release.Type</a></td>
+ <td></td>
+ <td><p>The type of schema change for all files in this release. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Release.File">Release.File</h3>
+ <p>A SQL file in a release.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>path</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The path of the file. e.g., `2.2/V0001_create_table.sql`. </p></td>
+ </tr>
+
+ <tr>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The version identifier for the file. </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_ghost</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to use gh-ost for online schema migration. </p></td>
+ </tr>
+
+ <tr>
+ <td>sheet</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>For inputs, we must either use `sheet` or `statement`.
+For outputs, we always use `sheet`. `statement` is the preview of the sheet content.
+
+The sheet that holds the content.
+Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>tasks</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The tasks to skip.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ <td>statement</td>
+ <td><a href="#bytes">bytes</a></td>
+ <td></td>
+ <td><p>The raw SQL statement content. </p></td>
</tr>
<tr>
- <td>reason</td>
+ <td>sheet_sha256</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The reason for skipping the tasks. </p></td>
+ <td><p>The SHA256 hash value of the sheet content or the statement. </p></td>
</tr>
</tbody>
@@ -24664,15 +23996,8 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p>
- <h3 id="bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.Release.VCSSource">Release.VCSSource</h3>
+ <p>Version control system source information.</p>
<table class="field-table">
@@ -24682,21 +24007,17 @@ Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>vcs_type</td>
+ <td><a href="#bytebase.v1.VCSType">VCSType</a></td>
<td></td>
- <td><p>The parent plan for which this rollout will be created.
-Format: projects/{project}/plans/{plan} </p></td>
+ <td><p>The type of VCS. </p></td>
</tr>
<tr>
- <td>target</td>
+ <td>url</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Create the rollout only for the specified target.
-Format: environments/{environment}
-If unspecified, all stages are created.
-If set to &#34;&#34;, no stages are created. </p></td>
+ <td></td>
+ <td><p>The url link to the e.g., GitHub commit or pull request. </p></td>
</tr>
</tbody>
@@ -24706,7 +24027,7 @@ If set to &#34;&#34;, no stages are created. </p></td>
- <h3 id="bytebase.v1.GetRolloutRequest">GetRolloutRequest</h3>
+ <h3 id="bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</h3>
<p></p>
@@ -24720,9 +24041,8 @@ If set to &#34;&#34;, no stages are created. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the rollout to retrieve.
-This is the rollout resource name, which is the plan name plus /rollout suffix.
-Format: projects/{project}/plans/{plan}/rollout </p></td>
+ <td><p>The name of the deleted release.
+Format: projects/{project}/releases/{release} </p></td>
</tr>
</tbody>
@@ -24732,7 +24052,7 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
- <h3 id="bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</h3>
+ <h3 id="bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</h3>
<p></p>
@@ -24743,34 +24063,17 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>release</td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>The release to update. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ <td><p>The list of fields to be updated. </p></td>
</tr>
</tbody>
@@ -24780,94 +24083,225 @@ Format: projects/{project}/plans/{plan}/rollout </p></td>
- <h3 id="bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</h3>
- <p></p>
+
+
+ <h3 id="bytebase.v1.Release.Type">Release.Type</h3>
+ <p>The type of schema change.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>VERSIONED</td>
+ <td>1</td>
+ <td><p>Versioned schema migration.</p></td>
+ </tr>
+
+ <tr>
+ <td>DECLARATIVE</td>
+ <td>2</td>
+ <td><p>Declarative schema definition.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ReleaseService">ReleaseService</h3>
+ <p>ReleaseService manages releases for coordinating deployments.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetRelease</td>
+ <td><a href="#bytebase.v1.GetReleaseRequest">GetReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Retrieves a release by name.
+Permissions required: bb.releases.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListReleases</td>
+ <td><a href="#bytebase.v1.ListReleasesRequest">ListReleasesRequest</a></td>
+ <td><a href="#bytebase.v1.ListReleasesResponse">ListReleasesResponse</a></td>
+ <td><p>Lists releases in a project.
+Permissions required: bb.releases.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateRelease</td>
+ <td><a href="#bytebase.v1.CreateReleaseRequest">CreateReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Creates a new release with SQL files.
+Permissions required: bb.releases.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateRelease</td>
+ <td><a href="#bytebase.v1.UpdateReleaseRequest">UpdateReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Updates an existing release.
+Permissions required: bb.releases.update
+When allow_missing=true, also requires: bb.releases.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteRelease</td>
+ <td><a href="#bytebase.v1.DeleteReleaseRequest">DeleteReleaseRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a release.
+Permissions required: bb.releases.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>UndeleteRelease</td>
+ <td><a href="#bytebase.v1.UndeleteReleaseRequest">UndeleteReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.Release">Release</a></td>
+ <td><p>Restores a deleted release.
+Permissions required: bb.releases.undelete</p></td>
+ </tr>
+
+ <tr>
+ <td>CheckRelease</td>
+ <td><a href="#bytebase.v1.CheckReleaseRequest">CheckReleaseRequest</a></td>
+ <td><a href="#bytebase.v1.CheckReleaseResponse">CheckReleaseResponse</a></td>
+ <td><p>Validates a release by dry-running checks on target databases.
+Permissions required: bb.releases.check</p></td>
+ </tr>
+
+ <tr>
+ <td>ListReleaseCategories</td>
+ <td><a href="#bytebase.v1.ListReleaseCategoriesRequest">ListReleaseCategoriesRequest</a></td>
+ <td><a href="#bytebase.v1.ListReleaseCategoriesResponse">ListReleaseCategoriesResponse</a></td>
+ <td><p>Lists all unique categories in a project.
+Permissions required: bb.releases.list</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>GetRelease</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/releases/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListReleases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/releases</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>CreateRelease</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/releases</td>
+ <td>release</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateRelease</td>
+ <td>PATCH</td>
+ <td>/v1/{release.name=projects/*/releases/*}</td>
+ <td>release</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteRelease</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/releases/*}</td>
+ <td></td>
+ </tr>
+
+
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
- </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>UndeleteRelease</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/releases/*}:undelete</td>
+ <td></td>
+ </tr>
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent, which owns this collection of rollouts.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list all rollouts from all projects. </p></td>
- </tr>
+
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of rollouts to return. The service may return fewer than
-this value.
-If unspecified, at most 10 rollouts will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A page token, received from a previous `ListRollouts` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListRollouts` must match
-the call that provided the page token. </p></td>
- </tr>
+ <tr>
+ <td>CheckRelease</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/releases:check</td>
+ <td>*</td>
+ </tr>
+
+
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Filter is used to filter rollouts returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filters:
-- update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
-- task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
-
-For example:
-update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
-task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
- </tr>
+ <tr>
+ <td>ListReleaseCategories</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/releases:listCategories</td>
+ <td></td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</h3>
+ <div class="file-heading">
+ <h2 id="v1/review_config_service.proto">v1/review_config_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</h3>
<p></p>
@@ -24878,18 +24312,10 @@ task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
<tbody>
<tr>
- <td>rollouts</td>
- <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
- <td>repeated</td>
- <td><p>The rollouts from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>review_config</td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</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 SQL review config to create. </p></td>
</tr>
</tbody>
@@ -24899,7 +24325,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</h3>
+ <h3 id="bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</h3>
<p></p>
@@ -24910,12 +24336,11 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent, which owns this collection of taskRuns.
-Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
-Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. </p></td>
+ <td><p>The name of the SQL review config to delete.
+Format: reviewConfigs/{reviewConfig} </p></td>
</tr>
</tbody>
@@ -24925,7 +24350,7 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</h3>
+ <h3 id="bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</h3>
<p></p>
@@ -24936,10 +24361,11 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<tbody>
<tr>
- <td>task_runs</td>
- <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
- <td>repeated</td>
- <td><p>The taskRuns from the specified request. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the SQL review config to retrieve.
+Format: reviewConfigs/{reviewConfig} </p></td>
</tr>
</tbody>
@@ -24949,31 +24375,14 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</h3>
+ <h3 id="bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</h3>
<p></p>
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
- <h3 id="bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</h3>
+ <h3 id="bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</h3>
<p></p>
@@ -24984,10 +24393,10 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<tbody>
<tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The rollback SQL statement that would undo the task run. </p></td>
+ <td>review_configs</td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td>repeated</td>
+ <td><p>The SQL review configs from the specified request. </p></td>
</tr>
</tbody>
@@ -24997,7 +24406,7 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
- <h3 id="bytebase.v1.Rollout">Rollout</h3>
+ <h3 id="bytebase.v1.ReviewConfig">ReviewConfig</h3>
<p></p>
@@ -25011,86 +24420,37 @@ Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list a
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the rollout.
-Format: projects/{project}/plans/{plan}/rollout </p></td>
+ <td><p>The name of the SQL review config.
+Format: reviewConfigs/{reviewConfig} </p></td>
</tr>
<tr>
<td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the rollout, inherited from the associated plan.
-This field is output only and cannot be directly set. </p></td>
- </tr>
-
- <tr>
- <td>stages</td>
- <td><a href="#bytebase.v1.Stage">Stage</a></td>
- <td>repeated</td>
- <td><p>Stages and thus tasks of the rollout. </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The title of the review configuration. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Stage">Stage</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>enabled</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}
-Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. </p></td>
+ <td><p>Whether the review configuration is enabled. </p></td>
</tr>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>id is the environment id of the stage.
-e.g., &#34;prod&#34;.
-Use &#34;-&#34; when the stage has no environment or deleted environment. </p></td>
+ <td>rules</td>
+ <td><a href="#bytebase.v1.SQLReviewRule">SQLReviewRule</a></td>
+ <td>repeated</td>
+ <td><p>The SQL review rules to enforce. </p></td>
</tr>
<tr>
- <td>environment</td>
+ <td>resources</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>environment is the environment of the stage.
-Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. </p></td>
- </tr>
-
- <tr>
- <td>tasks</td>
- <td><a href="#bytebase.v1.Task">Task</a></td>
<td>repeated</td>
- <td><p>The tasks within this stage. </p></td>
+ <td><p>Resources using the config.
+Format: {resource}/{resource id}, e.g., environments/test. </p></td>
</tr>
</tbody>
@@ -25100,94 +24460,77 @@ Format: environments/{environment} for valid environments, or &#34;environments/
- <h3 id="bytebase.v1.Task">Task</h3>
- <p></p>
+ <h3 id="bytebase.v1.SQLReviewRule">SQLReviewRule</h3>
+ <p>SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.</p>
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
- </tr>
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>spec_id</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</a></td>
<td></td>
- <td><p>A UUID4 string that uniquely identifies the Spec. </p></td>
+ <td><p>The type of SQL review rule. </p></td>
</tr>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Task.Status">Task.Status</a></td>
+ <td>level</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</a></td>
<td></td>
- <td><p>Status is the status of the task. </p></td>
+ <td><p>The severity level of the rule. </p></td>
</tr>
<tr>
- <td>skipped_reason</td>
- <td><a href="#string">string</a></td>
+ <td>naming_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td>
<td></td>
- <td><p>The reason why the task was skipped. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Task.Type">Task.Type</a></td>
+ <td>number_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>target</td>
- <td><a href="#string">string</a></td>
+ <td>string_array_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td>
<td></td>
- <td><p>Format: instances/{instance} if the task is DatabaseCreate.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>database_create</td>
- <td><a href="#bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</a></td>
+ <td>comment_convention_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>database_update</td>
- <td><a href="#bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</a></td>
+ <td>string_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>database_data_export</td>
- <td><a href="#bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</a></td>
+ <td>naming_case_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The update_time is the update time of latest task run.
-If there are no task runs, it will be empty. </p></td>
- </tr>
-
- <tr>
- <td>run_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The run_time is the scheduled run time of latest task run.
-If there are no task runs or the task run is not scheduled, it will be empty. </p></td>
+ <td>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td></td>
+ <td><p>The database engine this rule applies to. </p></td>
</tr>
</tbody>
@@ -25197,8 +24540,8 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
- <h3 id="bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</h3>
- <p>Payload for creating a new database.</p>
+ <h3 id="bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3>
+ <p></p>
<table class="field-table">
@@ -25208,10 +24551,17 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
<tbody>
<tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
+ <td>required</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -25221,8 +24571,8 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
- <h3 id="bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</h3>
- <p>Payload for exporting database data.</p>
+ <h3 id="bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3>
+ <p></p>
<table class="field-table">
@@ -25232,11 +24582,10 @@ If there are no task runs or the task run is not scheduled, it will be empty. </
<tbody>
<tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
+ <td>upper</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The resource name of the sheet.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -25246,8 +24595,8 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</h3>
- <p>Payload for updating a database schema.</p>
+ <h3 id="bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3>
+ <p>Payload message types for SQL review rules</p>
<table class="field-table">
@@ -25257,17 +24606,17 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tbody>
<tr>
- <td>sheet</td>
- <td><a href="#string">string</a></td>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>release</td>
+ <td>format</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/releases/{release} </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -25277,7 +24626,7 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.v1.TaskRun">TaskRun</h3>
+ <h3 id="bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3>
<p></p>
@@ -25288,84 +24637,99 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
-
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>number</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
+ <td>list</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.TaskRun.Status">TaskRun.Status</a></td>
- <td></td>
- <td><p>The current execution status of the task run. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>detail</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Below are the results of a task run.
-Detailed information about the task run result. </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The time when the task run started execution. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>export_archive_status</td>
- <td><a href="#bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</a></td>
+ <td>review_config</td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
<td></td>
- <td><p>The export archive status for data export tasks. </p></td>
+ <td><p>The SQL review config to update.
+
+The name field is used to identify the SQL review config to update. </p></td>
</tr>
<tr>
- <td>has_prior_backup</td>
- <td><a href="#bool">bool</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>Indicates whether a prior backup was created for this task run.
-When true, rollback SQL can be generated via PreviewTaskRunRollback.
-Backup details are available in the task run logs. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>scheduler_info</td>
- <td><a href="#bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Scheduling information about the task run. </p></td>
- </tr>
-
- <tr>
- <td>run_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>The task run should run after run_time.
-This can only be set when creating the task run calling BatchRunTasks. </p></td>
+ <td><p>If set to true, and the config is not found, a new config will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -25375,188 +24739,843 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
- <h3 id="bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</h3>
- <p>Information about task run scheduling.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>report_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The time when the scheduling info was reported. </p></td>
- </tr>
-
- <tr>
- <td>waiting_cause</td>
- <td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</a></td>
- <td></td>
- <td><p>The cause for the task run waiting. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</h3>
- <p>Information about why a task run is waiting.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parallel_tasks_limit</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Waiting due to parallel tasks limit. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+ <h3 id="bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</h3>
+ <p>The severity level for SQL review rules.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified level.</p></td>
+ </tr>
+
+ <tr>
+ <td>ERROR</td>
+ <td>1</td>
+ <td><p>Rule violation is an error.</p></td>
+ </tr>
+
+ <tr>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p>Rule violation is a warning.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.SQLReviewRule.Type">SQLReviewRule.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ENGINE_MYSQL_USE_INNODB</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_FULLY_QUALIFIED</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_TABLE</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_COLUMN</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_INDEX_PK</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_INDEX_UK</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_INDEX_FK</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_INDEX_IDX</td>
+ <td>8</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_COLUMN_AUTO_INCREMENT</td>
+ <td>9</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_TABLE_NO_KEYWORD</td>
+ <td>10</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_IDENTIFIER_NO_KEYWORD</td>
+ <td>11</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>NAMING_IDENTIFIER_CASE</td>
+ <td>12</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_SELECT_NO_SELECT_ALL</td>
+ <td>13</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_WHERE_REQUIRE_SELECT</td>
+ <td>14</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_WHERE_REQUIRE_UPDATE_DELETE</td>
+ <td>15</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE</td>
+ <td>16</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_ON_DEL_CASCADE</td>
+ <td>17</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_RM_TBL_CASCADE</td>
+ <td>18</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_COMMIT</td>
+ <td>19</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_LIMIT</td>
+ <td>20</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_ORDER_BY</td>
+ <td>21</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_MERGE_ALTER_TABLE</td>
+ <td>22</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_INSERT_ROW_LIMIT</td>
+ <td>23</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_INSERT_MUST_SPECIFY_COLUMN</td>
+ <td>24</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND</td>
+ <td>25</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_AFFECTED_ROW_LIMIT</td>
+ <td>26</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DML_DRY_RUN</td>
+ <td>27</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT</td>
+ <td>28</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_ADD_CHECK_NOT_VALID</td>
+ <td>29</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_ADD_FOREIGN_KEY_NOT_VALID</td>
+ <td>30</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_ADD_NOT_NULL</td>
+ <td>31</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_SELECT_FULL_TABLE_SCAN</td>
+ <td>32</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_CREATE_SPECIFY_SCHEMA</td>
+ <td>33</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_CHECK_SET_ROLE_VARIABLE</td>
+ <td>34</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_USING_FILESORT</td>
+ <td>35</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_USING_TEMPORARY</td>
+ <td>36</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_WHERE_NO_EQUAL_NULL</td>
+ <td>37</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS</td>
+ <td>38</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_QUERY_MINIMUM_PLAN_LEVEL</td>
+ <td>39</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT</td>
+ <td>40</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_MAXIMUM_LIMIT_VALUE</td>
+ <td>41</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_MAXIMUM_JOIN_TABLE_COUNT</td>
+ <td>42</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION</td>
+ <td>43</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_JOIN_STRICT_COLUMN_ATTRS</td>
+ <td>44</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_NON_TRANSACTIONAL</td>
+ <td>45</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_ADD_COLUMN_WITHOUT_POSITION</td>
+ <td>46</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_OFFLINE_DDL</td>
+ <td>47</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_DISALLOW_CROSS_DB_QUERIES</td>
+ <td>48</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_MAX_EXECUTION_TIME</td>
+ <td>49</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_REQUIRE_ALGORITHM_OPTION</td>
+ <td>50</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_REQUIRE_LOCK_OPTION</td>
+ <td>51</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STATEMENT_OBJECT_OWNER_CHECK</td>
+ <td>52</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_REQUIRE_PK</td>
+ <td>53</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_NO_FOREIGN_KEY</td>
+ <td>54</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_DROP_NAMING_CONVENTION</td>
+ <td>55</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_COMMENT</td>
+ <td>56</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_DISALLOW_PARTITION</td>
+ <td>57</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_DISALLOW_TRIGGER</td>
+ <td>58</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_NO_DUPLICATE_INDEX</td>
+ <td>59</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_TEXT_FIELDS_TOTAL_LENGTH</td>
+ <td>60</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_DISALLOW_SET_CHARSET</td>
+ <td>61</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_DISALLOW_DDL</td>
+ <td>62</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_DISALLOW_DML</td>
+ <td>63</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_LIMIT_SIZE</td>
+ <td>64</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_REQUIRE_CHARSET</td>
+ <td>65</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE_REQUIRE_COLLATION</td>
+ <td>66</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_REQUIRED</td>
+ <td>67</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_NO_NULL</td>
+ <td>68</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_CHANGE_TYPE</td>
+ <td>69</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_SET_DEFAULT_FOR_NOT_NULL</td>
+ <td>70</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_CHANGE</td>
+ <td>71</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_CHANGING_ORDER</td>
+ <td>72</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_DROP</td>
+ <td>73</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_DROP_IN_INDEX</td>
+ <td>74</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_COMMENT</td>
+ <td>75</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_AUTO_INCREMENT_MUST_INTEGER</td>
+ <td>76</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_TYPE_DISALLOW_LIST</td>
+ <td>77</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DISALLOW_SET_CHARSET</td>
+ <td>78</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_MAXIMUM_CHARACTER_LENGTH</td>
+ <td>79</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_MAXIMUM_VARCHAR_LENGTH</td>
+ <td>80</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_AUTO_INCREMENT_INITIAL_VALUE</td>
+ <td>81</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_AUTO_INCREMENT_MUST_UNSIGNED</td>
+ <td>82</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_CURRENT_TIME_COUNT_LIMIT</td>
+ <td>83</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_REQUIRE_DEFAULT</td>
+ <td>84</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_DEFAULT_DISALLOW_VOLATILE</td>
+ <td>85</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT</td>
+ <td>86</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_REQUIRE_CHARSET</td>
+ <td>87</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>COLUMN_REQUIRE_COLLATION</td>
+ <td>88</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SCHEMA_BACKWARD_COMPATIBILITY</td>
+ <td>89</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_DROP_EMPTY_DATABASE</td>
+ <td>90</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_NO_DUPLICATE_COLUMN</td>
+ <td>91</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_KEY_NUMBER_LIMIT</td>
+ <td>92</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_PK_TYPE_LIMIT</td>
+ <td>93</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_TYPE_NO_BLOB</td>
+ <td>94</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_TOTAL_NUMBER_LIMIT</td>
+ <td>95</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_PRIMARY_KEY_TYPE_ALLOWLIST</td>
+ <td>96</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_CREATE_CONCURRENTLY</td>
+ <td>97</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_TYPE_ALLOW_LIST</td>
+ <td>98</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INDEX_NOT_REDUNDANT</td>
+ <td>99</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_CHARSET_ALLOWLIST</td>
+ <td>100</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_COLLATION_ALLOWLIST</td>
+ <td>101</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_COMMENT_LENGTH</td>
+ <td>102</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_PROCEDURE_DISALLOW_CREATE</td>
+ <td>103</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_EVENT_DISALLOW_CREATE</td>
+ <td>104</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_VIEW_DISALLOW_CREATE</td>
+ <td>105</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_FUNCTION_DISALLOW_CREATE</td>
+ <td>106</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_FUNCTION_DISALLOWED_LIST</td>
+ <td>107</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ADVICE_ONLINE_MIGRATION</td>
+ <td>108</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>BUILTIN_PRIOR_BACKUP_CHECK</td>
+ <td>109</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
-
- <h3 id="bytebase.v1.TaskRunLog">TaskRunLog</h3>
- <p></p>
+ <h3 id="bytebase.v1.ReviewConfigService">ReviewConfigService</h3>
+ <p>ReviewConfigService manages approval flow configurations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>CreateReviewConfig</td>
+ <td><a href="#bytebase.v1.CreateReviewConfigRequest">CreateReviewConfigRequest</a></td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td><p>Creates a new SQL review configuration.
+Permissions required: bb.reviewConfigs.create</p></td>
+ </tr>
+
+ <tr>
+ <td>ListReviewConfigs</td>
+ <td><a href="#bytebase.v1.ListReviewConfigsRequest">ListReviewConfigsRequest</a></td>
+ <td><a href="#bytebase.v1.ListReviewConfigsResponse">ListReviewConfigsResponse</a></td>
+ <td><p>Lists all SQL review configurations.
+Permissions required: bb.reviewConfigs.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetReviewConfig</td>
+ <td><a href="#bytebase.v1.GetReviewConfigRequest">GetReviewConfigRequest</a></td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td><p>Retrieves a SQL review configuration by name.
+Permissions required: bb.reviewConfigs.get</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateReviewConfig</td>
+ <td><a href="#bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</a></td>
+ <td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td>
+ <td><p>Updates a SQL review configuration.
+Permissions required: bb.reviewConfigs.update
+When allow_missing=true, also requires: bb.reviewConfigs.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteReviewConfig</td>
+ <td><a href="#bytebase.v1.DeleteReviewConfigRequest">DeleteReviewConfigRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a SQL review configuration.
+Permissions required: bb.reviewConfigs.delete</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log </p></td>
- </tr>
- <tr>
- <td>entries</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</a></td>
- <td>repeated</td>
- <td><p>The log entries for this task run. </p></td>
- </tr>
+ <tr>
+ <td>CreateReviewConfig</td>
+ <td>POST</td>
+ <td>/v1/reviewConfigs</td>
+ <td>review_config</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</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.TaskRunLogEntry.Type">TaskRunLogEntry.Type</a></td>
- <td></td>
- <td><p>The type of this log entry. </p></td>
- </tr>
- <tr>
- <td>log_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The time when the log was recorded. </p></td>
- </tr>
+ <tr>
+ <td>ListReviewConfigs</td>
+ <td>GET</td>
+ <td>/v1/reviewConfigs</td>
+ <td></td>
+ </tr>
- <tr>
- <td>replica_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The replica ID for this log entry. </p></td>
- </tr>
+
- <tr>
- <td>schema_dump</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</a></td>
- <td></td>
- <td><p>Schema dump details (if type is SCHEMA_DUMP). </p></td>
- </tr>
- <tr>
- <td>command_execute</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</a></td>
- <td></td>
- <td><p>Command execution details (if type is COMMAND_EXECUTE). </p></td>
- </tr>
+ <tr>
+ <td>GetReviewConfig</td>
+ <td>GET</td>
+ <td>/v1/{name=reviewConfigs/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>database_sync</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</a></td>
- <td></td>
- <td><p>Database sync details (if type is DATABASE_SYNC). </p></td>
- </tr>
+
- <tr>
- <td>transaction_control</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</a></td>
- <td></td>
- <td><p>Transaction control details (if type is TRANSACTION_CONTROL). </p></td>
- </tr>
- <tr>
- <td>prior_backup</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</a></td>
- <td></td>
- <td><p>Prior backup details (if type is PRIOR_BACKUP). </p></td>
- </tr>
+ <tr>
+ <td>UpdateReviewConfig</td>
+ <td>PATCH</td>
+ <td>/v1/{review_config.name=reviewConfigs/*}</td>
+ <td>review_config</td>
+ </tr>
- <tr>
- <td>retry_info</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</a></td>
- <td></td>
- <td><p>Retry information details (if type is RETRY_INFO). </p></td>
- </tr>
+
- <tr>
- <td>compute_diff</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</a></td>
- <td></td>
- <td><p>Compute diff details (if type is COMPUTE_DIFF). </p></td>
- </tr>
- <tr>
- <td>release_file_execute</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</a></td>
- <td></td>
- <td><p>Release file execution details (if type is RELEASE_FILE_EXECUTE). </p></td>
- </tr>
+ <tr>
+ <td>DeleteReviewConfig</td>
+ <td>DELETE</td>
+ <td>/v1/{name=reviewConfigs/*}</td>
+ <td></td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</h3>
- <p>Command execution details.</p>
+ <div class="file-heading">
+ <h2 id="v1/revision_service.proto">v1/revision_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</h3>
+ <p></p>
<table class="field-table">
@@ -25566,33 +25585,19 @@ This can only be set when creating the task run calling BatchRunTasks. </p></td>
<tbody>
<tr>
- <td>log_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the command was logged. </p></td>
- </tr>
-
- <tr>
- <td>range</td>
- <td><a href="#bytebase.v1.Range">Range</a></td>
- <td></td>
- <td><p>The byte offset range of the executed command in the sheet.
-Uses byte offsets (not character indices) for efficient slicing of sheet content bytes.
-Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. </p></td>
- </tr>
-
- <tr>
- <td>statement</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The executed statement. </p></td>
+ <td><p>The parent resource shared by all revisions being created.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>response</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</a></td>
- <td></td>
- <td><p>The response from executing the command. </p></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the revisions to create.
+A maximum of 100 revisions can be created in a batch. </p></td>
</tr>
</tbody>
@@ -25602,8 +25607,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</h3>
- <p>Command execution response.</p>
+ <h3 id="bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</h3>
+ <p></p>
<table class="field-table">
@@ -25613,32 +25618,10 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>log_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the response was logged. </p></td>
- </tr>
-
- <tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Error message if command execution failed. </p></td>
- </tr>
-
- <tr>
- <td>affected_rows</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>Total affected rows. </p></td>
- </tr>
-
- <tr>
- <td>all_affected_rows</td>
- <td><a href="#int64">int64</a></td>
+ <td>revisions</td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
<td>repeated</td>
- <td><p>`all_affected_rows` is the affected rows of each command.
-`all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. </p></td>
+ <td><p>The created revisions. </p></td>
</tr>
</tbody>
@@ -25648,8 +25631,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</h3>
- <p>Schema diff computation details.</p>
+ <h3 id="bytebase.v1.CreateRevisionRequest">CreateRevisionRequest</h3>
+ <p></p>
<table class="field-table">
@@ -25659,24 +25642,42 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When diff computation started. </p></td>
+ <td><p>Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>revision</td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
<td></td>
- <td><p>When diff computation ended. </p></td>
+ <td><p>The revision to create. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>error</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if computation failed. </p></td>
+ <td><p>The name of the revision to delete.
+Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
</tr>
</tbody>
@@ -25686,8 +25687,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</h3>
- <p>Database synchronization details.</p>
+ <h3 id="bytebase.v1.GetRevisionRequest">GetRevisionRequest</h3>
+ <p></p>
<table class="field-table">
@@ -25697,24 +25698,11 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the database sync started. </p></td>
- </tr>
-
- <tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the database sync ended. </p></td>
- </tr>
-
- <tr>
- <td>error</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if sync failed. </p></td>
+ <td><p>The name of the revision.
+Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
</tr>
</tbody>
@@ -25724,8 +25712,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</h3>
- <p>Prior backup operation details.</p>
+ <h3 id="bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</h3>
+ <p></p>
<table class="field-table">
@@ -25735,31 +25723,38 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When the backup started. </p></td>
+ <td><p>The parent of the revisions.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>When the backup ended. </p></td>
+ <td><p>The maximum number of revisions to return. The service may return fewer
+than this value. If unspecified, at most 10 revisions will be returned. The
+maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>prior_backup_detail</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The backup details. </p></td>
+ <td><p>A page token, received from a previous `ListRevisions` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListRevisions` must
+match the call that provided the page token. </p></td>
</tr>
<tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Error message if the backup failed. </p></td>
+ <td><p>Whether to include deleted revisions in the results. </p></td>
</tr>
</tbody>
@@ -25769,8 +25764,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</h3>
- <p>Prior backup detail for rollback purposes.</p>
+ <h3 id="bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</h3>
+ <p></p>
<table class="field-table">
@@ -25780,10 +25775,18 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>items</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</a></td>
+ <td>revisions</td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
<td>repeated</td>
- <td><p>The list of backed up tables. </p></td>
+ <td><p>The revisions from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -25793,8 +25796,8 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</h3>
- <p>A single backup table mapping.</p>
+ <h3 id="bytebase.v1.Revision">Revision</h3>
+ <p></p>
<table class="field-table">
@@ -25804,70 +25807,86 @@ Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents
<tbody>
<tr>
- <td>source_table</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The original table information. </p></td>
+ <td><p>Format: instances/{instance}/databases/{database}/revisions/{revision} </p></td>
</tr>
<tr>
- <td>target_table</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
+ <td>release</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The target backup table information. </p></td>
+ <td><p>Format: projects/{project}/releases/{release}
+Can be empty. </p></td>
</tr>
<tr>
- <td>start_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The start position in the SQL statement. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>end_position</td>
- <td><a href="#bytebase.v1.Position">Position</a></td>
+ <td>deleter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The end position in the SQL statement. </p></td>
+ <td><p>Format: users/[email protected]
+Can be empty. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</h3>
- <p>Table 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>delete_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>Can be empty. </p></td>
+ </tr>
<tr>
- <td>database</td>
+ <td>file</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The database information.
-Format: instances/{instance}/databases/{database} </p></td>
+ <td><p>Format: projects/{project}/releases/{release}/files/{id}
+Can be empty. </p></td>
</tr>
<tr>
- <td>schema</td>
+ <td>version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema name. </p></td>
+ <td><p>The schema version string for this revision. </p></td>
</tr>
<tr>
- <td>table</td>
+ <td>sheet</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The table name. </p></td>
+ <td><p>The sheet that holds the content.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>sheet_sha256</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SHA256 hash value of the sheet. </p></td>
+ </tr>
+
+ <tr>
+ <td>task_run</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The task run associated with the revision.
+Can be empty.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Revision.Type">Revision.Type</a></td>
+ <td></td>
+ <td><p>The type of the revision. </p></td>
</tr>
</tbody>
@@ -25877,77 +25896,153 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</h3>
- <p>Release file execution details.</p>
+
+
+ <h3 id="bytebase.v1.Revision.Type">Revision.Type</h3>
+ <p>The type of schema revision.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>VERSIONED</td>
+ <td>1</td>
+ <td><p>Versioned schema migration.</p></td>
+ </tr>
+
+ <tr>
+ <td>DECLARATIVE</td>
+ <td>2</td>
+ <td><p>Declarative schema definition.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.RevisionService">RevisionService</h3>
+ <p>RevisionService manages schema revision history.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ListRevisions</td>
+ <td><a href="#bytebase.v1.ListRevisionsRequest">ListRevisionsRequest</a></td>
+ <td><a href="#bytebase.v1.ListRevisionsResponse">ListRevisionsResponse</a></td>
+ <td><p>Lists schema revisions for a database.
+Permissions required: bb.revisions.list</p></td>
+ </tr>
+
+ <tr>
+ <td>GetRevision</td>
+ <td><a href="#bytebase.v1.GetRevisionRequest">GetRevisionRequest</a></td>
+ <td><a href="#bytebase.v1.Revision">Revision</a></td>
+ <td><p>Retrieves a schema revision by name.
+Permissions required: bb.revisions.get</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchCreateRevisions</td>
+ <td><a href="#bytebase.v1.BatchCreateRevisionsRequest">BatchCreateRevisionsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchCreateRevisionsResponse">BatchCreateRevisionsResponse</a></td>
+ <td><p>Creates multiple schema revisions in a single operation.
+Permissions required: bb.revisions.create</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteRevision</td>
+ <td><a href="#bytebase.v1.DeleteRevisionRequest">DeleteRevisionRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a schema revision.
+Permissions required: bb.revisions.delete</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <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>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version of the file being executed (e.g., &#34;0001&#34;). </p></td>
- </tr>
- <tr>
- <td>file_path</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). </p></td>
- </tr>
+ <tr>
+ <td>ListRevisions</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*/databases/*}/revisions</td>
+ <td></td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</h3>
- <p>Retry information for failed operations.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The error that triggered the retry. </p></td>
- </tr>
- <tr>
- <td>retry_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Current retry attempt number. </p></td>
- </tr>
+ <tr>
+ <td>GetRevision</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>maximum_retries</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Maximum number of retries allowed. </p></td>
- </tr>
+
+
+
+ <tr>
+ <td>BatchCreateRevisions</td>
+ <td>POST</td>
+ <td>/v1/{parent=instances/*/databases/*}/revisions:batchCreate</td>
+ <td>*</td>
+ </tr>
+
+
+
+ <tr>
+ <td>DeleteRevision</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*/databases/*/revisions/*}</td>
+ <td></td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</h3>
- <p>Schema dump operation details.</p>
+ <div class="file-heading">
+ <h2 id="v1/role_service.proto">v1/role_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateRoleRequest">CreateRoleRequest</h3>
+ <p></p>
<table class="field-table">
@@ -25957,24 +26052,21 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>start_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>When the schema dump started. </p></td>
- </tr>
-
- <tr>
- <td>end_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>role</td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
<td></td>
- <td><p>When the schema dump ended. </p></td>
+ <td><p>The role to create. </p></td>
</tr>
<tr>
- <td>error</td>
+ <td>role_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if the schema dump failed. </p></td>
+ <td><p>The ID to use for the role, which will become the final component
+of the role&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][A-Z][0-9]/. </p></td>
</tr>
</tbody>
@@ -25984,8 +26076,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</h3>
- <p>Transaction control operation details.</p>
+ <h3 id="bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</h3>
+ <p></p>
<table class="field-table">
@@ -25995,17 +26087,11 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</a></td>
- <td></td>
- <td><p>The type of transaction control. </p></td>
- </tr>
-
- <tr>
- <td>error</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if the operation failed. </p></td>
+ <td><p>The name of the role to delete.
+Format: roles/{role} </p></td>
</tr>
</tbody>
@@ -26015,7 +26101,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunSession">TaskRunSession</h3>
+ <h3 id="bytebase.v1.GetRoleRequest">GetRoleRequest</h3>
<p></p>
@@ -26029,14 +26115,8 @@ Format: instances/{instance}/databases/{database} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session </p></td>
- </tr>
-
- <tr>
- <td>postgres</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</a></td>
- <td></td>
- <td><p>PostgreSQL session information. </p></td>
+ <td><p>The name of the role to retrieve.
+Format: roles/{role} </p></td>
</tr>
</tbody>
@@ -26046,8 +26126,15 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</h3>
- <p>PostgreSQL session information.</p>
+ <h3 id="bytebase.v1.ListRolesRequest">ListRolesRequest</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListRolesResponse">ListRolesResponse</h3>
+ <p></p>
<table class="field-table">
@@ -26057,24 +26144,10 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>session</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
- <td></td>
- <td><p>`session` is the session of the task run executing commands. </p></td>
- </tr>
-
- <tr>
- <td>blocking_sessions</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
- <td>repeated</td>
- <td><p>`blocking_sessions` block `session`. </p></td>
- </tr>
-
- <tr>
- <td>blocked_sessions</td>
- <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
<td>repeated</td>
- <td><p>`blocked_sessions` are blocked by `session`. </p></td>
+ <td><p>The roles from the specified request. </p></td>
</tr>
</tbody>
@@ -26084,8 +26157,8 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</h3>
- <p>PostgreSQL session information read from `pg_stat_activity`.</p>
+ <h3 id="bytebase.v1.Role">Role</h3>
+ <p>Role defines a set of permissions that can be assigned to users.</p>
<table class="field-table">
@@ -26095,101 +26168,38 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>pid</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Process ID of the session. </p></td>
- </tr>
-
- <tr>
- <td>blocked_by_pids</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>PIDs of sessions blocking this session. </p></td>
- </tr>
-
- <tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Current query being executed. </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Session state (active, idle, etc.). </p></td>
- </tr>
-
- <tr>
- <td>wait_event_type</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Wait event type if session is waiting. </p></td>
- </tr>
-
- <tr>
- <td>wait_event</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Specific wait event if session is waiting. </p></td>
- </tr>
-
- <tr>
- <td>datname</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Database name. </p></td>
- </tr>
-
- <tr>
- <td>usename</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>User name. </p></td>
- </tr>
-
- <tr>
- <td>application_name</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Application name. </p></td>
- </tr>
-
- <tr>
- <td>client_addr</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Client IP address. </p></td>
+ <td><p>Resource name. Format: roles/{role} </p></td>
</tr>
<tr>
- <td>client_port</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Client port number. </p></td>
+ <td></td>
+ <td><p>Human-readable title. </p></td>
</tr>
<tr>
- <td>backend_start</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>When the backend process started. </p></td>
+ <td><p>Optional description of the role. </p></td>
</tr>
<tr>
- <td>xact_start</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>When the current transaction started. </p></td>
+ <td>permissions</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>List of permission identifiers granted by this role. </p></td>
</tr>
<tr>
- <td>query_start</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td>optional</td>
- <td><p>When the current query started. </p></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Role.Type">Role.Type</a></td>
+ <td></td>
+ <td><p>Role type indicating if it&#39;s built-in or custom. </p></td>
</tr>
</tbody>
@@ -26199,230 +26209,49 @@ Format: instances/{instance}/databases/{database} </p></td>
-
-
- <h3 id="bytebase.v1.Task.Status">Task.Status</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>NOT_STARTED</td>
- <td>1</td>
- <td><p>Task has not started and is awaiting its turn in the deployment sequence.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>2</td>
- <td><p>Task is ready to run and waiting for approval or scheduled time.</p></td>
- </tr>
-
- <tr>
- <td>RUNNING</td>
- <td>3</td>
- <td><p>Task is currently executing.</p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>4</td>
- <td><p>Task completed successfully.</p></td>
- </tr>
-
- <tr>
- <td>FAILED</td>
- <td>5</td>
- <td><p>Task execution failed with errors.</p></td>
- </tr>
-
- <tr>
- <td>CANCELED</td>
- <td>6</td>
- <td><p>Task execution was canceled by a user.</p></td>
- </tr>
-
- <tr>
- <td>SKIPPED</td>
- <td>7</td>
- <td><p>Task was skipped and will not be executed.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Task.Type">Task.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified task type.</p></td>
- </tr>
-
- <tr>
- <td>GENERAL</td>
- <td>1</td>
- <td><p>General task for miscellaneous operations.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_CREATE</td>
- <td>2</td>
- <td><p>Database creation task that creates a new database.
-Use payload DatabaseCreate.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_MIGRATE</td>
- <td>3</td>
- <td><p>Database migration task that applies versioned schema changes.
-Use payload DatabaseUpdate.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_EXPORT</td>
- <td>4</td>
- <td><p>Database export task that exports query results or table data.
-Use payload DatabaseDataExport.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>EXPORT_ARCHIVE_STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified export archive status.</p></td>
- </tr>
-
- <tr>
- <td>READY</td>
- <td>1</td>
- <td><p>Export archive is ready for download.</p></td>
- </tr>
-
- <tr>
- <td>EXPORTED</td>
- <td>2</td>
- <td><p>Export archive has been downloaded by the user.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.TaskRun.Status">TaskRun.Status</h3>
+ <h3 id="bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p>Task run is queued and waiting to start execution.</p></td>
- </tr>
-
- <tr>
- <td>RUNNING</td>
- <td>2</td>
- <td><p>Task run is currently executing.</p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>3</td>
- <td><p>Task run completed successfully.</p></td>
- </tr>
-
- <tr>
- <td>FAILED</td>
- <td>4</td>
- <td><p>Task run execution failed with errors.</p></td>
- </tr>
-
- <tr>
- <td>CANCELED</td>
- <td>5</td>
- <td><p>Task run execution was canceled by a user.</p></td>
- </tr>
-
- <tr>
- <td>AVAILABLE</td>
- <td>6</td>
- <td><p>Task run is ready for immediate execution.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</h3>
- <p>Transaction control type.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>BEGIN</td>
- <td>1</td>
- <td><p>Begin transaction.</p></td>
- </tr>
-
- <tr>
- <td>COMMIT</td>
- <td>2</td>
- <td><p>Commit transaction.</p></td>
- </tr>
-
- <tr>
- <td>ROLLBACK</td>
- <td>3</td>
- <td><p>Rollback transaction.</p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>role</td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td></td>
+ <td><p>The role to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the role is not found, a new role will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</h3>
- <p>The type of log entry.</p>
+
+
+ <h3 id="bytebase.v1.Role.Type">Role.Type</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -26432,55 +26261,19 @@ Use payload DatabaseDataExport.</p></td>
<tr>
<td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>SCHEMA_DUMP</td>
+ <td>BUILT_IN</td>
<td>1</td>
- <td><p>Schema dump operation.</p></td>
+ <td><p>System-defined role that cannot be modified.</p></td>
</tr>
<tr>
- <td>COMMAND_EXECUTE</td>
+ <td>CUSTOM</td>
<td>2</td>
- <td><p>Command execution.</p></td>
- </tr>
-
- <tr>
- <td>DATABASE_SYNC</td>
- <td>3</td>
- <td><p>Database synchronization.</p></td>
- </tr>
-
- <tr>
- <td>TRANSACTION_CONTROL</td>
- <td>5</td>
- <td><p>Transaction control (BEGIN, COMMIT, ROLLBACK).</p></td>
- </tr>
-
- <tr>
- <td>PRIOR_BACKUP</td>
- <td>6</td>
- <td><p>Prior backup operation.</p></td>
- </tr>
-
- <tr>
- <td>RETRY_INFO</td>
- <td>7</td>
- <td><p>Retry information.</p></td>
- </tr>
-
- <tr>
- <td>COMPUTE_DIFF</td>
- <td>8</td>
- <td><p>Schema diff computation.</p></td>
- </tr>
-
- <tr>
- <td>RELEASE_FILE_EXECUTE</td>
- <td>9</td>
- <td><p>Release file execution.</p></td>
+ <td><p>User-defined role that can be modified.</p></td>
</tr>
</tbody>
@@ -26490,8 +26283,8 @@ Use payload DatabaseDataExport.</p></td>
- <h3 id="bytebase.v1.RolloutService">RolloutService</h3>
- <p>RolloutService manages the execution of deployment plans.</p>
+ <h3 id="bytebase.v1.RoleService">RoleService</h3>
+ <p>RoleService manages workspace roles and permissions.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -26499,91 +26292,44 @@ Use payload DatabaseDataExport.</p></td>
<tbody>
<tr>
- <td>GetRollout</td>
- <td><a href="#bytebase.v1.GetRolloutRequest">GetRolloutRequest</a></td>
- <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
- <td><p>Retrieves a rollout by its plan name.
-Permissions required: bb.rollouts.get</p></td>
- </tr>
-
- <tr>
- <td>ListRollouts</td>
- <td><a href="#bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</a></td>
- <td><a href="#bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</a></td>
- <td><p>Lists rollouts in a project.
-Permissions required: bb.rollouts.list</p></td>
- </tr>
-
- <tr>
- <td>CreateRollout</td>
- <td><a href="#bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</a></td>
- <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
- <td><p>Creates a new rollout for a plan.
-Permissions required: bb.rollouts.create</p></td>
- </tr>
-
- <tr>
- <td>ListTaskRuns</td>
- <td><a href="#bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</a></td>
- <td><a href="#bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</a></td>
- <td><p>Lists task run executions for a task.
-Permissions required: bb.taskRuns.list</p></td>
- </tr>
-
- <tr>
- <td>GetTaskRun</td>
- <td><a href="#bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</a></td>
- <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
- <td><p>Retrieves a task run by name.
-Permissions required: bb.taskRuns.list</p></td>
- </tr>
-
- <tr>
- <td>GetTaskRunLog</td>
- <td><a href="#bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</a></td>
- <td><a href="#bytebase.v1.TaskRunLog">TaskRunLog</a></td>
- <td><p>Retrieves execution logs for a task run.
-Permissions required: bb.taskRuns.list</p></td>
- </tr>
-
- <tr>
- <td>GetTaskRunSession</td>
- <td><a href="#bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</a></td>
- <td><a href="#bytebase.v1.TaskRunSession">TaskRunSession</a></td>
- <td><p>Retrieves database session information for a running task.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>ListRoles</td>
+ <td><a href="#bytebase.v1.ListRolesRequest">ListRolesRequest</a></td>
+ <td><a href="#bytebase.v1.ListRolesResponse">ListRolesResponse</a></td>
+ <td><p>Lists roles in the workspace.
+Permissions required: bb.roles.list</p></td>
</tr>
<tr>
- <td>BatchRunTasks</td>
- <td><a href="#bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</a></td>
- <td><a href="#bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</a></td>
- <td><p>Executes multiple tasks in a rollout stage.
-Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ <td>GetRole</td>
+ <td><a href="#bytebase.v1.GetRoleRequest">GetRoleRequest</a></td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td><p>Retrieves a role by name.
+Permissions required: bb.roles.get</p></td>
</tr>
<tr>
- <td>BatchSkipTasks</td>
- <td><a href="#bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</a></td>
- <td><a href="#bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</a></td>
- <td><p>Skips multiple tasks in a rollout stage.
-Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ <td>CreateRole</td>
+ <td><a href="#bytebase.v1.CreateRoleRequest">CreateRoleRequest</a></td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td><p>Creates a new custom role.
+Permissions required: bb.roles.create</p></td>
</tr>
<tr>
- <td>BatchCancelTaskRuns</td>
- <td><a href="#bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</a></td>
- <td><a href="#bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</a></td>
- <td><p>Cancels multiple running task executions.
-Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ <td>UpdateRole</td>
+ <td><a href="#bytebase.v1.UpdateRoleRequest">UpdateRoleRequest</a></td>
+ <td><a href="#bytebase.v1.Role">Role</a></td>
+ <td><p>Updates a role&#39;s properties.
+Permissions required: bb.roles.update
+When allow_missing=true, also requires: bb.roles.create</p></td>
</tr>
<tr>
- <td>PreviewTaskRunRollback</td>
- <td><a href="#bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</a></td>
- <td><a href="#bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</a></td>
- <td><p>Generates rollback SQL for a completed task run.
-Permissions required: bb.taskRuns.list</p></td>
+ <td>DeleteRole</td>
+ <td><a href="#bytebase.v1.DeleteRoleRequest">DeleteRoleRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a custom role.
+Permissions required: bb.roles.delete</p></td>
</tr>
</tbody>
@@ -26607,59 +26353,9 @@ Permissions required: bb.taskRuns.list</p></td>
<tr>
- <td>GetRollout</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/plans/*/rollout}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListRollouts</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/rollouts</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>CreateRollout</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*}/rollout</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ListTaskRuns</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetTaskRun</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>GetTaskRunLog</td>
+ <td>ListRoles</td>
<td>GET</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/log</td>
+ <td>/v1/roles</td>
<td></td>
</tr>
@@ -26667,9 +26363,9 @@ Permissions required: bb.taskRuns.list</p></td>
<tr>
- <td>GetTaskRunSession</td>
+ <td>GetRole</td>
<td>GET</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/session</td>
+ <td>/v1/{name=roles/*}</td>
<td></td>
</tr>
@@ -26677,40 +26373,30 @@ Permissions required: bb.taskRuns.list</p></td>
<tr>
- <td>BatchRunTasks</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchRun</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>BatchSkipTasks</td>
+ <td>CreateRole</td>
<td>POST</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchSkip</td>
- <td>*</td>
+ <td>/v1/roles</td>
+ <td>role</td>
</tr>
<tr>
- <td>BatchCancelTaskRuns</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns:batchCancel</td>
- <td>*</td>
+ <td>UpdateRole</td>
+ <td>PATCH</td>
+ <td>/v1/{role.name=roles/*}</td>
+ <td>role</td>
</tr>
<tr>
- <td>PreviewTaskRunRollback</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}:previewRollback</td>
- <td>*</td>
+ <td>DeleteRole</td>
+ <td>DELETE</td>
+ <td>/v1/{name=roles/*}</td>
+ <td></td>
</tr>
@@ -26721,12 +26407,12 @@ Permissions required: bb.taskRuns.list</p></td>
<div class="file-heading">
- <h2 id="v1/setting_service.proto">v1/setting_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/rollout_service.proto">v1/rollout_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.AISetting">AISetting</h3>
+ <h3 id="bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</h3>
<p></p>
@@ -26737,45 +26423,114 @@ Permissions required: bb.taskRuns.list</p></td>
<tbody>
<tr>
- <td>enabled</td>
- <td><a href="#bool">bool</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The task name for the taskRuns.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
+Use `projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/-` to cancel task runs under the same stage. </p></td>
</tr>
<tr>
- <td>provider</td>
- <td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>task_runs</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The taskRuns to cancel.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>endpoint</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The stage name for the tasks.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
</tr>
<tr>
- <td>api_key</td>
+ <td>tasks</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>repeated</td>
+ <td><p>The tasks to run.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
</tr>
<tr>
- <td>model</td>
+ <td>run_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The task run should run after run_time. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The stage name for the tasks.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage} </p></td>
</tr>
<tr>
- <td>version</td>
+ <td>tasks</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The tasks to skip.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task} </p></td>
+ </tr>
+
+ <tr>
+ <td>reason</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The reason for skipping the tasks. </p></td>
</tr>
</tbody>
@@ -26785,7 +26540,14 @@ Permissions required: bb.taskRuns.list</p></td>
- <h3 id="bytebase.v1.Algorithm">Algorithm</h3>
+ <h3 id="bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</h3>
<p></p>
@@ -26796,31 +26558,95 @@ Permissions required: bb.taskRuns.list</p></td>
<tbody>
<tr>
- <td>full_mask</td>
- <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent plan for which this rollout will be created.
+Format: projects/{project}/plans/{plan} </p></td>
</tr>
<tr>
- <td>range_mask</td>
- <td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Create the rollout only for the specified target.
+Format: environments/{environment}
+If unspecified, all stages are created.
+If set to &#34;&#34;, no stages are created. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetRolloutRequest">GetRolloutRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the rollout to retrieve.
+This is the rollout resource name, which is the plan name plus /rollout suffix.
+Format: projects/{project}/plans/{plan}/rollout </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>md5_mask</td>
- <td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>inner_outer_mask</td>
- <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</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}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
</tbody>
@@ -26830,7 +26656,7 @@ Permissions required: bb.taskRuns.list</p></td>
- <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>
+ <h3 id="bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</h3>
<p></p>
@@ -26841,11 +26667,10 @@ Permissions required: bb.taskRuns.list</p></td>
<tbody>
<tr>
- <td>substitution</td>
+ <td>parent</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>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
</tbody>
@@ -26855,7 +26680,7 @@ max length of the string is 16 bytes. </p></td>
- <h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>
+ <h3 id="bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</h3>
<p></p>
@@ -26866,31 +26691,49 @@ max length of the string is 16 bytes. </p></td>
<tbody>
<tr>
- <td>prefix_len</td>
- <td><a href="#int32">int32</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent, which owns this collection of rollouts.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list all rollouts from all projects. </p></td>
</tr>
<tr>
- <td>suffix_len</td>
+ <td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The maximum number of rollouts to return. The service may return fewer than
+this value.
+If unspecified, at most 10 rollouts will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A page token, received from a previous `ListRollouts` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListRollouts` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>substitution</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Filter is used to filter rollouts returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters:
+- update_time: rollout update time in &#34;2006-01-02T15:04:05Z07:00&#34; format, support &#34;&gt;=&#34; or &#34;&lt;=&#34; operator.
+- task_type: the task type, support &#34;in&#34; operator, check the Task.Type enum for the values.
+
+For example:
+update_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
+task_type in [&#34;DATABASE_MIGRATE&#34;, &#34;DATABASE_EXPORT&#34;] </p></td>
</tr>
</tbody>
@@ -26900,7 +26743,7 @@ max length of the string is 16 bytes. </p></td>
- <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>
+ <h3 id="bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</h3>
<p></p>
@@ -26911,10 +26754,18 @@ max length of the string is 16 bytes. </p></td>
<tbody>
<tr>
- <td>salt</td>
+ <td>rollouts</td>
+ <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
+ <td>repeated</td>
+ <td><p>The rollouts from the specified request. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>salt is the salt value to generate a different hash that with the word alone. </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>
@@ -26924,7 +26775,7 @@ max length of the string is 16 bytes. </p></td>
- <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</h3>
+ <h3 id="bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</h3>
<p></p>
@@ -26935,11 +26786,12 @@ max length of the string is 16 bytes. </p></td>
<tbody>
<tr>
- <td>slices</td>
- <td><a href="#bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</a></td>
- <td>repeated</td>
- <td><p>We store it as a repeated field to face the fact that the original value may have multiple parts should be masked.
-But frontend can be started with a single rule easily. </p></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent, which owns this collection of taskRuns.
+Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
+Use &#34;projects/{project}/plans/{plan}/rollout/stages/-/tasks/-&#34; to list all taskRuns from a rollout. </p></td>
</tr>
</tbody>
@@ -26949,7 +26801,7 @@ But frontend can be started with a single rule easily. </p></td>
- <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3>
+ <h3 id="bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</h3>
<p></p>
@@ -26960,27 +26812,10 @@ But frontend can be started with a single rule easily. </p></td>
<tbody>
<tr>
- <td>start</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>start is the start character index (0-based) of the original value, should be less than end.
-Uses character indices (not byte offsets) for display-oriented masking.
-Example: For &#34;你好world&#34;, character index 2 refers to &#39;w&#39; (the 3rd character). </p></td>
- </tr>
-
- <tr>
- <td>end</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>end is the end character index (exclusive) of the original value.
-Uses character indices (not byte offsets) for display-oriented masking. </p></td>
- </tr>
-
- <tr>
- <td>substitution</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>
+ <td>task_runs</td>
+ <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
+ <td>repeated</td>
+ <td><p>The taskRuns from the specified request. </p></td>
</tr>
</tbody>
@@ -26990,7 +26825,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.Announcement">Announcement</h3>
+ <h3 id="bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</h3>
<p></p>
@@ -27001,24 +26836,10 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>level</td>
- <td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td>
- <td></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 text of announcement </p></td>
- </tr>
-
- <tr>
- <td>link</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The optional link, user can follow the link to check extra details </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
</tbody>
@@ -27028,7 +26849,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>
+ <h3 id="bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</h3>
<p></p>
@@ -27039,10 +26860,10 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>settings</td>
- <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The rollback SQL statement that would undo the task run. </p></td>
</tr>
</tbody>
@@ -27052,7 +26873,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>
+ <h3 id="bytebase.v1.Rollout">Rollout</h3>
<p></p>
@@ -27063,22 +26884,38 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>client_id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The resource name of the rollout.
+Format: projects/{project}/plans/{plan}/rollout </p></td>
</tr>
<tr>
- <td>client_secret</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
+ <td><p>The title of the rollout, inherited from the associated plan.
+This field is output only and cannot be directly set. </p></td>
+ </tr>
+
+ <tr>
+ <td>stages</td>
+ <td><a href="#bytebase.v1.Stage">Stage</a></td>
+ <td>repeated</td>
+ <td><p>Stages and thus tasks of the rollout. </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>robot_code</td>
- <td><a href="#string">string</a></td>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -27090,7 +26927,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>
+ <h3 id="bytebase.v1.Stage">Stage</h3>
<p></p>
@@ -27101,17 +26938,35 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>app_id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}
+Use &#34;-&#34; for {stage} when the stage has no environment or deleted environment. </p></td>
</tr>
<tr>
- <td>app_secret</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>id is the environment id of the stage.
+e.g., &#34;prod&#34;.
+Use &#34;-&#34; when the stage has no environment or deleted environment. </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>environment is the environment of the stage.
+Format: environments/{environment} for valid environments, or &#34;environments/-&#34; for stages without environment or with deleted environments. </p></td>
+ </tr>
+
+ <tr>
+ <td>tasks</td>
+ <td><a href="#bytebase.v1.Task">Task</a></td>
+ <td>repeated</td>
+ <td><p>The tasks within this stage. </p></td>
</tr>
</tbody>
@@ -27121,7 +26976,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3>
+ <h3 id="bytebase.v1.Task">Task</h3>
<p></p>
@@ -27132,54 +26987,85 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.WebhookType">WebhookType</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}/rollout/stages/{stage}/tasks/{task} </p></td>
</tr>
<tr>
- <td>slack</td>
- <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td>
+ <td>spec_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>A UUID4 string that uniquely identifies the Spec. </p></td>
</tr>
<tr>
- <td>feishu</td>
- <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Task.Status">Task.Status</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Status is the status of the task. </p></td>
</tr>
<tr>
- <td>wecom</td>
- <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>
+ <td>skipped_reason</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The reason why the task was skipped. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Task.Type">Task.Type</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>lark</td>
- <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>
+ <td>target</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: instances/{instance} if the task is DatabaseCreate.
+Format: instances/{instance}/databases/{database} </p></td>
+ </tr>
+
+ <tr>
+ <td>database_create</td>
+ <td><a href="#bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>dingtalk</td>
- <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>
+ <td>database_update</td>
+ <td><a href="#bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>teams</td>
- <td><a href="#bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</a></td>
+ <td>database_data_export</td>
+ <td><a href="#bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The update_time is the update time of latest task run.
+If there are no task runs, it will be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>run_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The run_time is the scheduled run time of latest task run.
+If there are no task runs or the task run is not scheduled, it will be empty. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -27187,8 +27073,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3>
- <p></p>
+ <h3 id="bytebase.v1.Task.DatabaseCreate">Task.DatabaseCreate</h3>
+ <p>Payload for creating a new database.</p>
<table class="field-table">
@@ -27198,17 +27084,10 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>app_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>app_secret</td>
+ <td>sheet</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
</tbody>
@@ -27218,8 +27097,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3>
- <p></p>
+ <h3 id="bytebase.v1.Task.DatabaseDataExport">Task.DatabaseDataExport</h3>
+ <p>Payload for exporting database data.</p>
<table class="field-table">
@@ -27229,10 +27108,11 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>token</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>
</tbody>
@@ -27242,8 +27122,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Teams">AppIMSetting.Teams</h3>
- <p></p>
+ <h3 id="bytebase.v1.Task.DatabaseUpdate">Task.DatabaseUpdate</h3>
+ <p>Payload for updating a database schema.</p>
<table class="field-table">
@@ -27253,24 +27133,17 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>tenant_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Azure AD tenant ID (Directory ID). </p></td>
- </tr>
-
- <tr>
- <td>client_id</td>
+ <td>sheet</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Azure AD application (client) ID. </p></td>
+ <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>client_secret</td>
+ <td>release</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Azure AD client secret. </p></td>
+ <td><p>Format: projects/{project}/releases/{release} </p></td>
</tr>
</tbody>
@@ -27280,7 +27153,7 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>
+ <h3 id="bytebase.v1.TaskRun">TaskRun</h3>
<p></p>
@@ -27291,26 +27164,86 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>corp_id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
</tr>
<tr>
- <td>agent_id</td>
+ <td>creator</td>
<td><a href="#string">string</a></td>
<td></td>
+ <td><p>Format: users/[email protected] </p></td>
+ </tr>
+
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>secret</td>
- <td><a href="#string">string</a></td>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.TaskRun.Status">TaskRun.Status</a></td>
+ <td></td>
+ <td><p>The current execution status of the task run. </p></td>
+ </tr>
+
+ <tr>
+ <td>detail</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Below are the results of a task run.
+Detailed information about the task run result. </p></td>
+ </tr>
+
+ <tr>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The time when the task run started execution. </p></td>
+ </tr>
+
+ <tr>
+ <td>export_archive_status</td>
+ <td><a href="#bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</a></td>
+ <td></td>
+ <td><p>The export archive status for data export tasks. </p></td>
+ </tr>
+
+ <tr>
+ <td>has_prior_backup</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Indicates whether a prior backup was created for this task run.
+When true, rollback SQL can be generated via PreviewTaskRunRollback.
+Backup details are available in the task run logs. </p></td>
+ </tr>
+
+ <tr>
+ <td>scheduler_info</td>
+ <td><a href="#bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</a></td>
+ <td></td>
+ <td><p>Scheduling information about the task run. </p></td>
+ </tr>
+
+ <tr>
+ <td>run_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>The task run should run after run_time.
+This can only be set when creating the task run calling BatchRunTasks. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -27318,8 +27251,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.DataClassificationSetting">DataClassificationSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRun.SchedulerInfo">TaskRun.SchedulerInfo</h3>
+ <p>Information about task run scheduling.</p>
<table class="field-table">
@@ -27329,10 +27262,17 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>configs</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>report_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The time when the scheduling info was reported. </p></td>
+ </tr>
+
+ <tr>
+ <td>waiting_cause</td>
+ <td><a href="#bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</a></td>
+ <td></td>
+ <td><p>The cause for the task run waiting. </p></td>
</tr>
</tbody>
@@ -27342,8 +27282,8 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRun.SchedulerInfo.WaitingCause">TaskRun.SchedulerInfo.WaitingCause</h3>
+ <p>Information about why a task run is waiting.</p>
<table class="field-table">
@@ -27353,33 +27293,10 @@ Uses character indices (not byte offsets) for display-oriented masking. </p></td
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>parallel_tasks_limit</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]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
+ <td><p>Waiting due to parallel tasks limit. </p></td>
</tr>
</tbody>
@@ -27389,7 +27306,7 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3>
+ <h3 id="bytebase.v1.TaskRunLog">TaskRunLog</h3>
<p></p>
@@ -27400,17 +27317,17 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>key</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>entries</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</a></td>
+ <td>repeated</td>
+ <td><p>The log entries for this task run. </p></td>
</tr>
</tbody>
@@ -27420,7 +27337,7 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3>
+ <h3 id="bytebase.v1.TaskRunLogEntry">TaskRunLogEntry</h3>
<p></p>
@@ -27431,69 +27348,80 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</a></td>
<td></td>
- <td><p>id is the classification id in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
+ <td><p>The type of this log entry. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>log_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The time when the log was recorded. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>replica_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The replica ID for this log entry. </p></td>
</tr>
<tr>
- <td>level_id</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
+ <td>schema_dump</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</a></td>
+ <td></td>
+ <td><p>Schema dump details (if type is SCHEMA_DUMP). </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</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>command_execute</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</a></td>
+ <td></td>
+ <td><p>Command execution details (if type is COMMAND_EXECUTE). </p></td>
+ </tr>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
+ <td>database_sync</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Database sync details (if type is DATABASE_SYNC). </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>transaction_control</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Transaction control details (if type is TRANSACTION_CONTROL). </p></td>
</tr>
<tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
+ <td>prior_backup</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Prior backup details (if type is PRIOR_BACKUP). </p></td>
+ </tr>
+
+ <tr>
+ <td>retry_info</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</a></td>
+ <td></td>
+ <td><p>Retry information details (if type is RETRY_INFO). </p></td>
+ </tr>
+
+ <tr>
+ <td>compute_diff</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</a></td>
+ <td></td>
+ <td><p>Compute diff details (if type is COMPUTE_DIFF). </p></td>
+ </tr>
+
+ <tr>
+ <td>release_file_execute</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</a></td>
+ <td></td>
+ <td><p>Release file execution details (if type is RELEASE_FILE_EXECUTE). </p></td>
</tr>
</tbody>
@@ -27503,8 +27431,8 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute">TaskRunLogEntry.CommandExecute</h3>
+ <p>Command execution details.</p>
<table class="field-table">
@@ -27514,10 +27442,33 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>environments</td>
- <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>log_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the command was logged. </p></td>
+ </tr>
+
+ <tr>
+ <td>range</td>
+ <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td></td>
+ <td><p>The byte offset range of the executed command in the sheet.
+Uses byte offsets (not character indices) for efficient slicing of sheet content bytes.
+Example: For &#34;SELECT 你好;&#34; in a UTF-8 sheet, range [0, 13) represents all 13 bytes. </p></td>
+ </tr>
+
+ <tr>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The executed statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>response</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</a></td>
+ <td></td>
+ <td><p>The response from executing the command. </p></td>
</tr>
</tbody>
@@ -27527,8 +27478,8 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.CommandExecute.CommandResponse">TaskRunLogEntry.CommandExecute.CommandResponse</h3>
+ <p>Command execution response.</p>
<table class="field-table">
@@ -27538,42 +27489,32 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>log_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The resource name of the environment.
-Format: environments/{environment}.
-Output only. </p></td>
+ <td><p>When the response was logged. </p></td>
</tr>
<tr>
- <td>id</td>
+ <td>error</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>
+ <td><p>Error message if command execution failed. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>affected_rows</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The display name of the environment. </p></td>
+ <td><p>Total affected rows. </p></td>
</tr>
<tr>
- <td>tags</td>
- <td><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</a></td>
+ <td>all_affected_rows</td>
+ <td><a href="#int64">int64</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>
+ <td><p>`all_affected_rows` is the affected rows of each command.
+`all_affected_rows` may be unavailable if the database driver doesn&#39;t support it. Caller should fallback to `affected_rows` in that case. </p></td>
</tr>
</tbody>
@@ -27583,8 +27524,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.ComputeDiff">TaskRunLogEntry.ComputeDiff</h3>
+ <p>Schema diff computation details.</p>
<table class="field-table">
@@ -27594,17 +27535,24 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>When diff computation started. </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When diff computation ended. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Error message if computation failed. </p></td>
</tr>
</tbody>
@@ -27614,8 +27562,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.GetSettingRequest">GetSettingRequest</h3>
- <p>The request message for getting a setting.</p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.DatabaseSync">TaskRunLogEntry.DatabaseSync</h3>
+ <p>Database synchronization details.</p>
<table class="field-table">
@@ -27625,10 +27573,24 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the database sync started. </p></td>
+ </tr>
+
+ <tr>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the database sync ended. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the setting. </p></td>
+ <td><p>Error message if sync failed. </p></td>
</tr>
</tbody>
@@ -27638,8 +27600,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.TaskRunLogEntry.PriorBackup">TaskRunLogEntry.PriorBackup</h3>
+ <p>Prior backup operation details.</p>
<table class="field-table">
@@ -27649,41 +27611,31 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>setting</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>When the backup started. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</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>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the backup ended. </p></td>
+ </tr>
<tr>
- <td>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>prior_backup_detail</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</a></td>
+ <td></td>
+ <td><p>The backup details. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Error message if the backup failed. </p></td>
</tr>
</tbody>
@@ -27693,8 +27645,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail">TaskRunLogEntry.PriorBackup.PriorBackupDetail</h3>
+ <p>Prior backup detail for rollback purposes.</p>
<table class="field-table">
@@ -27704,10 +27656,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>types</td>
- <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>
+ <td>items</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>The list of backed up tables. </p></td>
</tr>
</tbody>
@@ -27717,8 +27669,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item</h3>
+ <p>A single backup table mapping.</p>
<table class="field-table">
@@ -27728,38 +27680,31 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>id is the uuid for semantic type. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>source_table</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
<td></td>
- <td><p>the title of the semantic type, it should not be empty. </p></td>
+ <td><p>The original table information. </p></td>
</tr>
<tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
+ <td>target_table</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</a></td>
<td></td>
- <td><p>the description of the semantic type, it can be empty. </p></td>
+ <td><p>The target backup table information. </p></td>
</tr>
<tr>
- <td>algorithm</td>
- <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>
+ <td>start_position</td>
+ <td><a href="#bytebase.v1.Position">Position</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The start position in the SQL statement. </p></td>
</tr>
<tr>
- <td>icon</td>
- <td><a href="#string">string</a></td>
+ <td>end_position</td>
+ <td><a href="#bytebase.v1.Position">Position</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>The end position in the SQL statement. </p></td>
</tr>
</tbody>
@@ -27769,8 +27714,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.TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table">TaskRunLogEntry.PriorBackup.PriorBackupDetail.Item.Table</h3>
+ <p>Table information.</p>
<table class="field-table">
@@ -27780,19 +27725,25 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>database</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the setting.
-Format: settings/{setting}
-Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
+ <td><p>The database information.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.SettingValue">SettingValue</a></td>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The configuration value of the setting. </p></td>
+ <td><p>The schema name. </p></td>
+ </tr>
+
+ <tr>
+ <td>table</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The table name. </p></td>
</tr>
</tbody>
@@ -27802,8 +27753,8 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
- <h3 id="bytebase.v1.SettingValue">SettingValue</h3>
- <p>The data in setting value.</p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.ReleaseFileExecute">TaskRunLogEntry.ReleaseFileExecute</h3>
+ <p>Release file execution details.</p>
<table class="field-table">
@@ -27813,52 +27764,17 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
<tbody>
<tr>
- <td>app_im</td>
- <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>workspace_profile</td>
- <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>workspace_approval</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>data_classification</td>
- <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>semantic_type</td>
- <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>ai</td>
- <td><a href="#bytebase.v1.AISetting">AISetting</a></td>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The version of the file being executed (e.g., &#34;0001&#34;). </p></td>
</tr>
<tr>
- <td>environment</td>
- <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>
+ <td>file_path</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The file path within the release (e.g., &#34;2.2/V0001_create_table.sql&#34;). </p></td>
</tr>
</tbody>
@@ -27868,8 +27784,8 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
- <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>
- <p>The request message for updating or creating a setting.</p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.RetryInfo">TaskRunLogEntry.RetryInfo</h3>
+ <p>Retry information for failed operations.</p>
<table class="field-table">
@@ -27879,32 +27795,24 @@ Example: &#34;settings/SEMANTIC_TYPES&#34; </p></td>
<tbody>
<tr>
- <td>setting</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td></td>
- <td><p>The setting to update. </p></td>
- </tr>
-
- <tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>error</td>
+ <td><a href="#string">string</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 error that triggered the retry. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>retry_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Current retry attempt number. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>maximum_retries</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Maximum number of retries allowed. </p></td>
</tr>
</tbody>
@@ -27914,8 +27822,8 @@ server would not persist the setting value if it is true. </p></td>
- <h3 id="bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.SchemaDump">TaskRunLogEntry.SchemaDump</h3>
+ <p>Schema dump operation details.</p>
<table class="field-table">
@@ -27925,10 +27833,24 @@ server would not persist the setting value if it is true. </p></td>
<tbody>
<tr>
- <td>rules</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>start_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the schema dump started. </p></td>
+ </tr>
+
+ <tr>
+ <td>end_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>When the schema dump ended. </p></td>
+ </tr>
+
+ <tr>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Error message if the schema dump failed. </p></td>
</tr>
</tbody>
@@ -27938,8 +27860,8 @@ server would not persist the setting value if it is true. </p></td>
- <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl">TaskRunLogEntry.TransactionControl</h3>
+ <p>Transaction control operation details.</p>
<table class="field-table">
@@ -27949,50 +27871,17 @@ server would not persist the setting value if it is true. </p></td>
<tbody>
<tr>
- <td>template</td>
- <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</a></td>
<td></td>
- <td><p>The condition that is associated with the rule.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-The `source` field filters which rules apply. The `condition` field then evaluates with full context.
-
-All supported variables:
-statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
-statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
-resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
-resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values.
-statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations.
-resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations.
-request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-
-When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*)
-When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name
-When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name
-When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
-
-For examples:
-resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100
-resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; </p></td>
+ <td><p>The type of transaction control. </p></td>
</tr>
<tr>
- <td>source</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Error message if the operation failed. </p></td>
</tr>
</tbody>
@@ -28002,7 +27891,7 @@ resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engin
- <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3>
+ <h3 id="bytebase.v1.TaskRunSession">TaskRunSession</h3>
<p></p>
@@ -28013,204 +27902,170 @@ resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engin
<tbody>
<tr>
- <td>external_url</td>
+ <td>name</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>
+ <td><p>Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session </p></td>
</tr>
<tr>
- <td>refresh_token_duration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>postgres</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</a></td>
<td></td>
- <td><p>The duration for refresh token. Default is 7 days. </p></td>
+ <td><p>PostgreSQL session information. </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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRunSession.Postgres">TaskRunSession.Postgres</h3>
+ <p>PostgreSQL session 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>maximum_role_expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>session</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
<td></td>
- <td><p>The max duration for role expired. </p></td>
+ <td><p>`session` is the session of the task run executing commands. </p></td>
</tr>
<tr>
- <td>domains</td>
- <td><a href="#string">string</a></td>
+ <td>blocking_sessions</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</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>
+ <td><p>`blocking_sessions` block `session`. </p></td>
</tr>
<tr>
- <td>inactive_session_timeout</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
+ <td>blocked_sessions</td>
+ <td><a href="#bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</a></td>
+ <td>repeated</td>
+ <td><p>`blocked_sessions` are blocked by `session`. </p></td>
</tr>
- <tr>
- <td>enable_audit_log_stdout</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to enable audit logging to stdout in structured JSON format.
-Requires TEAM or ENTERPRISE license. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.TaskRunSession.Postgres.Session">TaskRunSession.Postgres.Session</h3>
+ <p>PostgreSQL session information read from `pg_stat_activity`.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>watermark</td>
- <td><a href="#bool">bool</a></td>
+ <td>pid</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to display watermark on pages.
-Requires ENTERPRISE license. </p></td>
+ <td><p>Process ID of the session. </p></td>
</tr>
<tr>
- <td>directory_sync_token</td>
+ <td>blocked_by_pids</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The token for directory sync authentication. </p></td>
+ <td>repeated</td>
+ <td><p>PIDs of sessions blocking this session. </p></td>
</tr>
<tr>
- <td>branding_logo</td>
+ <td>query</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The branding logo as a data URI (e.g. data:image/png;base64,...). </p></td>
+ <td><p>Current query being executed. </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>state</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Session state (active, idle, etc.). </p></td>
</tr>
<tr>
- <td>access_token_duration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The duration for access token. Default is 1 hour. </p></td>
+ <td>wait_event_type</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Wait event type if session is waiting. </p></td>
</tr>
<tr>
- <td>enable_debug</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether debug mode is enabled. </p></td>
+ <td>wait_event</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Specific wait event if session is waiting. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.WorkspaceProfileSetting.PasswordRestriction">WorkspaceProfileSetting.PasswordRestriction</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>datname</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Database name. </p></td>
+ </tr>
<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>
+ <td>usename</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>User name. </p></td>
</tr>
<tr>
- <td>require_number</td>
- <td><a href="#bool">bool</a></td>
+ <td>application_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>require_number requires the password must contains at least one number. </p></td>
+ <td><p>Application name. </p></td>
</tr>
<tr>
- <td>require_letter</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td>
+ <td>client_addr</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Client IP address. </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>
+ <td>client_port</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Client port number. </p></td>
</tr>
<tr>
- <td>require_special_character</td>
- <td><a href="#bool">bool</a></td>
+ <td>backend_start</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>When the backend process started. </p></td>
</tr>
<tr>
- <td>require_reset_password_for_first_login</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td>
+ <td>xact_start</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>When the current transaction started. </p></td>
</tr>
<tr>
- <td>password_rotation</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>password_rotation requires users to reset their password after the duration. </p></td>
+ <td>query_start</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>optional</td>
+ <td><p>When the current query started. </p></td>
</tr>
</tbody>
@@ -28222,7 +28077,7 @@ Requires ENTERPRISE license. </p></td>
- <h3 id="bytebase.v1.AISetting.Provider">AISetting.Provider</h3>
+ <h3 id="bytebase.v1.Task.Status">Task.Status</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -28231,39 +28086,57 @@ Requires ENTERPRISE license. </p></td>
<tbody>
<tr>
- <td>PROVIDER_UNSPECIFIED</td>
+ <td>STATUS_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified status.</p></td>
</tr>
<tr>
- <td>OPEN_AI</td>
+ <td>NOT_STARTED</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Task has not started and is awaiting its turn in the deployment sequence.</p></td>
</tr>
<tr>
- <td>CLAUDE</td>
+ <td>PENDING</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Task is ready to run and waiting for approval or scheduled time.</p></td>
</tr>
<tr>
- <td>GEMINI</td>
+ <td>RUNNING</td>
<td>3</td>
- <td><p></p></td>
+ <td><p>Task is currently executing.</p></td>
</tr>
<tr>
- <td>AZURE_OPENAI</td>
+ <td>DONE</td>
<td>4</td>
- <td><p></p></td>
+ <td><p>Task completed successfully.</p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>5</td>
+ <td><p>Task execution failed with errors.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>6</td>
+ <td><p>Task execution was canceled by a user.</p></td>
+ </tr>
+
+ <tr>
+ <td>SKIPPED</td>
+ <td>7</td>
+ <td><p>Task was skipped and will not be executed.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3>
+ <h3 id="bytebase.v1.Task.Type">Task.Type</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -28272,28 +28145,43 @@ Requires ENTERPRISE license. </p></td>
<tbody>
<tr>
- <td>MASK_TYPE_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified task type.</p></td>
</tr>
<tr>
- <td>INNER</td>
+ <td>GENERAL</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>General task for miscellaneous operations.</p></td>
</tr>
<tr>
- <td>OUTER</td>
+ <td>DATABASE_CREATE</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Database creation task that creates a new database.
+Use payload DatabaseCreate.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_MIGRATE</td>
+ <td>3</td>
+ <td><p>Database migration task that applies versioned schema changes.
+Use payload DatabaseUpdate.</p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE_EXPORT</td>
+ <td>4</td>
+ <td><p>Database export task that exports query results or table data.
+Use payload DatabaseDataExport.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3>
- <p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p>
+ <h3 id="bytebase.v1.TaskRun.ExportArchiveStatus">TaskRun.ExportArchiveStatus</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -28301,34 +28189,81 @@ Requires ENTERPRISE license. </p></td>
<tbody>
<tr>
- <td>ALERT_LEVEL_UNSPECIFIED</td>
+ <td>EXPORT_ARCHIVE_STATUS_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified export archive status.</p></td>
</tr>
<tr>
- <td>INFO</td>
+ <td>READY</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Export archive is ready for download.</p></td>
</tr>
<tr>
- <td>WARNING</td>
+ <td>EXPORTED</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Export archive has been downloaded by the user.</p></td>
</tr>
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.TaskRun.Status">TaskRun.Status</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>CRITICAL</td>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified status.</p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p>Task run is queued and waiting to start execution.</p></td>
+ </tr>
+
+ <tr>
+ <td>RUNNING</td>
+ <td>2</td>
+ <td><p>Task run is currently executing.</p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
<td>3</td>
- <td><p></p></td>
+ <td><p>Task run completed successfully.</p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>4</td>
+ <td><p>Task run execution failed with errors.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>5</td>
+ <td><p>Task run execution was canceled by a user.</p></td>
+ </tr>
+
+ <tr>
+ <td>AVAILABLE</td>
+ <td>6</td>
+ <td><p>Task run is ready for immediate execution.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.TransactionControl.Type">TaskRunLogEntry.TransactionControl.Type</h3>
+ <p>Transaction control type.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -28336,29 +28271,34 @@ Requires ENTERPRISE license. </p></td>
<tbody>
<tr>
- <td>DATABASE_CHANGE_MODE_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified type.</p></td>
</tr>
<tr>
- <td>PIPELINE</td>
+ <td>BEGIN</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>
+ <td><p>Begin transaction.</p></td>
</tr>
<tr>
- <td>EDITOR</td>
+ <td>COMMIT</td>
<td>2</td>
- <td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td>
+ <td><p>Commit transaction.</p></td>
+ </tr>
+
+ <tr>
+ <td>ROLLBACK</td>
+ <td>3</td>
+ <td><p>Rollback transaction.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.Setting.SettingName">Setting.SettingName</h3>
- <p></p>
+ <h3 id="bytebase.v1.TaskRunLogEntry.Type">TaskRunLogEntry.Type</h3>
+ <p>The type of log entry.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -28366,131 +28306,160 @@ Default to this mode.</p></td>
<tbody>
<tr>
- <td>SETTING_NAME_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified type.</p></td>
</tr>
<tr>
- <td>WORKSPACE_PROFILE</td>
+ <td>SCHEMA_DUMP</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Schema dump operation.</p></td>
</tr>
<tr>
- <td>WORKSPACE_APPROVAL</td>
+ <td>COMMAND_EXECUTE</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Command execution.</p></td>
</tr>
<tr>
- <td>APP_IM</td>
+ <td>DATABASE_SYNC</td>
<td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AI</td>
- <td>4</td>
- <td><p></p></td>
+ <td><p>Database synchronization.</p></td>
</tr>
<tr>
- <td>DATA_CLASSIFICATION</td>
+ <td>TRANSACTION_CONTROL</td>
<td>5</td>
- <td><p></p></td>
+ <td><p>Transaction control (BEGIN, COMMIT, ROLLBACK).</p></td>
</tr>
<tr>
- <td>SEMANTIC_TYPES</td>
+ <td>PRIOR_BACKUP</td>
<td>6</td>
- <td><p></p></td>
+ <td><p>Prior backup operation.</p></td>
</tr>
<tr>
- <td>ENVIRONMENT</td>
+ <td>RETRY_INFO</td>
<td>7</td>
- <td><p></p></td>
+ <td><p>Retry information.</p></td>
+ </tr>
+
+ <tr>
+ <td>COMPUTE_DIFF</td>
+ <td>8</td>
+ <td><p>Schema diff computation.</p></td>
+ </tr>
+
+ <tr>
+ <td>RELEASE_FILE_EXECUTE</td>
+ <td>9</td>
+ <td><p>Release file execution.</p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3>
- <p></p>
+
+
+
+
+ <h3 id="bytebase.v1.RolloutService">RolloutService</h3>
+ <p>RolloutService manages the execution of deployment plans.</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>SOURCE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>GetRollout</td>
+ <td><a href="#bytebase.v1.GetRolloutRequest">GetRolloutRequest</a></td>
+ <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
+ <td><p>Retrieves a rollout by its plan name.
+Permissions required: bb.rollouts.get</p></td>
</tr>
<tr>
- <td>CHANGE_DATABASE</td>
- <td>1</td>
- <td><p></p></td>
+ <td>ListRollouts</td>
+ <td><a href="#bytebase.v1.ListRolloutsRequest">ListRolloutsRequest</a></td>
+ <td><a href="#bytebase.v1.ListRolloutsResponse">ListRolloutsResponse</a></td>
+ <td><p>Lists rollouts in a project.
+Permissions required: bb.rollouts.list</p></td>
</tr>
<tr>
- <td>CREATE_DATABASE</td>
- <td>2</td>
- <td><p></p></td>
+ <td>CreateRollout</td>
+ <td><a href="#bytebase.v1.CreateRolloutRequest">CreateRolloutRequest</a></td>
+ <td><a href="#bytebase.v1.Rollout">Rollout</a></td>
+ <td><p>Creates a new rollout for a plan.
+Permissions required: bb.rollouts.create</p></td>
</tr>
<tr>
- <td>EXPORT_DATA</td>
- <td>3</td>
- <td><p></p></td>
+ <td>ListTaskRuns</td>
+ <td><a href="#bytebase.v1.ListTaskRunsRequest">ListTaskRunsRequest</a></td>
+ <td><a href="#bytebase.v1.ListTaskRunsResponse">ListTaskRunsResponse</a></td>
+ <td><p>Lists task run executions for a task.
+Permissions required: bb.taskRuns.list</p></td>
</tr>
<tr>
- <td>REQUEST_ROLE</td>
- <td>4</td>
- <td><p></p></td>
+ <td>GetTaskRun</td>
+ <td><a href="#bytebase.v1.GetTaskRunRequest">GetTaskRunRequest</a></td>
+ <td><a href="#bytebase.v1.TaskRun">TaskRun</a></td>
+ <td><p>Retrieves a task run by name.
+Permissions required: bb.taskRuns.list</p></td>
</tr>
- </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>GetTaskRunLog</td>
+ <td><a href="#bytebase.v1.GetTaskRunLogRequest">GetTaskRunLogRequest</a></td>
+ <td><a href="#bytebase.v1.TaskRunLog">TaskRunLog</a></td>
+ <td><p>Retrieves execution logs for a task run.
+Permissions required: bb.taskRuns.list</p></td>
+ </tr>
<tr>
- <td>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>GetTaskRunSession</td>
+ <td><a href="#bytebase.v1.GetTaskRunSessionRequest">GetTaskRunSessionRequest</a></td>
+ <td><a href="#bytebase.v1.TaskRunSession">TaskRunSession</a></td>
+ <td><p>Retrieves database session information for a running task.
+Permissions required: bb.taskRuns.list</p></td>
</tr>
<tr>
- <td>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>BatchRunTasks</td>
+ <td><a href="#bytebase.v1.BatchRunTasksRequest">BatchRunTasksRequest</a></td>
+ <td><a href="#bytebase.v1.BatchRunTasksResponse">BatchRunTasksResponse</a></td>
+ <td><p>Executes multiple tasks in a rollout stage.
+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
</tr>
<tr>
- <td>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>BatchSkipTasks</td>
+ <td><a href="#bytebase.v1.BatchSkipTasksRequest">BatchSkipTasksRequest</a></td>
+ <td><a href="#bytebase.v1.BatchSkipTasksResponse">BatchSkipTasksResponse</a></td>
+ <td><p>Skips multiple tasks in a rollout stage.
+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchCancelTaskRuns</td>
+ <td><a href="#bytebase.v1.BatchCancelTaskRunsRequest">BatchCancelTaskRunsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchCancelTaskRunsResponse">BatchCancelTaskRunsResponse</a></td>
+ <td><p>Cancels multiple running task executions.
+Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)</p></td>
+ </tr>
+
+ <tr>
+ <td>PreviewTaskRunRollback</td>
+ <td><a href="#bytebase.v1.PreviewTaskRunRollbackRequest">PreviewTaskRunRollbackRequest</a></td>
+ <td><a href="#bytebase.v1.PreviewTaskRunRollbackResponse">PreviewTaskRunRollbackResponse</a></td>
+ <td><p>Generates rollback SQL for a completed task run.
+Permissions required: bb.taskRuns.list</p></td>
</tr>
</tbody>
@@ -28514,9 +28483,9 @@ Permissions required: bb.settings.set</p></td>
<tr>
- <td>ListSettings</td>
+ <td>GetRollout</td>
<td>GET</td>
- <td>/v1/settings</td>
+ <td>/v1/{name=projects/*/plans/*/rollout}</td>
<td></td>
</tr>
@@ -28524,9 +28493,9 @@ Permissions required: bb.settings.set</p></td>
<tr>
- <td>GetSetting</td>
+ <td>ListRollouts</td>
<td>GET</td>
- <td>/v1/{name=settings/*}</td>
+ <td>/v1/{parent=projects/*}/rollouts</td>
<td></td>
</tr>
@@ -28534,10 +28503,90 @@ Permissions required: bb.settings.set</p></td>
<tr>
- <td>UpdateSetting</td>
- <td>PATCH</td>
- <td>/v1/{setting.name=settings/*}</td>
- <td>setting</td>
+ <td>CreateRollout</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*}/rollout</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListTaskRuns</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetTaskRun</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetTaskRunLog</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/log</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetTaskRunSession</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}/session</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchRunTasks</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchRun</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchSkipTasks</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*}/tasks:batchSkip</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchCancelTaskRuns</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/plans/*/rollout/stages/*/tasks/*}/taskRuns:batchCancel</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>PreviewTaskRunRollback</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/plans/*/rollout/stages/*/tasks/*/taskRuns/*}:previewRollback</td>
+ <td>*</td>
</tr>
diff --git a/proto/v1/v1/actuator_service.proto b/proto/v1/v1/actuator_service.proto
index 074804c4ea..0350472cf0 100644
--- a/proto/v1/v1/actuator_service.proto
+++ b/proto/v1/v1/actuator_service.proto
@@ -9,6 +9,7 @@ import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
import "v1/annotation.proto";
import "v1/common.proto";
+import "v1/setting_service.proto";
import "v1/user_service.proto";
option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";
@@ -68,6 +69,17 @@ message GetActuatorInfoRequest {}
// Request message for deleting cache.
message DeleteCacheRequest {}
+message Restriction {
+ // Whether self-service user signup is disabled.
+ bool disallow_signup = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Whether password-based signin is disabled (except for workspace admins).
+ bool disallow_password_signin = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // Password complexity and restriction requirements.
+ WorkspaceProfileSetting.PasswordRestriction password_restriction = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
// System information and configuration for the Bytebase instance.
// Actuator concept is similar to the Spring Boot Actuator.
message ActuatorInfo {
@@ -139,4 +151,6 @@ message ActuatorInfo {
// The number of active replicas (servers sharing the same database).
int32 replica_count = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ Restriction restriction = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
}