Skip to content

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

refactor: remove deprecated SchemaTemplate feature (#18295)

Danny Xub11f47948c9f
diff --git a/backend/api/v1/setting_service.go b/backend/api/v1/setting_service.go
index ae99da74db..7dc7a10b6a 100644
--- a/backend/api/v1/setting_service.go
+++ b/backend/api/v1/setting_service.go
@@ -19,7 +19,6 @@ import (
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
"github.com/bytebase/bytebase/backend/generated-go/v1/v1connect"
- "github.com/bytebase/bytebase/backend/plugin/schema"
"github.com/bytebase/bytebase/backend/plugin/webhook/dingtalk"
"github.com/bytebase/bytebase/backend/plugin/webhook/feishu"
"github.com/bytebase/bytebase/backend/plugin/webhook/lark"
@@ -61,8 +60,6 @@ var whitelistSettings = []storepb.SettingName{
storepb.SettingName_AI,
storepb.SettingName_WORKSPACE_APPROVAL,
storepb.SettingName_WORKSPACE_PROFILE,
- storepb.SettingName_WORKSPACE_EXTERNAL_APPROVAL,
- storepb.SettingName_SCHEMA_TEMPLATE,
storepb.SettingName_DATA_CLASSIFICATION,
storepb.SettingName_SEMANTIC_TYPES,
storepb.SettingName_SCIM,
@@ -403,22 +400,6 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
}
storeSettingValue = string(bytes)
- case storepb.SettingName_SCHEMA_TEMPLATE:
- schemaTemplateSetting := request.Msg.Setting.Value.GetSchemaTemplateSettingValue()
- if schemaTemplateSetting == nil {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("value cannot be nil when setting schema template setting"))
- }
-
- if err := s.validateSchemaTemplate(ctx, schemaTemplateSetting); err != nil {
- return nil, err
- }
-
- payload := convertV1SchemaTemplateSetting(schemaTemplateSetting)
- bytes, err := protojson.Marshal(payload)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal external approval setting, error: %v", err))
- }
- storeSettingValue = string(bytes)
case storepb.SettingName_DATA_CLASSIFICATION:
if err := s.licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_DATA_CLASSIFICATION); err != nil {
return nil, connect.NewError(connect.CodePermissionDenied, err)
@@ -645,81 +626,6 @@ var disallowedDomains = map[string]bool{
"yeah.net": true,
}
-func (s *SettingService) validateSchemaTemplate(ctx context.Context, schemaTemplateSetting *v1pb.SchemaTemplateSetting) error {
- oldStoreSetting, err := s.store.GetSettingV2(ctx, storepb.SettingName_SCHEMA_TEMPLATE)
- if err != nil {
- return connect.NewError(connect.CodeInternal, errors.Errorf("failed to get setting %q: %v", storepb.SettingName_SCHEMA_TEMPLATE, err))
- }
- settingValue := "{}"
- if oldStoreSetting != nil {
- settingValue = oldStoreSetting.Value
- }
-
- value := new(storepb.SchemaTemplateSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(settingValue), value); err != nil {
- return connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %v with error: %v", storepb.SettingName_SCHEMA_TEMPLATE, err))
- }
- v1Value := convertToSchemaTemplateSetting(value)
-
- // validate the changed field(column) template.
- oldFieldTemplateMap := map[string]*v1pb.SchemaTemplateSetting_FieldTemplate{}
- for _, template := range v1Value.FieldTemplates {
- oldFieldTemplateMap[template.Id] = template
- }
- for _, template := range schemaTemplateSetting.FieldTemplates {
- oldTemplate, ok := oldFieldTemplateMap[template.Id]
- if ok && oldTemplate.Equal(template) {
- continue
- }
- tableMetadata := &v1pb.TableMetadata{
- Name: "temp_table",
- Columns: []*v1pb.ColumnMetadata{template.Column},
- }
- if err := validateTableMetadata(template.Engine, tableMetadata); err != nil {
- return err
- }
- }
-
- // validate the changed table template.
- oldTableTemplateMap := map[string]*v1pb.SchemaTemplateSetting_TableTemplate{}
- for _, template := range v1Value.TableTemplates {
- oldTableTemplateMap[template.Id] = template
- }
- for _, template := range schemaTemplateSetting.TableTemplates {
- oldTemplate, ok := oldTableTemplateMap[template.Id]
- if ok && oldTemplate.Equal(template) {
- continue
- }
- if err := validateTableMetadata(template.Engine, template.Table); err != nil {
- return err
- }
- }
-
- return nil
-}
-
-func validateTableMetadata(engine v1pb.Engine, tableMetadata *v1pb.TableMetadata) error {
- tempSchema := &v1pb.SchemaMetadata{
- Name: "",
- Tables: []*v1pb.TableMetadata{tableMetadata},
- }
- if engine == v1pb.Engine_POSTGRES {
- tempSchema.Name = "temp_schema"
- }
- tempMetadata := &v1pb.DatabaseMetadata{
- Name: "temp_database",
- Schemas: []*v1pb.SchemaMetadata{tempSchema},
- }
- tempStoreSchemaMetadata := convertV1DatabaseMetadata(tempMetadata)
- if err := checkDatabaseMetadata(storepb.Engine(engine), tempStoreSchemaMetadata); err != nil {
- return errors.Wrap(err, "failed to check database metadata")
- }
- if _, err := schema.GetDatabaseDefinition(storepb.Engine(engine), schema.GetDefinitionContext{}, tempStoreSchemaMetadata); err != nil {
- return errors.Wrap(err, "failed to transform database metadata to schema string")
- }
- return nil
-}
-
func settingInWhitelist(name storepb.SettingName) bool {
for _, whitelist := range whitelistSettings {
if name == whitelist {
diff --git a/backend/api/v1/setting_service_converter.go b/backend/api/v1/setting_service_converter.go
index e99b78435f..dd1ebe9749 100644
--- a/backend/api/v1/setting_service_converter.go
+++ b/backend/api/v1/setting_service_converter.go
@@ -67,21 +67,6 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
},
}, nil
- case storepb.SettingName_SCHEMA_TEMPLATE:
- storeValue := new(storepb.SchemaTemplateSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
- }
-
- sts := convertToSchemaTemplateSetting(storeValue)
- return &v1pb.Setting{
- Name: settingName,
- Value: &v1pb.Value{
- Value: &v1pb.Value_SchemaTemplateSettingValue{
- SchemaTemplateSettingValue: sts,
- },
- },
- }, nil
case storepb.SettingName_DATA_CLASSIFICATION:
storeValue := new(storepb.DataClassificationSetting)
if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
@@ -204,8 +189,6 @@ func convertStoreSettingNameToV1(storeName storepb.SettingName) v1pb.Setting_Set
return v1pb.Setting_WORKSPACE_PROFILE
case storepb.SettingName_WORKSPACE_APPROVAL:
return v1pb.Setting_WORKSPACE_APPROVAL
- case storepb.SettingName_WORKSPACE_EXTERNAL_APPROVAL:
- return v1pb.Setting_WORKSPACE_EXTERNAL_APPROVAL
case storepb.SettingName_ENTERPRISE_LICENSE:
return v1pb.Setting_ENTERPRISE_LICENSE
case storepb.SettingName_APP_IM:
@@ -214,8 +197,6 @@ func convertStoreSettingNameToV1(storeName storepb.SettingName) v1pb.Setting_Set
return v1pb.Setting_WATERMARK
case storepb.SettingName_AI:
return v1pb.Setting_AI
- case storepb.SettingName_SCHEMA_TEMPLATE:
- return v1pb.Setting_SCHEMA_TEMPLATE
case storepb.SettingName_DATA_CLASSIFICATION:
return v1pb.Setting_DATA_CLASSIFICATION
case storepb.SettingName_SEMANTIC_TYPES:
@@ -247,8 +228,6 @@ func convertV1SettingNameToStore(v1Name v1pb.Setting_SettingName) storepb.Settin
return storepb.SettingName_WORKSPACE_PROFILE
case v1pb.Setting_WORKSPACE_APPROVAL:
return storepb.SettingName_WORKSPACE_APPROVAL
- case v1pb.Setting_WORKSPACE_EXTERNAL_APPROVAL:
- return storepb.SettingName_WORKSPACE_EXTERNAL_APPROVAL
case v1pb.Setting_ENTERPRISE_LICENSE:
return storepb.SettingName_ENTERPRISE_LICENSE
case v1pb.Setting_APP_IM:
@@ -257,8 +236,6 @@ func convertV1SettingNameToStore(v1Name v1pb.Setting_SettingName) storepb.Settin
return storepb.SettingName_WATERMARK
case v1pb.Setting_AI:
return storepb.SettingName_AI
- case v1pb.Setting_SCHEMA_TEMPLATE:
- return storepb.SettingName_SCHEMA_TEMPLATE
case v1pb.Setting_DATA_CLASSIFICATION:
return storepb.SettingName_DATA_CLASSIFICATION
case v1pb.Setting_SEMANTIC_TYPES:
@@ -274,100 +251,6 @@ func convertV1SettingNameToStore(v1Name v1pb.Setting_SettingName) storepb.Settin
}
}
-func convertToSchemaTemplateSetting(template *storepb.SchemaTemplateSetting) *v1pb.SchemaTemplateSetting {
- v1Setting := new(v1pb.SchemaTemplateSetting)
- for _, v := range template.ColumnTypes {
- v1Setting.ColumnTypes = append(v1Setting.ColumnTypes, &v1pb.SchemaTemplateSetting_ColumnType{
- Engine: convertToEngine(v.Engine),
- Enabled: v.Enabled,
- Types: v.Types,
- })
- }
- for _, v := range template.FieldTemplates {
- if v == nil {
- continue
- }
- t := &v1pb.SchemaTemplateSetting_FieldTemplate{
- Id: v.Id,
- Engine: convertToEngine(v.Engine),
- Category: v.Category,
- }
- if v.Column != nil {
- t.Column = convertStoreColumnMetadata(v.Column)
- }
- if v.Catalog != nil {
- t.Catalog = convertColumnCatalog(v.Catalog)
- }
- v1Setting.FieldTemplates = append(v1Setting.FieldTemplates, t)
- }
- for _, v := range template.TableTemplates {
- if v == nil {
- continue
- }
- t := &v1pb.SchemaTemplateSetting_TableTemplate{
- Id: v.Id,
- Engine: convertToEngine(v.Engine),
- Category: v.Category,
- }
- if v.Table != nil {
- t.Table = convertStoreTableMetadata(v.Table)
- }
- if v.Catalog != nil {
- t.Catalog = convertTableCatalog(v.Catalog)
- }
- v1Setting.TableTemplates = append(v1Setting.TableTemplates, t)
- }
-
- return v1Setting
-}
-
-func convertV1SchemaTemplateSetting(template *v1pb.SchemaTemplateSetting) *storepb.SchemaTemplateSetting {
- v1Setting := new(storepb.SchemaTemplateSetting)
- for _, v := range template.ColumnTypes {
- v1Setting.ColumnTypes = append(v1Setting.ColumnTypes, &storepb.SchemaTemplateSetting_ColumnType{
- Engine: convertEngine(v.Engine),
- Enabled: v.Enabled,
- Types: v.Types,
- })
- }
- for _, v := range template.FieldTemplates {
- if v == nil {
- continue
- }
- t := &storepb.SchemaTemplateSetting_FieldTemplate{
- Id: v.Id,
- Engine: convertEngine(v.Engine),
- Category: v.Category,
- }
- if v.Column != nil {
- t.Column = convertV1ColumnMetadata(v.Column)
- }
- if v.Catalog != nil {
- t.Catalog = convertV1ColumnCatalog(v.Catalog)
- }
- v1Setting.FieldTemplates = append(v1Setting.FieldTemplates, t)
- }
- for _, v := range template.TableTemplates {
- if v == nil {
- continue
- }
- t := &storepb.SchemaTemplateSetting_TableTemplate{
- Id: v.Id,
- Engine: convertEngine(v.Engine),
- Category: v.Category,
- }
- if v.Table != nil {
- t.Table = convertV1TableMetadata(v.Table)
- }
- if v.Catalog != nil {
- t.Catalog = convertV1TableCatalog(v.Catalog)
- }
- v1Setting.TableTemplates = append(v1Setting.TableTemplates, t)
- }
-
- return v1Setting
-}
-
func convertToEnvironmentSetting(value string) (*v1pb.EnvironmentSetting, error) {
var setting storepb.EnvironmentSetting
if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(value), &setting); err != nil {
diff --git a/backend/generated-go/store/setting.pb.go b/backend/generated-go/store/setting.pb.go
index c743aa68cb..6919cfc039 100644
--- a/backend/generated-go/store/setting.pb.go
+++ b/backend/generated-go/store/setting.pb.go
@@ -26,23 +26,21 @@ const (
type SettingName int32
const (
- SettingName_SETTING_NAME_UNSPECIFIED SettingName = 0
- SettingName_AUTH_SECRET SettingName = 1
- SettingName_BRANDING_LOGO SettingName = 2
- SettingName_WORKSPACE_ID SettingName = 3
- SettingName_WORKSPACE_PROFILE SettingName = 4
- SettingName_WORKSPACE_APPROVAL SettingName = 5
- SettingName_WORKSPACE_EXTERNAL_APPROVAL SettingName = 6
- SettingName_ENTERPRISE_LICENSE SettingName = 7
- SettingName_APP_IM SettingName = 8
- SettingName_WATERMARK SettingName = 9
- SettingName_AI SettingName = 10
- SettingName_SCHEMA_TEMPLATE SettingName = 13
- SettingName_DATA_CLASSIFICATION SettingName = 14
- SettingName_SEMANTIC_TYPES SettingName = 15
- SettingName_SCIM SettingName = 17
- SettingName_PASSWORD_RESTRICTION SettingName = 18
- SettingName_ENVIRONMENT SettingName = 19
+ SettingName_SETTING_NAME_UNSPECIFIED SettingName = 0
+ SettingName_AUTH_SECRET SettingName = 1
+ SettingName_BRANDING_LOGO SettingName = 2
+ SettingName_WORKSPACE_ID SettingName = 3
+ SettingName_WORKSPACE_PROFILE SettingName = 4
+ SettingName_WORKSPACE_APPROVAL SettingName = 5
+ SettingName_ENTERPRISE_LICENSE SettingName = 7
+ SettingName_APP_IM SettingName = 8
+ SettingName_WATERMARK SettingName = 9
+ SettingName_AI SettingName = 10
+ SettingName_DATA_CLASSIFICATION SettingName = 14
+ SettingName_SEMANTIC_TYPES SettingName = 15
+ SettingName_SCIM SettingName = 17
+ SettingName_PASSWORD_RESTRICTION SettingName = 18
+ SettingName_ENVIRONMENT SettingName = 19
)
// Enum value maps for SettingName.
@@ -54,12 +52,10 @@ var (
3: "WORKSPACE_ID",
4: "WORKSPACE_PROFILE",
5: "WORKSPACE_APPROVAL",
- 6: "WORKSPACE_EXTERNAL_APPROVAL",
7: "ENTERPRISE_LICENSE",
8: "APP_IM",
9: "WATERMARK",
10: "AI",
- 13: "SCHEMA_TEMPLATE",
14: "DATA_CLASSIFICATION",
15: "SEMANTIC_TYPES",
17: "SCIM",
@@ -67,23 +63,21 @@ var (
19: "ENVIRONMENT",
}
SettingName_value = map[string]int32{
- "SETTING_NAME_UNSPECIFIED": 0,
- "AUTH_SECRET": 1,
- "BRANDING_LOGO": 2,
- "WORKSPACE_ID": 3,
- "WORKSPACE_PROFILE": 4,
- "WORKSPACE_APPROVAL": 5,
- "WORKSPACE_EXTERNAL_APPROVAL": 6,
- "ENTERPRISE_LICENSE": 7,
- "APP_IM": 8,
- "WATERMARK": 9,
- "AI": 10,
- "SCHEMA_TEMPLATE": 13,
- "DATA_CLASSIFICATION": 14,
- "SEMANTIC_TYPES": 15,
- "SCIM": 17,
- "PASSWORD_RESTRICTION": 18,
- "ENVIRONMENT": 19,
+ "SETTING_NAME_UNSPECIFIED": 0,
+ "AUTH_SECRET": 1,
+ "BRANDING_LOGO": 2,
+ "WORKSPACE_ID": 3,
+ "WORKSPACE_PROFILE": 4,
+ "WORKSPACE_APPROVAL": 5,
+ "ENTERPRISE_LICENSE": 7,
+ "APP_IM": 8,
+ "WATERMARK": 9,
+ "AI": 10,
+ "DATA_CLASSIFICATION": 14,
+ "SEMANTIC_TYPES": 15,
+ "SCIM": 17,
+ "PASSWORD_RESTRICTION": 18,
+ "ENVIRONMENT": 19,
}
)
@@ -320,7 +314,7 @@ func (x Algorithm_InnerOuterMask_MaskType) Number() protoreflect.EnumNumber {
// Deprecated: Use Algorithm_InnerOuterMask_MaskType.Descriptor instead.
func (Algorithm_InnerOuterMask_MaskType) EnumDescriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6, 3, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{5, 3, 0}
}
type AISetting_Provider int32
@@ -375,7 +369,7 @@ func (x AISetting_Provider) Number() protoreflect.EnumNumber {
// Deprecated: Use AISetting_Provider.Descriptor instead.
func (AISetting_Provider) EnumDescriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{10, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{9, 0}
}
type WorkspaceProfileSetting struct {
@@ -639,66 +633,6 @@ func (x *WorkspaceApprovalSetting) GetRules() []*WorkspaceApprovalSetting_Rule {
return nil
}
-type SchemaTemplateSetting struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- FieldTemplates []*SchemaTemplateSetting_FieldTemplate `protobuf:"bytes,1,rep,name=field_templates,json=fieldTemplates,proto3" json:"field_templates,omitempty"`
- ColumnTypes []*SchemaTemplateSetting_ColumnType `protobuf:"bytes,2,rep,name=column_types,json=columnTypes,proto3" json:"column_types,omitempty"`
- TableTemplates []*SchemaTemplateSetting_TableTemplate `protobuf:"bytes,3,rep,name=table_templates,json=tableTemplates,proto3" json:"table_templates,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting) Reset() {
- *x = SchemaTemplateSetting{}
- mi := &file_store_setting_proto_msgTypes[3]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[3]
- 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 SchemaTemplateSetting.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{3}
-}
-
-func (x *SchemaTemplateSetting) GetFieldTemplates() []*SchemaTemplateSetting_FieldTemplate {
- if x != nil {
- return x.FieldTemplates
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting) GetColumnTypes() []*SchemaTemplateSetting_ColumnType {
- if x != nil {
- return x.ColumnTypes
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting) GetTableTemplates() []*SchemaTemplateSetting_TableTemplate {
- if x != nil {
- return x.TableTemplates
- }
- return nil
-}
-
type DataClassificationSetting struct {
state protoimpl.MessageState `protogen:"open.v1"`
Configs []*DataClassificationSetting_DataClassificationConfig `protobuf:"bytes,1,rep,name=configs,proto3" json:"configs,omitempty"`
@@ -708,7 +642,7 @@ type DataClassificationSetting struct {
func (x *DataClassificationSetting) Reset() {
*x = DataClassificationSetting{}
- mi := &file_store_setting_proto_msgTypes[4]
+ mi := &file_store_setting_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -720,7 +654,7 @@ func (x *DataClassificationSetting) String() string {
func (*DataClassificationSetting) ProtoMessage() {}
func (x *DataClassificationSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[4]
+ mi := &file_store_setting_proto_msgTypes[3]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -733,7 +667,7 @@ func (x *DataClassificationSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use DataClassificationSetting.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{4}
+ return file_store_setting_proto_rawDescGZIP(), []int{3}
}
func (x *DataClassificationSetting) GetConfigs() []*DataClassificationSetting_DataClassificationConfig {
@@ -752,7 +686,7 @@ type SemanticTypeSetting struct {
func (x *SemanticTypeSetting) Reset() {
*x = SemanticTypeSetting{}
- mi := &file_store_setting_proto_msgTypes[5]
+ mi := &file_store_setting_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -764,7 +698,7 @@ func (x *SemanticTypeSetting) String() string {
func (*SemanticTypeSetting) ProtoMessage() {}
func (x *SemanticTypeSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[5]
+ mi := &file_store_setting_proto_msgTypes[4]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -777,7 +711,7 @@ func (x *SemanticTypeSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use SemanticTypeSetting.ProtoReflect.Descriptor instead.
func (*SemanticTypeSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{5}
+ return file_store_setting_proto_rawDescGZIP(), []int{4}
}
func (x *SemanticTypeSetting) GetTypes() []*SemanticTypeSetting_SemanticType {
@@ -802,7 +736,7 @@ type Algorithm struct {
func (x *Algorithm) Reset() {
*x = Algorithm{}
- mi := &file_store_setting_proto_msgTypes[6]
+ mi := &file_store_setting_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -814,7 +748,7 @@ func (x *Algorithm) String() string {
func (*Algorithm) ProtoMessage() {}
func (x *Algorithm) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[6]
+ mi := &file_store_setting_proto_msgTypes[5]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -827,7 +761,7 @@ func (x *Algorithm) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm.ProtoReflect.Descriptor instead.
func (*Algorithm) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6}
+ return file_store_setting_proto_rawDescGZIP(), []int{5}
}
func (x *Algorithm) GetMask() isAlgorithm_Mask {
@@ -910,7 +844,7 @@ type AppIMSetting struct {
func (x *AppIMSetting) Reset() {
*x = AppIMSetting{}
- mi := &file_store_setting_proto_msgTypes[7]
+ mi := &file_store_setting_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -922,7 +856,7 @@ func (x *AppIMSetting) String() string {
func (*AppIMSetting) ProtoMessage() {}
func (x *AppIMSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[7]
+ mi := &file_store_setting_proto_msgTypes[6]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -935,7 +869,7 @@ func (x *AppIMSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting.ProtoReflect.Descriptor instead.
func (*AppIMSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7}
+ return file_store_setting_proto_rawDescGZIP(), []int{6}
}
func (x *AppIMSetting) GetSettings() []*AppIMSetting_IMSetting {
@@ -954,7 +888,7 @@ type SCIMSetting struct {
func (x *SCIMSetting) Reset() {
*x = SCIMSetting{}
- mi := &file_store_setting_proto_msgTypes[8]
+ mi := &file_store_setting_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -966,7 +900,7 @@ func (x *SCIMSetting) String() string {
func (*SCIMSetting) ProtoMessage() {}
func (x *SCIMSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[8]
+ mi := &file_store_setting_proto_msgTypes[7]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -979,7 +913,7 @@ func (x *SCIMSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use SCIMSetting.ProtoReflect.Descriptor instead.
func (*SCIMSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{8}
+ return file_store_setting_proto_rawDescGZIP(), []int{7}
}
func (x *SCIMSetting) GetToken() string {
@@ -1011,7 +945,7 @@ type PasswordRestrictionSetting struct {
func (x *PasswordRestrictionSetting) Reset() {
*x = PasswordRestrictionSetting{}
- mi := &file_store_setting_proto_msgTypes[9]
+ mi := &file_store_setting_proto_msgTypes[8]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1023,7 +957,7 @@ func (x *PasswordRestrictionSetting) String() string {
func (*PasswordRestrictionSetting) ProtoMessage() {}
func (x *PasswordRestrictionSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[9]
+ mi := &file_store_setting_proto_msgTypes[8]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1036,7 +970,7 @@ func (x *PasswordRestrictionSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use PasswordRestrictionSetting.ProtoReflect.Descriptor instead.
func (*PasswordRestrictionSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{9}
+ return file_store_setting_proto_rawDescGZIP(), []int{8}
}
func (x *PasswordRestrictionSetting) GetMinLength() int32 {
@@ -1102,7 +1036,7 @@ type AISetting struct {
func (x *AISetting) Reset() {
*x = AISetting{}
- mi := &file_store_setting_proto_msgTypes[10]
+ mi := &file_store_setting_proto_msgTypes[9]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1114,7 +1048,7 @@ func (x *AISetting) String() string {
func (*AISetting) ProtoMessage() {}
func (x *AISetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[10]
+ mi := &file_store_setting_proto_msgTypes[9]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1127,7 +1061,7 @@ func (x *AISetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use AISetting.ProtoReflect.Descriptor instead.
func (*AISetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{10}
+ return file_store_setting_proto_rawDescGZIP(), []int{9}
}
func (x *AISetting) GetEnabled() bool {
@@ -1181,7 +1115,7 @@ type EnvironmentSetting struct {
func (x *EnvironmentSetting) Reset() {
*x = EnvironmentSetting{}
- mi := &file_store_setting_proto_msgTypes[11]
+ mi := &file_store_setting_proto_msgTypes[10]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1193,7 +1127,7 @@ func (x *EnvironmentSetting) String() string {
func (*EnvironmentSetting) ProtoMessage() {}
func (x *EnvironmentSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[11]
+ mi := &file_store_setting_proto_msgTypes[10]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1206,7 +1140,7 @@ func (x *EnvironmentSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use EnvironmentSetting.ProtoReflect.Descriptor instead.
func (*EnvironmentSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{11}
+ return file_store_setting_proto_rawDescGZIP(), []int{10}
}
func (x *EnvironmentSetting) GetEnvironments() []*EnvironmentSetting_Environment {
@@ -1227,7 +1161,7 @@ type WorkspaceApprovalSetting_Rule struct {
func (x *WorkspaceApprovalSetting_Rule) Reset() {
*x = WorkspaceApprovalSetting_Rule{}
- mi := &file_store_setting_proto_msgTypes[12]
+ mi := &file_store_setting_proto_msgTypes[11]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1239,7 +1173,7 @@ func (x *WorkspaceApprovalSetting_Rule) String() string {
func (*WorkspaceApprovalSetting_Rule) ProtoMessage() {}
func (x *WorkspaceApprovalSetting_Rule) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[12]
+ mi := &file_store_setting_proto_msgTypes[11]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1276,218 +1210,6 @@ func (x *WorkspaceApprovalSetting_Rule) GetSource() WorkspaceApprovalSetting_Rul
return WorkspaceApprovalSetting_Rule_SOURCE_UNSPECIFIED
}
-type SchemaTemplateSetting_FieldTemplate struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- Engine Engine `protobuf:"varint,2,opt,name=engine,proto3,enum=bytebase.store.Engine" json:"engine,omitempty"`
- Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
- Column *ColumnMetadata `protobuf:"bytes,4,opt,name=column,proto3" json:"column,omitempty"`
- Catalog *ColumnCatalog `protobuf:"bytes,5,opt,name=catalog,proto3" json:"catalog,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) Reset() {
- *x = SchemaTemplateSetting_FieldTemplate{}
- mi := &file_store_setting_proto_msgTypes[13]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting_FieldTemplate) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting_FieldTemplate) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[13]
- 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 SchemaTemplateSetting_FieldTemplate.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting_FieldTemplate) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{3, 0}
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetId() string {
- if x != nil {
- return x.Id
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetEngine() Engine {
- if x != nil {
- return x.Engine
- }
- return Engine_ENGINE_UNSPECIFIED
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetCategory() string {
- if x != nil {
- return x.Category
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetColumn() *ColumnMetadata {
- if x != nil {
- return x.Column
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetCatalog() *ColumnCatalog {
- if x != nil {
- return x.Catalog
- }
- return nil
-}
-
-type SchemaTemplateSetting_ColumnType struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Engine Engine `protobuf:"varint,1,opt,name=engine,proto3,enum=bytebase.store.Engine" json:"engine,omitempty"`
- Enabled bool `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
- Types []string `protobuf:"bytes,3,rep,name=types,proto3" json:"types,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting_ColumnType) Reset() {
- *x = SchemaTemplateSetting_ColumnType{}
- mi := &file_store_setting_proto_msgTypes[14]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting_ColumnType) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting_ColumnType) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting_ColumnType) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[14]
- 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 SchemaTemplateSetting_ColumnType.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting_ColumnType) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{3, 1}
-}
-
-func (x *SchemaTemplateSetting_ColumnType) GetEngine() Engine {
- if x != nil {
- return x.Engine
- }
- return Engine_ENGINE_UNSPECIFIED
-}
-
-func (x *SchemaTemplateSetting_ColumnType) GetEnabled() bool {
- if x != nil {
- return x.Enabled
- }
- return false
-}
-
-func (x *SchemaTemplateSetting_ColumnType) GetTypes() []string {
- if x != nil {
- return x.Types
- }
- return nil
-}
-
-type SchemaTemplateSetting_TableTemplate struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- Engine Engine `protobuf:"varint,2,opt,name=engine,proto3,enum=bytebase.store.Engine" json:"engine,omitempty"`
- Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
- Table *TableMetadata `protobuf:"bytes,4,opt,name=table,proto3" json:"table,omitempty"`
- Catalog *TableCatalog `protobuf:"bytes,5,opt,name=catalog,proto3" json:"catalog,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) Reset() {
- *x = SchemaTemplateSetting_TableTemplate{}
- mi := &file_store_setting_proto_msgTypes[15]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting_TableTemplate) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting_TableTemplate) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[15]
- 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 SchemaTemplateSetting_TableTemplate.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting_TableTemplate) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{3, 2}
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetId() string {
- if x != nil {
- return x.Id
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetEngine() Engine {
- if x != nil {
- return x.Engine
- }
- return Engine_ENGINE_UNSPECIFIED
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetCategory() string {
- if x != nil {
- return x.Category
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetTable() *TableMetadata {
- if x != nil {
- return x.Table
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetCatalog() *TableCatalog {
- if x != nil {
- return x.Catalog
- }
- return nil
-}
-
type DataClassificationSetting_DataClassificationConfig struct {
state protoimpl.MessageState `protogen:"open.v1"`
// id is the uuid for classification. Each project can chose one
@@ -1506,7 +1228,7 @@ type DataClassificationSetting_DataClassificationConfig struct {
func (x *DataClassificationSetting_DataClassificationConfig) Reset() {
*x = DataClassificationSetting_DataClassificationConfig{}
- mi := &file_store_setting_proto_msgTypes[16]
+ mi := &file_store_setting_proto_msgTypes[12]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1518,7 +1240,7 @@ func (x *DataClassificationSetting_DataClassificationConfig) String() string {
func (*DataClassificationSetting_DataClassificationConfig) ProtoMessage() {}
func (x *DataClassificationSetting_DataClassificationConfig) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[16]
+ mi := &file_store_setting_proto_msgTypes[12]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1531,7 +1253,7 @@ func (x *DataClassificationSetting_DataClassificationConfig) ProtoReflect() prot
// Deprecated: Use DataClassificationSetting_DataClassificationConfig.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting_DataClassificationConfig) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{4, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{3, 0}
}
func (x *DataClassificationSetting_DataClassificationConfig) GetId() string {
@@ -1573,7 +1295,7 @@ type DataClassificationSetting_DataClassificationConfig_Level struct {
func (x *DataClassificationSetting_DataClassificationConfig_Level) Reset() {
*x = DataClassificationSetting_DataClassificationConfig_Level{}
- mi := &file_store_setting_proto_msgTypes[17]
+ mi := &file_store_setting_proto_msgTypes[13]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1585,7 +1307,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_Level) String() stri
func (*DataClassificationSetting_DataClassificationConfig_Level) ProtoMessage() {}
func (x *DataClassificationSetting_DataClassificationConfig_Level) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[17]
+ mi := &file_store_setting_proto_msgTypes[13]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1598,7 +1320,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_Level) ProtoReflect(
// Deprecated: Use DataClassificationSetting_DataClassificationConfig_Level.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting_DataClassificationConfig_Level) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{4, 0, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{3, 0, 0}
}
func (x *DataClassificationSetting_DataClassificationConfig_Level) GetId() string {
@@ -1635,7 +1357,7 @@ type DataClassificationSetting_DataClassificationConfig_DataClassification struc
func (x *DataClassificationSetting_DataClassificationConfig_DataClassification) Reset() {
*x = DataClassificationSetting_DataClassificationConfig_DataClassification{}
- mi := &file_store_setting_proto_msgTypes[18]
+ mi := &file_store_setting_proto_msgTypes[14]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1647,7 +1369,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_DataClassification)
func (*DataClassificationSetting_DataClassificationConfig_DataClassification) ProtoMessage() {}
func (x *DataClassificationSetting_DataClassificationConfig_DataClassification) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[18]
+ mi := &file_store_setting_proto_msgTypes[14]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1660,7 +1382,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_DataClassification)
// Deprecated: Use DataClassificationSetting_DataClassificationConfig_DataClassification.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting_DataClassificationConfig_DataClassification) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{4, 0, 1}
+ return file_store_setting_proto_rawDescGZIP(), []int{3, 0, 1}
}
func (x *DataClassificationSetting_DataClassificationConfig_DataClassification) GetId() string {
@@ -1708,7 +1430,7 @@ type SemanticTypeSetting_SemanticType struct {
func (x *SemanticTypeSetting_SemanticType) Reset() {
*x = SemanticTypeSetting_SemanticType{}
- mi := &file_store_setting_proto_msgTypes[20]
+ mi := &file_store_setting_proto_msgTypes[16]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1720,7 +1442,7 @@ func (x *SemanticTypeSetting_SemanticType) String() string {
func (*SemanticTypeSetting_SemanticType) ProtoMessage() {}
func (x *SemanticTypeSetting_SemanticType) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[20]
+ mi := &file_store_setting_proto_msgTypes[16]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1733,7 +1455,7 @@ func (x *SemanticTypeSetting_SemanticType) ProtoReflect() protoreflect.Message {
// Deprecated: Use SemanticTypeSetting_SemanticType.ProtoReflect.Descriptor instead.
func (*SemanticTypeSetting_SemanticType) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{5, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{4, 0}
}
func (x *SemanticTypeSetting_SemanticType) GetId() string {
@@ -1782,7 +1504,7 @@ type Algorithm_FullMask struct {
func (x *Algorithm_FullMask) Reset() {
*x = Algorithm_FullMask{}
- mi := &file_store_setting_proto_msgTypes[21]
+ mi := &file_store_setting_proto_msgTypes[17]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1794,7 +1516,7 @@ func (x *Algorithm_FullMask) String() string {
func (*Algorithm_FullMask) ProtoMessage() {}
func (x *Algorithm_FullMask) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[21]
+ mi := &file_store_setting_proto_msgTypes[17]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1807,7 +1529,7 @@ func (x *Algorithm_FullMask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_FullMask.ProtoReflect.Descriptor instead.
func (*Algorithm_FullMask) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{5, 0}
}
func (x *Algorithm_FullMask) GetSubstitution() string {
@@ -1828,7 +1550,7 @@ type Algorithm_RangeMask struct {
func (x *Algorithm_RangeMask) Reset() {
*x = Algorithm_RangeMask{}
- mi := &file_store_setting_proto_msgTypes[22]
+ mi := &file_store_setting_proto_msgTypes[18]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1840,7 +1562,7 @@ func (x *Algorithm_RangeMask) String() string {
func (*Algorithm_RangeMask) ProtoMessage() {}
func (x *Algorithm_RangeMask) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[22]
+ mi := &file_store_setting_proto_msgTypes[18]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1853,7 +1575,7 @@ func (x *Algorithm_RangeMask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_RangeMask.ProtoReflect.Descriptor instead.
func (*Algorithm_RangeMask) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6, 1}
+ return file_store_setting_proto_rawDescGZIP(), []int{5, 1}
}
func (x *Algorithm_RangeMask) GetSlices() []*Algorithm_RangeMask_Slice {
@@ -1873,7 +1595,7 @@ type Algorithm_MD5Mask struct {
func (x *Algorithm_MD5Mask) Reset() {
*x = Algorithm_MD5Mask{}
- mi := &file_store_setting_proto_msgTypes[23]
+ mi := &file_store_setting_proto_msgTypes[19]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1885,7 +1607,7 @@ func (x *Algorithm_MD5Mask) String() string {
func (*Algorithm_MD5Mask) ProtoMessage() {}
func (x *Algorithm_MD5Mask) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[23]
+ mi := &file_store_setting_proto_msgTypes[19]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1898,7 +1620,7 @@ func (x *Algorithm_MD5Mask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_MD5Mask.ProtoReflect.Descriptor instead.
func (*Algorithm_MD5Mask) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6, 2}
+ return file_store_setting_proto_rawDescGZIP(), []int{5, 2}
}
func (x *Algorithm_MD5Mask) GetSalt() string {
@@ -1920,7 +1642,7 @@ type Algorithm_InnerOuterMask struct {
func (x *Algorithm_InnerOuterMask) Reset() {
*x = Algorithm_InnerOuterMask{}
- mi := &file_store_setting_proto_msgTypes[24]
+ mi := &file_store_setting_proto_msgTypes[20]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1932,7 +1654,7 @@ func (x *Algorithm_InnerOuterMask) String() string {
func (*Algorithm_InnerOuterMask) ProtoMessage() {}
func (x *Algorithm_InnerOuterMask) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[24]
+ mi := &file_store_setting_proto_msgTypes[20]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1945,7 +1667,7 @@ func (x *Algorithm_InnerOuterMask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_InnerOuterMask.ProtoReflect.Descriptor instead.
func (*Algorithm_InnerOuterMask) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6, 3}
+ return file_store_setting_proto_rawDescGZIP(), []int{5, 3}
}
func (x *Algorithm_InnerOuterMask) GetPrefixLen() int32 {
@@ -1990,7 +1712,7 @@ type Algorithm_RangeMask_Slice struct {
func (x *Algorithm_RangeMask_Slice) Reset() {
*x = Algorithm_RangeMask_Slice{}
- mi := &file_store_setting_proto_msgTypes[25]
+ mi := &file_store_setting_proto_msgTypes[21]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2002,7 +1724,7 @@ func (x *Algorithm_RangeMask_Slice) String() string {
func (*Algorithm_RangeMask_Slice) ProtoMessage() {}
func (x *Algorithm_RangeMask_Slice) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[25]
+ mi := &file_store_setting_proto_msgTypes[21]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2015,7 +1737,7 @@ func (x *Algorithm_RangeMask_Slice) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_RangeMask_Slice.ProtoReflect.Descriptor instead.
func (*Algorithm_RangeMask_Slice) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{6, 1, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{5, 1, 0}
}
func (x *Algorithm_RangeMask_Slice) GetStart() int32 {
@@ -2048,7 +1770,7 @@ type AppIMSetting_Slack struct {
func (x *AppIMSetting_Slack) Reset() {
*x = AppIMSetting_Slack{}
- mi := &file_store_setting_proto_msgTypes[26]
+ mi := &file_store_setting_proto_msgTypes[22]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2060,7 +1782,7 @@ func (x *AppIMSetting_Slack) String() string {
func (*AppIMSetting_Slack) ProtoMessage() {}
func (x *AppIMSetting_Slack) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[26]
+ mi := &file_store_setting_proto_msgTypes[22]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2073,7 +1795,7 @@ func (x *AppIMSetting_Slack) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting_Slack.ProtoReflect.Descriptor instead.
func (*AppIMSetting_Slack) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{6, 0}
}
func (x *AppIMSetting_Slack) GetToken() string {
@@ -2093,7 +1815,7 @@ type AppIMSetting_Feishu struct {
func (x *AppIMSetting_Feishu) Reset() {
*x = AppIMSetting_Feishu{}
- mi := &file_store_setting_proto_msgTypes[27]
+ mi := &file_store_setting_proto_msgTypes[23]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2105,7 +1827,7 @@ func (x *AppIMSetting_Feishu) String() string {
func (*AppIMSetting_Feishu) ProtoMessage() {}
func (x *AppIMSetting_Feishu) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[27]
+ mi := &file_store_setting_proto_msgTypes[23]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2118,7 +1840,7 @@ func (x *AppIMSetting_Feishu) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting_Feishu.ProtoReflect.Descriptor instead.
func (*AppIMSetting_Feishu) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7, 1}
+ return file_store_setting_proto_rawDescGZIP(), []int{6, 1}
}
func (x *AppIMSetting_Feishu) GetAppId() string {
@@ -2146,7 +1868,7 @@ type AppIMSetting_Wecom struct {
func (x *AppIMSetting_Wecom) Reset() {
*x = AppIMSetting_Wecom{}
- mi := &file_store_setting_proto_msgTypes[28]
+ mi := &file_store_setting_proto_msgTypes[24]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2158,7 +1880,7 @@ func (x *AppIMSetting_Wecom) String() string {
func (*AppIMSetting_Wecom) ProtoMessage() {}
func (x *AppIMSetting_Wecom) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[28]
+ mi := &file_store_setting_proto_msgTypes[24]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2171,7 +1893,7 @@ func (x *AppIMSetting_Wecom) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting_Wecom.ProtoReflect.Descriptor instead.
func (*AppIMSetting_Wecom) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7, 2}
+ return file_store_setting_proto_rawDescGZIP(), []int{6, 2}
}
func (x *AppIMSetting_Wecom) GetCorpId() string {
@@ -2205,7 +1927,7 @@ type AppIMSetting_Lark struct {
func (x *AppIMSetting_Lark) Reset() {
*x = AppIMSetting_Lark{}
- mi := &file_store_setting_proto_msgTypes[29]
+ mi := &file_store_setting_proto_msgTypes[25]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2217,7 +1939,7 @@ func (x *AppIMSetting_Lark) String() string {
func (*AppIMSetting_Lark) ProtoMessage() {}
func (x *AppIMSetting_Lark) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[29]
+ mi := &file_store_setting_proto_msgTypes[25]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2230,7 +1952,7 @@ func (x *AppIMSetting_Lark) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting_Lark.ProtoReflect.Descriptor instead.
func (*AppIMSetting_Lark) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7, 3}
+ return file_store_setting_proto_rawDescGZIP(), []int{6, 3}
}
func (x *AppIMSetting_Lark) GetAppId() string {
@@ -2258,7 +1980,7 @@ type AppIMSetting_DingTalk struct {
func (x *AppIMSetting_DingTalk) Reset() {
*x = AppIMSetting_DingTalk{}
- mi := &file_store_setting_proto_msgTypes[30]
+ mi := &file_store_setting_proto_msgTypes[26]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2270,7 +1992,7 @@ func (x *AppIMSetting_DingTalk) String() string {
func (*AppIMSetting_DingTalk) ProtoMessage() {}
func (x *AppIMSetting_DingTalk) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[30]
+ mi := &file_store_setting_proto_msgTypes[26]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2283,7 +2005,7 @@ func (x *AppIMSetting_DingTalk) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting_DingTalk.ProtoReflect.Descriptor instead.
func (*AppIMSetting_DingTalk) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7, 4}
+ return file_store_setting_proto_rawDescGZIP(), []int{6, 4}
}
func (x *AppIMSetting_DingTalk) GetClientId() string {
@@ -2324,7 +2046,7 @@ type AppIMSetting_IMSetting struct {
func (x *AppIMSetting_IMSetting) Reset() {
*x = AppIMSetting_IMSetting{}
- mi := &file_store_setting_proto_msgTypes[31]
+ mi := &file_store_setting_proto_msgTypes[27]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2336,7 +2058,7 @@ func (x *AppIMSetting_IMSetting) String() string {
func (*AppIMSetting_IMSetting) ProtoMessage() {}
func (x *AppIMSetting_IMSetting) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[31]
+ mi := &file_store_setting_proto_msgTypes[27]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2349,7 +2071,7 @@ func (x *AppIMSetting_IMSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use AppIMSetting_IMSetting.ProtoReflect.Descriptor instead.
func (*AppIMSetting_IMSetting) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{7, 5}
+ return file_store_setting_proto_rawDescGZIP(), []int{6, 5}
}
func (x *AppIMSetting_IMSetting) GetType() ProjectWebhook_Type {
@@ -2461,7 +2183,7 @@ type EnvironmentSetting_Environment struct {
func (x *EnvironmentSetting_Environment) Reset() {
*x = EnvironmentSetting_Environment{}
- mi := &file_store_setting_proto_msgTypes[32]
+ mi := &file_store_setting_proto_msgTypes[28]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2473,7 +2195,7 @@ func (x *EnvironmentSetting_Environment) String() string {
func (*EnvironmentSetting_Environment) ProtoMessage() {}
func (x *EnvironmentSetting_Environment) ProtoReflect() protoreflect.Message {
- mi := &file_store_setting_proto_msgTypes[32]
+ mi := &file_store_setting_proto_msgTypes[28]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2486,7 +2208,7 @@ func (x *EnvironmentSetting_Environment) ProtoReflect() protoreflect.Message {
// Deprecated: Use EnvironmentSetting_Environment.ProtoReflect.Descriptor instead.
func (*EnvironmentSetting_Environment) Descriptor() ([]byte, []int) {
- return file_store_setting_proto_rawDescGZIP(), []int{11, 0}
+ return file_store_setting_proto_rawDescGZIP(), []int{10, 0}
}
func (x *EnvironmentSetting_Environment) GetId() string {
@@ -2521,7 +2243,7 @@ var File_store_setting_proto protoreflect.FileDescriptor
const file_store_setting_proto_rawDesc = "" +
"\n" +
- "\x13store/setting.proto\x12\x0ebytebase.store\x1a\x1egoogle/protobuf/duration.proto\x1a\x16google/type/expr.proto\x1a\x14store/approval.proto\x1a\x12store/common.proto\x1a\x14store/database.proto\x1a\x1bstore/project_webhook.proto\"\x85\x06\n" +
+ "\x13store/setting.proto\x12\x0ebytebase.store\x1a\x1egoogle/protobuf/duration.proto\x1a\x16google/type/expr.proto\x1a\x14store/approval.proto\x1a\x1bstore/project_webhook.proto\"\x85\x06\n" +
"\x17WorkspaceProfileSetting\x12!\n" +
"\fexternal_url\x18\x01 \x01(\tR\vexternalUrl\x12'\n" +
"\x0fdisallow_signup\x18\x02 \x01(\bR\x0edisallowSignup\x12\x1f\n" +
@@ -2559,28 +2281,7 @@ const file_store_setting_proto_rawDesc = "" +
"\x0fCHANGE_DATABASE\x10\x01\x12\x13\n" +
"\x0fCREATE_DATABASE\x10\x02\x12\x0f\n" +
"\vEXPORT_DATA\x10\x03\x12\x10\n" +
- "\fREQUEST_ROLE\x10\x04\"\xd0\x06\n" +
- "\x15SchemaTemplateSetting\x12\\\n" +
- "\x0ffield_templates\x18\x01 \x03(\v23.bytebase.store.SchemaTemplateSetting.FieldTemplateR\x0efieldTemplates\x12S\n" +
- "\fcolumn_types\x18\x02 \x03(\v20.bytebase.store.SchemaTemplateSetting.ColumnTypeR\vcolumnTypes\x12\\\n" +
- "\x0ftable_templates\x18\x03 \x03(\v23.bytebase.store.SchemaTemplateSetting.TableTemplateR\x0etableTemplates\x1a\xdc\x01\n" +
- "\rFieldTemplate\x12\x0e\n" +
- "\x02id\x18\x01 \x01(\tR\x02id\x12.\n" +
- "\x06engine\x18\x02 \x01(\x0e2\x16.bytebase.store.EngineR\x06engine\x12\x1a\n" +
- "\bcategory\x18\x03 \x01(\tR\bcategory\x126\n" +
- "\x06column\x18\x04 \x01(\v2\x1e.bytebase.store.ColumnMetadataR\x06column\x127\n" +
- "\acatalog\x18\x05 \x01(\v2\x1d.bytebase.store.ColumnCatalogR\acatalog\x1al\n" +
- "\n" +
- "ColumnType\x12.\n" +
- "\x06engine\x18\x01 \x01(\x0e2\x16.bytebase.store.EngineR\x06engine\x12\x18\n" +
- "\aenabled\x18\x02 \x01(\bR\aenabled\x12\x14\n" +
- "\x05types\x18\x03 \x03(\tR\x05types\x1a\xd8\x01\n" +
- "\rTableTemplate\x12\x0e\n" +
- "\x02id\x18\x01 \x01(\tR\x02id\x12.\n" +
- "\x06engine\x18\x02 \x01(\x0e2\x16.bytebase.store.EngineR\x06engine\x12\x1a\n" +
- "\bcategory\x18\x03 \x01(\tR\bcategory\x123\n" +
- "\x05table\x18\x04 \x01(\v2\x1d.bytebase.store.TableMetadataR\x05table\x126\n" +
- "\acatalog\x18\x05 \x01(\v2\x1c.bytebase.store.TableCatalogR\acatalog\"\x96\x06\n" +
+ "\fREQUEST_ROLE\x10\x04\"\x96\x06\n" +
"\x19DataClassificationSetting\x12\\\n" +
"\aconfigs\x18\x01 \x03(\v2B.bytebase.store.DataClassificationSetting.DataClassificationConfigR\aconfigs\x1a\x9a\x05\n" +
"\x18DataClassificationConfig\x12\x0e\n" +
@@ -2701,27 +2402,25 @@ const file_store_setting_proto_rawDesc = "" +
"\x05color\x18\x04 \x01(\tR\x05color\x1a7\n" +
"\tTagsEntry\x12\x10\n" +
"\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n" +
- "\x05value\x18\x02 \x01(\tR\x05value:\x028\x01*\xe9\x02\n" +
+ "\x05value\x18\x02 \x01(\tR\x05value:\x028\x01*\xbf\x02\n" +
"\vSettingName\x12\x1c\n" +
"\x18SETTING_NAME_UNSPECIFIED\x10\x00\x12\x0f\n" +
"\vAUTH_SECRET\x10\x01\x12\x11\n" +
"\rBRANDING_LOGO\x10\x02\x12\x10\n" +
"\fWORKSPACE_ID\x10\x03\x12\x15\n" +
"\x11WORKSPACE_PROFILE\x10\x04\x12\x16\n" +
- "\x12WORKSPACE_APPROVAL\x10\x05\x12\x1f\n" +
- "\x1bWORKSPACE_EXTERNAL_APPROVAL\x10\x06\x12\x16\n" +
+ "\x12WORKSPACE_APPROVAL\x10\x05\x12\x16\n" +
"\x12ENTERPRISE_LICENSE\x10\a\x12\n" +
"\n" +
"\x06APP_IM\x10\b\x12\r\n" +
"\tWATERMARK\x10\t\x12\x06\n" +
"\x02AI\x10\n" +
- "\x12\x13\n" +
- "\x0fSCHEMA_TEMPLATE\x10\r\x12\x17\n" +
+ "\x12\x17\n" +
"\x13DATA_CLASSIFICATION\x10\x0e\x12\x12\n" +
"\x0eSEMANTIC_TYPES\x10\x0f\x12\b\n" +
"\x04SCIM\x10\x11\x12\x18\n" +
"\x14PASSWORD_RESTRICTION\x10\x12\x12\x0f\n" +
- "\vENVIRONMENT\x10\x13\"\x04\b\x10\x10\x10*T\n" +
+ "\vENVIRONMENT\x10\x13\"\x04\b\x10\x10\x10\"\x04\b\x06\x10\x06\"\x04\b\r\x10\r*T\n" +
"\x12DatabaseChangeMode\x12$\n" +
" DATABASE_CHANGE_MODE_UNSPECIFIED\x10\x00\x12\f\n" +
"\bPIPELINE\x10\x01\x12\n" +
@@ -2742,7 +2441,7 @@ func file_store_setting_proto_rawDescGZIP() []byte {
}
var file_store_setting_proto_enumTypes = make([]protoimpl.EnumInfo, 6)
-var file_store_setting_proto_msgTypes = make([]protoimpl.MessageInfo, 34)
+var file_store_setting_proto_msgTypes = make([]protoimpl.MessageInfo, 30)
var file_store_setting_proto_goTypes = []any{
(SettingName)(0), // 0: bytebase.store.SettingName
(DatabaseChangeMode)(0), // 1: bytebase.store.DatabaseChangeMode
@@ -2753,96 +2452,77 @@ var file_store_setting_proto_goTypes = []any{
(*WorkspaceProfileSetting)(nil), // 6: bytebase.store.WorkspaceProfileSetting
(*Announcement)(nil), // 7: bytebase.store.Announcement
(*WorkspaceApprovalSetting)(nil), // 8: bytebase.store.WorkspaceApprovalSetting
- (*SchemaTemplateSetting)(nil), // 9: bytebase.store.SchemaTemplateSetting
- (*DataClassificationSetting)(nil), // 10: bytebase.store.DataClassificationSetting
- (*SemanticTypeSetting)(nil), // 11: bytebase.store.SemanticTypeSetting
- (*Algorithm)(nil), // 12: bytebase.store.Algorithm
- (*AppIMSetting)(nil), // 13: bytebase.store.AppIMSetting
- (*SCIMSetting)(nil), // 14: bytebase.store.SCIMSetting
- (*PasswordRestrictionSetting)(nil), // 15: bytebase.store.PasswordRestrictionSetting
- (*AISetting)(nil), // 16: bytebase.store.AISetting
- (*EnvironmentSetting)(nil), // 17: bytebase.store.EnvironmentSetting
- (*WorkspaceApprovalSetting_Rule)(nil), // 18: bytebase.store.WorkspaceApprovalSetting.Rule
- (*SchemaTemplateSetting_FieldTemplate)(nil), // 19: bytebase.store.SchemaTemplateSetting.FieldTemplate
- (*SchemaTemplateSetting_ColumnType)(nil), // 20: bytebase.store.SchemaTemplateSetting.ColumnType
- (*SchemaTemplateSetting_TableTemplate)(nil), // 21: bytebase.store.SchemaTemplateSetting.TableTemplate
- (*DataClassificationSetting_DataClassificationConfig)(nil), // 22: bytebase.store.DataClassificationSetting.DataClassificationConfig
- (*DataClassificationSetting_DataClassificationConfig_Level)(nil), // 23: bytebase.store.DataClassificationSetting.DataClassificationConfig.Level
- (*DataClassificationSetting_DataClassificationConfig_DataClassification)(nil), // 24: bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification
- nil, // 25: bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
- (*SemanticTypeSetting_SemanticType)(nil), // 26: bytebase.store.SemanticTypeSetting.SemanticType
- (*Algorithm_FullMask)(nil), // 27: bytebase.store.Algorithm.FullMask
- (*Algorithm_RangeMask)(nil), // 28: bytebase.store.Algorithm.RangeMask
- (*Algorithm_MD5Mask)(nil), // 29: bytebase.store.Algorithm.MD5Mask
- (*Algorithm_InnerOuterMask)(nil), // 30: bytebase.store.Algorithm.InnerOuterMask
- (*Algorithm_RangeMask_Slice)(nil), // 31: bytebase.store.Algorithm.RangeMask.Slice
- (*AppIMSetting_Slack)(nil), // 32: bytebase.store.AppIMSetting.Slack
- (*AppIMSetting_Feishu)(nil), // 33: bytebase.store.AppIMSetting.Feishu
- (*AppIMSetting_Wecom)(nil), // 34: bytebase.store.AppIMSetting.Wecom
- (*AppIMSetting_Lark)(nil), // 35: bytebase.store.AppIMSetting.Lark
- (*AppIMSetting_DingTalk)(nil), // 36: bytebase.store.AppIMSetting.DingTalk
- (*AppIMSetting_IMSetting)(nil), // 37: bytebase.store.AppIMSetting.IMSetting
- (*EnvironmentSetting_Environment)(nil), // 38: bytebase.store.EnvironmentSetting.Environment
- nil, // 39: bytebase.store.EnvironmentSetting.Environment.TagsEntry
- (*durationpb.Duration)(nil), // 40: google.protobuf.Duration
- (*ApprovalTemplate)(nil), // 41: bytebase.store.ApprovalTemplate
- (*expr.Expr)(nil), // 42: google.type.Expr
- (Engine)(0), // 43: bytebase.store.Engine
- (*ColumnMetadata)(nil), // 44: bytebase.store.ColumnMetadata
- (*ColumnCatalog)(nil), // 45: bytebase.store.ColumnCatalog
- (*TableMetadata)(nil), // 46: bytebase.store.TableMetadata
- (*TableCatalog)(nil), // 47: bytebase.store.TableCatalog
- (ProjectWebhook_Type)(0), // 48: bytebase.store.ProjectWebhook.Type
+ (*DataClassificationSetting)(nil), // 9: bytebase.store.DataClassificationSetting
+ (*SemanticTypeSetting)(nil), // 10: bytebase.store.SemanticTypeSetting
+ (*Algorithm)(nil), // 11: bytebase.store.Algorithm
+ (*AppIMSetting)(nil), // 12: bytebase.store.AppIMSetting
+ (*SCIMSetting)(nil), // 13: bytebase.store.SCIMSetting
+ (*PasswordRestrictionSetting)(nil), // 14: bytebase.store.PasswordRestrictionSetting
+ (*AISetting)(nil), // 15: bytebase.store.AISetting
+ (*EnvironmentSetting)(nil), // 16: bytebase.store.EnvironmentSetting
+ (*WorkspaceApprovalSetting_Rule)(nil), // 17: bytebase.store.WorkspaceApprovalSetting.Rule
+ (*DataClassificationSetting_DataClassificationConfig)(nil), // 18: bytebase.store.DataClassificationSetting.DataClassificationConfig
+ (*DataClassificationSetting_DataClassificationConfig_Level)(nil), // 19: bytebase.store.DataClassificationSetting.DataClassificationConfig.Level
+ (*DataClassificationSetting_DataClassificationConfig_DataClassification)(nil), // 20: bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification
+ nil, // 21: bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+ (*SemanticTypeSetting_SemanticType)(nil), // 22: bytebase.store.SemanticTypeSetting.SemanticType
+ (*Algorithm_FullMask)(nil), // 23: bytebase.store.Algorithm.FullMask
+ (*Algorithm_RangeMask)(nil), // 24: bytebase.store.Algorithm.RangeMask
+ (*Algorithm_MD5Mask)(nil), // 25: bytebase.store.Algorithm.MD5Mask
+ (*Algorithm_InnerOuterMask)(nil), // 26: bytebase.store.Algorithm.InnerOuterMask
+ (*Algorithm_RangeMask_Slice)(nil), // 27: bytebase.store.Algorithm.RangeMask.Slice
+ (*AppIMSetting_Slack)(nil), // 28: bytebase.store.AppIMSetting.Slack
+ (*AppIMSetting_Feishu)(nil), // 29: bytebase.store.AppIMSetting.Feishu
+ (*AppIMSetting_Wecom)(nil), // 30: bytebase.store.AppIMSetting.Wecom
+ (*AppIMSetting_Lark)(nil), // 31: bytebase.store.AppIMSetting.Lark
+ (*AppIMSetting_DingTalk)(nil), // 32: bytebase.store.AppIMSetting.DingTalk
+ (*AppIMSetting_IMSetting)(nil), // 33: bytebase.store.AppIMSetting.IMSetting
+ (*EnvironmentSetting_Environment)(nil), // 34: bytebase.store.EnvironmentSetting.Environment
+ nil, // 35: bytebase.store.EnvironmentSetting.Environment.TagsEntry
+ (*durationpb.Duration)(nil), // 36: google.protobuf.Duration
+ (*ApprovalTemplate)(nil), // 37: bytebase.store.ApprovalTemplate
+ (*expr.Expr)(nil), // 38: google.type.Expr
+ (ProjectWebhook_Type)(0), // 39: bytebase.store.ProjectWebhook.Type
}
var file_store_setting_proto_depIdxs = []int32{
- 40, // 0: bytebase.store.WorkspaceProfileSetting.token_duration:type_name -> google.protobuf.Duration
+ 36, // 0: bytebase.store.WorkspaceProfileSetting.token_duration:type_name -> google.protobuf.Duration
7, // 1: bytebase.store.WorkspaceProfileSetting.announcement:type_name -> bytebase.store.Announcement
- 40, // 2: bytebase.store.WorkspaceProfileSetting.maximum_role_expiration:type_name -> google.protobuf.Duration
+ 36, // 2: bytebase.store.WorkspaceProfileSetting.maximum_role_expiration:type_name -> google.protobuf.Duration
1, // 3: bytebase.store.WorkspaceProfileSetting.database_change_mode:type_name -> bytebase.store.DatabaseChangeMode
- 40, // 4: bytebase.store.WorkspaceProfileSetting.inactive_session_timeout:type_name -> google.protobuf.Duration
+ 36, // 4: bytebase.store.WorkspaceProfileSetting.inactive_session_timeout:type_name -> google.protobuf.Duration
2, // 5: bytebase.store.Announcement.level:type_name -> bytebase.store.Announcement.AlertLevel
- 18, // 6: bytebase.store.WorkspaceApprovalSetting.rules:type_name -> bytebase.store.WorkspaceApprovalSetting.Rule
- 19, // 7: bytebase.store.SchemaTemplateSetting.field_templates:type_name -> bytebase.store.SchemaTemplateSetting.FieldTemplate
- 20, // 8: bytebase.store.SchemaTemplateSetting.column_types:type_name -> bytebase.store.SchemaTemplateSetting.ColumnType
- 21, // 9: bytebase.store.SchemaTemplateSetting.table_templates:type_name -> bytebase.store.SchemaTemplateSetting.TableTemplate
- 22, // 10: bytebase.store.DataClassificationSetting.configs:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig
- 26, // 11: bytebase.store.SemanticTypeSetting.types:type_name -> bytebase.store.SemanticTypeSetting.SemanticType
- 27, // 12: bytebase.store.Algorithm.full_mask:type_name -> bytebase.store.Algorithm.FullMask
- 28, // 13: bytebase.store.Algorithm.range_mask:type_name -> bytebase.store.Algorithm.RangeMask
- 29, // 14: bytebase.store.Algorithm.md5_mask:type_name -> bytebase.store.Algorithm.MD5Mask
- 30, // 15: bytebase.store.Algorithm.inner_outer_mask:type_name -> bytebase.store.Algorithm.InnerOuterMask
- 37, // 16: bytebase.store.AppIMSetting.settings:type_name -> bytebase.store.AppIMSetting.IMSetting
- 40, // 17: bytebase.store.PasswordRestrictionSetting.password_rotation:type_name -> google.protobuf.Duration
- 5, // 18: bytebase.store.AISetting.provider:type_name -> bytebase.store.AISetting.Provider
- 38, // 19: bytebase.store.EnvironmentSetting.environments:type_name -> bytebase.store.EnvironmentSetting.Environment
- 41, // 20: bytebase.store.WorkspaceApprovalSetting.Rule.template:type_name -> bytebase.store.ApprovalTemplate
- 42, // 21: bytebase.store.WorkspaceApprovalSetting.Rule.condition:type_name -> google.type.Expr
- 3, // 22: bytebase.store.WorkspaceApprovalSetting.Rule.source:type_name -> bytebase.store.WorkspaceApprovalSetting.Rule.Source
- 43, // 23: bytebase.store.SchemaTemplateSetting.FieldTemplate.engine:type_name -> bytebase.store.Engine
- 44, // 24: bytebase.store.SchemaTemplateSetting.FieldTemplate.column:type_name -> bytebase.store.ColumnMetadata
- 45, // 25: bytebase.store.SchemaTemplateSetting.FieldTemplate.catalog:type_name -> bytebase.store.ColumnCatalog
- 43, // 26: bytebase.store.SchemaTemplateSetting.ColumnType.engine:type_name -> bytebase.store.Engine
- 43, // 27: bytebase.store.SchemaTemplateSetting.TableTemplate.engine:type_name -> bytebase.store.Engine
- 46, // 28: bytebase.store.SchemaTemplateSetting.TableTemplate.table:type_name -> bytebase.store.TableMetadata
- 47, // 29: bytebase.store.SchemaTemplateSetting.TableTemplate.catalog:type_name -> bytebase.store.TableCatalog
- 23, // 30: bytebase.store.DataClassificationSetting.DataClassificationConfig.levels:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig.Level
- 25, // 31: bytebase.store.DataClassificationSetting.DataClassificationConfig.classification:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
- 24, // 32: bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry.value:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification
- 12, // 33: bytebase.store.SemanticTypeSetting.SemanticType.algorithm:type_name -> bytebase.store.Algorithm
- 31, // 34: bytebase.store.Algorithm.RangeMask.slices:type_name -> bytebase.store.Algorithm.RangeMask.Slice
- 4, // 35: bytebase.store.Algorithm.InnerOuterMask.type:type_name -> bytebase.store.Algorithm.InnerOuterMask.MaskType
- 48, // 36: bytebase.store.AppIMSetting.IMSetting.type:type_name -> bytebase.store.ProjectWebhook.Type
- 32, // 37: bytebase.store.AppIMSetting.IMSetting.slack:type_name -> bytebase.store.AppIMSetting.Slack
- 33, // 38: bytebase.store.AppIMSetting.IMSetting.feishu:type_name -> bytebase.store.AppIMSetting.Feishu
- 34, // 39: bytebase.store.AppIMSetting.IMSetting.wecom:type_name -> bytebase.store.AppIMSetting.Wecom
- 35, // 40: bytebase.store.AppIMSetting.IMSetting.lark:type_name -> bytebase.store.AppIMSetting.Lark
- 36, // 41: bytebase.store.AppIMSetting.IMSetting.dingtalk:type_name -> bytebase.store.AppIMSetting.DingTalk
- 39, // 42: bytebase.store.EnvironmentSetting.Environment.tags:type_name -> bytebase.store.EnvironmentSetting.Environment.TagsEntry
- 43, // [43:43] is the sub-list for method output_type
- 43, // [43:43] is the sub-list for method input_type
- 43, // [43:43] is the sub-list for extension type_name
- 43, // [43:43] is the sub-list for extension extendee
- 0, // [0:43] is the sub-list for field type_name
+ 17, // 6: bytebase.store.WorkspaceApprovalSetting.rules:type_name -> bytebase.store.WorkspaceApprovalSetting.Rule
+ 18, // 7: bytebase.store.DataClassificationSetting.configs:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig
+ 22, // 8: bytebase.store.SemanticTypeSetting.types:type_name -> bytebase.store.SemanticTypeSetting.SemanticType
+ 23, // 9: bytebase.store.Algorithm.full_mask:type_name -> bytebase.store.Algorithm.FullMask
+ 24, // 10: bytebase.store.Algorithm.range_mask:type_name -> bytebase.store.Algorithm.RangeMask
+ 25, // 11: bytebase.store.Algorithm.md5_mask:type_name -> bytebase.store.Algorithm.MD5Mask
+ 26, // 12: bytebase.store.Algorithm.inner_outer_mask:type_name -> bytebase.store.Algorithm.InnerOuterMask
+ 33, // 13: bytebase.store.AppIMSetting.settings:type_name -> bytebase.store.AppIMSetting.IMSetting
+ 36, // 14: bytebase.store.PasswordRestrictionSetting.password_rotation:type_name -> google.protobuf.Duration
+ 5, // 15: bytebase.store.AISetting.provider:type_name -> bytebase.store.AISetting.Provider
+ 34, // 16: bytebase.store.EnvironmentSetting.environments:type_name -> bytebase.store.EnvironmentSetting.Environment
+ 37, // 17: bytebase.store.WorkspaceApprovalSetting.Rule.template:type_name -> bytebase.store.ApprovalTemplate
+ 38, // 18: bytebase.store.WorkspaceApprovalSetting.Rule.condition:type_name -> google.type.Expr
+ 3, // 19: bytebase.store.WorkspaceApprovalSetting.Rule.source:type_name -> bytebase.store.WorkspaceApprovalSetting.Rule.Source
+ 19, // 20: bytebase.store.DataClassificationSetting.DataClassificationConfig.levels:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig.Level
+ 21, // 21: bytebase.store.DataClassificationSetting.DataClassificationConfig.classification:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+ 20, // 22: bytebase.store.DataClassificationSetting.DataClassificationConfig.ClassificationEntry.value:type_name -> bytebase.store.DataClassificationSetting.DataClassificationConfig.DataClassification
+ 11, // 23: bytebase.store.SemanticTypeSetting.SemanticType.algorithm:type_name -> bytebase.store.Algorithm
+ 27, // 24: bytebase.store.Algorithm.RangeMask.slices:type_name -> bytebase.store.Algorithm.RangeMask.Slice
+ 4, // 25: bytebase.store.Algorithm.InnerOuterMask.type:type_name -> bytebase.store.Algorithm.InnerOuterMask.MaskType
+ 39, // 26: bytebase.store.AppIMSetting.IMSetting.type:type_name -> bytebase.store.ProjectWebhook.Type
+ 28, // 27: bytebase.store.AppIMSetting.IMSetting.slack:type_name -> bytebase.store.AppIMSetting.Slack
+ 29, // 28: bytebase.store.AppIMSetting.IMSetting.feishu:type_name -> bytebase.store.AppIMSetting.Feishu
+ 30, // 29: bytebase.store.AppIMSetting.IMSetting.wecom:type_name -> bytebase.store.AppIMSetting.Wecom
+ 31, // 30: bytebase.store.AppIMSetting.IMSetting.lark:type_name -> bytebase.store.AppIMSetting.Lark
+ 32, // 31: bytebase.store.AppIMSetting.IMSetting.dingtalk:type_name -> bytebase.store.AppIMSetting.DingTalk
+ 35, // 32: bytebase.store.EnvironmentSetting.Environment.tags:type_name -> bytebase.store.EnvironmentSetting.Environment.TagsEntry
+ 33, // [33:33] is the sub-list for method output_type
+ 33, // [33:33] is the sub-list for method input_type
+ 33, // [33:33] is the sub-list for extension type_name
+ 33, // [33:33] is the sub-list for extension extendee
+ 0, // [0:33] is the sub-list for field type_name
}
func init() { file_store_setting_proto_init() }
@@ -2851,17 +2531,15 @@ func file_store_setting_proto_init() {
return
}
file_store_approval_proto_init()
- file_store_common_proto_init()
- file_store_database_proto_init()
file_store_project_webhook_proto_init()
- file_store_setting_proto_msgTypes[6].OneofWrappers = []any{
+ file_store_setting_proto_msgTypes[5].OneofWrappers = []any{
(*Algorithm_FullMask_)(nil),
(*Algorithm_RangeMask_)(nil),
(*Algorithm_Md5Mask)(nil),
(*Algorithm_InnerOuterMask_)(nil),
}
- file_store_setting_proto_msgTypes[18].OneofWrappers = []any{}
- file_store_setting_proto_msgTypes[31].OneofWrappers = []any{
+ file_store_setting_proto_msgTypes[14].OneofWrappers = []any{}
+ file_store_setting_proto_msgTypes[27].OneofWrappers = []any{
(*AppIMSetting_IMSetting_Slack)(nil),
(*AppIMSetting_IMSetting_Feishu)(nil),
(*AppIMSetting_IMSetting_Wecom)(nil),
@@ -2874,7 +2552,7 @@ func file_store_setting_proto_init() {
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_store_setting_proto_rawDesc), len(file_store_setting_proto_rawDesc)),
NumEnums: 6,
- NumMessages: 34,
+ NumMessages: 30,
NumExtensions: 0,
NumServices: 0,
},
diff --git a/backend/generated-go/store/setting_equal.pb.go b/backend/generated-go/store/setting_equal.pb.go
index 05de3c213b..a050a4abcf 100644
--- a/backend/generated-go/store/setting_equal.pb.go
+++ b/backend/generated-go/store/setting_equal.pb.go
@@ -120,114 +120,6 @@ func (x *WorkspaceApprovalSetting) Equal(y *WorkspaceApprovalSetting) bool {
return true
}
-func (x *SchemaTemplateSetting_FieldTemplate) Equal(y *SchemaTemplateSetting_FieldTemplate) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.Id != y.Id {
- return false
- }
- if x.Engine != y.Engine {
- return false
- }
- if x.Category != y.Category {
- return false
- }
- if !x.Column.Equal(y.Column) {
- return false
- }
- if !x.Catalog.Equal(y.Catalog) {
- return false
- }
- return true
-}
-
-func (x *SchemaTemplateSetting_ColumnType) Equal(y *SchemaTemplateSetting_ColumnType) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.Engine != y.Engine {
- return false
- }
- if x.Enabled != y.Enabled {
- return false
- }
- if len(x.Types) != len(y.Types) {
- return false
- }
- for i := 0; i < len(x.Types); i++ {
- if x.Types[i] != y.Types[i] {
- return false
- }
- }
- return true
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) Equal(y *SchemaTemplateSetting_TableTemplate) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.Id != y.Id {
- return false
- }
- if x.Engine != y.Engine {
- return false
- }
- if x.Category != y.Category {
- return false
- }
- if !x.Table.Equal(y.Table) {
- return false
- }
- if !x.Catalog.Equal(y.Catalog) {
- return false
- }
- return true
-}
-
-func (x *SchemaTemplateSetting) Equal(y *SchemaTemplateSetting) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if len(x.FieldTemplates) != len(y.FieldTemplates) {
- return false
- }
- for i := 0; i < len(x.FieldTemplates); i++ {
- if !x.FieldTemplates[i].Equal(y.FieldTemplates[i]) {
- return false
- }
- }
- if len(x.ColumnTypes) != len(y.ColumnTypes) {
- return false
- }
- for i := 0; i < len(x.ColumnTypes); i++ {
- if !x.ColumnTypes[i].Equal(y.ColumnTypes[i]) {
- return false
- }
- }
- if len(x.TableTemplates) != len(y.TableTemplates) {
- return false
- }
- for i := 0; i < len(x.TableTemplates); i++ {
- if !x.TableTemplates[i].Equal(y.TableTemplates[i]) {
- return false
- }
- }
- return true
-}
-
func (x *DataClassificationSetting_DataClassificationConfig_Level) Equal(y *DataClassificationSetting_DataClassificationConfig_Level) bool {
if x == y {
return true
diff --git a/backend/generated-go/v1/setting_service.pb.go b/backend/generated-go/v1/setting_service.pb.go
index 8398240bc2..ce2336eb06 100644
--- a/backend/generated-go/v1/setting_service.pb.go
+++ b/backend/generated-go/v1/setting_service.pb.go
@@ -80,23 +80,21 @@ func (DatabaseChangeMode) EnumDescriptor() ([]byte, []int) {
type Setting_SettingName int32
const (
- Setting_SETTING_NAME_UNSPECIFIED Setting_SettingName = 0
- Setting_AUTH_SECRET Setting_SettingName = 1
- Setting_BRANDING_LOGO Setting_SettingName = 2
- Setting_WORKSPACE_ID Setting_SettingName = 3
- Setting_WORKSPACE_PROFILE Setting_SettingName = 4
- Setting_WORKSPACE_APPROVAL Setting_SettingName = 5
- Setting_WORKSPACE_EXTERNAL_APPROVAL Setting_SettingName = 6
- Setting_ENTERPRISE_LICENSE Setting_SettingName = 7
- Setting_APP_IM Setting_SettingName = 8
- Setting_WATERMARK Setting_SettingName = 9
- Setting_AI Setting_SettingName = 10
- Setting_SCHEMA_TEMPLATE Setting_SettingName = 13
- Setting_DATA_CLASSIFICATION Setting_SettingName = 14
- Setting_SEMANTIC_TYPES Setting_SettingName = 15
- Setting_SCIM Setting_SettingName = 17
- Setting_PASSWORD_RESTRICTION Setting_SettingName = 18
- Setting_ENVIRONMENT Setting_SettingName = 19
+ Setting_SETTING_NAME_UNSPECIFIED Setting_SettingName = 0
+ Setting_AUTH_SECRET Setting_SettingName = 1
+ Setting_BRANDING_LOGO Setting_SettingName = 2
+ Setting_WORKSPACE_ID Setting_SettingName = 3
+ Setting_WORKSPACE_PROFILE Setting_SettingName = 4
+ Setting_WORKSPACE_APPROVAL Setting_SettingName = 5
+ Setting_ENTERPRISE_LICENSE Setting_SettingName = 7
+ Setting_APP_IM Setting_SettingName = 8
+ Setting_WATERMARK Setting_SettingName = 9
+ Setting_AI Setting_SettingName = 10
+ Setting_DATA_CLASSIFICATION Setting_SettingName = 14
+ Setting_SEMANTIC_TYPES Setting_SettingName = 15
+ Setting_SCIM Setting_SettingName = 17
+ Setting_PASSWORD_RESTRICTION Setting_SettingName = 18
+ Setting_ENVIRONMENT Setting_SettingName = 19
)
// Enum value maps for Setting_SettingName.
@@ -108,12 +106,10 @@ var (
3: "WORKSPACE_ID",
4: "WORKSPACE_PROFILE",
5: "WORKSPACE_APPROVAL",
- 6: "WORKSPACE_EXTERNAL_APPROVAL",
7: "ENTERPRISE_LICENSE",
8: "APP_IM",
9: "WATERMARK",
10: "AI",
- 13: "SCHEMA_TEMPLATE",
14: "DATA_CLASSIFICATION",
15: "SEMANTIC_TYPES",
17: "SCIM",
@@ -121,23 +117,21 @@ var (
19: "ENVIRONMENT",
}
Setting_SettingName_value = map[string]int32{
- "SETTING_NAME_UNSPECIFIED": 0,
- "AUTH_SECRET": 1,
- "BRANDING_LOGO": 2,
- "WORKSPACE_ID": 3,
- "WORKSPACE_PROFILE": 4,
- "WORKSPACE_APPROVAL": 5,
- "WORKSPACE_EXTERNAL_APPROVAL": 6,
- "ENTERPRISE_LICENSE": 7,
- "APP_IM": 8,
- "WATERMARK": 9,
- "AI": 10,
- "SCHEMA_TEMPLATE": 13,
- "DATA_CLASSIFICATION": 14,
- "SEMANTIC_TYPES": 15,
- "SCIM": 17,
- "PASSWORD_RESTRICTION": 18,
- "ENVIRONMENT": 19,
+ "SETTING_NAME_UNSPECIFIED": 0,
+ "AUTH_SECRET": 1,
+ "BRANDING_LOGO": 2,
+ "WORKSPACE_ID": 3,
+ "WORKSPACE_PROFILE": 4,
+ "WORKSPACE_APPROVAL": 5,
+ "ENTERPRISE_LICENSE": 7,
+ "APP_IM": 8,
+ "WATERMARK": 9,
+ "AI": 10,
+ "DATA_CLASSIFICATION": 14,
+ "SEMANTIC_TYPES": 15,
+ "SCIM": 17,
+ "PASSWORD_RESTRICTION": 18,
+ "ENVIRONMENT": 19,
}
)
@@ -322,7 +316,7 @@ func (x Algorithm_InnerOuterMask_MaskType) Number() protoreflect.EnumNumber {
// Deprecated: Use Algorithm_InnerOuterMask_MaskType.Descriptor instead.
func (Algorithm_InnerOuterMask_MaskType) EnumDescriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14, 3, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 3, 0}
}
type AISetting_Provider int32
@@ -377,7 +371,7 @@ func (x AISetting_Provider) Number() protoreflect.EnumNumber {
// Deprecated: Use AISetting_Provider.Descriptor instead.
func (AISetting_Provider) EnumDescriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{17, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{16, 0}
}
type ListSettingsRequest struct {
@@ -693,7 +687,6 @@ type Value struct {
// *Value_AppImSettingValue
// *Value_WorkspaceProfileSettingValue
// *Value_WorkspaceApprovalSettingValue
- // *Value_SchemaTemplateSettingValue
// *Value_DataClassificationSettingValue
// *Value_SemanticTypeSettingValue
// *Value_ScimSetting
@@ -778,15 +771,6 @@ func (x *Value) GetWorkspaceApprovalSettingValue() *WorkspaceApprovalSetting {
return nil
}
-func (x *Value) GetSchemaTemplateSettingValue() *SchemaTemplateSetting {
- if x != nil {
- if x, ok := x.Value.(*Value_SchemaTemplateSettingValue); ok {
- return x.SchemaTemplateSettingValue
- }
- }
- return nil
-}
-
func (x *Value) GetDataClassificationSettingValue() *DataClassificationSetting {
if x != nil {
if x, ok := x.Value.(*Value_DataClassificationSettingValue); ok {
@@ -863,10 +847,6 @@ type Value_WorkspaceApprovalSettingValue struct {
WorkspaceApprovalSettingValue *WorkspaceApprovalSetting `protobuf:"bytes,6,opt,name=workspace_approval_setting_value,json=workspaceApprovalSettingValue,proto3,oneof"`
}
-type Value_SchemaTemplateSettingValue struct {
- SchemaTemplateSettingValue *SchemaTemplateSetting `protobuf:"bytes,9,opt,name=schema_template_setting_value,json=schemaTemplateSettingValue,proto3,oneof"`
-}
-
type Value_DataClassificationSettingValue struct {
DataClassificationSettingValue *DataClassificationSetting `protobuf:"bytes,10,opt,name=data_classification_setting_value,json=dataClassificationSettingValue,proto3,oneof"`
}
@@ -899,8 +879,6 @@ func (*Value_WorkspaceProfileSettingValue) isValue_Value() {}
func (*Value_WorkspaceApprovalSettingValue) isValue_Value() {}
-func (*Value_SchemaTemplateSettingValue) isValue_Value() {}
-
func (*Value_DataClassificationSettingValue) isValue_Value() {}
func (*Value_SemanticTypeSettingValue) isValue_Value() {}
@@ -1218,66 +1196,6 @@ func (x *WorkspaceApprovalSetting) GetRules() []*WorkspaceApprovalSetting_Rule {
return nil
}
-type SchemaTemplateSetting struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- FieldTemplates []*SchemaTemplateSetting_FieldTemplate `protobuf:"bytes,1,rep,name=field_templates,json=fieldTemplates,proto3" json:"field_templates,omitempty"`
- ColumnTypes []*SchemaTemplateSetting_ColumnType `protobuf:"bytes,2,rep,name=column_types,json=columnTypes,proto3" json:"column_types,omitempty"`
- TableTemplates []*SchemaTemplateSetting_TableTemplate `protobuf:"bytes,3,rep,name=table_templates,json=tableTemplates,proto3" json:"table_templates,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting) Reset() {
- *x = SchemaTemplateSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[11]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[11]
- 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 SchemaTemplateSetting.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{11}
-}
-
-func (x *SchemaTemplateSetting) GetFieldTemplates() []*SchemaTemplateSetting_FieldTemplate {
- if x != nil {
- return x.FieldTemplates
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting) GetColumnTypes() []*SchemaTemplateSetting_ColumnType {
- if x != nil {
- return x.ColumnTypes
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting) GetTableTemplates() []*SchemaTemplateSetting_TableTemplate {
- if x != nil {
- return x.TableTemplates
- }
- return nil
-}
-
type DataClassificationSetting struct {
state protoimpl.MessageState `protogen:"open.v1"`
Configs []*DataClassificationSetting_DataClassificationConfig `protobuf:"bytes,1,rep,name=configs,proto3" json:"configs,omitempty"`
@@ -1287,7 +1205,7 @@ type DataClassificationSetting struct {
func (x *DataClassificationSetting) Reset() {
*x = DataClassificationSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[12]
+ mi := &file_v1_setting_service_proto_msgTypes[11]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1299,7 +1217,7 @@ func (x *DataClassificationSetting) String() string {
func (*DataClassificationSetting) ProtoMessage() {}
func (x *DataClassificationSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[12]
+ mi := &file_v1_setting_service_proto_msgTypes[11]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1312,7 +1230,7 @@ func (x *DataClassificationSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use DataClassificationSetting.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{12}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{11}
}
func (x *DataClassificationSetting) GetConfigs() []*DataClassificationSetting_DataClassificationConfig {
@@ -1331,7 +1249,7 @@ type SemanticTypeSetting struct {
func (x *SemanticTypeSetting) Reset() {
*x = SemanticTypeSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[13]
+ mi := &file_v1_setting_service_proto_msgTypes[12]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1343,7 +1261,7 @@ func (x *SemanticTypeSetting) String() string {
func (*SemanticTypeSetting) ProtoMessage() {}
func (x *SemanticTypeSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[13]
+ mi := &file_v1_setting_service_proto_msgTypes[12]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1356,7 +1274,7 @@ func (x *SemanticTypeSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use SemanticTypeSetting.ProtoReflect.Descriptor instead.
func (*SemanticTypeSetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{13}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{12}
}
func (x *SemanticTypeSetting) GetTypes() []*SemanticTypeSetting_SemanticType {
@@ -1381,7 +1299,7 @@ type Algorithm struct {
func (x *Algorithm) Reset() {
*x = Algorithm{}
- mi := &file_v1_setting_service_proto_msgTypes[14]
+ mi := &file_v1_setting_service_proto_msgTypes[13]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1393,7 +1311,7 @@ func (x *Algorithm) String() string {
func (*Algorithm) ProtoMessage() {}
func (x *Algorithm) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[14]
+ mi := &file_v1_setting_service_proto_msgTypes[13]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1406,7 +1324,7 @@ func (x *Algorithm) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm.ProtoReflect.Descriptor instead.
func (*Algorithm) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13}
}
func (x *Algorithm) GetMask() isAlgorithm_Mask {
@@ -1489,7 +1407,7 @@ type SCIMSetting struct {
func (x *SCIMSetting) Reset() {
*x = SCIMSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[15]
+ mi := &file_v1_setting_service_proto_msgTypes[14]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1501,7 +1419,7 @@ func (x *SCIMSetting) String() string {
func (*SCIMSetting) ProtoMessage() {}
func (x *SCIMSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[15]
+ mi := &file_v1_setting_service_proto_msgTypes[14]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1514,7 +1432,7 @@ func (x *SCIMSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use SCIMSetting.ProtoReflect.Descriptor instead.
func (*SCIMSetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{15}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{14}
}
func (x *SCIMSetting) GetToken() string {
@@ -1546,7 +1464,7 @@ type PasswordRestrictionSetting struct {
func (x *PasswordRestrictionSetting) Reset() {
*x = PasswordRestrictionSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[16]
+ mi := &file_v1_setting_service_proto_msgTypes[15]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1558,7 +1476,7 @@ func (x *PasswordRestrictionSetting) String() string {
func (*PasswordRestrictionSetting) ProtoMessage() {}
func (x *PasswordRestrictionSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[16]
+ mi := &file_v1_setting_service_proto_msgTypes[15]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1571,7 +1489,7 @@ func (x *PasswordRestrictionSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use PasswordRestrictionSetting.ProtoReflect.Descriptor instead.
func (*PasswordRestrictionSetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{16}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{15}
}
func (x *PasswordRestrictionSetting) GetMinLength() int32 {
@@ -1637,7 +1555,7 @@ type AISetting struct {
func (x *AISetting) Reset() {
*x = AISetting{}
- mi := &file_v1_setting_service_proto_msgTypes[17]
+ mi := &file_v1_setting_service_proto_msgTypes[16]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1649,7 +1567,7 @@ func (x *AISetting) String() string {
func (*AISetting) ProtoMessage() {}
func (x *AISetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[17]
+ mi := &file_v1_setting_service_proto_msgTypes[16]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1662,7 +1580,7 @@ func (x *AISetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use AISetting.ProtoReflect.Descriptor instead.
func (*AISetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{17}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{16}
}
func (x *AISetting) GetEnabled() bool {
@@ -1716,7 +1634,7 @@ type EnvironmentSetting struct {
func (x *EnvironmentSetting) Reset() {
*x = EnvironmentSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[18]
+ mi := &file_v1_setting_service_proto_msgTypes[17]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1728,7 +1646,7 @@ func (x *EnvironmentSetting) String() string {
func (*EnvironmentSetting) ProtoMessage() {}
func (x *EnvironmentSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[18]
+ mi := &file_v1_setting_service_proto_msgTypes[17]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1741,7 +1659,7 @@ func (x *EnvironmentSetting) ProtoReflect() protoreflect.Message {
// Deprecated: Use EnvironmentSetting.ProtoReflect.Descriptor instead.
func (*EnvironmentSetting) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{18}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{17}
}
func (x *EnvironmentSetting) GetEnvironments() []*EnvironmentSetting_Environment {
@@ -1760,7 +1678,7 @@ type AppIMSetting_Slack struct {
func (x *AppIMSetting_Slack) Reset() {
*x = AppIMSetting_Slack{}
- mi := &file_v1_setting_service_proto_msgTypes[19]
+ mi := &file_v1_setting_service_proto_msgTypes[18]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1772,7 +1690,7 @@ func (x *AppIMSetting_Slack) String() string {
func (*AppIMSetting_Slack) ProtoMessage() {}
func (x *AppIMSetting_Slack) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[19]
+ mi := &file_v1_setting_service_proto_msgTypes[18]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1805,7 +1723,7 @@ type AppIMSetting_Feishu struct {
func (x *AppIMSetting_Feishu) Reset() {
*x = AppIMSetting_Feishu{}
- mi := &file_v1_setting_service_proto_msgTypes[20]
+ mi := &file_v1_setting_service_proto_msgTypes[19]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1817,7 +1735,7 @@ func (x *AppIMSetting_Feishu) String() string {
func (*AppIMSetting_Feishu) ProtoMessage() {}
func (x *AppIMSetting_Feishu) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[20]
+ mi := &file_v1_setting_service_proto_msgTypes[19]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1858,7 +1776,7 @@ type AppIMSetting_Wecom struct {
func (x *AppIMSetting_Wecom) Reset() {
*x = AppIMSetting_Wecom{}
- mi := &file_v1_setting_service_proto_msgTypes[21]
+ mi := &file_v1_setting_service_proto_msgTypes[20]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1870,7 +1788,7 @@ func (x *AppIMSetting_Wecom) String() string {
func (*AppIMSetting_Wecom) ProtoMessage() {}
func (x *AppIMSetting_Wecom) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[21]
+ mi := &file_v1_setting_service_proto_msgTypes[20]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1917,7 +1835,7 @@ type AppIMSetting_Lark struct {
func (x *AppIMSetting_Lark) Reset() {
*x = AppIMSetting_Lark{}
- mi := &file_v1_setting_service_proto_msgTypes[22]
+ mi := &file_v1_setting_service_proto_msgTypes[21]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1929,7 +1847,7 @@ func (x *AppIMSetting_Lark) String() string {
func (*AppIMSetting_Lark) ProtoMessage() {}
func (x *AppIMSetting_Lark) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[22]
+ mi := &file_v1_setting_service_proto_msgTypes[21]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -1970,7 +1888,7 @@ type AppIMSetting_DingTalk struct {
func (x *AppIMSetting_DingTalk) Reset() {
*x = AppIMSetting_DingTalk{}
- mi := &file_v1_setting_service_proto_msgTypes[23]
+ mi := &file_v1_setting_service_proto_msgTypes[22]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -1982,7 +1900,7 @@ func (x *AppIMSetting_DingTalk) String() string {
func (*AppIMSetting_DingTalk) ProtoMessage() {}
func (x *AppIMSetting_DingTalk) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[23]
+ mi := &file_v1_setting_service_proto_msgTypes[22]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2036,7 +1954,7 @@ type AppIMSetting_IMSetting struct {
func (x *AppIMSetting_IMSetting) Reset() {
*x = AppIMSetting_IMSetting{}
- mi := &file_v1_setting_service_proto_msgTypes[24]
+ mi := &file_v1_setting_service_proto_msgTypes[23]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2048,7 +1966,7 @@ func (x *AppIMSetting_IMSetting) String() string {
func (*AppIMSetting_IMSetting) ProtoMessage() {}
func (x *AppIMSetting_IMSetting) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[24]
+ mi := &file_v1_setting_service_proto_msgTypes[23]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2195,7 +2113,7 @@ type WorkspaceApprovalSetting_Rule struct {
func (x *WorkspaceApprovalSetting_Rule) Reset() {
*x = WorkspaceApprovalSetting_Rule{}
- mi := &file_v1_setting_service_proto_msgTypes[25]
+ mi := &file_v1_setting_service_proto_msgTypes[24]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2207,7 +2125,7 @@ func (x *WorkspaceApprovalSetting_Rule) String() string {
func (*WorkspaceApprovalSetting_Rule) ProtoMessage() {}
func (x *WorkspaceApprovalSetting_Rule) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[25]
+ mi := &file_v1_setting_service_proto_msgTypes[24]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2244,218 +2162,6 @@ func (x *WorkspaceApprovalSetting_Rule) GetSource() WorkspaceApprovalSetting_Rul
return WorkspaceApprovalSetting_Rule_SOURCE_UNSPECIFIED
}
-type SchemaTemplateSetting_FieldTemplate struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- Engine Engine `protobuf:"varint,2,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`
- Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
- Column *ColumnMetadata `protobuf:"bytes,4,opt,name=column,proto3" json:"column,omitempty"`
- Catalog *ColumnCatalog `protobuf:"bytes,5,opt,name=catalog,proto3" json:"catalog,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) Reset() {
- *x = SchemaTemplateSetting_FieldTemplate{}
- mi := &file_v1_setting_service_proto_msgTypes[26]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting_FieldTemplate) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting_FieldTemplate) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[26]
- 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 SchemaTemplateSetting_FieldTemplate.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting_FieldTemplate) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{11, 0}
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetId() string {
- if x != nil {
- return x.Id
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetEngine() Engine {
- if x != nil {
- return x.Engine
- }
- return Engine_ENGINE_UNSPECIFIED
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetCategory() string {
- if x != nil {
- return x.Category
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetColumn() *ColumnMetadata {
- if x != nil {
- return x.Column
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting_FieldTemplate) GetCatalog() *ColumnCatalog {
- if x != nil {
- return x.Catalog
- }
- return nil
-}
-
-type SchemaTemplateSetting_ColumnType struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Engine Engine `protobuf:"varint,1,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`
- Enabled bool `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
- Types []string `protobuf:"bytes,3,rep,name=types,proto3" json:"types,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting_ColumnType) Reset() {
- *x = SchemaTemplateSetting_ColumnType{}
- mi := &file_v1_setting_service_proto_msgTypes[27]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting_ColumnType) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting_ColumnType) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting_ColumnType) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[27]
- 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 SchemaTemplateSetting_ColumnType.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting_ColumnType) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{11, 1}
-}
-
-func (x *SchemaTemplateSetting_ColumnType) GetEngine() Engine {
- if x != nil {
- return x.Engine
- }
- return Engine_ENGINE_UNSPECIFIED
-}
-
-func (x *SchemaTemplateSetting_ColumnType) GetEnabled() bool {
- if x != nil {
- return x.Enabled
- }
- return false
-}
-
-func (x *SchemaTemplateSetting_ColumnType) GetTypes() []string {
- if x != nil {
- return x.Types
- }
- return nil
-}
-
-type SchemaTemplateSetting_TableTemplate struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- Engine Engine `protobuf:"varint,2,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`
- Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
- Table *TableMetadata `protobuf:"bytes,4,opt,name=table,proto3" json:"table,omitempty"`
- Catalog *TableCatalog `protobuf:"bytes,5,opt,name=catalog,proto3" json:"catalog,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) Reset() {
- *x = SchemaTemplateSetting_TableTemplate{}
- mi := &file_v1_setting_service_proto_msgTypes[28]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SchemaTemplateSetting_TableTemplate) ProtoMessage() {}
-
-func (x *SchemaTemplateSetting_TableTemplate) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[28]
- 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 SchemaTemplateSetting_TableTemplate.ProtoReflect.Descriptor instead.
-func (*SchemaTemplateSetting_TableTemplate) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{11, 2}
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetId() string {
- if x != nil {
- return x.Id
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetEngine() Engine {
- if x != nil {
- return x.Engine
- }
- return Engine_ENGINE_UNSPECIFIED
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetCategory() string {
- if x != nil {
- return x.Category
- }
- return ""
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetTable() *TableMetadata {
- if x != nil {
- return x.Table
- }
- return nil
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) GetCatalog() *TableCatalog {
- if x != nil {
- return x.Catalog
- }
- return nil
-}
-
type DataClassificationSetting_DataClassificationConfig struct {
state protoimpl.MessageState `protogen:"open.v1"`
// id is the uuid for classification. Each project can chose one classification config.
@@ -2473,7 +2179,7 @@ type DataClassificationSetting_DataClassificationConfig struct {
func (x *DataClassificationSetting_DataClassificationConfig) Reset() {
*x = DataClassificationSetting_DataClassificationConfig{}
- mi := &file_v1_setting_service_proto_msgTypes[29]
+ mi := &file_v1_setting_service_proto_msgTypes[25]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2485,7 +2191,7 @@ func (x *DataClassificationSetting_DataClassificationConfig) String() string {
func (*DataClassificationSetting_DataClassificationConfig) ProtoMessage() {}
func (x *DataClassificationSetting_DataClassificationConfig) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[29]
+ mi := &file_v1_setting_service_proto_msgTypes[25]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2498,7 +2204,7 @@ func (x *DataClassificationSetting_DataClassificationConfig) ProtoReflect() prot
// Deprecated: Use DataClassificationSetting_DataClassificationConfig.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting_DataClassificationConfig) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{12, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{11, 0}
}
func (x *DataClassificationSetting_DataClassificationConfig) GetId() string {
@@ -2540,7 +2246,7 @@ type DataClassificationSetting_DataClassificationConfig_Level struct {
func (x *DataClassificationSetting_DataClassificationConfig_Level) Reset() {
*x = DataClassificationSetting_DataClassificationConfig_Level{}
- mi := &file_v1_setting_service_proto_msgTypes[30]
+ mi := &file_v1_setting_service_proto_msgTypes[26]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2552,7 +2258,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_Level) String() stri
func (*DataClassificationSetting_DataClassificationConfig_Level) ProtoMessage() {}
func (x *DataClassificationSetting_DataClassificationConfig_Level) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[30]
+ mi := &file_v1_setting_service_proto_msgTypes[26]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2565,7 +2271,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_Level) ProtoReflect(
// Deprecated: Use DataClassificationSetting_DataClassificationConfig_Level.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting_DataClassificationConfig_Level) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{12, 0, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{11, 0, 0}
}
func (x *DataClassificationSetting_DataClassificationConfig_Level) GetId() string {
@@ -2602,7 +2308,7 @@ type DataClassificationSetting_DataClassificationConfig_DataClassification struc
func (x *DataClassificationSetting_DataClassificationConfig_DataClassification) Reset() {
*x = DataClassificationSetting_DataClassificationConfig_DataClassification{}
- mi := &file_v1_setting_service_proto_msgTypes[31]
+ mi := &file_v1_setting_service_proto_msgTypes[27]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2614,7 +2320,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_DataClassification)
func (*DataClassificationSetting_DataClassificationConfig_DataClassification) ProtoMessage() {}
func (x *DataClassificationSetting_DataClassificationConfig_DataClassification) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[31]
+ mi := &file_v1_setting_service_proto_msgTypes[27]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2627,7 +2333,7 @@ func (x *DataClassificationSetting_DataClassificationConfig_DataClassification)
// Deprecated: Use DataClassificationSetting_DataClassificationConfig_DataClassification.ProtoReflect.Descriptor instead.
func (*DataClassificationSetting_DataClassificationConfig_DataClassification) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{12, 0, 1}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{11, 0, 1}
}
func (x *DataClassificationSetting_DataClassificationConfig_DataClassification) GetId() string {
@@ -2675,7 +2381,7 @@ type SemanticTypeSetting_SemanticType struct {
func (x *SemanticTypeSetting_SemanticType) Reset() {
*x = SemanticTypeSetting_SemanticType{}
- mi := &file_v1_setting_service_proto_msgTypes[33]
+ mi := &file_v1_setting_service_proto_msgTypes[29]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2687,7 +2393,7 @@ func (x *SemanticTypeSetting_SemanticType) String() string {
func (*SemanticTypeSetting_SemanticType) ProtoMessage() {}
func (x *SemanticTypeSetting_SemanticType) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[33]
+ mi := &file_v1_setting_service_proto_msgTypes[29]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2700,7 +2406,7 @@ func (x *SemanticTypeSetting_SemanticType) ProtoReflect() protoreflect.Message {
// Deprecated: Use SemanticTypeSetting_SemanticType.ProtoReflect.Descriptor instead.
func (*SemanticTypeSetting_SemanticType) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{12, 0}
}
func (x *SemanticTypeSetting_SemanticType) GetId() string {
@@ -2749,7 +2455,7 @@ type Algorithm_FullMask struct {
func (x *Algorithm_FullMask) Reset() {
*x = Algorithm_FullMask{}
- mi := &file_v1_setting_service_proto_msgTypes[34]
+ mi := &file_v1_setting_service_proto_msgTypes[30]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2761,7 +2467,7 @@ func (x *Algorithm_FullMask) String() string {
func (*Algorithm_FullMask) ProtoMessage() {}
func (x *Algorithm_FullMask) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[34]
+ mi := &file_v1_setting_service_proto_msgTypes[30]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2774,7 +2480,7 @@ func (x *Algorithm_FullMask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_FullMask.ProtoReflect.Descriptor instead.
func (*Algorithm_FullMask) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 0}
}
func (x *Algorithm_FullMask) GetSubstitution() string {
@@ -2795,7 +2501,7 @@ type Algorithm_RangeMask struct {
func (x *Algorithm_RangeMask) Reset() {
*x = Algorithm_RangeMask{}
- mi := &file_v1_setting_service_proto_msgTypes[35]
+ mi := &file_v1_setting_service_proto_msgTypes[31]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2807,7 +2513,7 @@ func (x *Algorithm_RangeMask) String() string {
func (*Algorithm_RangeMask) ProtoMessage() {}
func (x *Algorithm_RangeMask) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[35]
+ mi := &file_v1_setting_service_proto_msgTypes[31]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2820,7 +2526,7 @@ func (x *Algorithm_RangeMask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_RangeMask.ProtoReflect.Descriptor instead.
func (*Algorithm_RangeMask) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14, 1}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 1}
}
func (x *Algorithm_RangeMask) GetSlices() []*Algorithm_RangeMask_Slice {
@@ -2840,7 +2546,7 @@ type Algorithm_MD5Mask struct {
func (x *Algorithm_MD5Mask) Reset() {
*x = Algorithm_MD5Mask{}
- mi := &file_v1_setting_service_proto_msgTypes[36]
+ mi := &file_v1_setting_service_proto_msgTypes[32]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2852,7 +2558,7 @@ func (x *Algorithm_MD5Mask) String() string {
func (*Algorithm_MD5Mask) ProtoMessage() {}
func (x *Algorithm_MD5Mask) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[36]
+ mi := &file_v1_setting_service_proto_msgTypes[32]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2865,7 +2571,7 @@ func (x *Algorithm_MD5Mask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_MD5Mask.ProtoReflect.Descriptor instead.
func (*Algorithm_MD5Mask) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14, 2}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 2}
}
func (x *Algorithm_MD5Mask) GetSalt() string {
@@ -2887,7 +2593,7 @@ type Algorithm_InnerOuterMask struct {
func (x *Algorithm_InnerOuterMask) Reset() {
*x = Algorithm_InnerOuterMask{}
- mi := &file_v1_setting_service_proto_msgTypes[37]
+ mi := &file_v1_setting_service_proto_msgTypes[33]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2899,7 +2605,7 @@ func (x *Algorithm_InnerOuterMask) String() string {
func (*Algorithm_InnerOuterMask) ProtoMessage() {}
func (x *Algorithm_InnerOuterMask) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[37]
+ mi := &file_v1_setting_service_proto_msgTypes[33]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2912,7 +2618,7 @@ func (x *Algorithm_InnerOuterMask) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_InnerOuterMask.ProtoReflect.Descriptor instead.
func (*Algorithm_InnerOuterMask) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14, 3}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 3}
}
func (x *Algorithm_InnerOuterMask) GetPrefixLen() int32 {
@@ -2957,7 +2663,7 @@ type Algorithm_RangeMask_Slice struct {
func (x *Algorithm_RangeMask_Slice) Reset() {
*x = Algorithm_RangeMask_Slice{}
- mi := &file_v1_setting_service_proto_msgTypes[38]
+ mi := &file_v1_setting_service_proto_msgTypes[34]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -2969,7 +2675,7 @@ func (x *Algorithm_RangeMask_Slice) String() string {
func (*Algorithm_RangeMask_Slice) ProtoMessage() {}
func (x *Algorithm_RangeMask_Slice) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[38]
+ mi := &file_v1_setting_service_proto_msgTypes[34]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -2982,7 +2688,7 @@ func (x *Algorithm_RangeMask_Slice) ProtoReflect() protoreflect.Message {
// Deprecated: Use Algorithm_RangeMask_Slice.ProtoReflect.Descriptor instead.
func (*Algorithm_RangeMask_Slice) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{14, 1, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{13, 1, 0}
}
func (x *Algorithm_RangeMask_Slice) GetStart() int32 {
@@ -3026,7 +2732,7 @@ type EnvironmentSetting_Environment struct {
func (x *EnvironmentSetting_Environment) Reset() {
*x = EnvironmentSetting_Environment{}
- mi := &file_v1_setting_service_proto_msgTypes[39]
+ mi := &file_v1_setting_service_proto_msgTypes[35]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
@@ -3038,7 +2744,7 @@ func (x *EnvironmentSetting_Environment) String() string {
func (*EnvironmentSetting_Environment) ProtoMessage() {}
func (x *EnvironmentSetting_Environment) ProtoReflect() protoreflect.Message {
- mi := &file_v1_setting_service_proto_msgTypes[39]
+ mi := &file_v1_setting_service_proto_msgTypes[35]
if x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
@@ -3051,7 +2757,7 @@ func (x *EnvironmentSetting_Environment) ProtoReflect() protoreflect.Message {
// Deprecated: Use EnvironmentSetting_Environment.ProtoReflect.Descriptor instead.
func (*EnvironmentSetting_Environment) Descriptor() ([]byte, []int) {
- return file_v1_setting_service_proto_rawDescGZIP(), []int{18, 0}
+ return file_v1_setting_service_proto_rawDescGZIP(), []int{17, 0}
}
func (x *EnvironmentSetting_Environment) GetName() string {
@@ -3093,7 +2799,7 @@ var File_v1_setting_service_proto protoreflect.FileDescriptor
const file_v1_setting_service_proto_rawDesc = "" +
"\n" +
- "\x18v1/setting_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1egoogle/protobuf/duration.proto\x1a google/protobuf/field_mask.proto\x1a\x16google/type/expr.proto\x1a\x13v1/annotation.proto\x1a\x0fv1/common.proto\x1a!v1/database_catalog_service.proto\x1a\x19v1/database_service.proto\x1a\x16v1/issue_service.proto\x1a\x18v1/project_service.proto\"\x15\n" +
+ "\x18v1/setting_service.proto\x12\vbytebase.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1egoogle/protobuf/duration.proto\x1a google/protobuf/field_mask.proto\x1a\x16google/type/expr.proto\x1a\x13v1/annotation.proto\x1a\x16v1/issue_service.proto\x1a\x18v1/project_service.proto\"\x15\n" +
"\x13ListSettingsRequest\"H\n" +
"\x14ListSettingsResponse\x120\n" +
"\bsettings\x18\x01 \x03(\v2\x14.bytebase.v1.SettingR\bsettings\"E\n" +
@@ -3107,37 +2813,34 @@ const file_v1_setting_service_proto_rawDesc = "" +
"\rvalidate_only\x18\x02 \x01(\bR\fvalidateOnly\x12#\n" +
"\rallow_missing\x18\x03 \x01(\bR\fallowMissing\x12;\n" +
"\vupdate_mask\x18\x04 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
- "updateMask\"\xe2\x03\n" +
+ "updateMask\"\xb8\x03\n" +
"\aSetting\x12\x12\n" +
"\x04name\x18\x01 \x01(\tR\x04name\x12(\n" +
- "\x05value\x18\x02 \x01(\v2\x12.bytebase.v1.ValueR\x05value\"\xe3\x02\n" +
+ "\x05value\x18\x02 \x01(\v2\x12.bytebase.v1.ValueR\x05value\"\xb9\x02\n" +
"\vSettingName\x12\x1c\n" +
"\x18SETTING_NAME_UNSPECIFIED\x10\x00\x12\x0f\n" +
"\vAUTH_SECRET\x10\x01\x12\x11\n" +
"\rBRANDING_LOGO\x10\x02\x12\x10\n" +
"\fWORKSPACE_ID\x10\x03\x12\x15\n" +
"\x11WORKSPACE_PROFILE\x10\x04\x12\x16\n" +
- "\x12WORKSPACE_APPROVAL\x10\x05\x12\x1f\n" +
- "\x1bWORKSPACE_EXTERNAL_APPROVAL\x10\x06\x12\x16\n" +
+ "\x12WORKSPACE_APPROVAL\x10\x05\x12\x16\n" +
"\x12ENTERPRISE_LICENSE\x10\a\x12\n" +
"\n" +
"\x06APP_IM\x10\b\x12\r\n" +
"\tWATERMARK\x10\t\x12\x06\n" +
"\x02AI\x10\n" +
- "\x12\x13\n" +
- "\x0fSCHEMA_TEMPLATE\x10\r\x12\x17\n" +
+ "\x12\x17\n" +
"\x13DATA_CLASSIFICATION\x10\x0e\x12\x12\n" +
"\x0eSEMANTIC_TYPES\x10\x0f\x12\b\n" +
"\x04SCIM\x10\x11\x12\x18\n" +
"\x14PASSWORD_RESTRICTION\x10\x12\x12\x0f\n" +
- "\vENVIRONMENT\x10\x13:-\xeaA*\n" +
- "\x14bytebase.com/Setting\x12\x12settings/{setting}J\x04\b\x10\x10\x11\"\xe4\a\n" +
+ "\vENVIRONMENT\x10\x13\"\x04\b\x06\x10\x06\"\x04\b\r\x10\r:-\xeaA*\n" +
+ "\x14bytebase.com/Setting\x12\x12settings/{setting}J\x04\b\x10\x10\x11\"\x81\a\n" +
"\x05Value\x12#\n" +
"\fstring_value\x18\x01 \x01(\tH\x00R\vstringValue\x12L\n" +
"\x14app_im_setting_value\x18\x03 \x01(\v2\x19.bytebase.v1.AppIMSettingH\x00R\x11appImSettingValue\x12m\n" +
"\x1fworkspace_profile_setting_value\x18\x05 \x01(\v2$.bytebase.v1.WorkspaceProfileSettingH\x00R\x1cworkspaceProfileSettingValue\x12p\n" +
- " workspace_approval_setting_value\x18\x06 \x01(\v2%.bytebase.v1.WorkspaceApprovalSettingH\x00R\x1dworkspaceApprovalSettingValue\x12g\n" +
- "\x1dschema_template_setting_value\x18\t \x01(\v2\".bytebase.v1.SchemaTemplateSettingH\x00R\x1aschemaTemplateSettingValue\x12s\n" +
+ " workspace_approval_setting_value\x18\x06 \x01(\v2%.bytebase.v1.WorkspaceApprovalSettingH\x00R\x1dworkspaceApprovalSettingValue\x12s\n" +
"!data_classification_setting_value\x18\n" +
" \x01(\v2&.bytebase.v1.DataClassificationSettingH\x00R\x1edataClassificationSettingValue\x12a\n" +
"\x1bsemantic_type_setting_value\x18\v \x01(\v2 .bytebase.v1.SemanticTypeSettingH\x00R\x18semanticTypeSettingValue\x12=\n" +
@@ -3146,7 +2849,8 @@ const file_v1_setting_service_proto_rawDesc = "" +
"\n" +
"ai_setting\x18\x10 \x01(\v2\x16.bytebase.v1.AISettingH\x00R\taiSetting\x12R\n" +
"\x13environment_setting\x18\x11 \x01(\v2\x1f.bytebase.v1.EnvironmentSettingH\x00R\x12environmentSettingB\a\n" +
- "\x05valueJ\x04\b\x12\x10\x13\"\xd3\x06\n" +
+ "\x05valueJ\x04\b\x12\x10\x13J\x04\b\t\x10\n" +
+ "\"\xd3\x06\n" +
"\fAppIMSetting\x12?\n" +
"\bsettings\x18\x01 \x03(\v2#.bytebase.v1.AppIMSetting.IMSettingR\bsettings\x1a\"\n" +
"\x05Slack\x12\x19\n" +
@@ -3213,28 +2917,7 @@ const file_v1_setting_service_proto_rawDesc = "" +
"\x0fCHANGE_DATABASE\x10\x01\x12\x13\n" +
"\x0fCREATE_DATABASE\x10\x02\x12\x0f\n" +
"\vEXPORT_DATA\x10\x03\x12\x10\n" +
- "\fREQUEST_ROLE\x10\x04\"\xb2\x06\n" +
- "\x15SchemaTemplateSetting\x12Y\n" +
- "\x0ffield_templates\x18\x01 \x03(\v20.bytebase.v1.SchemaTemplateSetting.FieldTemplateR\x0efieldTemplates\x12P\n" +
- "\fcolumn_types\x18\x02 \x03(\v2-.bytebase.v1.SchemaTemplateSetting.ColumnTypeR\vcolumnTypes\x12Y\n" +
- "\x0ftable_templates\x18\x03 \x03(\v20.bytebase.v1.SchemaTemplateSetting.TableTemplateR\x0etableTemplates\x1a\xd3\x01\n" +
- "\rFieldTemplate\x12\x0e\n" +
- "\x02id\x18\x01 \x01(\tR\x02id\x12+\n" +
- "\x06engine\x18\x02 \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine\x12\x1a\n" +
- "\bcategory\x18\x03 \x01(\tR\bcategory\x123\n" +
- "\x06column\x18\x04 \x01(\v2\x1b.bytebase.v1.ColumnMetadataR\x06column\x124\n" +
- "\acatalog\x18\x05 \x01(\v2\x1a.bytebase.v1.ColumnCatalogR\acatalog\x1ai\n" +
- "\n" +
- "ColumnType\x12+\n" +
- "\x06engine\x18\x01 \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine\x12\x18\n" +
- "\aenabled\x18\x02 \x01(\bR\aenabled\x12\x14\n" +
- "\x05types\x18\x03 \x03(\tR\x05types\x1a\xcf\x01\n" +
- "\rTableTemplate\x12\x0e\n" +
- "\x02id\x18\x01 \x01(\tR\x02id\x12+\n" +
- "\x06engine\x18\x02 \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine\x12\x1a\n" +
- "\bcategory\x18\x03 \x01(\tR\bcategory\x120\n" +
- "\x05table\x18\x04 \x01(\v2\x1a.bytebase.v1.TableMetadataR\x05table\x123\n" +
- "\acatalog\x18\x05 \x01(\v2\x19.bytebase.v1.TableCatalogR\acatalog\"\x8a\x06\n" +
+ "\fREQUEST_ROLE\x10\x04\"\x8a\x06\n" +
"\x19DataClassificationSetting\x12Y\n" +
"\aconfigs\x18\x01 \x03(\v2?.bytebase.v1.DataClassificationSetting.DataClassificationConfigR\aconfigs\x1a\x91\x05\n" +
"\x18DataClassificationConfig\x12\x0e\n" +
@@ -3353,7 +3036,7 @@ func file_v1_setting_service_proto_rawDescGZIP() []byte {
}
var file_v1_setting_service_proto_enumTypes = make([]protoimpl.EnumInfo, 6)
-var file_v1_setting_service_proto_msgTypes = make([]protoimpl.MessageInfo, 41)
+var file_v1_setting_service_proto_msgTypes = make([]protoimpl.MessageInfo, 37)
var file_v1_setting_service_proto_goTypes = []any{
(DatabaseChangeMode)(0), // 0: bytebase.v1.DatabaseChangeMode
(Setting_SettingName)(0), // 1: bytebase.v1.Setting.SettingName
@@ -3372,117 +3055,97 @@ var file_v1_setting_service_proto_goTypes = []any{
(*WorkspaceProfileSetting)(nil), // 14: bytebase.v1.WorkspaceProfileSetting
(*Announcement)(nil), // 15: bytebase.v1.Announcement
(*WorkspaceApprovalSetting)(nil), // 16: bytebase.v1.WorkspaceApprovalSetting
- (*SchemaTemplateSetting)(nil), // 17: bytebase.v1.SchemaTemplateSetting
- (*DataClassificationSetting)(nil), // 18: bytebase.v1.DataClassificationSetting
- (*SemanticTypeSetting)(nil), // 19: bytebase.v1.SemanticTypeSetting
- (*Algorithm)(nil), // 20: bytebase.v1.Algorithm
- (*SCIMSetting)(nil), // 21: bytebase.v1.SCIMSetting
- (*PasswordRestrictionSetting)(nil), // 22: bytebase.v1.PasswordRestrictionSetting
- (*AISetting)(nil), // 23: bytebase.v1.AISetting
- (*EnvironmentSetting)(nil), // 24: bytebase.v1.EnvironmentSetting
- (*AppIMSetting_Slack)(nil), // 25: bytebase.v1.AppIMSetting.Slack
- (*AppIMSetting_Feishu)(nil), // 26: bytebase.v1.AppIMSetting.Feishu
- (*AppIMSetting_Wecom)(nil), // 27: bytebase.v1.AppIMSetting.Wecom
- (*AppIMSetting_Lark)(nil), // 28: bytebase.v1.AppIMSetting.Lark
- (*AppIMSetting_DingTalk)(nil), // 29: bytebase.v1.AppIMSetting.DingTalk
- (*AppIMSetting_IMSetting)(nil), // 30: bytebase.v1.AppIMSetting.IMSetting
- (*WorkspaceApprovalSetting_Rule)(nil), // 31: bytebase.v1.WorkspaceApprovalSetting.Rule
- (*SchemaTemplateSetting_FieldTemplate)(nil), // 32: bytebase.v1.SchemaTemplateSetting.FieldTemplate
- (*SchemaTemplateSetting_ColumnType)(nil), // 33: bytebase.v1.SchemaTemplateSetting.ColumnType
- (*SchemaTemplateSetting_TableTemplate)(nil), // 34: bytebase.v1.SchemaTemplateSetting.TableTemplate
- (*DataClassificationSetting_DataClassificationConfig)(nil), // 35: bytebase.v1.DataClassificationSetting.DataClassificationConfig
- (*DataClassificationSetting_DataClassificationConfig_Level)(nil), // 36: bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level
- (*DataClassificationSetting_DataClassificationConfig_DataClassification)(nil), // 37: bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification
- nil, // 38: bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
- (*SemanticTypeSetting_SemanticType)(nil), // 39: bytebase.v1.SemanticTypeSetting.SemanticType
- (*Algorithm_FullMask)(nil), // 40: bytebase.v1.Algorithm.FullMask
- (*Algorithm_RangeMask)(nil), // 41: bytebase.v1.Algorithm.RangeMask
- (*Algorithm_MD5Mask)(nil), // 42: bytebase.v1.Algorithm.MD5Mask
- (*Algorithm_InnerOuterMask)(nil), // 43: bytebase.v1.Algorithm.InnerOuterMask
- (*Algorithm_RangeMask_Slice)(nil), // 44: bytebase.v1.Algorithm.RangeMask.Slice
- (*EnvironmentSetting_Environment)(nil), // 45: bytebase.v1.EnvironmentSetting.Environment
- nil, // 46: bytebase.v1.EnvironmentSetting.Environment.TagsEntry
- (*fieldmaskpb.FieldMask)(nil), // 47: google.protobuf.FieldMask
- (*durationpb.Duration)(nil), // 48: google.protobuf.Duration
- (Webhook_Type)(0), // 49: bytebase.v1.Webhook.Type
- (*ApprovalTemplate)(nil), // 50: bytebase.v1.ApprovalTemplate
- (*expr.Expr)(nil), // 51: google.type.Expr
- (Engine)(0), // 52: bytebase.v1.Engine
- (*ColumnMetadata)(nil), // 53: bytebase.v1.ColumnMetadata
- (*ColumnCatalog)(nil), // 54: bytebase.v1.ColumnCatalog
- (*TableMetadata)(nil), // 55: bytebase.v1.TableMetadata
- (*TableCatalog)(nil), // 56: bytebase.v1.TableCatalog
+ (*DataClassificationSetting)(nil), // 17: bytebase.v1.DataClassificationSetting
+ (*SemanticTypeSetting)(nil), // 18: bytebase.v1.SemanticTypeSetting
+ (*Algorithm)(nil), // 19: bytebase.v1.Algorithm
+ (*SCIMSetting)(nil), // 20: bytebase.v1.SCIMSetting
+ (*PasswordRestrictionSetting)(nil), // 21: bytebase.v1.PasswordRestrictionSetting
+ (*AISetting)(nil), // 22: bytebase.v1.AISetting
+ (*EnvironmentSetting)(nil), // 23: bytebase.v1.EnvironmentSetting
+ (*AppIMSetting_Slack)(nil), // 24: bytebase.v1.AppIMSetting.Slack
+ (*AppIMSetting_Feishu)(nil), // 25: bytebase.v1.AppIMSetting.Feishu
+ (*AppIMSetting_Wecom)(nil), // 26: bytebase.v1.AppIMSetting.Wecom
+ (*AppIMSetting_Lark)(nil), // 27: bytebase.v1.AppIMSetting.Lark
+ (*AppIMSetting_DingTalk)(nil), // 28: bytebase.v1.AppIMSetting.DingTalk
+ (*AppIMSetting_IMSetting)(nil), // 29: bytebase.v1.AppIMSetting.IMSetting
+ (*WorkspaceApprovalSetting_Rule)(nil), // 30: bytebase.v1.WorkspaceApprovalSetting.Rule
+ (*DataClassificationSetting_DataClassificationConfig)(nil), // 31: bytebase.v1.DataClassificationSetting.DataClassificationConfig
+ (*DataClassificationSetting_DataClassificationConfig_Level)(nil), // 32: bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level
+ (*DataClassificationSetting_DataClassificationConfig_DataClassification)(nil), // 33: bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification
+ nil, // 34: bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+ (*SemanticTypeSetting_SemanticType)(nil), // 35: bytebase.v1.SemanticTypeSetting.SemanticType
+ (*Algorithm_FullMask)(nil), // 36: bytebase.v1.Algorithm.FullMask
+ (*Algorithm_RangeMask)(nil), // 37: bytebase.v1.Algorithm.RangeMask
+ (*Algorithm_MD5Mask)(nil), // 38: bytebase.v1.Algorithm.MD5Mask
+ (*Algorithm_InnerOuterMask)(nil), // 39: bytebase.v1.Algorithm.InnerOuterMask
+ (*Algorithm_RangeMask_Slice)(nil), // 40: bytebase.v1.Algorithm.RangeMask.Slice
+ (*EnvironmentSetting_Environment)(nil), // 41: bytebase.v1.EnvironmentSetting.Environment
+ nil, // 42: bytebase.v1.EnvironmentSetting.Environment.TagsEntry
+ (*fieldmaskpb.FieldMask)(nil), // 43: google.protobuf.FieldMask
+ (*durationpb.Duration)(nil), // 44: google.protobuf.Duration
+ (Webhook_Type)(0), // 45: bytebase.v1.Webhook.Type
+ (*ApprovalTemplate)(nil), // 46: bytebase.v1.ApprovalTemplate
+ (*expr.Expr)(nil), // 47: google.type.Expr
}
var file_v1_setting_service_proto_depIdxs = []int32{
11, // 0: bytebase.v1.ListSettingsResponse.settings:type_name -> bytebase.v1.Setting
11, // 1: bytebase.v1.GetSettingResponse.setting:type_name -> bytebase.v1.Setting
11, // 2: bytebase.v1.UpdateSettingRequest.setting:type_name -> bytebase.v1.Setting
- 47, // 3: bytebase.v1.UpdateSettingRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 43, // 3: bytebase.v1.UpdateSettingRequest.update_mask:type_name -> google.protobuf.FieldMask
12, // 4: bytebase.v1.Setting.value:type_name -> bytebase.v1.Value
13, // 5: bytebase.v1.Value.app_im_setting_value:type_name -> bytebase.v1.AppIMSetting
14, // 6: bytebase.v1.Value.workspace_profile_setting_value:type_name -> bytebase.v1.WorkspaceProfileSetting
16, // 7: bytebase.v1.Value.workspace_approval_setting_value:type_name -> bytebase.v1.WorkspaceApprovalSetting
- 17, // 8: bytebase.v1.Value.schema_template_setting_value:type_name -> bytebase.v1.SchemaTemplateSetting
- 18, // 9: bytebase.v1.Value.data_classification_setting_value:type_name -> bytebase.v1.DataClassificationSetting
- 19, // 10: bytebase.v1.Value.semantic_type_setting_value:type_name -> bytebase.v1.SemanticTypeSetting
- 21, // 11: bytebase.v1.Value.scim_setting:type_name -> bytebase.v1.SCIMSetting
- 22, // 12: bytebase.v1.Value.password_restriction_setting:type_name -> bytebase.v1.PasswordRestrictionSetting
- 23, // 13: bytebase.v1.Value.ai_setting:type_name -> bytebase.v1.AISetting
- 24, // 14: bytebase.v1.Value.environment_setting:type_name -> bytebase.v1.EnvironmentSetting
- 30, // 15: bytebase.v1.AppIMSetting.settings:type_name -> bytebase.v1.AppIMSetting.IMSetting
- 48, // 16: bytebase.v1.WorkspaceProfileSetting.token_duration:type_name -> google.protobuf.Duration
- 15, // 17: bytebase.v1.WorkspaceProfileSetting.announcement:type_name -> bytebase.v1.Announcement
- 48, // 18: bytebase.v1.WorkspaceProfileSetting.maximum_role_expiration:type_name -> google.protobuf.Duration
- 0, // 19: bytebase.v1.WorkspaceProfileSetting.database_change_mode:type_name -> bytebase.v1.DatabaseChangeMode
- 48, // 20: bytebase.v1.WorkspaceProfileSetting.inactive_session_timeout:type_name -> google.protobuf.Duration
- 2, // 21: bytebase.v1.Announcement.level:type_name -> bytebase.v1.Announcement.AlertLevel
- 31, // 22: bytebase.v1.WorkspaceApprovalSetting.rules:type_name -> bytebase.v1.WorkspaceApprovalSetting.Rule
- 32, // 23: bytebase.v1.SchemaTemplateSetting.field_templates:type_name -> bytebase.v1.SchemaTemplateSetting.FieldTemplate
- 33, // 24: bytebase.v1.SchemaTemplateSetting.column_types:type_name -> bytebase.v1.SchemaTemplateSetting.ColumnType
- 34, // 25: bytebase.v1.SchemaTemplateSetting.table_templates:type_name -> bytebase.v1.SchemaTemplateSetting.TableTemplate
- 35, // 26: bytebase.v1.DataClassificationSetting.configs:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig
- 39, // 27: bytebase.v1.SemanticTypeSetting.types:type_name -> bytebase.v1.SemanticTypeSetting.SemanticType
- 40, // 28: bytebase.v1.Algorithm.full_mask:type_name -> bytebase.v1.Algorithm.FullMask
- 41, // 29: bytebase.v1.Algorithm.range_mask:type_name -> bytebase.v1.Algorithm.RangeMask
- 42, // 30: bytebase.v1.Algorithm.md5_mask:type_name -> bytebase.v1.Algorithm.MD5Mask
- 43, // 31: bytebase.v1.Algorithm.inner_outer_mask:type_name -> bytebase.v1.Algorithm.InnerOuterMask
- 48, // 32: bytebase.v1.PasswordRestrictionSetting.password_rotation:type_name -> google.protobuf.Duration
- 5, // 33: bytebase.v1.AISetting.provider:type_name -> bytebase.v1.AISetting.Provider
- 45, // 34: bytebase.v1.EnvironmentSetting.environments:type_name -> bytebase.v1.EnvironmentSetting.Environment
- 49, // 35: bytebase.v1.AppIMSetting.IMSetting.type:type_name -> bytebase.v1.Webhook.Type
- 25, // 36: bytebase.v1.AppIMSetting.IMSetting.slack:type_name -> bytebase.v1.AppIMSetting.Slack
- 26, // 37: bytebase.v1.AppIMSetting.IMSetting.feishu:type_name -> bytebase.v1.AppIMSetting.Feishu
- 27, // 38: bytebase.v1.AppIMSetting.IMSetting.wecom:type_name -> bytebase.v1.AppIMSetting.Wecom
- 28, // 39: bytebase.v1.AppIMSetting.IMSetting.lark:type_name -> bytebase.v1.AppIMSetting.Lark
- 29, // 40: bytebase.v1.AppIMSetting.IMSetting.dingtalk:type_name -> bytebase.v1.AppIMSetting.DingTalk
- 50, // 41: bytebase.v1.WorkspaceApprovalSetting.Rule.template:type_name -> bytebase.v1.ApprovalTemplate
- 51, // 42: bytebase.v1.WorkspaceApprovalSetting.Rule.condition:type_name -> google.type.Expr
- 3, // 43: bytebase.v1.WorkspaceApprovalSetting.Rule.source:type_name -> bytebase.v1.WorkspaceApprovalSetting.Rule.Source
- 52, // 44: bytebase.v1.SchemaTemplateSetting.FieldTemplate.engine:type_name -> bytebase.v1.Engine
- 53, // 45: bytebase.v1.SchemaTemplateSetting.FieldTemplate.column:type_name -> bytebase.v1.ColumnMetadata
- 54, // 46: bytebase.v1.SchemaTemplateSetting.FieldTemplate.catalog:type_name -> bytebase.v1.ColumnCatalog
- 52, // 47: bytebase.v1.SchemaTemplateSetting.ColumnType.engine:type_name -> bytebase.v1.Engine
- 52, // 48: bytebase.v1.SchemaTemplateSetting.TableTemplate.engine:type_name -> bytebase.v1.Engine
- 55, // 49: bytebase.v1.SchemaTemplateSetting.TableTemplate.table:type_name -> bytebase.v1.TableMetadata
- 56, // 50: bytebase.v1.SchemaTemplateSetting.TableTemplate.catalog:type_name -> bytebase.v1.TableCatalog
- 36, // 51: bytebase.v1.DataClassificationSetting.DataClassificationConfig.levels:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level
- 38, // 52: bytebase.v1.DataClassificationSetting.DataClassificationConfig.classification:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
- 37, // 53: bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry.value:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification
- 20, // 54: bytebase.v1.SemanticTypeSetting.SemanticType.algorithm:type_name -> bytebase.v1.Algorithm
- 44, // 55: bytebase.v1.Algorithm.RangeMask.slices:type_name -> bytebase.v1.Algorithm.RangeMask.Slice
- 4, // 56: bytebase.v1.Algorithm.InnerOuterMask.type:type_name -> bytebase.v1.Algorithm.InnerOuterMask.MaskType
- 46, // 57: bytebase.v1.EnvironmentSetting.Environment.tags:type_name -> bytebase.v1.EnvironmentSetting.Environment.TagsEntry
- 6, // 58: bytebase.v1.SettingService.ListSettings:input_type -> bytebase.v1.ListSettingsRequest
- 8, // 59: bytebase.v1.SettingService.GetSetting:input_type -> bytebase.v1.GetSettingRequest
- 10, // 60: bytebase.v1.SettingService.UpdateSetting:input_type -> bytebase.v1.UpdateSettingRequest
- 7, // 61: bytebase.v1.SettingService.ListSettings:output_type -> bytebase.v1.ListSettingsResponse
- 11, // 62: bytebase.v1.SettingService.GetSetting:output_type -> bytebase.v1.Setting
- 11, // 63: bytebase.v1.SettingService.UpdateSetting:output_type -> bytebase.v1.Setting
- 61, // [61:64] is the sub-list for method output_type
- 58, // [58:61] is the sub-list for method input_type
- 58, // [58:58] is the sub-list for extension type_name
- 58, // [58:58] is the sub-list for extension extendee
- 0, // [0:58] is the sub-list for field type_name
+ 17, // 8: bytebase.v1.Value.data_classification_setting_value:type_name -> bytebase.v1.DataClassificationSetting
+ 18, // 9: bytebase.v1.Value.semantic_type_setting_value:type_name -> bytebase.v1.SemanticTypeSetting
+ 20, // 10: bytebase.v1.Value.scim_setting:type_name -> bytebase.v1.SCIMSetting
+ 21, // 11: bytebase.v1.Value.password_restriction_setting:type_name -> bytebase.v1.PasswordRestrictionSetting
+ 22, // 12: bytebase.v1.Value.ai_setting:type_name -> bytebase.v1.AISetting
+ 23, // 13: bytebase.v1.Value.environment_setting:type_name -> bytebase.v1.EnvironmentSetting
+ 29, // 14: bytebase.v1.AppIMSetting.settings:type_name -> bytebase.v1.AppIMSetting.IMSetting
+ 44, // 15: bytebase.v1.WorkspaceProfileSetting.token_duration:type_name -> google.protobuf.Duration
+ 15, // 16: bytebase.v1.WorkspaceProfileSetting.announcement:type_name -> bytebase.v1.Announcement
+ 44, // 17: bytebase.v1.WorkspaceProfileSetting.maximum_role_expiration:type_name -> google.protobuf.Duration
+ 0, // 18: bytebase.v1.WorkspaceProfileSetting.database_change_mode:type_name -> bytebase.v1.DatabaseChangeMode
+ 44, // 19: bytebase.v1.WorkspaceProfileSetting.inactive_session_timeout:type_name -> google.protobuf.Duration
+ 2, // 20: bytebase.v1.Announcement.level:type_name -> bytebase.v1.Announcement.AlertLevel
+ 30, // 21: bytebase.v1.WorkspaceApprovalSetting.rules:type_name -> bytebase.v1.WorkspaceApprovalSetting.Rule
+ 31, // 22: bytebase.v1.DataClassificationSetting.configs:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig
+ 35, // 23: bytebase.v1.SemanticTypeSetting.types:type_name -> bytebase.v1.SemanticTypeSetting.SemanticType
+ 36, // 24: bytebase.v1.Algorithm.full_mask:type_name -> bytebase.v1.Algorithm.FullMask
+ 37, // 25: bytebase.v1.Algorithm.range_mask:type_name -> bytebase.v1.Algorithm.RangeMask
+ 38, // 26: bytebase.v1.Algorithm.md5_mask:type_name -> bytebase.v1.Algorithm.MD5Mask
+ 39, // 27: bytebase.v1.Algorithm.inner_outer_mask:type_name -> bytebase.v1.Algorithm.InnerOuterMask
+ 44, // 28: bytebase.v1.PasswordRestrictionSetting.password_rotation:type_name -> google.protobuf.Duration
+ 5, // 29: bytebase.v1.AISetting.provider:type_name -> bytebase.v1.AISetting.Provider
+ 41, // 30: bytebase.v1.EnvironmentSetting.environments:type_name -> bytebase.v1.EnvironmentSetting.Environment
+ 45, // 31: bytebase.v1.AppIMSetting.IMSetting.type:type_name -> bytebase.v1.Webhook.Type
+ 24, // 32: bytebase.v1.AppIMSetting.IMSetting.slack:type_name -> bytebase.v1.AppIMSetting.Slack
+ 25, // 33: bytebase.v1.AppIMSetting.IMSetting.feishu:type_name -> bytebase.v1.AppIMSetting.Feishu
+ 26, // 34: bytebase.v1.AppIMSetting.IMSetting.wecom:type_name -> bytebase.v1.AppIMSetting.Wecom
+ 27, // 35: bytebase.v1.AppIMSetting.IMSetting.lark:type_name -> bytebase.v1.AppIMSetting.Lark
+ 28, // 36: bytebase.v1.AppIMSetting.IMSetting.dingtalk:type_name -> bytebase.v1.AppIMSetting.DingTalk
+ 46, // 37: bytebase.v1.WorkspaceApprovalSetting.Rule.template:type_name -> bytebase.v1.ApprovalTemplate
+ 47, // 38: bytebase.v1.WorkspaceApprovalSetting.Rule.condition:type_name -> google.type.Expr
+ 3, // 39: bytebase.v1.WorkspaceApprovalSetting.Rule.source:type_name -> bytebase.v1.WorkspaceApprovalSetting.Rule.Source
+ 32, // 40: bytebase.v1.DataClassificationSetting.DataClassificationConfig.levels:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level
+ 34, // 41: bytebase.v1.DataClassificationSetting.DataClassificationConfig.classification:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+ 33, // 42: bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry.value:type_name -> bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification
+ 19, // 43: bytebase.v1.SemanticTypeSetting.SemanticType.algorithm:type_name -> bytebase.v1.Algorithm
+ 40, // 44: bytebase.v1.Algorithm.RangeMask.slices:type_name -> bytebase.v1.Algorithm.RangeMask.Slice
+ 4, // 45: bytebase.v1.Algorithm.InnerOuterMask.type:type_name -> bytebase.v1.Algorithm.InnerOuterMask.MaskType
+ 42, // 46: bytebase.v1.EnvironmentSetting.Environment.tags:type_name -> bytebase.v1.EnvironmentSetting.Environment.TagsEntry
+ 6, // 47: bytebase.v1.SettingService.ListSettings:input_type -> bytebase.v1.ListSettingsRequest
+ 8, // 48: bytebase.v1.SettingService.GetSetting:input_type -> bytebase.v1.GetSettingRequest
+ 10, // 49: bytebase.v1.SettingService.UpdateSetting:input_type -> bytebase.v1.UpdateSettingRequest
+ 7, // 50: bytebase.v1.SettingService.ListSettings:output_type -> bytebase.v1.ListSettingsResponse
+ 11, // 51: bytebase.v1.SettingService.GetSetting:output_type -> bytebase.v1.Setting
+ 11, // 52: bytebase.v1.SettingService.UpdateSetting:output_type -> bytebase.v1.Setting
+ 50, // [50:53] is the sub-list for method output_type
+ 47, // [47:50] is the sub-list for method input_type
+ 47, // [47:47] is the sub-list for extension type_name
+ 47, // [47:47] is the sub-list for extension extendee
+ 0, // [0:47] is the sub-list for field type_name
}
func init() { file_v1_setting_service_proto_init() }
@@ -3491,9 +3154,6 @@ func file_v1_setting_service_proto_init() {
return
}
file_v1_annotation_proto_init()
- file_v1_common_proto_init()
- file_v1_database_catalog_service_proto_init()
- file_v1_database_service_proto_init()
file_v1_issue_service_proto_init()
file_v1_project_service_proto_init()
file_v1_setting_service_proto_msgTypes[6].OneofWrappers = []any{
@@ -3501,7 +3161,6 @@ func file_v1_setting_service_proto_init() {
(*Value_AppImSettingValue)(nil),
(*Value_WorkspaceProfileSettingValue)(nil),
(*Value_WorkspaceApprovalSettingValue)(nil),
- (*Value_SchemaTemplateSettingValue)(nil),
(*Value_DataClassificationSettingValue)(nil),
(*Value_SemanticTypeSettingValue)(nil),
(*Value_ScimSetting)(nil),
@@ -3509,27 +3168,27 @@ func file_v1_setting_service_proto_init() {
(*Value_AiSetting)(nil),
(*Value_EnvironmentSetting)(nil),
}
- file_v1_setting_service_proto_msgTypes[14].OneofWrappers = []any{
+ file_v1_setting_service_proto_msgTypes[13].OneofWrappers = []any{
(*Algorithm_FullMask_)(nil),
(*Algorithm_RangeMask_)(nil),
(*Algorithm_Md5Mask)(nil),
(*Algorithm_InnerOuterMask_)(nil),
}
- file_v1_setting_service_proto_msgTypes[24].OneofWrappers = []any{
+ file_v1_setting_service_proto_msgTypes[23].OneofWrappers = []any{
(*AppIMSetting_IMSetting_Slack)(nil),
(*AppIMSetting_IMSetting_Feishu)(nil),
(*AppIMSetting_IMSetting_Wecom)(nil),
(*AppIMSetting_IMSetting_Lark)(nil),
(*AppIMSetting_IMSetting_Dingtalk)(nil),
}
- file_v1_setting_service_proto_msgTypes[31].OneofWrappers = []any{}
+ file_v1_setting_service_proto_msgTypes[27].OneofWrappers = []any{}
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_setting_service_proto_rawDesc), len(file_v1_setting_service_proto_rawDesc)),
NumEnums: 6,
- NumMessages: 41,
+ NumMessages: 37,
NumExtensions: 0,
NumServices: 1,
},
diff --git a/backend/generated-go/v1/setting_service_equal.pb.go b/backend/generated-go/v1/setting_service_equal.pb.go
index e564b60e62..4fca5818c9 100644
--- a/backend/generated-go/v1/setting_service_equal.pb.go
+++ b/backend/generated-go/v1/setting_service_equal.pb.go
@@ -124,9 +124,6 @@ func (x *Value) Equal(y *Value) bool {
if !x.GetWorkspaceApprovalSettingValue().Equal(y.GetWorkspaceApprovalSettingValue()) {
return false
}
- if !x.GetSchemaTemplateSettingValue().Equal(y.GetSchemaTemplateSettingValue()) {
- return false
- }
if !x.GetDataClassificationSettingValue().Equal(y.GetDataClassificationSettingValue()) {
return false
}
@@ -389,114 +386,6 @@ func (x *WorkspaceApprovalSetting) Equal(y *WorkspaceApprovalSetting) bool {
return true
}
-func (x *SchemaTemplateSetting_FieldTemplate) Equal(y *SchemaTemplateSetting_FieldTemplate) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.Id != y.Id {
- return false
- }
- if x.Engine != y.Engine {
- return false
- }
- if x.Category != y.Category {
- return false
- }
- if !x.Column.Equal(y.Column) {
- return false
- }
- if !x.Catalog.Equal(y.Catalog) {
- return false
- }
- return true
-}
-
-func (x *SchemaTemplateSetting_ColumnType) Equal(y *SchemaTemplateSetting_ColumnType) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.Engine != y.Engine {
- return false
- }
- if x.Enabled != y.Enabled {
- return false
- }
- if len(x.Types) != len(y.Types) {
- return false
- }
- for i := 0; i < len(x.Types); i++ {
- if x.Types[i] != y.Types[i] {
- return false
- }
- }
- return true
-}
-
-func (x *SchemaTemplateSetting_TableTemplate) Equal(y *SchemaTemplateSetting_TableTemplate) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if x.Id != y.Id {
- return false
- }
- if x.Engine != y.Engine {
- return false
- }
- if x.Category != y.Category {
- return false
- }
- if !x.Table.Equal(y.Table) {
- return false
- }
- if !x.Catalog.Equal(y.Catalog) {
- return false
- }
- return true
-}
-
-func (x *SchemaTemplateSetting) Equal(y *SchemaTemplateSetting) bool {
- if x == y {
- return true
- }
- if x == nil || y == nil {
- return x == nil && y == nil
- }
- if len(x.FieldTemplates) != len(y.FieldTemplates) {
- return false
- }
- for i := 0; i < len(x.FieldTemplates); i++ {
- if !x.FieldTemplates[i].Equal(y.FieldTemplates[i]) {
- return false
- }
- }
- if len(x.ColumnTypes) != len(y.ColumnTypes) {
- return false
- }
- for i := 0; i < len(x.ColumnTypes); i++ {
- if !x.ColumnTypes[i].Equal(y.ColumnTypes[i]) {
- return false
- }
- }
- if len(x.TableTemplates) != len(y.TableTemplates) {
- return false
- }
- for i := 0; i < len(x.TableTemplates); i++ {
- if !x.TableTemplates[i].Equal(y.TableTemplates[i]) {
- return false
- }
- }
- return true
-}
-
func (x *DataClassificationSetting_DataClassificationConfig_Level) Equal(y *DataClassificationSetting_DataClassificationConfig_Level) bool {
if x == y {
return true
diff --git a/backend/migrator/migration/3.13/0008##delete_schema_template_setting.sql b/backend/migrator/migration/3.13/0008##delete_schema_template_setting.sql
new file mode 100644
index 0000000000..898cf90fde
--- /dev/null
+++ b/backend/migrator/migration/3.13/0008##delete_schema_template_setting.sql
@@ -0,0 +1,2 @@
+-- Delete the deprecated SCHEMA_TEMPLATE setting
+DELETE FROM setting WHERE name = 'SCHEMA_TEMPLATE';
diff --git a/backend/migrator/migration/LATEST.sql b/backend/migrator/migration/LATEST.sql
index 55bed057a1..1766e69ac1 100644
--- a/backend/migrator/migration/LATEST.sql
+++ b/backend/migrator/migration/LATEST.sql
@@ -34,7 +34,7 @@ CREATE TABLE principal (
CREATE TABLE setting (
id serial PRIMARY KEY,
-- name: AUTH_SECRET, BRANDING_LOGO, WORKSPACE_ID, WORKSPACE_PROFILE, WORKSPACE_APPROVAL,
- -- WORKSPACE_EXTERNAL_APPROVAL, ENTERPRISE_LICENSE, APP_IM, WATERMARK, AI, SCHEMA_TEMPLATE,
+ -- ENTERPRISE_LICENSE, APP_IM, WATERMARK, AI,
-- DATA_CLASSIFICATION, SEMANTIC_TYPES, SCIM, PASSWORD_RESTRICTION, ENVIRONMENT
-- Enum: SettingName (proto/store/store/setting.proto)
name text NOT NULL,
@@ -553,7 +553,6 @@ INSERT INTO setting (name, value) VALUES ('BRANDING_LOGO', '');
INSERT INTO setting (name, value) VALUES ('ENTERPRISE_LICENSE', '');
INSERT INTO setting (name, value) VALUES ('APP_IM', '{}');
INSERT INTO setting (name, value) VALUES ('WATERMARK', '0');
-INSERT INTO setting (name, value) VALUES ('SCHEMA_TEMPLATE', '{}');
INSERT INTO setting (name, value) VALUES ('DATA_CLASSIFICATION', '{}');
INSERT INTO setting (name, value) VALUES ('WORKSPACE_APPROVAL', '{}');
INSERT INTO setting (name, value) VALUES ('PASSWORD_RESTRICTION', '{"minLength":8}');
diff --git a/backend/migrator/migrator_test.go b/backend/migrator/migrator_test.go
index 52e015ee09..6ad0650572 100644
--- a/backend/migrator/migrator_test.go
+++ b/backend/migrator/migrator_test.go
@@ -12,7 +12,7 @@ import (
func TestLatestVersion(t *testing.T) {
files, err := getSortedVersionedFiles()
require.NoError(t, err)
- require.Equal(t, semver.MustParse("3.13.7"), *files[len(files)-1].version)
+ require.Equal(t, semver.MustParse("3.13.8"), *files[len(files)-1].version)
}
func TestVersionUnique(t *testing.T) {
diff --git a/frontend/src/components/ColumnDataTable/ClassificationCell.vue b/frontend/src/components/ColumnDataTable/ClassificationCell.vue
index 56a20f26db..6f25d21718 100644
--- a/frontend/src/components/ColumnDataTable/ClassificationCell.vue
+++ b/frontend/src/components/ColumnDataTable/ClassificationCell.vue
@@ -36,11 +36,11 @@
import { PencilIcon, XIcon } from "lucide-vue-next";
import { NPopconfirm } from "naive-ui";
import { ref } from "vue";
-import ClassificationLevelBadge from "@/components/SchemaTemplate/ClassificationLevelBadge.vue";
+import ClassificationLevelBadge from "@/components/SensitiveData/components/ClassificationLevelBadge.vue";
+import SelectClassificationDrawer from "@/components/SensitiveData/components/SelectClassificationDrawer.vue";
import { MiniActionButton } from "@/components/v2";
import type { Engine } from "@/types/proto-es/v1/common_pb";
import type { DataClassificationSetting_DataClassificationConfig as DataClassificationConfig } from "@/types/proto-es/v1/setting_service_pb";
-import SelectClassificationDrawer from "../SchemaTemplate/SelectClassificationDrawer.vue";
defineProps<{
classification?: string | undefined;
diff --git a/frontend/src/components/SchemaEditorLite/Panels/DatabaseEditor.vue b/frontend/src/components/SchemaEditorLite/Panels/DatabaseEditor.vue
index f20f5b7ccd..4394b39142 100644
--- a/frontend/src/components/SchemaEditorLite/Panels/DatabaseEditor.vue
+++ b/frontend/src/components/SchemaEditorLite/Panels/DatabaseEditor.vue
@@ -29,16 +29,6 @@
</template>
{{ $t("schema-editor.actions.create-table") }}
</NButton>
- <NButton
- v-if="!readonly"
- :disabled="!allowCreateTable"
- @click="state.showSchemaTemplateDrawer = true"
- >
- <template #icon>
- <PlusIcon class="w-4 h-4" />
- </template>
- {{ $t("schema-editor.actions.add-from-template") }}
- </NButton>
<div
v-if="selectionEnabled"
class="text-sm flex flex-row items-center gap-x-2"
@@ -124,47 +114,22 @@
mode="create"
@close="state.tableNameModalContext = undefined"
/>
-
- <Drawer
- :show="state.showSchemaTemplateDrawer"
- @close="state.showSchemaTemplateDrawer = false"
- >
- <DrawerContent :title="$t('schema-template.table-template.self')">
- <div class="w-[calc(100vw-36rem)] min-w-5xl max-w-[calc(100vw-8rem)]">
- <TableTemplates
- :engine="engine"
- :readonly="true"
- @apply="handleApplyTemplate"
- />
- </div>
- </DrawerContent>
- </Drawer>
</template>
<script lang="ts" setup>
-import { create } from "@bufbuild/protobuf";
import { head, sumBy } from "lodash-es";
import { PlusIcon } from "lucide-vue-next";
import { NButton, NSelect, NTooltip } from "naive-ui";
import { computed, nextTick, reactive, watch } from "vue";
import SchemaDiagram, { SchemaDiagramIcon } from "@/components/SchemaDiagram";
-import { Drawer, DrawerContent } from "@/components/v2";
import type { ComposedDatabase } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type {
ColumnMetadata,
DatabaseMetadata,
- ColumnMetadata as NewColumnMetadata,
- TableMetadata as NewTableMetadata,
SchemaMetadata,
TableMetadata,
} from "@/types/proto-es/v1/database_service_pb";
-import {
- ColumnMetadataSchema,
- TableMetadataSchema,
-} from "@/types/proto-es/v1/database_service_pb";
-import type { SchemaTemplateSetting_TableTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import TableTemplates from "@/views/SchemaTemplate/TableTemplates.vue";
import { useSchemaEditorContext } from "../context";
import TableNameModal from "../Modals/TableNameModal.vue";
import TableList from "./TableList";
@@ -189,45 +154,11 @@ const emit = defineEmits<{
(event: "update:selected-schema-name", schema: string | undefined): void;
}>();
-// Conversion function for TableMetadata at service boundaries
-const convertNewTableToOld = (newTable: NewTableMetadata): TableMetadata => {
- return create(TableMetadataSchema, {
- name: newTable.name,
- columns: newTable.columns.map(convertNewColumnToOld),
- engine: newTable.engine,
- collation: newTable.collation,
- comment: newTable.comment,
- indexes: [], // Initialize empty, will be handled separately if needed
- partitions: [], // Initialize empty, will be handled separately if needed
- foreignKeys: [], // Initialize empty, will be handled separately if needed
- });
-};
-
-// Conversion function for ColumnMetadata at service boundaries
-const convertNewColumnToOld = (
- newColumn: NewColumnMetadata
-): ColumnMetadata => {
- return create(ColumnMetadataSchema, {
- name: newColumn.name,
- position: newColumn.position,
- hasDefault: newColumn.hasDefault,
- default: newColumn.default,
- onUpdate: newColumn.onUpdate,
- nullable: newColumn.nullable,
- type: newColumn.type,
- characterSet: newColumn.characterSet,
- collation: newColumn.collation,
- comment: newColumn.comment,
- // classification, labels, effectiveMaskingLevel are not available in old proto types
- });
-};
-
type SubTabType = "table-list" | "schema-diagram";
interface LocalState {
selectedSubTab: SubTabType;
showFeatureModal: boolean;
- showSchemaTemplateDrawer: boolean;
tableNameModalContext?: {
schema: SchemaMetadata;
};
@@ -235,20 +166,10 @@ interface LocalState {
}
const context = useSchemaEditorContext();
-const {
- readonly,
- selectionEnabled,
- events,
- addTab,
- getSchemaStatus,
- markEditStatus,
- upsertTableCatalog,
- queuePendingScrollToTable,
-} = context;
+const { readonly, selectionEnabled, addTab, getSchemaStatus } = context;
const state = reactive<LocalState>({
selectedSubTab: "table-list",
showFeatureModal: false,
- showSchemaTemplateDrawer: false,
});
const engine = computed(() => {
return props.db.instanceResource.engine;
@@ -359,60 +280,4 @@ const tryEditColumn = async (
// }
}
};
-
-const handleApplyTemplate = (template: SchemaTemplateSetting_TableTemplate) => {
- state.showSchemaTemplateDrawer = false;
- if (!template.table) {
- return;
- }
- if (template.engine !== engine.value) {
- return;
- }
-
- const table = convertNewTableToOld(template.table);
- const schema = selectedSchema.value;
- if (!schema) {
- return;
- }
- schema.tables.push(table);
- const metadataForTable = () => {
- return {
- database: props.database,
- schema,
- table,
- };
- };
- const { db } = props;
- if (template.catalog) {
- upsertTableCatalog(
- {
- database: props.db.name,
- schema: schema.name,
- table: table.name,
- },
- (catalog) => {
- Object.assign(catalog, template.catalog);
- }
- );
- }
- markEditStatus(db, metadataForTable(), "created");
- table.columns.forEach((column) => {
- markEditStatus(db, { ...metadataForTable(), column }, "created");
- });
-
- addTab({
- type: "table",
- database: db,
- metadata: metadataForTable(),
- });
-
- queuePendingScrollToTable({
- db,
- metadata: metadataForTable(),
- });
-
- events.emit("rebuild-tree", {
- openFirstChild: false,
- });
-};
</script>
diff --git a/frontend/src/components/SchemaEditorLite/Panels/TableColumnEditor/TableColumnEditor.vue b/frontend/src/components/SchemaEditorLite/Panels/TableColumnEditor/TableColumnEditor.vue
index b402a391ad..d2a285d019 100644
--- a/frontend/src/components/SchemaEditorLite/Panels/TableColumnEditor/TableColumnEditor.vue
+++ b/frontend/src/components/SchemaEditorLite/Panels/TableColumnEditor/TableColumnEditor.vue
@@ -39,7 +39,7 @@ import {
upsertColumnPrimaryKey,
} from "@/components/SchemaEditorLite";
import { InlineInput } from "@/components/v2";
-import { pushNotification, useSettingV1Store } from "@/store";
+import { pushNotification } from "@/store";
import type { ComposedDatabase } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type {
@@ -49,7 +49,6 @@ import type {
SchemaMetadata,
TableMetadata,
} from "@/types/proto-es/v1/database_service_pb";
-import { Setting_SettingName } from "@/types/proto-es/v1/setting_service_pb";
import { arraySwap } from "@/utils";
import { useSchemaEditorContext } from "../../context";
import type { EditStatus } from "../../types";
@@ -138,7 +137,6 @@ const tableBodyHeight = computed(() => {
// Use this to avoid unnecessary initial rendering
const layoutReady = computed(() => tableHeaderHeight.value > 0);
const { t } = useI18n();
-const settingStore = useSettingV1Store();
const metadataForColumn = (column: ColumnMetadata) => {
return {
@@ -509,20 +507,7 @@ const isColumnPrimaryKey = (column: ColumnMetadata): boolean => {
};
const schemaTemplateColumnTypes = computed(() => {
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- if (setting?.value?.value?.case === "schemaTemplateSettingValue") {
- const columnTypes = setting.value.value.value.columnTypes;
- if (columnTypes && columnTypes.length > 0) {
- const columnType = columnTypes.find(
- (columnType) => columnType.engine === props.engine
- );
- if (columnType && columnType.enabled) {
- return columnType.types;
- }
- }
- }
+ // SchemaTemplate feature has been removed
return [];
});
diff --git a/frontend/src/components/SchemaEditorLite/Panels/TableEditor.vue b/frontend/src/components/SchemaEditorLite/Panels/TableEditor.vue
index f2f6889226..96d2bb977b 100644
--- a/frontend/src/components/SchemaEditorLite/Panels/TableEditor.vue
+++ b/frontend/src/components/SchemaEditorLite/Panels/TableEditor.vue
@@ -42,16 +42,6 @@
<PlusIcon class="w-4 h-auto mr-1 text-gray-400" />
{{ $t("schema-editor.actions.add-column") }}
</NButton>
- <NButton
- size="small"
- :disabled="disableChangeTable"
- @click="state.showSchemaTemplateDrawer = true"
- >
- <template #icon>
- <PlusIcon class="w-4 h-auto mr-1 text-gray-400" />
- </template>
- {{ $t("schema-editor.actions.add-from-template") }}
- </NButton>
</template>
<NButton
v-if="showIndexes"
@@ -162,21 +152,6 @@
:foreign-key="editForeignKeyContext.foreignKey"
@close="state.showEditColumnForeignKeyModal = false"
/>
-
- <Drawer
- :show="state.showSchemaTemplateDrawer"
- @close="state.showSchemaTemplateDrawer = false"
- >
- <DrawerContent :title="$t('schema-template.field-template.self')">
- <div class="w-[calc(100vw-36rem)] min-w-5xl max-w-[calc(100vw-8rem)]">
- <FieldTemplates
- :engine="engine"
- :readonly="true"
- @apply="handleApplyColumnTemplate"
- />
- </div>
- </DrawerContent>
- </Drawer>
</template>
<script lang="ts" setup>
@@ -186,7 +161,6 @@ import { ArrowLeftIcon, PlusIcon } from "lucide-vue-next";
import { NButton } from "naive-ui";
import { computed, reactive, ref } from "vue";
import { IndexIcon, TablePartitionIcon } from "@/components/Icon";
-import { Drawer, DrawerContent } from "@/components/v2";
import type { ComposedDatabase } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
import {
@@ -197,7 +171,6 @@ import type {
ColumnMetadata,
DatabaseMetadata,
ForeignKeyMetadata,
- ColumnMetadata as NewColumnMetadata,
SchemaMetadata,
TableMetadata,
} from "@/types/proto-es/v1/database_service_pb";
@@ -208,9 +181,7 @@ import {
TablePartitionMetadata_Type,
TablePartitionMetadataSchema,
} from "@/types/proto-es/v1/database_service_pb";
-import type { SchemaTemplateSetting_FieldTemplate } from "@/types/proto-es/v1/setting_service_pb";
import { instanceV1AllowsReorderColumns, randomString } from "@/utils";
-import FieldTemplates from "@/views/SchemaTemplate/FieldTemplates.vue";
import { useSchemaEditorContext } from "../context";
import EditColumnForeignKeyModal from "../Modals/EditColumnForeignKeyModal.vue";
import {
@@ -242,7 +213,6 @@ const props = withDefaults(
interface LocalState {
mode: EditMode;
showEditColumnForeignKeyModal: boolean;
- showSchemaTemplateDrawer: boolean;
showFeatureModal: boolean;
}
@@ -256,36 +226,16 @@ const {
getTableStatus,
getColumnStatus,
getDatabaseCatalog,
- upsertColumnCatalog,
queuePendingScrollToColumn,
selectionEnabled,
} = useSchemaEditorContext();
-// Conversion function for ColumnMetadata at service boundaries
-const convertNewColumnToOld = (
- newColumn: NewColumnMetadata
-): ColumnMetadata => {
- return create(ColumnMetadataSchema, {
- name: newColumn.name,
- position: newColumn.position,
- hasDefault: newColumn.hasDefault,
- default: newColumn.default,
- onUpdate: newColumn.onUpdate,
- nullable: newColumn.nullable,
- type: newColumn.type,
- characterSet: newColumn.characterSet,
- collation: newColumn.collation,
- comment: newColumn.comment,
- // classification, labels, effectiveMaskingLevel are not available in old proto types
- });
-};
const engine = computed((): Engine => {
return props.db.instanceResource.engine;
});
const state = reactive<LocalState>({
mode: "COLUMNS",
showEditColumnForeignKeyModal: false,
- showSchemaTemplateDrawer: false,
showFeatureModal: false,
});
@@ -394,47 +344,6 @@ const handleAddColumn = () => {
openFirstChild: false,
});
};
-
-const handleApplyColumnTemplate = (
- template: SchemaTemplateSetting_FieldTemplate
-) => {
- state.showSchemaTemplateDrawer = false;
- if (!template.column) {
- return;
- }
- if (template.engine !== engine.value) {
- return;
- }
- const column = convertNewColumnToOld(template.column);
- /* eslint-disable-next-line vue/no-mutating-props */
- props.table.columns.push(column);
- if (template.catalog) {
- upsertColumnCatalog(
- {
- database: props.db.name,
- schema: props.schema.name,
- table: props.table.name,
- column: template.column.name,
- },
- (catalog) => {
- Object.assign(catalog, template.catalog);
- }
- );
- }
- markColumnStatus(column, "created");
- queuePendingScrollToColumn({
- db: props.db,
- metadata: {
- database: props.database,
- schema: props.schema,
- table: props.table,
- column,
- },
- });
- events.emit("rebuild-tree", {
- openFirstChild: false,
- });
-};
const handleAddIndex = () => {
// eslint-disable-next-line vue/no-mutating-props
props.table.indexes.push(
diff --git a/frontend/src/components/SchemaEditorLite/Panels/TableList/TableList.vue b/frontend/src/components/SchemaEditorLite/Panels/TableList/TableList.vue
index 4d6f00af79..579dd42f05 100644
--- a/frontend/src/components/SchemaEditorLite/Panels/TableList/TableList.vue
+++ b/frontend/src/components/SchemaEditorLite/Panels/TableList/TableList.vue
@@ -22,21 +22,6 @@
class="schema-editor-table-list"
/>
</div>
-
- <Drawer
- :show="state.showSchemaTemplateDrawer"
- @close="state.showSchemaTemplateDrawer = false"
- >
- <DrawerContent :title="$t('schema-template.table-template.self')">
- <div class="w-[calc(100vw-36rem)] min-w-5xl max-w-[calc(100vw-8rem)]">
- <TableTemplates
- :engine="engine"
- :readonly="true"
- @apply="handleApplyTemplate"
- />
- </div>
- </DrawerContent>
- </Drawer>
</template>
<script lang="ts" setup>
@@ -44,17 +29,15 @@ import { useElementSize } from "@vueuse/core";
import { pick } from "lodash-es";
import type { DataTableColumn, DataTableInst } from "naive-ui";
import { NCheckbox, NDataTable } from "naive-ui";
-import { computed, h, reactive, ref } from "vue";
+import { computed, h, ref } from "vue";
import { useI18n } from "vue-i18n";
-import { Drawer, DrawerContent, InlineInput } from "@/components/v2";
+import { InlineInput } from "@/components/v2";
import type { ComposedDatabase } from "@/types";
import type {
DatabaseMetadata,
SchemaMetadata,
TableMetadata,
} from "@/types/proto-es/v1/database_service_pb";
-import type { SchemaTemplateSetting_TableTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import TableTemplates from "@/views/SchemaTemplate/TableTemplates.vue";
import { useSchemaEditorContext } from "../../context";
import { markUUID } from "../common";
import { NameCell, OperationCell, SelectionCell } from "./components";
@@ -79,12 +62,6 @@ const emit = defineEmits<{
): void;
}>();
-interface LocalState {
- showFeatureModal: boolean;
- showSchemaTemplateDrawer: boolean;
- activeTable?: TableMetadata;
-}
-
const { t } = useI18n();
const {
readonly,
@@ -94,7 +71,6 @@ const {
removeEditStatus,
getSchemaStatus,
getTableStatus,
- upsertTableCatalog,
useConsumePendingScrollToTable,
getAllTablesSelectionState,
updateAllTablesSelection,
@@ -115,10 +91,6 @@ const tableBodyHeight = computed(() => {
});
// Use this to avoid unnecessary initial rendering
const layoutReady = computed(() => tableHeaderHeight.value > 0);
-const state = reactive<LocalState>({
- showFeatureModal: false,
- showSchemaTemplateDrawer: false,
-});
const filteredTables = computed(() => {
const keyword = props.searchPattern?.trim();
if (!keyword) {
@@ -127,10 +99,6 @@ const filteredTables = computed(() => {
return props.tables.filter((table) => table.name.includes(keyword));
});
-const engine = computed(() => {
- return props.db.instanceResource.engine;
-});
-
const metadataForTable = (table: TableMetadata) => {
return {
database: props.database,
@@ -290,37 +258,6 @@ const handleRestoreTable = (table: TableMetadata) => {
removeEditStatus(props.db, metadataForTable(table), /* recursive */ false);
};
-const handleApplyTemplate = (template: SchemaTemplateSetting_TableTemplate) => {
- state.showSchemaTemplateDrawer = false;
- if (!template.table) {
- return;
- }
- if (template.engine !== engine.value) {
- return;
- }
-
- const table = template.table;
- /* eslint-disable-next-line vue/no-mutating-props */
- props.schema.tables.push(table);
- const metadata = metadataForTable(table);
-
- upsertTableCatalog(
- {
- database: props.db.name,
- schema: props.schema.name,
- table: table.name,
- },
- (catalog) => Object.assign(catalog, template.catalog)
- );
-
- markEditStatus(props.db, metadata, "created");
- addTab({
- type: "table",
- database: props.db,
- metadata,
- });
-};
-
const isDroppedTable = (table: TableMetadata) => {
return statusForTable(table) === "dropped";
};
diff --git a/frontend/src/components/SchemaEditorLite/SchemaEditorLite.vue b/frontend/src/components/SchemaEditorLite/SchemaEditorLite.vue
index bbf0253665..6cfbd39416 100644
--- a/frontend/src/components/SchemaEditorLite/SchemaEditorLite.vue
+++ b/frontend/src/components/SchemaEditorLite/SchemaEditorLite.vue
@@ -26,13 +26,11 @@
<script lang="ts" setup>
import { cloneDeep } from "lodash-es";
import { NSplit } from "naive-ui";
-import { computed, onMounted, toRef } from "vue";
+import { computed, toRef } from "vue";
import MaskSpinner from "@/components/misc/MaskSpinner.vue";
import { useEmitteryEventListener } from "@/composables/useEmitteryEventListener";
-import { useSettingV1Store } from "@/store";
import type { DatabaseMetadata } from "@/types/proto-es/v1/database_service_pb";
import type { Project } from "@/types/proto-es/v1/project_service_pb";
-import { Setting_SettingName } from "@/types/proto-es/v1/setting_service_pb";
import Aside from "./Aside";
import { useAlgorithm } from "./algorithm";
import { provideSchemaEditorContext } from "./context";
@@ -53,15 +51,6 @@ const emit = defineEmits<{
(event: "update-is-editing", objects: RolloutObject[]): void;
}>();
-const settingStore = useSettingV1Store();
-
-// Prepare schema template contexts.
-onMounted(async () => {
- await settingStore.getOrFetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
-});
-
const targets = computed(() => {
return props.targets ?? [];
});
diff --git a/frontend/src/components/SchemaTemplate/FieldTemplateForm.vue b/frontend/src/components/SchemaTemplate/FieldTemplateForm.vue
deleted file mode 100644
index 768a5ca9bb..0000000000
--- a/frontend/src/components/SchemaTemplate/FieldTemplateForm.vue
+++ /dev/null
@@ -1,313 +0,0 @@
-<template>
- <DrawerContent :title="$t('schema-template.field-template.self')">
- <div>
- <div class="flex flex-col gap-y-6 pb-6">
- <!-- category -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="category" class="textlabel">
- {{ $t("schema-template.form.category") }}
- </label>
- <p class="text-sm text-gray-500 mb-2">
- {{ $t("schema-template.form.category-desc") }}
- </p>
- <div class="relative flex flex-row justify-between items-center mt-1">
- <DropdownInput
- v-model:value="state.category"
- :options="categoryOptions"
- :placeholder="$t('schema-template.form.unclassified')"
- :disabled="readonly"
- :consistent-menu-width="true"
- :allow-filter="true"
- />
- </div>
- </div>
-
- <div class="w-full flex flex-col gap-y-1">
- <label for="engine" class="textlabel">
- {{ $t("database.engine") }}
- </label>
- <InstanceEngineRadioGrid
- v-model:engine="state.engine"
- :engine-list="engineList"
- :disabled="readonly"
- class="grid-cols-4 gap-2"
- />
- </div>
- </div>
- <div class="flex flex-col gap-y-6 border-t border-block-border pt-6">
- <div class="grid grid-cols-1 gap-y-6 gap-x-4 sm:grid-cols-4">
- <!-- column name -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="column-name" class="textlabel">
- {{ $t("schema-template.form.column-name") }}
- <RequiredStar />
- </label>
- <NInput
- v-model:value="state.column!.name"
- placeholder="column name"
- :disabled="readonly"
- />
- </div>
-
- <!-- type -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="column-type" class="textlabel">
- {{ $t("schema-template.form.column-type") }}
- <RequiredStar />
- </label>
- <div
- class="relative flex flex-row justify-between items-center mt-1"
- >
- <DropdownInput
- :value="state.column!.type || null"
- :allow-input-value="
- schemaTemplateColumnTypeOptions.length === 0
- "
- :options="
- schemaTemplateColumnTypeOptions.length > 0
- ? schemaTemplateColumnTypeOptions
- : dataTypeOptions
- "
- :disabled="readonly"
- :allow-filter="true"
- placeholder="column type"
- @update:value="state.column!.type = $event"
- />
- </div>
- </div>
-
- <!-- default value -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="default-value" class="textlabel">
- {{ $t("schema-template.form.default-value") }}
- </label>
- <div class="flex flex-row items-center relative">
- <DefaultValueCell
- :column="state.column"
- :disabled="readonly"
- border="1px solid rgb(var(--color-control-border))"
- @update="handleColumnDefaultSelect"
- />
- </div>
- </div>
-
- <!-- nullable -->
- <div class="sm:col-span-2 ml-0 sm:ml-3">
- <label for="nullable" class="textlabel">
- {{ $t("schema-template.form.nullable") }}
- </label>
- <div class="flex flex-row items-center h-[34px]">
- <NSwitch
- v-model:value="state.column!.nullable"
- :text="false"
- :disabled="readonly"
- />
- </div>
- </div>
-
- <!-- on update -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="default-value" class="textlabel">
- {{ $t("schema-template.form.on-update") }}
- </label>
- <div class="flex flex-row items-center relative">
- <NInput v-model:value="state.column!.onUpdate" />
- </div>
- </div>
-
- <!-- comment -->
- <div class="sm:col-span-4 sm:col-start-1">
- <label for="comment" class="textlabel">
- {{ $t("schema-template.form.comment") }}
- </label>
- <NInput
- v-model:value="state.column!.comment"
- type="textarea"
- :autosize="{ minRows: 3, maxRows: 3 }"
- :disabled="readonly"
- />
- </div>
- </div>
- </div>
- </div>
-
- <template #footer>
- <div class="w-full flex justify-between items-center">
- <div class="w-full flex justify-end items-center gap-x-2">
- <NButton @click.prevent="$emit('dismiss')">
- {{ $t("common.cancel") }}
- </NButton>
- <NButton
- v-if="!readonly"
- :disabled="submitDisabled"
- type="primary"
- @click.prevent="submit"
- >
- {{ create ? $t("common.create") : $t("common.update") }}
- </NButton>
- </div>
- </div>
- </template>
- </DrawerContent>
-</template>
-
-<script lang="ts" setup>
-import { create as createProto } from "@bufbuild/protobuf";
-import { cloneDeep, isEqual } from "lodash-es";
-import type { SelectOption } from "naive-ui";
-import { NButton, NInput, NSwitch } from "naive-ui";
-import { computed, reactive } from "vue";
-import { useI18n } from "vue-i18n";
-import RequiredStar from "@/components/RequiredStar.vue";
-import { DefaultValueCell } from "@/components/SchemaEditorLite/Panels/TableColumnEditor/components";
-import type { DefaultValue } from "@/components/SchemaEditorLite/utils";
-import {
- DrawerContent,
- DropdownInput,
- InstanceEngineRadioGrid,
-} from "@/components/v2";
-import { useNotificationStore, useSettingV1Store } from "@/store";
-import { ColumnCatalogSchema } from "@/types/proto-es/v1/database_catalog_service_pb";
-import {
- type ColumnMetadata,
- ColumnMetadataSchema,
-} from "@/types/proto-es/v1/database_service_pb";
-import type { SchemaTemplateSetting_FieldTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSetting_FieldTemplateSchema,
- SchemaTemplateSettingSchema,
- Setting_SettingName,
- ValueSchema as SettingValueSchema,
-} from "@/types/proto-es/v1/setting_service_pb";
-import { getDataTypeSuggestionList } from "@/utils";
-import { categoryList, engineList } from "./utils";
-
-const props = defineProps<{
- create: boolean;
- readonly?: boolean;
- template: SchemaTemplateSetting_FieldTemplate;
-}>();
-
-const emit = defineEmits(["dismiss"]);
-
-interface LocalState extends SchemaTemplateSetting_FieldTemplate {
- column: ColumnMetadata;
-}
-
-const state = reactive<LocalState>({
- ...createProto(SchemaTemplateSetting_FieldTemplateSchema, {
- id: props.template.id,
- engine: props.template.engine,
- category: props.template.category,
- catalog: createProto(ColumnCatalogSchema, props.template.catalog ?? {}),
- }),
- column: createProto(ColumnMetadataSchema, props.template.column ?? {}),
-});
-const { t } = useI18n();
-const settingStore = useSettingV1Store();
-
-const dataTypeOptions = computed(() => {
- return getDataTypeSuggestionList(state.engine).map<SelectOption>(
- (dataType) => {
- return {
- label: dataType,
- value: dataType,
- };
- }
- );
-});
-
-const categoryOptions = computed(() => {
- return categoryList.value.map<SelectOption>((category) => ({
- label: category,
- value: category,
- }));
-});
-
-const schemaTemplateColumnTypes = computed(() => {
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- if (!setting?.value?.value) return [];
- const value = setting.value.value;
- if (value.case !== "schemaTemplateSettingValue") return [];
- const columnTypes = value.value.columnTypes;
- if (columnTypes && columnTypes.length > 0) {
- const columnType = columnTypes.find(
- (columnType) => columnType.engine === state.engine
- );
- if (columnType && columnType.enabled) {
- return columnType.types;
- }
- }
- return [];
-});
-
-const schemaTemplateColumnTypeOptions = computed(() => {
- return schemaTemplateColumnTypes.value.map<SelectOption>((type) => ({
- label: type,
- value: type,
- }));
-});
-
-const submitDisabled = computed(() => {
- if (!state.column?.name || !state.column?.type) {
- return true;
- }
- if (!props.create && isEqual(props.template, state)) {
- return true;
- }
- return false;
-});
-
-const submit = async () => {
- const template = createProto(SchemaTemplateSetting_FieldTemplateSchema, {
- id: state.id,
- engine: state.engine,
- category: state.category,
- column: state.column,
- catalog: createProto(ColumnCatalogSchema, {}),
- });
- const setting = await settingStore.fetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
-
- let settingValue = createProto(SchemaTemplateSettingSchema, {});
- if (
- setting?.value?.value &&
- setting.value.value.case === "schemaTemplateSettingValue"
- ) {
- settingValue = cloneDeep(setting.value.value.value);
- }
-
- const index = settingValue.fieldTemplates.findIndex(
- (t) => t.id === template.id
- );
- if (index >= 0) {
- settingValue.fieldTemplates[index] = template;
- } else {
- settingValue.fieldTemplates.push(template);
- }
-
- await settingStore.upsertSetting({
- name: Setting_SettingName.SCHEMA_TEMPLATE,
- value: createProto(SettingValueSchema, {
- value: {
- case: "schemaTemplateSettingValue",
- value: settingValue,
- },
- }),
- });
- useNotificationStore().pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.updated"),
- });
- emit("dismiss");
-};
-
-const handleColumnDefaultSelect = (defaultValue: DefaultValue) => {
- state.column.hasDefault = defaultValue.hasDefault;
- state.column.default = defaultValue.default;
-};
-</script>
diff --git a/frontend/src/components/SchemaTemplate/FieldTemplateTable.vue b/frontend/src/components/SchemaTemplate/FieldTemplateTable.vue
deleted file mode 100644
index b7f4e44b21..0000000000
--- a/frontend/src/components/SchemaTemplate/FieldTemplateTable.vue
+++ /dev/null
@@ -1,173 +0,0 @@
-<template>
- <NDataTable
- size="small"
- :columns="columns"
- :data="templateList"
- :striped="true"
- :bordered="true"
- :row-props="rowProps"
- />
-</template>
-
-<script lang="tsx" setup>
-import { create as createProto } from "@bufbuild/protobuf";
-import { pullAt } from "lodash-es";
-import { PencilIcon, TrashIcon } from "lucide-vue-next";
-import type { DataTableColumn } from "naive-ui";
-import { NDataTable, NPopconfirm } from "naive-ui";
-import { computed } from "vue";
-import { useI18n } from "vue-i18n";
-import { getColumnDefaultValuePlaceholder } from "@/components/SchemaEditorLite";
-import { MiniActionButton } from "@/components/v2";
-import { LabelsCell } from "@/components/v2/Model/cells";
-import { useSettingV1Store } from "@/store";
-import type { Engine } from "@/types/proto-es/v1/common_pb";
-import type { SchemaTemplateSetting_FieldTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSettingSchema,
- Setting_SettingName,
- ValueSchema as SettingValueSchema,
-} from "@/types/proto-es/v1/setting_service_pb";
-import { EngineIcon } from "../Icon";
-
-const props = defineProps<{
- engine?: Engine;
- readonly: boolean;
- templateList: SchemaTemplateSetting_FieldTemplate[];
-}>();
-
-const emit = defineEmits<{
- (event: "view", item: SchemaTemplateSetting_FieldTemplate): void;
- (event: "apply", item: SchemaTemplateSetting_FieldTemplate): void;
-}>();
-
-const { t } = useI18n();
-const settingStore = useSettingV1Store();
-
-const columns = computed(
- (): DataTableColumn<SchemaTemplateSetting_FieldTemplate>[] => {
- const cols: DataTableColumn<SchemaTemplateSetting_FieldTemplate>[] = [
- {
- title: t("schema-template.form.category"),
- key: "category",
- render: (item) => item.category || "-",
- },
- {
- title: t("schema-template.form.column-name"),
- key: "name",
- render: (item) => (
- <div class="flex justify-start items-center">
- <EngineIcon engine={item.engine} customClass="ml-0 mr-1" />
- {item.column?.name ?? ""}
- </div>
- ),
- },
- ];
-
- cols.push(
- {
- title: t("schema-template.form.column-type"),
- key: "type",
- render: (item) => item.column?.type ?? "",
- },
- {
- title: t("schema-template.form.default-value"),
- key: "default",
- render: (item) => getColumnDefaultValuePlaceholder(item.column!),
- },
- {
- title: t("schema-template.form.comment"),
- key: "comment",
- render: (item) => item.column?.comment ?? "",
- },
- {
- title: t("common.labels"),
- key: "labels",
- render: (item) => (
- <LabelsCell labels={item.catalog?.labels ?? {}} showCount={2} />
- ),
- }
- );
-
- if (!props.readonly) {
- cols.push({
- title: t("common.operations"),
- key: "operations",
- width: 160,
- render: (item) => (
- <div class="flex items-center justify-start gap-x-2">
- <MiniActionButton
- onClick={(e: MouseEvent) => {
- e.stopPropagation();
- emit("view", item);
- }}
- >
- <PencilIcon class="w-4 h-4" />
- </MiniActionButton>
- <NPopconfirm onPositiveClick={() => deleteTemplate(item.id)}>
- {{
- trigger: () => (
- <MiniActionButton
- type="error"
- onClick={(e: MouseEvent) => e.stopPropagation()}
- >
- <TrashIcon class="w-4 h-4" />
- </MiniActionButton>
- ),
- default: () => (
- <div class="whitespace-nowrap">
- {t("common.delete")} '{item.column?.name}'?
- </div>
- ),
- }}
- </NPopconfirm>
- </div>
- ),
- });
- }
-
- return cols;
- }
-);
-
-const rowProps = (row: SchemaTemplateSetting_FieldTemplate) => {
- if (row.engine === props.engine) {
- return {
- style: "cursor: pointer;",
- onClick: () => {
- emit("apply", row);
- },
- };
- }
- return {};
-};
-
-const deleteTemplate = async (id: string) => {
- const setting = await settingStore.fetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
-
- let settingValue = createProto(SchemaTemplateSettingSchema, {});
- if (
- setting?.value?.value &&
- setting.value.value.case === "schemaTemplateSettingValue"
- ) {
- settingValue = setting.value.value.value;
- }
-
- const index = settingValue.fieldTemplates.findIndex((t) => t.id === id);
- if (index >= 0) {
- pullAt(settingValue.fieldTemplates, index);
-
- await settingStore.upsertSetting({
- name: Setting_SettingName.SCHEMA_TEMPLATE,
- value: createProto(SettingValueSchema, {
- value: {
- case: "schemaTemplateSettingValue",
- value: settingValue,
- },
- }),
- });
- }
-};
-</script>
diff --git a/frontend/src/components/SchemaTemplate/FieldTemplateView.vue b/frontend/src/components/SchemaTemplate/FieldTemplateView.vue
deleted file mode 100644
index 9cea1c7d1f..0000000000
--- a/frontend/src/components/SchemaTemplate/FieldTemplateView.vue
+++ /dev/null
@@ -1,109 +0,0 @@
-<template>
- <NEmpty v-if="templateList.length === 0" class="py-12 border rounded-sm" />
- <div v-else class="flex">
- <div
- class="hidden lg:flex w-1/5 max-w-xs flex-col gap-y-3 border-r mr-5 pr-5"
- >
- <p class="text-lg">
- {{ $t("schema-template.form.category") }}
- </p>
- <div class="flex flex-col gap-y-2">
- <NCheckbox
- v-for="item in categoryList"
- :key="item.id"
- :checked="state.selectedCategory.has(item.id)"
- @update:checked="toggleCategoryCheck(item.id)"
- >
- <div class="flex items-center gap-x-1 text-sm text-gray-600">
- <span class="text-ellipsis whitespace-nowrap overflow-hidden">
- {{ item.text }}
- </span>
- <span
- class="items-center text-xs px-2 py-0.5 rounded-full bg-gray-200 text-gray-800"
- >
- {{ item.count }}
- </span>
- </div>
- </NCheckbox>
- </div>
- </div>
- <FieldTemplateTable
- :engine="engine"
- :readonly="readonly"
- :template-list="filteredTemplateList"
- class="flex-1"
- @view="
- (template: SchemaTemplateSetting_FieldTemplate) =>
- $emit('view', template)
- "
- @apply="
- (template: SchemaTemplateSetting_FieldTemplate) =>
- $emit('apply', template)
- "
- />
- </div>
-</template>
-
-<script lang="ts" setup>
-import { NCheckbox, NEmpty } from "naive-ui";
-import { computed, reactive } from "vue";
-import { useI18n } from "vue-i18n";
-import type { Engine } from "@/types/proto-es/v1/common_pb";
-import type { SchemaTemplateSetting_FieldTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import FieldTemplateTable from "./FieldTemplateTable.vue";
-
-interface LocalState {
- selectedCategory: Set<string>;
-}
-
-const props = defineProps<{
- engine?: Engine;
- readonly: boolean;
- templateList: SchemaTemplateSetting_FieldTemplate[];
-}>();
-
-defineEmits<{
- (event: "view", item: SchemaTemplateSetting_FieldTemplate): void;
- (event: "apply", item: SchemaTemplateSetting_FieldTemplate): void;
-}>();
-
-const state = reactive<LocalState>({
- selectedCategory: new Set<string>(),
-});
-const { t } = useI18n();
-
-const toggleCategoryCheck = (category: string) => {
- if (state.selectedCategory.has(category)) {
- state.selectedCategory.delete(category);
- } else {
- state.selectedCategory.add(category);
- }
-};
-
-const categoryList = computed(() => {
- const categoryMap = new Map<string, number>();
- for (const template of props.templateList) {
- const num = categoryMap.get(template.category) ?? 0;
- categoryMap.set(template.category, num + 1);
- }
-
- const resp = [];
- for (const [category, count] of categoryMap.entries()) {
- resp.push({
- id: category,
- text: category || t("schema-template.form.unclassified"),
- count,
- });
- }
- return resp;
-});
-
-const filteredTemplateList = computed(() => {
- if (state.selectedCategory.size === 0) {
- return props.templateList;
- }
- return props.templateList.filter((template) =>
- state.selectedCategory.has(template.category)
- );
-});
-</script>
diff --git a/frontend/src/components/SchemaTemplate/TableTemplateForm.vue b/frontend/src/components/SchemaTemplate/TableTemplateForm.vue
deleted file mode 100644
index e5ac62cf71..0000000000
--- a/frontend/src/components/SchemaTemplate/TableTemplateForm.vue
+++ /dev/null
@@ -1,450 +0,0 @@
-<template>
- <DrawerContent :title="$t('schema-template.table-template.self')">
- <div class="w-[calc(100vw-256px)]">
- <div class="flex flex-col gap-y-6 pb-6">
- <!-- category -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="category" class="textlabel">
- {{ $t("schema-template.form.category") }}
- </label>
- <p class="text-sm text-gray-500 mb-2">
- {{ $t("schema-template.form.category-desc") }}
- </p>
- <div class="relative flex flex-row justify-between items-center mt-1">
- <DropdownInput
- v-model:value="editing.category"
- :options="categoryOptions"
- :placeholder="$t('schema-template.form.unclassified')"
- :disabled="readonly"
- :consistent-menu-width="true"
- :allow-filter="true"
- />
- </div>
- </div>
-
- <div class="w-full mb-6 flex flex-col gap-y-1">
- <label for="engine" class="textlabel">
- {{ $t("database.engine") }}
- </label>
- <InstanceEngineRadioGrid
- v-model:engine="editing.engine"
- :engine-list="engineList"
- :disabled="readonly"
- class="grid-cols-4 gap-2"
- />
- </div>
- </div>
- <div class="flex flex-col gap-y-6 border-t border-block-border pt-6">
- <div class="grid grid-cols-1 gap-y-6 gap-x-4 sm:grid-cols-4">
- <!-- table name -->
- <div class="sm:col-span-2 sm:col-start-1">
- <label for="table-name" class="textlabel">
- {{ $t("schema-template.form.table-name") }}
- <RequiredStar />
- </label>
- <NInput
- :value="tableMetadata.name"
- :disabled="readonly"
- placeholder="table name"
- @update:value="handleUpdateTableName"
- />
- </div>
-
- <!-- comment -->
- <div class="sm:col-span-4 sm:col-start-1">
- <label for="comment" class="textlabel">
- {{ $t("schema-template.form.comment") }}
- </label>
- <NInput
- v-model:value="tableMetadata.comment"
- type="textarea"
- :autosize="{ minRows: 3, maxRows: 3 }"
- :disabled="readonly"
- />
- </div>
-
- <div class="col-span-4">
- <div v-if="!readonly" class="w-full py-2 flex items-center gap-x-2">
- <NButton size="small" :disabled="false" @click="onColumnAdd">
- <template #icon>
- <PlusIcon class="w-4 h-4 text-control-placeholder" />
- </template>
- {{ $t("schema-editor.actions.add-column") }}
- </NButton>
- <NButton
- size="small"
- :disabled="false"
- @click="state.showFieldTemplateDrawer = true"
- >
- <template #icon>
- <PlusIcon class="w-4 h-4 text-control-placeholder" />
- </template>
- {{ $t("schema-editor.actions.add-from-template") }}
- </NButton>
- </div>
-
- <TableColumnEditor
- :readonly="!!readonly"
- :show-foreign-key="false"
- :db="editing.db"
- :database="editing.databaseMetadata"
- :schema="schemaMetadata"
- :table="tableMetadata"
- :engine="editing.engine"
- :allow-change-primary-keys="true"
- :allow-reorder-columns="allowReorderColumns"
- :max-body-height="640"
- />
- </div>
- </div>
- </div>
- </div>
-
- <template #footer>
- <div class="w-full flex justify-between items-center">
- <div class="w-full flex justify-end items-center gap-x-2">
- <NButton @click.prevent="$emit('dismiss')">
- {{ $t("common.cancel") }}
- </NButton>
- <NButton
- v-if="!readonly"
- :disabled="submitDisabled"
- type="primary"
- @click.prevent="onSubmit"
- >
- {{ create ? $t("common.create") : $t("common.update") }}
- </NButton>
- </div>
- </div>
- </template>
- </DrawerContent>
-
- <Drawer
- :show="state.showFieldTemplateDrawer"
- @close="state.showFieldTemplateDrawer = false"
- >
- <DrawerContent :title="$t('schema-template.field-template.self')">
- <div class="w-[calc(100vw-36rem)] min-w-5xl max-w-[calc(100vw-8rem)]">
- <FieldTemplates
- :engine="editing.engine"
- :readonly="false"
- @apply="handleApplyColumnTemplate"
- />
- </div>
- </DrawerContent>
- </Drawer>
-</template>
-
-<script lang="ts" setup>
-import { create as createProto } from "@bufbuild/protobuf";
-import { cloneDeep, isEqual } from "lodash-es";
-import { PlusIcon } from "lucide-vue-next";
-import type { SelectOption } from "naive-ui";
-import { NButton, NInput } from "naive-ui";
-import { computed, onMounted, reactive, ref, toRef } from "vue";
-import { useI18n } from "vue-i18n";
-import RequiredStar from "@/components/RequiredStar.vue";
-import {
- type EditStatus,
- type EditTarget,
- provideSchemaEditorContext,
- TableColumnEditor,
-} from "@/components/SchemaEditorLite";
-import {
- Drawer,
- DrawerContent,
- DropdownInput,
- InstanceEngineRadioGrid,
-} from "@/components/v2";
-import { pushNotification, useSettingV1Store } from "@/store";
-import { unknownProject } from "@/types";
-import { TableCatalogSchema } from "@/types/proto-es/v1/database_catalog_service_pb";
-import {
- type ColumnMetadata,
- ColumnMetadataSchema,
-} from "@/types/proto-es/v1/database_service_pb";
-import {
- type SchemaTemplateSetting_FieldTemplate,
- type SchemaTemplateSetting_TableTemplate,
- SchemaTemplateSettingSchema,
- Setting_SettingName,
- ValueSchema as SettingValueSchema,
-} from "@/types/proto-es/v1/setting_service_pb";
-import { instanceV1AllowsReorderColumns } from "@/utils";
-import FieldTemplates from "@/views/SchemaTemplate/FieldTemplates.vue";
-import {
- categoryList,
- engineList,
- mockMetadataFromTableTemplate,
- rebuildTableTemplateFromMetadata,
-} from "./utils";
-
-const props = defineProps<{
- create: boolean;
- readonly?: boolean;
- template: SchemaTemplateSetting_TableTemplate;
-}>();
-
-const emit = defineEmits(["dismiss"]);
-
-interface LocalState {
- showFieldTemplateDrawer: boolean;
-}
-
-const editing = computed(() => {
- return mockMetadataFromTableTemplate(props.template);
-});
-
-const isCreate = computed(() => !props.template.table?.name);
-
-const schemaMetadata = computed(
- () => editing.value.databaseMetadata.schemas[0]
-);
-
-const tableMetadata = computed(() => schemaMetadata.value.tables[0]);
-
-const targets = computed(() => {
- const target: EditTarget = {
- database: editing.value.db,
- metadata: editing.value.databaseMetadata,
- baselineMetadata: cloneDeep(editing.value.databaseMetadata),
- catalog: editing.value.databaseCatalog,
- baselineCatalog: cloneDeep(editing.value.databaseCatalog),
- };
- return [target];
-});
-
-const context = provideSchemaEditorContext({
- targets,
- project: ref(unknownProject()),
- readonly: toRef(props, "readonly"),
- selectedRolloutObjects: ref(undefined),
- hidePreview: ref(false),
-});
-
-onMounted(() => {
- context.markEditStatus(
- editing.value.db,
- {
- schema: schemaMetadata.value,
- table: tableMetadata.value,
- },
- isCreate.value ? "created" : "normal"
- );
- for (const column of tableMetadata.value.columns) {
- context.markEditStatus(
- editing.value.db,
- {
- schema: schemaMetadata.value,
- table: tableMetadata.value,
- column,
- },
- isCreate.value ? "created" : "normal"
- );
- }
-});
-
-const state = reactive<LocalState>({
- showFieldTemplateDrawer: false,
-});
-const { t } = useI18n();
-const settingStore = useSettingV1Store();
-
-const tableCatalog = computed(() =>
- context.getTableCatalog({
- database: editing.value.databaseMetadata.name,
- schema: schemaMetadata.value.name,
- table: tableMetadata.value.name,
- })
-);
-
-const metadataForColumn = (column: ColumnMetadata) => {
- const { databaseMetadata: database } = editing.value;
- return {
- database: database,
- schema: schemaMetadata.value,
- table: tableMetadata.value,
- column: column,
- };
-};
-
-const markColumnStatus = (column: ColumnMetadata, status: EditStatus) => {
- context.markEditStatus(editing.value.db, metadataForColumn(column), status);
-};
-
-const categoryOptions = computed(() => {
- return categoryList.value.map<SelectOption>((category) => ({
- label: category,
- value: category,
- }));
-});
-
-const allowReorderColumns = computed(() => {
- return instanceV1AllowsReorderColumns(editing.value.engine);
-});
-
-const validColumns = computed(() => {
- return tableMetadata.value.columns.filter((col) => {
- if (!col.name || !col.type) {
- return false;
- }
- const status = context.getColumnStatus(
- editing.value.db,
- metadataForColumn(col)
- );
- return status !== "dropped";
- });
-});
-
-const submitDisabled = computed(() => {
- const { category } = editing.value;
- if (!tableMetadata.value.name) {
- return true;
- }
- if (tableMetadata.value.columns.some((col) => !col.name || !col.type)) {
- return true;
- }
- if (validColumns.value.length === 0) {
- return true;
- }
- if (
- !props.create &&
- isEqual(props.template.table, tableMetadata) &&
- isEqual(props.template.catalog, tableCatalog.value) &&
- props.template.category === category
- ) {
- return true;
- }
- return false;
-});
-
-const onSubmit = async () => {
- const template = rebuildTableTemplateFromMetadata({
- ...editing.value,
- tableMetadata: {
- ...tableMetadata.value,
- columns: [...validColumns.value],
- },
- tableCatalog: tableCatalog.value
- ? tableCatalog.value
- : createProto(TableCatalogSchema, {}),
- });
- const setting = await settingStore.fetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
-
- const existingValue =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value
- : undefined;
- const settingValue = createProto(SchemaTemplateSettingSchema, {
- columnTypes: existingValue?.columnTypes ?? [],
- fieldTemplates: existingValue?.fieldTemplates ?? [],
- tableTemplates: existingValue?.tableTemplates ?? [],
- });
-
- const index = settingValue.tableTemplates.findIndex(
- (t) => t.id === template.id
- );
- if (index >= 0) {
- settingValue.tableTemplates[index] = template;
- } else {
- settingValue.tableTemplates.push(template);
- }
-
- await settingStore.upsertSetting({
- name: Setting_SettingName.SCHEMA_TEMPLATE,
- value: createProto(SettingValueSchema, {
- value: {
- case: "schemaTemplateSettingValue",
- value: settingValue,
- },
- }),
- });
-
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: t("common.updated"),
- });
-
- emit("dismiss");
-};
-
-const onColumnAdd = () => {
- const { db, databaseMetadata: database } = editing.value;
- const column = createProto(ColumnMetadataSchema, {});
- tableMetadata.value.columns.push(column);
- markColumnStatus(column, "created");
-
- context.queuePendingScrollToColumn({
- db,
- metadata: {
- database: database,
- schema: schemaMetadata.value,
- table: tableMetadata.value,
- column: column,
- },
- });
-};
-
-const handleApplyColumnTemplate = (
- template: SchemaTemplateSetting_FieldTemplate
-) => {
- state.showFieldTemplateDrawer = false;
- if (!template.column) {
- return;
- }
- const { db, engine } = editing.value;
- if (template.engine !== engine) {
- return;
- }
- const column = cloneDeep(template.column);
- tableMetadata.value.columns.push(column);
- if (template.catalog) {
- context.upsertColumnCatalog(
- {
- database: editing.value.databaseCatalog.name,
- schema: schemaMetadata.value.name,
- table: tableMetadata.value.name,
- column: template.column.name,
- },
- (config) => {
- Object.assign(config, template.catalog);
- }
- );
- }
- markColumnStatus(column, "created");
- context.queuePendingScrollToColumn({
- db: db,
- metadata: metadataForColumn(column),
- });
-};
-
-const handleUpdateTableName = (name: string) => {
- context.upsertTableCatalog(
- {
- database: editing.value.databaseCatalog.name,
- schema: schemaMetadata.value.name,
- table: tableMetadata.value.name,
- },
- (catalog) => {
- catalog.name = name;
- }
- );
- context.removeTableCatalog({
- database: editing.value.databaseCatalog.name,
- schema: schemaMetadata.value.name,
- table: tableMetadata.value.name,
- });
- context.replaceTableName(
- editing.value.db,
- {
- schema: schemaMetadata.value,
- table: tableMetadata.value,
- },
- name
- );
- tableMetadata.value.name = name;
-};
-</script>
diff --git a/frontend/src/components/SchemaTemplate/TableTemplateTable.vue b/frontend/src/components/SchemaTemplate/TableTemplateTable.vue
deleted file mode 100644
index f5f8a8cfab..0000000000
--- a/frontend/src/components/SchemaTemplate/TableTemplateTable.vue
+++ /dev/null
@@ -1,154 +0,0 @@
-<template>
- <NDataTable
- size="small"
- :columns="columns"
- :data="templateList"
- :striped="true"
- :bordered="true"
- :row-props="rowProps"
- />
-</template>
-
-<script lang="tsx" setup>
-import { create as createProto } from "@bufbuild/protobuf";
-import { pullAt } from "lodash-es";
-import { PencilIcon, TrashIcon } from "lucide-vue-next";
-import type { DataTableColumn } from "naive-ui";
-import { NDataTable, NPopconfirm } from "naive-ui";
-import { computed } from "vue";
-import { useI18n } from "vue-i18n";
-import { MiniActionButton } from "@/components/v2";
-import { useSettingV1Store } from "@/store";
-import { Engine } from "@/types/proto-es/v1/common_pb";
-import type { SchemaTemplateSetting_TableTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSettingSchema,
- Setting_SettingName,
- ValueSchema as SettingValueSchema,
-} from "@/types/proto-es/v1/setting_service_pb";
-import { EngineIcon } from "../Icon";
-
-const props = defineProps<{
- engine?: Engine;
- readonly: boolean;
- templateList: SchemaTemplateSetting_TableTemplate[];
-}>();
-
-const emit = defineEmits<{
- (event: "view", item: SchemaTemplateSetting_TableTemplate): void;
- (event: "apply", item: SchemaTemplateSetting_TableTemplate): void;
-}>();
-
-const { t } = useI18n();
-const settingStore = useSettingV1Store();
-
-const columns = computed(
- (): DataTableColumn<SchemaTemplateSetting_TableTemplate>[] => {
- const cols: DataTableColumn<SchemaTemplateSetting_TableTemplate>[] = [
- {
- title: t("schema-template.form.category"),
- key: "category",
- render: (item) => item.category || "-",
- },
- {
- title: t("schema-template.form.table-name"),
- key: "name",
- render: (item) => (
- <div class="flex justify-start items-center">
- <EngineIcon engine={item.engine} customClass="ml-0 mr-1" />
- {item.table?.name ?? ""}
- </div>
- ),
- },
- ];
-
- cols.push({
- title: t("schema-template.form.comment"),
- key: "comment",
- render: (item) => item.table?.comment ?? "",
- });
-
- if (!props.readonly) {
- cols.push({
- title: t("common.operations"),
- key: "operations",
- width: 160,
- render: (item) => (
- <div class="flex items-center justify-start gap-x-2">
- <MiniActionButton
- onClick={(e: MouseEvent) => {
- e.stopPropagation();
- emit("view", item);
- }}
- >
- <PencilIcon class="w-4 h-4" />
- </MiniActionButton>
- <NPopconfirm onPositiveClick={() => deleteTemplate(item.id)}>
- {{
- trigger: () => (
- <MiniActionButton
- type="error"
- onClick={(e: MouseEvent) => e.stopPropagation()}
- >
- <TrashIcon class="w-4 h-4" />
- </MiniActionButton>
- ),
- default: () => (
- <div class="whitespace-nowrap">
- {t("common.delete")} '{item.table?.name}'?
- </div>
- ),
- }}
- </NPopconfirm>
- </div>
- ),
- });
- }
-
- return cols;
- }
-);
-
-const rowProps = (row: SchemaTemplateSetting_TableTemplate) => {
- if (row.engine === props.engine) {
- return {
- style: "cursor: pointer;",
- onClick: () => {
- emit("apply", row);
- },
- };
- }
- return {};
-};
-
-const deleteTemplate = async (id: string) => {
- const setting = await settingStore.fetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
-
- const existingValue =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value
- : undefined;
- const settingValue = createProto(SchemaTemplateSettingSchema, {
- fieldTemplates: existingValue?.fieldTemplates || [],
- columnTypes: existingValue?.columnTypes || [],
- tableTemplates: existingValue?.tableTemplates || [],
- });
-
- const index = settingValue.tableTemplates.findIndex((t) => t.id === id);
- if (index >= 0) {
- pullAt(settingValue.tableTemplates, index);
-
- await settingStore.upsertSetting({
- name: Setting_SettingName.SCHEMA_TEMPLATE,
- value: createProto(SettingValueSchema, {
- value: {
- case: "schemaTemplateSettingValue",
- value: settingValue,
- },
- }),
- });
- }
-};
-</script>
diff --git a/frontend/src/components/SchemaTemplate/TableTemplateView.vue b/frontend/src/components/SchemaTemplate/TableTemplateView.vue
deleted file mode 100644
index 518e7f83a6..0000000000
--- a/frontend/src/components/SchemaTemplate/TableTemplateView.vue
+++ /dev/null
@@ -1,103 +0,0 @@
-<template>
- <NEmpty v-if="templateList.length === 0" class="py-12 border rounded-sm" />
- <div v-else class="flex">
- <div
- class="hidden lg:flex w-1/5 max-w-xs flex-col gap-y-3 border-r mr-5 pr-5"
- >
- <p class="text-lg">
- {{ $t("schema-template.form.category") }}
- </p>
- <div class="flex flex-col gap-y-2">
- <NCheckbox
- v-for="item in categoryList"
- :key="item.id"
- :checked="state.selectedCategory.has(item.id)"
- @update:checked="toggleCategoryCheck(item.id)"
- >
- <div class="flex items-center gap-x-1 text-sm text-gray-600">
- <span class="text-ellipsis whitespace-nowrap overflow-hidden">
- {{ item.text }}
- </span>
- <span
- class="items-center text-xs px-2 py-0.5 rounded-full bg-gray-200 text-gray-800"
- >
- {{ item.count }}
- </span>
- </div>
- </NCheckbox>
- </div>
- </div>
- <TableTemplateTable
- :engine="engine"
- :readonly="readonly"
- :template-list="filteredTemplateList"
- class="flex-1"
- @view="$emit('view', $event)"
- @apply="$emit('apply', $event)"
- />
- </div>
-</template>
-
-<script lang="ts" setup>
-import { NCheckbox, NEmpty } from "naive-ui";
-import { computed, reactive } from "vue";
-import { useI18n } from "vue-i18n";
-import type { Engine } from "@/types/proto-es/v1/common_pb";
-import type { SchemaTemplateSetting_TableTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import TableTemplateTable from "./TableTemplateTable.vue";
-
-interface LocalState {
- selectedCategory: Set<string>;
-}
-
-const props = defineProps<{
- engine?: Engine;
- readonly: boolean;
- templateList: SchemaTemplateSetting_TableTemplate[];
-}>();
-
-defineEmits<{
- (event: "view", item: SchemaTemplateSetting_TableTemplate): void;
- (event: "apply", item: SchemaTemplateSetting_TableTemplate): void;
-}>();
-
-const state = reactive<LocalState>({
- selectedCategory: new Set<string>(),
-});
-const { t } = useI18n();
-
-const toggleCategoryCheck = (category: string) => {
- if (state.selectedCategory.has(category)) {
- state.selectedCategory.delete(category);
- } else {
- state.selectedCategory.add(category);
- }
-};
-
-const categoryList = computed(() => {
- const categoryMap = new Map<string, number>();
- for (const template of props.templateList) {
- const num = categoryMap.get(template.category) ?? 0;
- categoryMap.set(template.category, num + 1);
- }
-
- const resp = [];
- for (const [category, count] of categoryMap.entries()) {
- resp.push({
- id: category,
- text: category || t("schema-template.form.unclassified"),
- count,
- });
- }
- return resp;
-});
-
-const filteredTemplateList = computed(() => {
- if (state.selectedCategory.size === 0) {
- return props.templateList;
- }
- return props.templateList.filter((template) =>
- state.selectedCategory.has(template.category)
- );
-});
-</script>
diff --git a/frontend/src/components/SchemaTemplate/utils.ts b/frontend/src/components/SchemaTemplate/utils.ts
deleted file mode 100644
index 96a4c1dda0..0000000000
--- a/frontend/src/components/SchemaTemplate/utils.ts
+++ /dev/null
@@ -1,169 +0,0 @@
-import { create } from "@bufbuild/protobuf";
-import { cloneDeep } from "lodash-es";
-import { computed, reactive } from "vue";
-import { useSettingV1Store } from "@/store";
-import { type ComposedDatabase, unknownDatabase } from "@/types";
-import { Engine } from "@/types/proto-es/v1/common_pb";
-import {
- DatabaseCatalogSchema,
- SchemaCatalogSchema,
- type TableCatalog,
- TableCatalog_ColumnsSchema,
- TableCatalogSchema,
-} from "@/types/proto-es/v1/database_catalog_service_pb";
-import {
- DatabaseMetadataSchema,
- SchemaMetadataSchema,
- type TableMetadata,
- TableMetadataSchema,
-} from "@/types/proto-es/v1/database_service_pb";
-import type {
- DataClassificationSetting_DataClassificationConfig,
- SchemaTemplateSetting_TableTemplate,
-} from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSetting_TableTemplateSchema,
- Setting_SettingName,
-} from "@/types/proto-es/v1/setting_service_pb";
-
-export const engineList = [Engine.MYSQL, Engine.POSTGRES];
-
-// Create empty schema template table template
-export const createEmptyTableTemplate =
- (): SchemaTemplateSetting_TableTemplate => {
- return create(SchemaTemplateSetting_TableTemplateSchema, {
- id: "",
- category: "",
- engine: Engine.ENGINE_UNSPECIFIED,
- table: create(TableMetadataSchema, {}),
- catalog: create(TableCatalogSchema, {
- name: "",
- kind: {
- case: "columns",
- value: create(TableCatalog_ColumnsSchema, {}),
- },
- }),
- });
- };
-
-export const categoryList = computed(() => {
- const settingStore = useSettingV1Store();
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
-
- if (
- !setting ||
- !setting.value ||
- setting.value.value.case !== "schemaTemplateSettingValue"
- ) {
- return [];
- }
-
- const schemaTemplateSetting = setting.value.value.value;
- const fieldTemplateList = schemaTemplateSetting.fieldTemplates ?? [];
- const tableTemplateList = schemaTemplateSetting.tableTemplates ?? [];
- const resp = [];
-
- for (const category of new Set([
- ...fieldTemplateList.map((template) => template.category),
- ...tableTemplateList.map((template) => template.category),
- ])) {
- if (!category) {
- continue;
- }
- resp.push(category);
- }
- return resp;
-});
-
-export const classificationConfig = computed(
- (): DataClassificationSetting_DataClassificationConfig | undefined => {
- const settingStore = useSettingV1Store();
- const setting = settingStore.getSettingByName(
- Setting_SettingName.DATA_CLASSIFICATION
- );
-
- if (
- !setting ||
- !setting.value ||
- setting.value.value.case !== "dataClassificationSettingValue"
- ) {
- return undefined;
- }
-
- const configs = setting.value.value.value.configs;
- return configs.length > 0 ? configs[0] : undefined;
- }
-);
-
-export const mockMetadataFromTableTemplate = (
- template: SchemaTemplateSetting_TableTemplate
-) => {
- const db = {
- ...unknownDatabase(),
- };
-
- const databaseMetadata = create(DatabaseMetadataSchema, {
- name: db.name,
- schemas: [
- create(SchemaMetadataSchema, {
- name: "",
- tables: [
- cloneDeep(template.table) ??
- create(TableMetadataSchema, {
- name: "",
- columns: [],
- }),
- ],
- }),
- ],
- });
-
- const databaseCatalog = create(DatabaseCatalogSchema, {
- name: db.name,
- schemas: [
- create(SchemaCatalogSchema, {
- name: "",
- tables: [
- cloneDeep(template.catalog) ??
- create(TableCatalogSchema, {
- name: "",
- kind: {
- case: "columns",
- value: create(TableCatalog_ColumnsSchema, {}),
- },
- }),
- ],
- }),
- ],
- });
-
- return reactive({
- db,
- databaseMetadata,
- databaseCatalog,
- id: template.id,
- category: template.category,
- engine: template.engine,
- });
-};
-
-export const rebuildTableTemplateFromMetadata = (params: {
- db: ComposedDatabase;
- tableMetadata: TableMetadata;
- tableCatalog: TableCatalog;
- id: string;
- category: string;
- engine: Engine;
-}) => {
- const { tableMetadata, tableCatalog, id, category, engine } = params;
-
- return create(SchemaTemplateSetting_TableTemplateSchema, {
- table: tableMetadata,
- catalog: tableCatalog,
- id,
- category,
- engine,
- });
-};
diff --git a/frontend/src/components/SensitiveData/ClassificationView.vue b/frontend/src/components/SensitiveData/ClassificationView.vue
index 29b45efbea..d24da617ec 100644
--- a/frontend/src/components/SensitiveData/ClassificationView.vue
+++ b/frontend/src/components/SensitiveData/ClassificationView.vue
@@ -91,8 +91,8 @@ import {
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { hasWorkspacePermissionV2 } from "@/utils";
import LearnMoreLink from "../LearnMoreLink.vue";
-import ClassificationTree from "../SchemaTemplate/ClassificationTree.vue";
import SingleFileSelector from "../SingleFileSelector.vue";
+import ClassificationTree from "./components/ClassificationTree.vue";
import DataExampleModal from "./components/DataExampleModal.vue";
const uploader = ref<HTMLInputElement | null>(null);
diff --git a/frontend/src/components/SchemaTemplate/ClassificationLevelBadge.vue b/frontend/src/components/SensitiveData/components/ClassificationLevelBadge.vue
similarity index 94%
rename from frontend/src/components/SchemaTemplate/ClassificationLevelBadge.vue
rename to frontend/src/components/SensitiveData/components/ClassificationLevelBadge.vue
index 2a359b2dee..422de79533 100644
--- a/frontend/src/components/SchemaTemplate/ClassificationLevelBadge.vue
+++ b/frontend/src/components/SensitiveData/components/ClassificationLevelBadge.vue
@@ -7,10 +7,7 @@
{{ placeholder }}
</span>
</NPerformantEllipsis>
- <span
- v-if="level"
- :class="['ml-1 px-1 py-0.5 rounded-sm text-xs', levelColor]"
- >
+ <span v-if="level" :class="['ml-1 px-1 py-0.5 rounded text-xs', levelColor]">
{{ level.title }}
</span>
</template>
diff --git a/frontend/src/components/SchemaTemplate/ClassificationTree.vue b/frontend/src/components/SensitiveData/components/ClassificationTree.vue
similarity index 97%
rename from frontend/src/components/SchemaTemplate/ClassificationTree.vue
rename to frontend/src/components/SensitiveData/components/ClassificationTree.vue
index 27d1491d72..d55c266bb2 100644
--- a/frontend/src/components/SchemaTemplate/ClassificationTree.vue
+++ b/frontend/src/components/SensitiveData/components/ClassificationTree.vue
@@ -1,5 +1,5 @@
<template>
- <div class="flex flex-col gap-y-4 h-full">
+ <div class="divide-block-border space-y-4 h-full">
<SearchBox
v-model:value="state.searchText"
style="max-width: 100%"
@@ -29,9 +29,9 @@
import type { TreeOption } from "naive-ui";
import { NTree } from "naive-ui";
import { computed, h, reactive } from "vue";
+import { SearchBox } from "@/components/v2";
import type { DataClassificationSetting_DataClassificationConfig } from "@/types/proto-es/v1/setting_service_pb";
import { getHighlightHTMLByKeyWords } from "@/utils";
-import { SearchBox } from "../v2";
import ClassificationLevelBadge from "./ClassificationLevelBadge.vue";
const props = defineProps<{
diff --git a/frontend/src/components/SchemaTemplate/SelectClassificationDrawer.vue b/frontend/src/components/SensitiveData/components/SelectClassificationDrawer.vue
similarity index 91%
rename from frontend/src/components/SchemaTemplate/SelectClassificationDrawer.vue
rename to frontend/src/components/SensitiveData/components/SelectClassificationDrawer.vue
index 7f13a8f5f3..76fd265a12 100644
--- a/frontend/src/components/SchemaTemplate/SelectClassificationDrawer.vue
+++ b/frontend/src/components/SensitiveData/components/SelectClassificationDrawer.vue
@@ -1,7 +1,7 @@
<template>
<Drawer :show="show" @close="$emit('dismiss')">
<DrawerContent :title="$t('schema-template.classification.select')">
- <div class="w-100 h-full">
+ <div class="w-[25rem] h-full">
<ClassificationTree
:classification-config="classificationConfig"
@apply="onApply"
@@ -23,9 +23,9 @@
<script lang="ts" setup>
import { NButton } from "naive-ui";
-import ClassificationTree from "@/components/SchemaTemplate/ClassificationTree.vue";
import { Drawer, DrawerContent } from "@/components/v2";
import type { DataClassificationSetting_DataClassificationConfig } from "@/types/proto-es/v1/setting_service_pb";
+import ClassificationTree from "./ClassificationTree.vue";
defineProps<{
show: boolean;
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index efa64f5fbd..9cfcb69755 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -2199,7 +2199,6 @@
"drop-table": "Drop table",
"restore": "Restore",
"add-column": "Add column",
- "add-from-template": "Add from template",
"drop-column": "Drop column",
"create-procedure": "Create procedure",
"create-function": "Create function",
@@ -2698,41 +2697,6 @@
}
},
"schema-template": {
- "self": "Schema Template",
- "field-template": {
- "self": "Field Template",
- "description": "You can pre-define the field template, then apply the template during the schema change."
- },
- "column-type-restriction": {
- "self": "Column Type Restriction",
- "description": "You can restrict the allowed column types for each database engine.",
- "allow-all": "Allow all",
- "allow-limited-types": "Allow limited types",
- "back-to-edit": "Back to edit",
- "add-and-save": "Add and save",
- "messages": {
- "unable-to-update": "Unable to update restriction",
- "following-column-types-are-used": "Following column types are still used by field template",
- "one-allowed-type-per-line": "One allowed data type per line"
- }
- },
- "table-template": {
- "self": "Table Template",
- "description": "You can pre-define the table template, then apply the template during the schema change."
- },
- "search-by-name-or-comment": "Search by name or comment",
- "form": {
- "category": "Category",
- "category-desc": "Select an existing category or create a new one",
- "unclassified": "Unclassified",
- "column-name": "Column name",
- "column-type": "Column type",
- "default-value": "Default",
- "comment": "Comment",
- "nullable": "Nullable",
- "table-name": "Table name",
- "on-update": "On Update"
- },
"classification": {
"select": "Select classification",
"search": "Search classification"
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index 75b08f6d85..43a7ab7130 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -2199,7 +2199,6 @@
"drop-table": "Eliminar tabla",
"restore": "Restaurar",
"add-column": "Agregar columna",
- "add-from-template": "Agregar desde plantilla",
"drop-column": "Eliminar columna",
"create-procedure": "Crear procedimiento",
"create-function": "Crear función",
@@ -2698,41 +2697,6 @@
}
},
"schema-template": {
- "self": "Plantilla de esquema",
- "field-template": {
- "self": "Plantilla de campo",
- "description": "Predefina la plantilla de campo, luego aplique la plantilla durante el cambio de esquema."
- },
- "column-type-restriction": {
- "self": "Restricción de tipos de columna",
- "description": "Para cada motor de base de datos, puede limitar los tipos de columna permitidos.",
- "allow-all": "Permitir todos los tipos",
- "allow-limited-types": "Permitir solo algunos tipos",
- "back-to-edit": "Volver a editar",
- "add-and-save": "Agregar y guardar",
- "messages": {
- "unable-to-update": "No se puede actualizar la restricción",
- "following-column-types-are-used": "Los siguientes tipos de columna todavía se usan en la plantilla de campos.",
- "one-allowed-type-per-line": "Un tipo permitido por línea"
- }
- },
- "table-template": {
- "self": "Plantilla de tabla",
- "description": "Puede predefinir la plantilla de tabla y luego aplicar la plantilla durante el cambio de esquema."
- },
- "search-by-name-or-comment": "Buscar por nombre o comentario",
- "form": {
- "category": "Categoría",
- "category-desc": "Seleccione una categoría existente o cree una nueva",
- "unclassified": "Desclasificada",
- "column-name": "Nombre de la columna",
- "column-type": "Tipo de columna",
- "default-value": "Por defecto",
- "comment": "Comentario",
- "nullable": "Anulable",
- "table-name": "Nombre de la tabla",
- "on-update": "En actualización"
- },
"classification": {
"select": "Seleccionar clasificación",
"search": "Clasificación de búsqueda"
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index 588a379ded..18af942ff5 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -2199,7 +2199,6 @@
"drop-table": "テーブルの削除",
"restore": "復元する",
"add-column": "列の追加",
- "add-from-template": "テンプレートから追加",
"drop-column": "列の削除",
"create-procedure": "プロシージャの作成",
"create-function": "関数の作成",
@@ -2698,41 +2697,6 @@
}
},
"schema-template": {
- "self": "スキーマテンプレート",
- "field-template": {
- "self": "フィールドテンプレート",
- "description": "後でスキーマを変更または設計するときに適用できる、事前定義されたフィールド テンプレート。"
- },
- "column-type-restriction": {
- "self": "列の型の制約",
- "description": "各データベース エンジンで、許可される列の種類を制限できます。",
- "allow-all": "すべてのタイプが許可される",
- "allow-limited-types": "一部のタイプのみが許可されます",
- "back-to-edit": "編集に戻る",
- "add-and-save": "追加して保存",
- "messages": {
- "unable-to-update": "制限を更新できません",
- "following-column-types-are-used": "次のタイプは引き続きフィールド テンプレートで使用されます。",
- "one-allowed-type-per-line": "許可されるデータ型を 1 行に 1 つずつ入力します"
- }
- },
- "table-template": {
- "self": "テーブルテンプレート",
- "description": "後でスキーマを変更または設計するときに適用できるテーブル テンプレートを事前定義します。"
- },
- "search-by-name-or-comment": "名前やメモで検索",
- "form": {
- "category": "分類",
- "category-desc": "既存のカテゴリを選択するか、新しいカテゴリを作成します",
- "unclassified": "未分類",
- "column-name": "フィールド名",
- "column-type": "フィールドタイプ",
- "default-value": "デフォルト値",
- "comment": "コメント",
- "nullable": "null も可能",
- "table-name": "テーブル名",
- "on-update": "アップデート時"
- },
"classification": {
"select": "カテゴリを選択してください",
"search": "カテゴリを検索する"
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index 294a53ee5c..c37e7c6fb0 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -2199,7 +2199,6 @@
"drop-table": "Xóa bảng",
"restore": "Khôi phục",
"add-column": "Thêm cột",
- "add-from-template": "Thêm từ mẫu",
"drop-column": "Xóa cột",
"create-procedure": "Tạo thủ tục",
"create-function": "Tạo hàm",
@@ -2698,41 +2697,6 @@
}
},
"schema-template": {
- "self": "Mẫu lược đồ",
- "field-template": {
- "self": "Mẫu trường",
- "description": "Bạn có thể xác định trước mẫu trường, sau đó áp dụng mẫu trong quá trình thay đổi lược đồ."
- },
- "column-type-restriction": {
- "self": "Hạn chế loại cột",
- "description": "Bạn có thể hạn chế các loại cột được phép cho từng công cụ cơ sở dữ liệu.",
- "allow-all": "Cho phép tất cả",
- "allow-limited-types": "Cho phép các loại hạn chế",
- "back-to-edit": "Quay lại chỉnh sửa",
- "add-and-save": "Thêm và lưu",
- "messages": {
- "unable-to-update": "Không thể cập nhật hạn chế",
- "following-column-types-are-used": "Các loại cột sau vẫn được sử dụng bởi mẫu trường",
- "one-allowed-type-per-line": "Một loại dữ liệu được phép trên mỗi dòng"
- }
- },
- "table-template": {
- "self": "Mẫu bảng",
- "description": "Bạn có thể xác định trước mẫu bảng, sau đó áp dụng mẫu trong quá trình thay đổi lược đồ."
- },
- "search-by-name-or-comment": "Tìm kiếm theo tên hoặc bình luận",
- "form": {
- "category": "Danh mục",
- "category-desc": "Chọn một danh mục hiện có hoặc tạo một danh mục mới",
- "unclassified": "Chưa phân loại",
- "column-name": "Tên cột",
- "column-type": "Loại cột",
- "default-value": "Mặc định",
- "comment": "Bình luận",
- "nullable": "Có thể null",
- "table-name": "Tên bảng",
- "on-update": "Khi cập nhật"
- },
"classification": {
"select": "Chọn phân loại",
"search": "Tìm kiếm phân loại"
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index f4cb7ca398..9e93a7776d 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -2199,7 +2199,6 @@
"drop-table": "删除表",
"restore": "恢复",
"add-column": "添加列",
- "add-from-template": "从模板添加",
"drop-column": "删除列",
"create-procedure": "新建存储过程",
"create-function": "新建函数",
@@ -2698,41 +2697,6 @@
}
},
"schema-template": {
- "self": "Schema 模板",
- "field-template": {
- "self": "字段模板",
- "description": "预定义字段模板,之后可以在变更或设计 Schema 时应用这些模板。"
- },
- "column-type-restriction": {
- "self": "列类型约束",
- "description": "在每一个数据库引擎上,您可以限制允许使用的列类型。",
- "allow-all": "允许所有类型",
- "allow-limited-types": "只允许部分类型",
- "back-to-edit": "返回编辑",
- "add-and-save": "添加并保存",
- "messages": {
- "unable-to-update": "无法更新限制",
- "following-column-types-are-used": "以下列类型仍在字段模板中使用。",
- "one-allowed-type-per-line": "每行放一个允许的数据类型"
- }
- },
- "table-template": {
- "self": "表模板",
- "description": "预定义表模板,之后可以在变更或设计 Schema 时应用这些模板。"
- },
- "search-by-name-or-comment": "根据名称或备注搜索",
- "form": {
- "category": "分类",
- "category-desc": "选择一个已有分类,或者创建新分类",
- "unclassified": "未分类",
- "column-name": "字段名",
- "column-type": "字段类型",
- "default-value": "默认值",
- "comment": "备注",
- "nullable": "可为空",
- "table-name": "表名",
- "on-update": "更新时"
- },
"classification": {
"select": "选择分类",
"search": "搜索分类"
diff --git a/frontend/src/router/dashboard/workspace.ts b/frontend/src/router/dashboard/workspace.ts
index e6db00134f..46fe2f6b7e 100644
--- a/frontend/src/router/dashboard/workspace.ts
+++ b/frontend/src/router/dashboard/workspace.ts
@@ -1,4 +1,3 @@
-import { startCase } from "lodash-es";
import type { RouteRecordRaw } from "vue-router";
import DummyRootView from "@/DummyRootView";
import { t } from "@/plugins/i18n";
@@ -18,7 +17,6 @@ import {
WORKSPACE_ROUTE_LANDING,
WORKSPACE_ROUTE_MEMBERS,
WORKSPACE_ROUTE_ROLES,
- WORKSPACE_ROUTE_SCHEMA_TEMPLATE,
WORKSPACE_ROUTE_SEMANTIC_TYPES,
WORKSPACE_ROUTE_SQL_REVIEW,
WORKSPACE_ROUTE_SQL_REVIEW_CREATE,
@@ -227,16 +225,6 @@ const workspaceRoutes: RouteRecordRaw[] = [
component: () => import("@/views/SettingWorkspaceCustomApproval.vue"),
props: true,
},
- {
- path: "schema-template",
- name: WORKSPACE_ROUTE_SCHEMA_TEMPLATE,
- meta: {
- title: () => startCase(t("schema-template.self")),
- requiredPermissionList: () => ["bb.policies.get"],
- },
- component: () => import("@/views/SettingWorkspaceSchemaTemplate.vue"),
- props: true,
- },
{
path: "global-masking",
name: WORKSPACE_ROUTE_GLOBAL_MASKING,
diff --git a/frontend/src/router/dashboard/workspaceRoutes.ts b/frontend/src/router/dashboard/workspaceRoutes.ts
index 57404fc801..04910c27b6 100644
--- a/frontend/src/router/dashboard/workspaceRoutes.ts
+++ b/frontend/src/router/dashboard/workspaceRoutes.ts
@@ -13,7 +13,6 @@ export const WORKSPACE_ROUTE_SQL_REVIEW = "workspace.sql-review";
export const WORKSPACE_ROUTE_SQL_REVIEW_CREATE = `${WORKSPACE_ROUTE_SQL_REVIEW}.create`;
export const WORKSPACE_ROUTE_SQL_REVIEW_DETAIL = `${WORKSPACE_ROUTE_SQL_REVIEW}.detail`;
-export const WORKSPACE_ROUTE_SCHEMA_TEMPLATE = "workspace.schema-template";
export const WORKSPACE_ROUTE_CUSTOM_APPROVAL = "workspace.custom-approval";
export const WORKSPACE_ROUTE_GLOBAL_MASKING = "workspace.global-masking";
export const WORKSPACE_ROUTE_SEMANTIC_TYPES = "workspace.semantic-types";
diff --git a/frontend/src/types/proto-es/v1/setting_service_pb.d.ts b/frontend/src/types/proto-es/v1/setting_service_pb.d.ts
index 2a05625552..499d9504e5 100644
--- a/frontend/src/types/proto-es/v1/setting_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/setting_service_pb.d.ts
@@ -8,9 +8,6 @@ import type { Duration, FieldMask } from "@bufbuild/protobuf/wkt";
import type { Webhook_Type } from "./project_service_pb";
import type { ApprovalTemplate } from "./issue_service_pb";
import type { Expr } from "../google/type/expr_pb";
-import type { Engine } from "./common_pb";
-import type { ColumnMetadata, TableMetadata } from "./database_service_pb";
-import type { ColumnCatalog, TableCatalog } from "./database_catalog_service_pb";
/**
* Describes the file v1/setting_service.proto.
@@ -187,11 +184,6 @@ export enum Setting_SettingName {
*/
WORKSPACE_APPROVAL = 5,
- /**
- * @generated from enum value: WORKSPACE_EXTERNAL_APPROVAL = 6;
- */
- WORKSPACE_EXTERNAL_APPROVAL = 6,
-
/**
* @generated from enum value: ENTERPRISE_LICENSE = 7;
*/
@@ -212,11 +204,6 @@ export enum Setting_SettingName {
*/
AI = 10,
- /**
- * @generated from enum value: SCHEMA_TEMPLATE = 13;
- */
- SCHEMA_TEMPLATE = 13,
-
/**
* @generated from enum value: DATA_CLASSIFICATION = 14;
*/
@@ -287,12 +274,6 @@ export declare type Value = Message<"bytebase.v1.Value"> & {
*/
value: WorkspaceApprovalSetting;
case: "workspaceApprovalSettingValue";
- } | {
- /**
- * @generated from field: bytebase.v1.SchemaTemplateSetting schema_template_setting_value = 9;
- */
- value: SchemaTemplateSetting;
- case: "schemaTemplateSettingValue";
} | {
/**
* @generated from field: bytebase.v1.DataClassificationSetting data_classification_setting_value = 10;
@@ -787,130 +768,6 @@ export enum WorkspaceApprovalSetting_Rule_Source {
*/
export declare const WorkspaceApprovalSetting_Rule_SourceSchema: GenEnum<WorkspaceApprovalSetting_Rule_Source>;
-/**
- * @generated from message bytebase.v1.SchemaTemplateSetting
- */
-export declare type SchemaTemplateSetting = Message<"bytebase.v1.SchemaTemplateSetting"> & {
- /**
- * @generated from field: repeated bytebase.v1.SchemaTemplateSetting.FieldTemplate field_templates = 1;
- */
- fieldTemplates: SchemaTemplateSetting_FieldTemplate[];
-
- /**
- * @generated from field: repeated bytebase.v1.SchemaTemplateSetting.ColumnType column_types = 2;
- */
- columnTypes: SchemaTemplateSetting_ColumnType[];
-
- /**
- * @generated from field: repeated bytebase.v1.SchemaTemplateSetting.TableTemplate table_templates = 3;
- */
- tableTemplates: SchemaTemplateSetting_TableTemplate[];
-};
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.
- * Use `create(SchemaTemplateSettingSchema)` to create a new message.
- */
-export declare const SchemaTemplateSettingSchema: GenMessage<SchemaTemplateSetting>;
-
-/**
- * @generated from message bytebase.v1.SchemaTemplateSetting.FieldTemplate
- */
-export declare type SchemaTemplateSetting_FieldTemplate = Message<"bytebase.v1.SchemaTemplateSetting.FieldTemplate"> & {
- /**
- * @generated from field: string id = 1;
- */
- id: string;
-
- /**
- * @generated from field: bytebase.v1.Engine engine = 2;
- */
- engine: Engine;
-
- /**
- * @generated from field: string category = 3;
- */
- category: string;
-
- /**
- * @generated from field: bytebase.v1.ColumnMetadata column = 4;
- */
- column?: ColumnMetadata;
-
- /**
- * @generated from field: bytebase.v1.ColumnCatalog catalog = 5;
- */
- catalog?: ColumnCatalog;
-};
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.FieldTemplate.
- * Use `create(SchemaTemplateSetting_FieldTemplateSchema)` to create a new message.
- */
-export declare const SchemaTemplateSetting_FieldTemplateSchema: GenMessage<SchemaTemplateSetting_FieldTemplate>;
-
-/**
- * @generated from message bytebase.v1.SchemaTemplateSetting.ColumnType
- */
-export declare type SchemaTemplateSetting_ColumnType = Message<"bytebase.v1.SchemaTemplateSetting.ColumnType"> & {
- /**
- * @generated from field: bytebase.v1.Engine engine = 1;
- */
- engine: Engine;
-
- /**
- * @generated from field: bool enabled = 2;
- */
- enabled: boolean;
-
- /**
- * @generated from field: repeated string types = 3;
- */
- types: string[];
-};
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.ColumnType.
- * Use `create(SchemaTemplateSetting_ColumnTypeSchema)` to create a new message.
- */
-export declare const SchemaTemplateSetting_ColumnTypeSchema: GenMessage<SchemaTemplateSetting_ColumnType>;
-
-/**
- * @generated from message bytebase.v1.SchemaTemplateSetting.TableTemplate
- */
-export declare type SchemaTemplateSetting_TableTemplate = Message<"bytebase.v1.SchemaTemplateSetting.TableTemplate"> & {
- /**
- * @generated from field: string id = 1;
- */
- id: string;
-
- /**
- * @generated from field: bytebase.v1.Engine engine = 2;
- */
- engine: Engine;
-
- /**
- * @generated from field: string category = 3;
- */
- category: string;
-
- /**
- * @generated from field: bytebase.v1.TableMetadata table = 4;
- */
- table?: TableMetadata;
-
- /**
- * @generated from field: bytebase.v1.TableCatalog catalog = 5;
- */
- catalog?: TableCatalog;
-};
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.TableTemplate.
- * Use `create(SchemaTemplateSetting_TableTemplateSchema)` to create a new message.
- */
-export declare const SchemaTemplateSetting_TableTemplateSchema: GenMessage<SchemaTemplateSetting_TableTemplate>;
-
/**
* @generated from message bytebase.v1.DataClassificationSetting
*/
diff --git a/frontend/src/types/proto-es/v1/setting_service_pb.js b/frontend/src/types/proto-es/v1/setting_service_pb.js
index 331d63cf37..18b02188f3 100644
--- a/frontend/src/types/proto-es/v1/setting_service_pb.js
+++ b/frontend/src/types/proto-es/v1/setting_service_pb.js
@@ -10,9 +10,6 @@ import { file_google_api_resource } from "../google/api/resource_pb";
import { file_google_protobuf_duration, file_google_protobuf_field_mask } from "@bufbuild/protobuf/wkt";
import { file_google_type_expr } from "../google/type/expr_pb";
import { file_v1_annotation } from "./annotation_pb";
-import { file_v1_common } from "./common_pb";
-import { file_v1_database_catalog_service } from "./database_catalog_service_pb";
-import { file_v1_database_service } from "./database_service_pb";
import { file_v1_issue_service } from "./issue_service_pb";
import { file_v1_project_service } from "./project_service_pb";
@@ -20,7 +17,7 @@ import { file_v1_project_service } from "./project_service_pb";
* Describes the file v1/setting_service.proto.
*/
export const file_v1_setting_service = /*@__PURE__*/
- fileDesc("Chh2MS9zZXR0aW5nX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIhUKE0xpc3RTZXR0aW5nc1JlcXVlc3QiPgoUTGlzdFNldHRpbmdzUmVzcG9uc2USJgoIc2V0dGluZ3MYASADKAsyFC5ieXRlYmFzZS52MS5TZXR0aW5nIj8KEUdldFNldHRpbmdSZXF1ZXN0EioKBG5hbWUYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1NldHRpbmciOwoSR2V0U2V0dGluZ1Jlc3BvbnNlEiUKB3NldHRpbmcYASABKAsyFC5ieXRlYmFzZS52MS5TZXR0aW5nIqEBChRVcGRhdGVTZXR0aW5nUmVxdWVzdBIqCgdzZXR0aW5nGAEgASgLMhQuYnl0ZWJhc2UudjEuU2V0dGluZ0ID4EECEhUKDXZhbGlkYXRlX29ubHkYAiABKAgSFQoNYWxsb3dfbWlzc2luZxgDIAEoCBIvCgt1cGRhdGVfbWFzaxgEIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2si1QMKB1NldHRpbmcSDAoEbmFtZRgBIAEoCRIhCgV2YWx1ZRgCIAEoCzISLmJ5dGViYXNlLnYxLlZhbHVlIuMCCgtTZXR0aW5nTmFtZRIcChhTRVRUSU5HX05BTUVfVU5TUEVDSUZJRUQQABIPCgtBVVRIX1NFQ1JFVBABEhEKDUJSQU5ESU5HX0xPR08QAhIQCgxXT1JLU1BBQ0VfSUQQAxIVChFXT1JLU1BBQ0VfUFJPRklMRRAEEhYKEldPUktTUEFDRV9BUFBST1ZBTBAFEh8KG1dPUktTUEFDRV9FWFRFUk5BTF9BUFBST1ZBTBAGEhYKEkVOVEVSUFJJU0VfTElDRU5TRRAHEgoKBkFQUF9JTRAIEg0KCVdBVEVSTUFSSxAJEgYKAkFJEAoSEwoPU0NIRU1BX1RFTVBMQVRFEA0SFwoTREFUQV9DTEFTU0lGSUNBVElPThAOEhIKDlNFTUFOVElDX1RZUEVTEA8SCAoEU0NJTRAREhgKFFBBU1NXT1JEX1JFU1RSSUNUSU9OEBISDwoLRU5WSVJPTk1FTlQQEzot6kEqChRieXRlYmFzZS5jb20vU2V0dGluZxISc2V0dGluZ3Mve3NldHRpbmd9SgQIEBARIukFCgVWYWx1ZRIWCgxzdHJpbmdfdmFsdWUYASABKAlIABI5ChRhcHBfaW1fc2V0dGluZ192YWx1ZRgDIAEoCzIZLmJ5dGViYXNlLnYxLkFwcElNU2V0dGluZ0gAEk8KH3dvcmtzcGFjZV9wcm9maWxlX3NldHRpbmdfdmFsdWUYBSABKAsyJC5ieXRlYmFzZS52MS5Xb3Jrc3BhY2VQcm9maWxlU2V0dGluZ0gAElEKIHdvcmtzcGFjZV9hcHByb3ZhbF9zZXR0aW5nX3ZhbHVlGAYgASgLMiUuYnl0ZWJhc2UudjEuV29ya3NwYWNlQXBwcm92YWxTZXR0aW5nSAASSwodc2NoZW1hX3RlbXBsYXRlX3NldHRpbmdfdmFsdWUYCSABKAsyIi5ieXRlYmFzZS52MS5TY2hlbWFUZW1wbGF0ZVNldHRpbmdIABJTCiFkYXRhX2NsYXNzaWZpY2F0aW9uX3NldHRpbmdfdmFsdWUYCiABKAsyJi5ieXRlYmFzZS52MS5EYXRhQ2xhc3NpZmljYXRpb25TZXR0aW5nSAASRwobc2VtYW50aWNfdHlwZV9zZXR0aW5nX3ZhbHVlGAsgASgLMiAuYnl0ZWJhc2UudjEuU2VtYW50aWNUeXBlU2V0dGluZ0gAEjAKDHNjaW1fc2V0dGluZxgOIAEoCzIYLmJ5dGViYXNlLnYxLlNDSU1TZXR0aW5nSAASTwoccGFzc3dvcmRfcmVzdHJpY3Rpb25fc2V0dGluZxgPIAEoCzInLmJ5dGViYXNlLnYxLlBhc3N3b3JkUmVzdHJpY3Rpb25TZXR0aW5nSAASLAoKYWlfc2V0dGluZxgQIAEoCzIWLmJ5dGViYXNlLnYxLkFJU2V0dGluZ0gAEj4KE2Vudmlyb25tZW50X3NldHRpbmcYESABKAsyHy5ieXRlYmFzZS52MS5FbnZpcm9ubWVudFNldHRpbmdIAEIHCgV2YWx1ZUoECBIQEyK2BQoMQXBwSU1TZXR0aW5nEjUKCHNldHRpbmdzGAEgAygLMiMuYnl0ZWJhc2UudjEuQXBwSU1TZXR0aW5nLklNU2V0dGluZxobCgVTbGFjaxISCgV0b2tlbhgBIAEoCUID4EEEGjYKBkZlaXNodRITCgZhcHBfaWQYASABKAlCA+BBBBIXCgphcHBfc2VjcmV0GAIgASgJQgPgQQQaSQoFV2Vjb20SFAoHY29ycF9pZBgBIAEoCUID4EEEEhUKCGFnZW50X2lkGAIgASgJQgPgQQQSEwoGc2VjcmV0GAMgASgJQgPgQQQaNAoETGFyaxITCgZhcHBfaWQYASABKAlCA+BBBBIXCgphcHBfc2VjcmV0GAIgASgJQgPgQQQaVwoIRGluZ1RhbGsSFgoJY2xpZW50X2lkGAEgASgJQgPgQQQSGgoNY2xpZW50X3NlY3JldBgCIAEoCUID4EEEEhcKCnJvYm90X2NvZGUYAyABKAlCA+BBBBq/AgoJSU1TZXR0aW5nEicKBHR5cGUYASABKA4yGS5ieXRlYmFzZS52MS5XZWJob29rLlR5cGUSMAoFc2xhY2sYAiABKAsyHy5ieXRlYmFzZS52MS5BcHBJTVNldHRpbmcuU2xhY2tIABIyCgZmZWlzaHUYAyABKAsyIC5ieXRlYmFzZS52MS5BcHBJTVNldHRpbmcuRmVpc2h1SAASMAoFd2Vjb20YBCABKAsyHy5ieXRlYmFzZS52MS5BcHBJTVNldHRpbmcuV2Vjb21IABIuCgRsYXJrGAUgASgLMh4uYnl0ZWJhc2UudjEuQXBwSU1TZXR0aW5nLkxhcmtIABI2CghkaW5ndGFsaxgGIAEoCzIiLmJ5dGViYXNlLnYxLkFwcElNU2V0dGluZy5EaW5nVGFsa0gAQgkKB3BheWxvYWQikAQKF1dvcmtzcGFjZVByb2ZpbGVTZXR0aW5nEhQKDGV4dGVybmFsX3VybBgBIAEoCRIXCg9kaXNhbGxvd19zaWdudXAYAiABKAgSEwoLcmVxdWlyZV8yZmEYAyABKAgSMQoOdG9rZW5fZHVyYXRpb24YBiABKAsyGS5nb29nbGUucHJvdG9idWYuRHVyYXRpb24SLwoMYW5ub3VuY2VtZW50GAcgASgLMhkuYnl0ZWJhc2UudjEuQW5ub3VuY2VtZW50EjoKF21heGltdW1fcm9sZV9leHBpcmF0aW9uGAggASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uEg8KB2RvbWFpbnMYCSADKAkSHwoXZW5mb3JjZV9pZGVudGl0eV9kb21haW4YCiABKAgSPQoUZGF0YWJhc2VfY2hhbmdlX21vZGUYCyABKA4yHy5ieXRlYmFzZS52MS5EYXRhYmFzZUNoYW5nZU1vZGUSIAoYZGlzYWxsb3dfcGFzc3dvcmRfc2lnbmluGAwgASgIEiAKGGVuYWJsZV9tZXRyaWNfY29sbGVjdGlvbhgNIAEoCBI7ChhpbmFjdGl2ZV9zZXNzaW9uX3RpbWVvdXQYDiABKAsyGS5nb29nbGUucHJvdG9idWYuRHVyYXRpb24SHwoXZW5hYmxlX2F1ZGl0X2xvZ19zdGRvdXQYDyABKAgirwEKDEFubm91bmNlbWVudBIzCgVsZXZlbBgBIAEoDjIkLmJ5dGViYXNlLnYxLkFubm91bmNlbWVudC5BbGVydExldmVsEgwKBHRleHQYAiABKAkSDAoEbGluaxgDIAEoCSJOCgpBbGVydExldmVsEhsKF0FMRVJUX0xFVkVMX1VOU1BFQ0lGSUVEEAASCAoESU5GTxABEgsKB1dBUk5JTkcQAhIMCghDUklUSUNBTBADIucCChhXb3Jrc3BhY2VBcHByb3ZhbFNldHRpbmcSOQoFcnVsZXMYASADKAsyKi5ieXRlYmFzZS52MS5Xb3Jrc3BhY2VBcHByb3ZhbFNldHRpbmcuUnVsZRqPAgoEUnVsZRIvCgh0ZW1wbGF0ZRgBIAEoCzIdLmJ5dGViYXNlLnYxLkFwcHJvdmFsVGVtcGxhdGUSJAoJY29uZGl0aW9uGAIgASgLMhEuZ29vZ2xlLnR5cGUuRXhwchJBCgZzb3VyY2UYAyABKA4yMS5ieXRlYmFzZS52MS5Xb3Jrc3BhY2VBcHByb3ZhbFNldHRpbmcuUnVsZS5Tb3VyY2UibQoGU291cmNlEhYKElNPVVJDRV9VTlNQRUNJRklFRBAAEhMKD0NIQU5HRV9EQVRBQkFTRRABEhMKD0NSRUFURV9EQVRBQkFTRRACEg8KC0VYUE9SVF9EQVRBEAMSEAoMUkVRVUVTVF9ST0xFEAQioAUKFVNjaGVtYVRlbXBsYXRlU2V0dGluZxJJCg9maWVsZF90ZW1wbGF0ZXMYASADKAsyMC5ieXRlYmFzZS52MS5TY2hlbWFUZW1wbGF0ZVNldHRpbmcuRmllbGRUZW1wbGF0ZRJDCgxjb2x1bW5fdHlwZXMYAiADKAsyLS5ieXRlYmFzZS52MS5TY2hlbWFUZW1wbGF0ZVNldHRpbmcuQ29sdW1uVHlwZRJJCg90YWJsZV90ZW1wbGF0ZXMYAyADKAsyMC5ieXRlYmFzZS52MS5TY2hlbWFUZW1wbGF0ZVNldHRpbmcuVGFibGVUZW1wbGF0ZRqsAQoNRmllbGRUZW1wbGF0ZRIKCgJpZBgBIAEoCRIjCgZlbmdpbmUYAiABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSEAoIY2F0ZWdvcnkYAyABKAkSKwoGY29sdW1uGAQgASgLMhsuYnl0ZWJhc2UudjEuQ29sdW1uTWV0YWRhdGESKwoHY2F0YWxvZxgFIAEoCzIaLmJ5dGViYXNlLnYxLkNvbHVtbkNhdGFsb2caUQoKQ29sdW1uVHlwZRIjCgZlbmdpbmUYASABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSDwoHZW5hYmxlZBgCIAEoCBINCgV0eXBlcxgDIAMoCRqpAQoNVGFibGVUZW1wbGF0ZRIKCgJpZBgBIAEoCRIjCgZlbmdpbmUYAiABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUSEAoIY2F0ZWdvcnkYAyABKAkSKQoFdGFibGUYBCABKAsyGi5ieXRlYmFzZS52MS5UYWJsZU1ldGFkYXRhEioKB2NhdGFsb2cYBSABKAsyGS5ieXRlYmFzZS52MS5UYWJsZUNhdGFsb2cimAUKGURhdGFDbGFzc2lmaWNhdGlvblNldHRpbmcSUAoHY29uZmlncxgBIAMoCzI/LmJ5dGViYXNlLnYxLkRhdGFDbGFzc2lmaWNhdGlvblNldHRpbmcuRGF0YUNsYXNzaWZpY2F0aW9uQ29uZmlnGqgEChhEYXRhQ2xhc3NpZmljYXRpb25Db25maWcSCgoCaWQYASABKAkSDQoFdGl0bGUYAiABKAkSVQoGbGV2ZWxzGAMgAygLMkUuYnl0ZWJhc2UudjEuRGF0YUNsYXNzaWZpY2F0aW9uU2V0dGluZy5EYXRhQ2xhc3NpZmljYXRpb25Db25maWcuTGV2ZWwSawoOY2xhc3NpZmljYXRpb24YBCADKAsyUy5ieXRlYmFzZS52MS5EYXRhQ2xhc3NpZmljYXRpb25TZXR0aW5nLkRhdGFDbGFzc2lmaWNhdGlvbkNvbmZpZy5DbGFzc2lmaWNhdGlvbkVudHJ5GjcKBUxldmVsEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEhMKC2Rlc2NyaXB0aW9uGAMgASgJGmgKEkRhdGFDbGFzc2lmaWNhdGlvbhIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCRIVCghsZXZlbF9pZBgEIAEoCUgAiAEBQgsKCV9sZXZlbF9pZBqJAQoTQ2xhc3NpZmljYXRpb25FbnRyeRILCgNrZXkYASABKAkSYQoFdmFsdWUYAiABKAsyUi5ieXRlYmFzZS52MS5EYXRhQ2xhc3NpZmljYXRpb25TZXR0aW5nLkRhdGFDbGFzc2lmaWNhdGlvbkNvbmZpZy5EYXRhQ2xhc3NpZmljYXRpb246AjgBIswBChNTZW1hbnRpY1R5cGVTZXR0aW5nEjwKBXR5cGVzGAEgAygLMi0uYnl0ZWJhc2UudjEuU2VtYW50aWNUeXBlU2V0dGluZy5TZW1hbnRpY1R5cGUadwoMU2VtYW50aWNUeXBlEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEhMKC2Rlc2NyaXB0aW9uGAMgASgJEikKCWFsZ29yaXRobRgGIAEoCzIWLmJ5dGViYXNlLnYxLkFsZ29yaXRobRIMCgRpY29uGAcgASgJIv8ECglBbGdvcml0aG0SNAoJZnVsbF9tYXNrGAUgASgLMh8uYnl0ZWJhc2UudjEuQWxnb3JpdGhtLkZ1bGxNYXNrSAASNgoKcmFuZ2VfbWFzaxgGIAEoCzIgLmJ5dGViYXNlLnYxLkFsZ29yaXRobS5SYW5nZU1hc2tIABIyCghtZDVfbWFzaxgHIAEoCzIeLmJ5dGViYXNlLnYxLkFsZ29yaXRobS5NRDVNYXNrSAASQQoQaW5uZXJfb3V0ZXJfbWFzaxgIIAEoCzIlLmJ5dGViYXNlLnYxLkFsZ29yaXRobS5Jbm5lck91dGVyTWFza0gAGiAKCEZ1bGxNYXNrEhQKDHN1YnN0aXR1dGlvbhgBIAEoCRp+CglSYW5nZU1hc2sSNgoGc2xpY2VzGAEgAygLMiYuYnl0ZWJhc2UudjEuQWxnb3JpdGhtLlJhbmdlTWFzay5TbGljZRo5CgVTbGljZRINCgVzdGFydBgBIAEoBRILCgNlbmQYAiABKAUSFAoMc3Vic3RpdHV0aW9uGAMgASgJGhcKB01ENU1hc2sSDAoEc2FsdBgBIAEoCRrJAQoOSW5uZXJPdXRlck1hc2sSEgoKcHJlZml4X2xlbhgBIAEoBRISCgpzdWZmaXhfbGVuGAIgASgFEjwKBHR5cGUYAyABKA4yLi5ieXRlYmFzZS52MS5BbGdvcml0aG0uSW5uZXJPdXRlck1hc2suTWFza1R5cGUSFAoMc3Vic3RpdHV0aW9uGAQgASgJIjsKCE1hc2tUeXBlEhkKFU1BU0tfVFlQRV9VTlNQRUNJRklFRBAAEgkKBUlOTkVSEAESCQoFT1VURVIQAkIGCgRtYXNrIhwKC1NDSU1TZXR0aW5nEg0KBXRva2VuGAEgASgJIosCChpQYXNzd29yZFJlc3RyaWN0aW9uU2V0dGluZxISCgptaW5fbGVuZ3RoGAEgASgFEhYKDnJlcXVpcmVfbnVtYmVyGAIgASgIEhYKDnJlcXVpcmVfbGV0dGVyGAMgASgIEiAKGHJlcXVpcmVfdXBwZXJjYXNlX2xldHRlchgEIAEoCBIhChlyZXF1aXJlX3NwZWNpYWxfY2hhcmFjdGVyGAUgASgIEi4KJnJlcXVpcmVfcmVzZXRfcGFzc3dvcmRfZm9yX2ZpcnN0X2xvZ2luGAYgASgIEjQKEXBhc3N3b3JkX3JvdGF0aW9uGAcgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uIu8BCglBSVNldHRpbmcSDwoHZW5hYmxlZBgBIAEoCBIxCghwcm92aWRlchgCIAEoDjIfLmJ5dGViYXNlLnYxLkFJU2V0dGluZy5Qcm92aWRlchIQCghlbmRwb2ludBgDIAEoCRIPCgdhcGlfa2V5GAQgASgJEg0KBW1vZGVsGAUgASgJEg8KB3ZlcnNpb24YBiABKAkiWwoIUHJvdmlkZXISGAoUUFJPVklERVJfVU5TUEVDSUZJRUQQABILCgdPUEVOX0FJEAESCgoGQ0xBVURFEAISCgoGR0VNSU5JEAMSEAoMQVpVUkVfT1BFTkFJEAQilgIKEkVudmlyb25tZW50U2V0dGluZxJBCgxlbnZpcm9ubWVudHMYASADKAsyKy5ieXRlYmFzZS52MS5FbnZpcm9ubWVudFNldHRpbmcuRW52aXJvbm1lbnQavAEKC0Vudmlyb25tZW50EhEKBG5hbWUYASABKAlCA+BBAxIKCgJpZBgCIAEoCRINCgV0aXRsZRgDIAEoCRJDCgR0YWdzGAQgAygLMjUuYnl0ZWJhc2UudjEuRW52aXJvbm1lbnRTZXR0aW5nLkVudmlyb25tZW50LlRhZ3NFbnRyeRINCgVjb2xvchgFIAEoCRorCglUYWdzRW50cnkSCwoDa2V5GAEgASgJEg0KBXZhbHVlGAIgASgJOgI4ASpUChJEYXRhYmFzZUNoYW5nZU1vZGUSJAogREFUQUJBU0VfQ0hBTkdFX01PREVfVU5TUEVDSUZJRUQQABIMCghQSVBFTElORRABEgoKBkVESVRPUhACMq4DCg5TZXR0aW5nU2VydmljZRKEAQoMTGlzdFNldHRpbmdzEiAuYnl0ZWJhc2UudjEuTGlzdFNldHRpbmdzUmVxdWVzdBohLmJ5dGViYXNlLnYxLkxpc3RTZXR0aW5nc1Jlc3BvbnNlIi/aQQCK6jAQYmIuc2V0dGluZ3MubGlzdJDqMAGC0+STAg4SDC92MS9zZXR0aW5ncxJ/CgpHZXRTZXR0aW5nEh4uYnl0ZWJhc2UudjEuR2V0U2V0dGluZ1JlcXVlc3QaFC5ieXRlYmFzZS52MS5TZXR0aW5nIjvaQQRuYW1liuowD2JiLnNldHRpbmdzLmdldJDqMAGC0+STAhcSFS92MS97bmFtZT1zZXR0aW5ncy8qfRKTAQoNVXBkYXRlU2V0dGluZxIhLmJ5dGViYXNlLnYxLlVwZGF0ZVNldHRpbmdSZXF1ZXN0GhQuYnl0ZWJhc2UudjEuU2V0dGluZyJJiuowD2JiLnNldHRpbmdzLnNldJDqMAGY6jABgtPkkwIoOgdzZXR0aW5nMh0vdjEve3NldHRpbmcubmFtZT1zZXR0aW5ncy8qfUKpAQoPY29tLmJ5dGViYXNlLnYxQhNTZXR0aW5nU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_duration, file_google_protobuf_field_mask, file_google_type_expr, file_v1_annotation, file_v1_common, file_v1_database_catalog_service, file_v1_database_service, file_v1_issue_service, file_v1_project_service]);
+ fileDesc("Chh2MS9zZXR0aW5nX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIhUKE0xpc3RTZXR0aW5nc1JlcXVlc3QiPgoUTGlzdFNldHRpbmdzUmVzcG9uc2USJgoIc2V0dGluZ3MYASADKAsyFC5ieXRlYmFzZS52MS5TZXR0aW5nIj8KEUdldFNldHRpbmdSZXF1ZXN0EioKBG5hbWUYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1NldHRpbmciOwoSR2V0U2V0dGluZ1Jlc3BvbnNlEiUKB3NldHRpbmcYASABKAsyFC5ieXRlYmFzZS52MS5TZXR0aW5nIqEBChRVcGRhdGVTZXR0aW5nUmVxdWVzdBIqCgdzZXR0aW5nGAEgASgLMhQuYnl0ZWJhc2UudjEuU2V0dGluZ0ID4EECEhUKDXZhbGlkYXRlX29ubHkYAiABKAgSFQoNYWxsb3dfbWlzc2luZxgDIAEoCBIvCgt1cGRhdGVfbWFzaxgEIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2siqwMKB1NldHRpbmcSDAoEbmFtZRgBIAEoCRIhCgV2YWx1ZRgCIAEoCzISLmJ5dGViYXNlLnYxLlZhbHVlIrkCCgtTZXR0aW5nTmFtZRIcChhTRVRUSU5HX05BTUVfVU5TUEVDSUZJRUQQABIPCgtBVVRIX1NFQ1JFVBABEhEKDUJSQU5ESU5HX0xPR08QAhIQCgxXT1JLU1BBQ0VfSUQQAxIVChFXT1JLU1BBQ0VfUFJPRklMRRAEEhYKEldPUktTUEFDRV9BUFBST1ZBTBAFEhYKEkVOVEVSUFJJU0VfTElDRU5TRRAHEgoKBkFQUF9JTRAIEg0KCVdBVEVSTUFSSxAJEgYKAkFJEAoSFwoTREFUQV9DTEFTU0lGSUNBVElPThAOEhIKDlNFTUFOVElDX1RZUEVTEA8SCAoEU0NJTRAREhgKFFBBU1NXT1JEX1JFU1RSSUNUSU9OEBISDwoLRU5WSVJPTk1FTlQQEyIECAYQBiIECA0QDTot6kEqChRieXRlYmFzZS5jb20vU2V0dGluZxISc2V0dGluZ3Mve3NldHRpbmd9SgQIEBARIqIFCgVWYWx1ZRIWCgxzdHJpbmdfdmFsdWUYASABKAlIABI5ChRhcHBfaW1fc2V0dGluZ192YWx1ZRgDIAEoCzIZLmJ5dGViYXNlLnYxLkFwcElNU2V0dGluZ0gAEk8KH3dvcmtzcGFjZV9wcm9maWxlX3NldHRpbmdfdmFsdWUYBSABKAsyJC5ieXRlYmFzZS52MS5Xb3Jrc3BhY2VQcm9maWxlU2V0dGluZ0gAElEKIHdvcmtzcGFjZV9hcHByb3ZhbF9zZXR0aW5nX3ZhbHVlGAYgASgLMiUuYnl0ZWJhc2UudjEuV29ya3NwYWNlQXBwcm92YWxTZXR0aW5nSAASUwohZGF0YV9jbGFzc2lmaWNhdGlvbl9zZXR0aW5nX3ZhbHVlGAogASgLMiYuYnl0ZWJhc2UudjEuRGF0YUNsYXNzaWZpY2F0aW9uU2V0dGluZ0gAEkcKG3NlbWFudGljX3R5cGVfc2V0dGluZ192YWx1ZRgLIAEoCzIgLmJ5dGViYXNlLnYxLlNlbWFudGljVHlwZVNldHRpbmdIABIwCgxzY2ltX3NldHRpbmcYDiABKAsyGC5ieXRlYmFzZS52MS5TQ0lNU2V0dGluZ0gAEk8KHHBhc3N3b3JkX3Jlc3RyaWN0aW9uX3NldHRpbmcYDyABKAsyJy5ieXRlYmFzZS52MS5QYXNzd29yZFJlc3RyaWN0aW9uU2V0dGluZ0gAEiwKCmFpX3NldHRpbmcYECABKAsyFi5ieXRlYmFzZS52MS5BSVNldHRpbmdIABI+ChNlbnZpcm9ubWVudF9zZXR0aW5nGBEgASgLMh8uYnl0ZWJhc2UudjEuRW52aXJvbm1lbnRTZXR0aW5nSABCBwoFdmFsdWVKBAgSEBNKBAgJEAoitgUKDEFwcElNU2V0dGluZxI1CghzZXR0aW5ncxgBIAMoCzIjLmJ5dGViYXNlLnYxLkFwcElNU2V0dGluZy5JTVNldHRpbmcaGwoFU2xhY2sSEgoFdG9rZW4YASABKAlCA+BBBBo2CgZGZWlzaHUSEwoGYXBwX2lkGAEgASgJQgPgQQQSFwoKYXBwX3NlY3JldBgCIAEoCUID4EEEGkkKBVdlY29tEhQKB2NvcnBfaWQYASABKAlCA+BBBBIVCghhZ2VudF9pZBgCIAEoCUID4EEEEhMKBnNlY3JldBgDIAEoCUID4EEEGjQKBExhcmsSEwoGYXBwX2lkGAEgASgJQgPgQQQSFwoKYXBwX3NlY3JldBgCIAEoCUID4EEEGlcKCERpbmdUYWxrEhYKCWNsaWVudF9pZBgBIAEoCUID4EEEEhoKDWNsaWVudF9zZWNyZXQYAiABKAlCA+BBBBIXCgpyb2JvdF9jb2RlGAMgASgJQgPgQQQavwIKCUlNU2V0dGluZxInCgR0eXBlGAEgASgOMhkuYnl0ZWJhc2UudjEuV2ViaG9vay5UeXBlEjAKBXNsYWNrGAIgASgLMh8uYnl0ZWJhc2UudjEuQXBwSU1TZXR0aW5nLlNsYWNrSAASMgoGZmVpc2h1GAMgASgLMiAuYnl0ZWJhc2UudjEuQXBwSU1TZXR0aW5nLkZlaXNodUgAEjAKBXdlY29tGAQgASgLMh8uYnl0ZWJhc2UudjEuQXBwSU1TZXR0aW5nLldlY29tSAASLgoEbGFyaxgFIAEoCzIeLmJ5dGViYXNlLnYxLkFwcElNU2V0dGluZy5MYXJrSAASNgoIZGluZ3RhbGsYBiABKAsyIi5ieXRlYmFzZS52MS5BcHBJTVNldHRpbmcuRGluZ1RhbGtIAEIJCgdwYXlsb2FkIpAEChdXb3Jrc3BhY2VQcm9maWxlU2V0dGluZxIUCgxleHRlcm5hbF91cmwYASABKAkSFwoPZGlzYWxsb3dfc2lnbnVwGAIgASgIEhMKC3JlcXVpcmVfMmZhGAMgASgIEjEKDnRva2VuX2R1cmF0aW9uGAYgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uEi8KDGFubm91bmNlbWVudBgHIAEoCzIZLmJ5dGViYXNlLnYxLkFubm91bmNlbWVudBI6ChdtYXhpbXVtX3JvbGVfZXhwaXJhdGlvbhgIIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbhIPCgdkb21haW5zGAkgAygJEh8KF2VuZm9yY2VfaWRlbnRpdHlfZG9tYWluGAogASgIEj0KFGRhdGFiYXNlX2NoYW5nZV9tb2RlGAsgASgOMh8uYnl0ZWJhc2UudjEuRGF0YWJhc2VDaGFuZ2VNb2RlEiAKGGRpc2FsbG93X3Bhc3N3b3JkX3NpZ25pbhgMIAEoCBIgChhlbmFibGVfbWV0cmljX2NvbGxlY3Rpb24YDSABKAgSOwoYaW5hY3RpdmVfc2Vzc2lvbl90aW1lb3V0GA4gASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uEh8KF2VuYWJsZV9hdWRpdF9sb2dfc3Rkb3V0GA8gASgIIq8BCgxBbm5vdW5jZW1lbnQSMwoFbGV2ZWwYASABKA4yJC5ieXRlYmFzZS52MS5Bbm5vdW5jZW1lbnQuQWxlcnRMZXZlbBIMCgR0ZXh0GAIgASgJEgwKBGxpbmsYAyABKAkiTgoKQWxlcnRMZXZlbBIbChdBTEVSVF9MRVZFTF9VTlNQRUNJRklFRBAAEggKBElORk8QARILCgdXQVJOSU5HEAISDAoIQ1JJVElDQUwQAyLnAgoYV29ya3NwYWNlQXBwcm92YWxTZXR0aW5nEjkKBXJ1bGVzGAEgAygLMiouYnl0ZWJhc2UudjEuV29ya3NwYWNlQXBwcm92YWxTZXR0aW5nLlJ1bGUajwIKBFJ1bGUSLwoIdGVtcGxhdGUYASABKAsyHS5ieXRlYmFzZS52MS5BcHByb3ZhbFRlbXBsYXRlEiQKCWNvbmRpdGlvbhgCIAEoCzIRLmdvb2dsZS50eXBlLkV4cHISQQoGc291cmNlGAMgASgOMjEuYnl0ZWJhc2UudjEuV29ya3NwYWNlQXBwcm92YWxTZXR0aW5nLlJ1bGUuU291cmNlIm0KBlNvdXJjZRIWChJTT1VSQ0VfVU5TUEVDSUZJRUQQABITCg9DSEFOR0VfREFUQUJBU0UQARITCg9DUkVBVEVfREFUQUJBU0UQAhIPCgtFWFBPUlRfREFUQRADEhAKDFJFUVVFU1RfUk9MRRAEIpgFChlEYXRhQ2xhc3NpZmljYXRpb25TZXR0aW5nElAKB2NvbmZpZ3MYASADKAsyPy5ieXRlYmFzZS52MS5EYXRhQ2xhc3NpZmljYXRpb25TZXR0aW5nLkRhdGFDbGFzc2lmaWNhdGlvbkNvbmZpZxqoBAoYRGF0YUNsYXNzaWZpY2F0aW9uQ29uZmlnEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJElUKBmxldmVscxgDIAMoCzJFLmJ5dGViYXNlLnYxLkRhdGFDbGFzc2lmaWNhdGlvblNldHRpbmcuRGF0YUNsYXNzaWZpY2F0aW9uQ29uZmlnLkxldmVsEmsKDmNsYXNzaWZpY2F0aW9uGAQgAygLMlMuYnl0ZWJhc2UudjEuRGF0YUNsYXNzaWZpY2F0aW9uU2V0dGluZy5EYXRhQ2xhc3NpZmljYXRpb25Db25maWcuQ2xhc3NpZmljYXRpb25FbnRyeRo3CgVMZXZlbBIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCRpoChJEYXRhQ2xhc3NpZmljYXRpb24SCgoCaWQYASABKAkSDQoFdGl0bGUYAiABKAkSEwoLZGVzY3JpcHRpb24YAyABKAkSFQoIbGV2ZWxfaWQYBCABKAlIAIgBAUILCglfbGV2ZWxfaWQaiQEKE0NsYXNzaWZpY2F0aW9uRW50cnkSCwoDa2V5GAEgASgJEmEKBXZhbHVlGAIgASgLMlIuYnl0ZWJhc2UudjEuRGF0YUNsYXNzaWZpY2F0aW9uU2V0dGluZy5EYXRhQ2xhc3NpZmljYXRpb25Db25maWcuRGF0YUNsYXNzaWZpY2F0aW9uOgI4ASLMAQoTU2VtYW50aWNUeXBlU2V0dGluZxI8CgV0eXBlcxgBIAMoCzItLmJ5dGViYXNlLnYxLlNlbWFudGljVHlwZVNldHRpbmcuU2VtYW50aWNUeXBlGncKDFNlbWFudGljVHlwZRIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCRIpCglhbGdvcml0aG0YBiABKAsyFi5ieXRlYmFzZS52MS5BbGdvcml0aG0SDAoEaWNvbhgHIAEoCSL/BAoJQWxnb3JpdGhtEjQKCWZ1bGxfbWFzaxgFIAEoCzIfLmJ5dGViYXNlLnYxLkFsZ29yaXRobS5GdWxsTWFza0gAEjYKCnJhbmdlX21hc2sYBiABKAsyIC5ieXRlYmFzZS52MS5BbGdvcml0aG0uUmFuZ2VNYXNrSAASMgoIbWQ1X21hc2sYByABKAsyHi5ieXRlYmFzZS52MS5BbGdvcml0aG0uTUQ1TWFza0gAEkEKEGlubmVyX291dGVyX21hc2sYCCABKAsyJS5ieXRlYmFzZS52MS5BbGdvcml0aG0uSW5uZXJPdXRlck1hc2tIABogCghGdWxsTWFzaxIUCgxzdWJzdGl0dXRpb24YASABKAkafgoJUmFuZ2VNYXNrEjYKBnNsaWNlcxgBIAMoCzImLmJ5dGViYXNlLnYxLkFsZ29yaXRobS5SYW5nZU1hc2suU2xpY2UaOQoFU2xpY2USDQoFc3RhcnQYASABKAUSCwoDZW5kGAIgASgFEhQKDHN1YnN0aXR1dGlvbhgDIAEoCRoXCgdNRDVNYXNrEgwKBHNhbHQYASABKAkayQEKDklubmVyT3V0ZXJNYXNrEhIKCnByZWZpeF9sZW4YASABKAUSEgoKc3VmZml4X2xlbhgCIAEoBRI8CgR0eXBlGAMgASgOMi4uYnl0ZWJhc2UudjEuQWxnb3JpdGhtLklubmVyT3V0ZXJNYXNrLk1hc2tUeXBlEhQKDHN1YnN0aXR1dGlvbhgEIAEoCSI7CghNYXNrVHlwZRIZChVNQVNLX1RZUEVfVU5TUEVDSUZJRUQQABIJCgVJTk5FUhABEgkKBU9VVEVSEAJCBgoEbWFzayIcCgtTQ0lNU2V0dGluZxINCgV0b2tlbhgBIAEoCSKLAgoaUGFzc3dvcmRSZXN0cmljdGlvblNldHRpbmcSEgoKbWluX2xlbmd0aBgBIAEoBRIWCg5yZXF1aXJlX251bWJlchgCIAEoCBIWCg5yZXF1aXJlX2xldHRlchgDIAEoCBIgChhyZXF1aXJlX3VwcGVyY2FzZV9sZXR0ZXIYBCABKAgSIQoZcmVxdWlyZV9zcGVjaWFsX2NoYXJhY3RlchgFIAEoCBIuCiZyZXF1aXJlX3Jlc2V0X3Bhc3N3b3JkX2Zvcl9maXJzdF9sb2dpbhgGIAEoCBI0ChFwYXNzd29yZF9yb3RhdGlvbhgHIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbiLvAQoJQUlTZXR0aW5nEg8KB2VuYWJsZWQYASABKAgSMQoIcHJvdmlkZXIYAiABKA4yHy5ieXRlYmFzZS52MS5BSVNldHRpbmcuUHJvdmlkZXISEAoIZW5kcG9pbnQYAyABKAkSDwoHYXBpX2tleRgEIAEoCRINCgVtb2RlbBgFIAEoCRIPCgd2ZXJzaW9uGAYgASgJIlsKCFByb3ZpZGVyEhgKFFBST1ZJREVSX1VOU1BFQ0lGSUVEEAASCwoHT1BFTl9BSRABEgoKBkNMQVVERRACEgoKBkdFTUlOSRADEhAKDEFaVVJFX09QRU5BSRAEIpYCChJFbnZpcm9ubWVudFNldHRpbmcSQQoMZW52aXJvbm1lbnRzGAEgAygLMisuYnl0ZWJhc2UudjEuRW52aXJvbm1lbnRTZXR0aW5nLkVudmlyb25tZW50GrwBCgtFbnZpcm9ubWVudBIRCgRuYW1lGAEgASgJQgPgQQMSCgoCaWQYAiABKAkSDQoFdGl0bGUYAyABKAkSQwoEdGFncxgEIAMoCzI1LmJ5dGViYXNlLnYxLkVudmlyb25tZW50U2V0dGluZy5FbnZpcm9ubWVudC5UYWdzRW50cnkSDQoFY29sb3IYBSABKAkaKwoJVGFnc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEqVAoSRGF0YWJhc2VDaGFuZ2VNb2RlEiQKIERBVEFCQVNFX0NIQU5HRV9NT0RFX1VOU1BFQ0lGSUVEEAASDAoIUElQRUxJTkUQARIKCgZFRElUT1IQAjKuAwoOU2V0dGluZ1NlcnZpY2UShAEKDExpc3RTZXR0aW5ncxIgLmJ5dGViYXNlLnYxLkxpc3RTZXR0aW5nc1JlcXVlc3QaIS5ieXRlYmFzZS52MS5MaXN0U2V0dGluZ3NSZXNwb25zZSIv2kEAiuowEGJiLnNldHRpbmdzLmxpc3SQ6jABgtPkkwIOEgwvdjEvc2V0dGluZ3MSfwoKR2V0U2V0dGluZxIeLmJ5dGViYXNlLnYxLkdldFNldHRpbmdSZXF1ZXN0GhQuYnl0ZWJhc2UudjEuU2V0dGluZyI72kEEbmFtZYrqMA9iYi5zZXR0aW5ncy5nZXSQ6jABgtPkkwIXEhUvdjEve25hbWU9c2V0dGluZ3MvKn0SkwEKDVVwZGF0ZVNldHRpbmcSIS5ieXRlYmFzZS52MS5VcGRhdGVTZXR0aW5nUmVxdWVzdBoULmJ5dGViYXNlLnYxLlNldHRpbmciSYrqMA9iYi5zZXR0aW5ncy5zZXSQ6jABmOowAYLT5JMCKDoHc2V0dGluZzIdL3YxL3tzZXR0aW5nLm5hbWU9c2V0dGluZ3MvKn1CqQEKD2NvbS5ieXRlYmFzZS52MUITU2V0dGluZ1NlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_duration, file_google_protobuf_field_mask, file_google_type_expr, file_v1_annotation, file_v1_issue_service, file_v1_project_service]);
/**
* Describes the message bytebase.v1.ListSettingsRequest.
@@ -186,123 +183,95 @@ export const WorkspaceApprovalSetting_Rule_SourceSchema = /*@__PURE__*/
export const WorkspaceApprovalSetting_Rule_Source = /*@__PURE__*/
tsEnum(WorkspaceApprovalSetting_Rule_SourceSchema);
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.
- * Use `create(SchemaTemplateSettingSchema)` to create a new message.
- */
-export const SchemaTemplateSettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 11);
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.FieldTemplate.
- * Use `create(SchemaTemplateSetting_FieldTemplateSchema)` to create a new message.
- */
-export const SchemaTemplateSetting_FieldTemplateSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 11, 0);
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.ColumnType.
- * Use `create(SchemaTemplateSetting_ColumnTypeSchema)` to create a new message.
- */
-export const SchemaTemplateSetting_ColumnTypeSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 11, 1);
-
-/**
- * Describes the message bytebase.v1.SchemaTemplateSetting.TableTemplate.
- * Use `create(SchemaTemplateSetting_TableTemplateSchema)` to create a new message.
- */
-export const SchemaTemplateSetting_TableTemplateSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 11, 2);
-
/**
* Describes the message bytebase.v1.DataClassificationSetting.
* Use `create(DataClassificationSettingSchema)` to create a new message.
*/
export const DataClassificationSettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 12);
+ messageDesc(file_v1_setting_service, 11);
/**
* Describes the message bytebase.v1.DataClassificationSetting.DataClassificationConfig.
* Use `create(DataClassificationSetting_DataClassificationConfigSchema)` to create a new message.
*/
export const DataClassificationSetting_DataClassificationConfigSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 12, 0);
+ messageDesc(file_v1_setting_service, 11, 0);
/**
* Describes the message bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level.
* Use `create(DataClassificationSetting_DataClassificationConfig_LevelSchema)` to create a new message.
*/
export const DataClassificationSetting_DataClassificationConfig_LevelSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 12, 0, 0);
+ messageDesc(file_v1_setting_service, 11, 0, 0);
/**
* Describes the message bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification.
* Use `create(DataClassificationSetting_DataClassificationConfig_DataClassificationSchema)` to create a new message.
*/
export const DataClassificationSetting_DataClassificationConfig_DataClassificationSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 12, 0, 1);
+ messageDesc(file_v1_setting_service, 11, 0, 1);
/**
* Describes the message bytebase.v1.SemanticTypeSetting.
* Use `create(SemanticTypeSettingSchema)` to create a new message.
*/
export const SemanticTypeSettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 13);
+ messageDesc(file_v1_setting_service, 12);
/**
* Describes the message bytebase.v1.SemanticTypeSetting.SemanticType.
* Use `create(SemanticTypeSetting_SemanticTypeSchema)` to create a new message.
*/
export const SemanticTypeSetting_SemanticTypeSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 13, 0);
+ messageDesc(file_v1_setting_service, 12, 0);
/**
* Describes the message bytebase.v1.Algorithm.
* Use `create(AlgorithmSchema)` to create a new message.
*/
export const AlgorithmSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 14);
+ messageDesc(file_v1_setting_service, 13);
/**
* Describes the message bytebase.v1.Algorithm.FullMask.
* Use `create(Algorithm_FullMaskSchema)` to create a new message.
*/
export const Algorithm_FullMaskSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 14, 0);
+ messageDesc(file_v1_setting_service, 13, 0);
/**
* Describes the message bytebase.v1.Algorithm.RangeMask.
* Use `create(Algorithm_RangeMaskSchema)` to create a new message.
*/
export const Algorithm_RangeMaskSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 14, 1);
+ messageDesc(file_v1_setting_service, 13, 1);
/**
* Describes the message bytebase.v1.Algorithm.RangeMask.Slice.
* Use `create(Algorithm_RangeMask_SliceSchema)` to create a new message.
*/
export const Algorithm_RangeMask_SliceSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 14, 1, 0);
+ messageDesc(file_v1_setting_service, 13, 1, 0);
/**
* Describes the message bytebase.v1.Algorithm.MD5Mask.
* Use `create(Algorithm_MD5MaskSchema)` to create a new message.
*/
export const Algorithm_MD5MaskSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 14, 2);
+ messageDesc(file_v1_setting_service, 13, 2);
/**
* Describes the message bytebase.v1.Algorithm.InnerOuterMask.
* Use `create(Algorithm_InnerOuterMaskSchema)` to create a new message.
*/
export const Algorithm_InnerOuterMaskSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 14, 3);
+ messageDesc(file_v1_setting_service, 13, 3);
/**
* Describes the enum bytebase.v1.Algorithm.InnerOuterMask.MaskType.
*/
export const Algorithm_InnerOuterMask_MaskTypeSchema = /*@__PURE__*/
- enumDesc(file_v1_setting_service, 14, 3, 0);
+ enumDesc(file_v1_setting_service, 13, 3, 0);
/**
* @generated from enum bytebase.v1.Algorithm.InnerOuterMask.MaskType
@@ -315,27 +284,27 @@ export const Algorithm_InnerOuterMask_MaskType = /*@__PURE__*/
* Use `create(SCIMSettingSchema)` to create a new message.
*/
export const SCIMSettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 15);
+ messageDesc(file_v1_setting_service, 14);
/**
* Describes the message bytebase.v1.PasswordRestrictionSetting.
* Use `create(PasswordRestrictionSettingSchema)` to create a new message.
*/
export const PasswordRestrictionSettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 16);
+ messageDesc(file_v1_setting_service, 15);
/**
* Describes the message bytebase.v1.AISetting.
* Use `create(AISettingSchema)` to create a new message.
*/
export const AISettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 17);
+ messageDesc(file_v1_setting_service, 16);
/**
* Describes the enum bytebase.v1.AISetting.Provider.
*/
export const AISetting_ProviderSchema = /*@__PURE__*/
- enumDesc(file_v1_setting_service, 17, 0);
+ enumDesc(file_v1_setting_service, 16, 0);
/**
* @generated from enum bytebase.v1.AISetting.Provider
@@ -348,14 +317,14 @@ export const AISetting_Provider = /*@__PURE__*/
* Use `create(EnvironmentSettingSchema)` to create a new message.
*/
export const EnvironmentSettingSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 18);
+ messageDesc(file_v1_setting_service, 17);
/**
* Describes the message bytebase.v1.EnvironmentSetting.Environment.
* Use `create(EnvironmentSetting_EnvironmentSchema)` to create a new message.
*/
export const EnvironmentSetting_EnvironmentSchema = /*@__PURE__*/
- messageDesc(file_v1_setting_service, 18, 0);
+ messageDesc(file_v1_setting_service, 17, 0);
/**
* Describes the enum bytebase.v1.DatabaseChangeMode.
diff --git a/frontend/src/utils/useDashboardSidebar.ts b/frontend/src/utils/useDashboardSidebar.ts
index a19492ae35..8770ec5c0e 100644
--- a/frontend/src/utils/useDashboardSidebar.ts
+++ b/frontend/src/utils/useDashboardSidebar.ts
@@ -30,7 +30,6 @@ import {
WORKSPACE_ROUTE_LANDING,
WORKSPACE_ROUTE_MEMBERS,
WORKSPACE_ROUTE_ROLES,
- WORKSPACE_ROUTE_SCHEMA_TEMPLATE,
WORKSPACE_ROUTE_SEMANTIC_TYPES,
WORKSPACE_ROUTE_SQL_REVIEW,
WORKSPACE_ROUTE_USER_PROFILE,
@@ -199,11 +198,6 @@ export const useDashboardSidebar = () => {
name: WORKSPACE_ROUTE_CUSTOM_APPROVAL,
type: "route",
},
- {
- title: t("schema-template.self"),
- name: WORKSPACE_ROUTE_SCHEMA_TEMPLATE,
- type: "route",
- },
],
},
{
diff --git a/frontend/src/views/SchemaTemplate/ColumnTypes.vue b/frontend/src/views/SchemaTemplate/ColumnTypes.vue
deleted file mode 100644
index 4dc52638f5..0000000000
--- a/frontend/src/views/SchemaTemplate/ColumnTypes.vue
+++ /dev/null
@@ -1,480 +0,0 @@
-<template>
- <div class="w-full flex flex-col gap-y-4 text-sm">
- <div class="flex flex-col gap-y-4">
- <div class="flex items-center justify-between gap-x-6">
- <div class="flex-1 textinfolabel">
- {{ $t("schema-template.column-type-restriction.description") }}
- </div>
- </div>
- </div>
- <div class="w-full flex flex-col justify-start items-start gap-2">
- <div class="w-full flex flex-row justify-between items-center">
- <div class="flex flex-row justify-start items-center">
- <EngineIcon :engine="Engine.MYSQL" :custom-class="'mr-1'" />
- MySQL
- </div>
- <NRadioGroup
- v-model:value="columnTypeTemplateForMySQL.enabled"
- class="gap-x-2"
- :disabled="readonly"
- @change="handleMySQLEnabledChange"
- >
- <NRadio
- :value="false"
- :label="$t('schema-template.column-type-restriction.allow-all')"
- />
- <NRadio
- :value="true"
- :label="
- $t('schema-template.column-type-restriction.allow-limited-types')
- "
- />
- </NRadioGroup>
- </div>
- <NInput
- v-if="columnTypeTemplateForMySQL.enabled"
- v-model:value="columnTypesForMySQL"
- :disabled="readonly"
- type="textarea"
- :placeholder="
- $t(
- 'schema-template.column-type-restriction.messages.one-allowed-type-per-line'
- )
- "
- :autosize="{
- minRows: 5,
- maxRows: 10,
- }"
- />
- <div class="w-full flex flex-row justify-end items-center mt-2">
- <NButton
- type="primary"
- :disabled="!allowToUpdateColumnTypeTemplateForMySQL"
- @click="handleMySQLTypesChange"
- >
- {{ $t("common.update") }}
- </NButton>
- </div>
- </div>
- <NDivider class="w-full py-2" />
- <div class="w-full flex flex-col justify-start items-start gap-2">
- <div class="w-full flex flex-row justify-between items-center">
- <div class="flex flex-row justify-start items-center">
- <EngineIcon :engine="Engine.POSTGRES" :custom-class="'mr-1'" />
- PostgreSQL
- </div>
- <NRadioGroup
- v-model:value="columnTypeTemplateForPostgreSQL.enabled"
- class="gap-x-2"
- :disabled="readonly"
- @change="handlePostgreSQLEnabledChange"
- >
- <NRadio
- :value="false"
- :label="$t('schema-template.column-type-restriction.allow-all')"
- />
- <NRadio
- :value="true"
- :label="
- $t('schema-template.column-type-restriction.allow-limited-types')
- "
- />
- </NRadioGroup>
- </div>
- <NInput
- v-if="columnTypeTemplateForPostgreSQL.enabled"
- v-model:value="columnTypesForPostgreSQL"
- :disabled="readonly"
- type="textarea"
- :placeholder="
- $t(
- 'schema-template.column-type-restriction.messages.one-allowed-type-per-line'
- )
- "
- :autosize="{
- minRows: 5,
- maxRows: 10,
- }"
- />
- <div class="w-full flex flex-row justify-end items-center mt-2">
- <NButton
- type="primary"
- :disabled="!allowToUpdateColumnTypeTemplateForPostgreSQL"
- @click="handlePostgreSQLTypesChange"
- >{{ $t("common.update") }}</NButton
- >
- </div>
- </div>
- </div>
-
- <ColumnTypesUpdateFailedModal
- v-if="unmatchedFieldTemplates.length > 0"
- :field-templates="unmatchedFieldTemplates"
- @close="unmatchedFieldTemplates = []"
- @save-all="handleSaveAllUnmatchedFieldTemplates"
- />
-</template>
-
-<script lang="ts" setup>
-import { create } from "@bufbuild/protobuf";
-import { cloneDeep, isEqual, uniq, uniqBy } from "lodash-es";
-import { NButton, NDivider, NInput, NRadio, NRadioGroup } from "naive-ui";
-import { computed, onMounted, ref } from "vue";
-import EngineIcon from "@/components/Icon/EngineIcon.vue";
-import { pushNotification, useSettingV1Store } from "@/store";
-import { Engine } from "@/types/proto-es/v1/common_pb";
-import type {
- SchemaTemplateSetting_ColumnType,
- SchemaTemplateSetting_FieldTemplate,
-} from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSetting_ColumnTypeSchema,
- SchemaTemplateSettingSchema,
- Setting_SettingName,
- ValueSchema as SettingValueSchema,
-} from "@/types/proto-es/v1/setting_service_pb";
-import { getDataTypeSuggestionList } from "@/utils";
-import ColumnTypesUpdateFailedModal from "./ColumnTypesUpdateFailedModal.vue";
-
-const props = defineProps<{
- readonly?: boolean;
-}>();
-
-const settingStore = useSettingV1Store();
-const columnTypeTemplateForMySQL = ref(
- create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: Engine.MYSQL,
- })
-);
-const columnTypesForMySQL = ref<string>("");
-const columnTypeTemplateForPostgreSQL = ref(
- create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: Engine.POSTGRES,
- })
-);
-const columnTypesForPostgreSQL = ref<string>("");
-const unmatchedFieldTemplates = ref<SchemaTemplateSetting_FieldTemplate[]>([]);
-
-const allowToUpdateColumnTypeTemplateForMySQL = computed(() => {
- if (props.readonly) {
- return false;
- }
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- const columnTypes =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value.columnTypes || []
- : [];
- const existingTemplate = columnTypes.find(
- (item) => item.engine === Engine.MYSQL
- );
- const originTemplate = existingTemplate
- ? create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: existingTemplate.engine,
- enabled: existingTemplate.enabled,
- types: existingTemplate.types || [],
- })
- : create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: Engine.MYSQL,
- enabled: false,
- types: [],
- });
- const newTemplate = create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: Engine.MYSQL,
- enabled: columnTypeTemplateForMySQL.value.enabled,
- types: columnTypesForMySQL.value
- .split("\n")
- .map((item) => item.trim())
- .filter(Boolean),
- });
- if (isEqual(originTemplate.enabled, newTemplate.enabled)) {
- if (!newTemplate.enabled) {
- return false;
- }
- if (isEqual(originTemplate.types, newTemplate.types)) {
- return false;
- }
- }
- return true;
-});
-
-const allowToUpdateColumnTypeTemplateForPostgreSQL = computed(() => {
- if (props.readonly) {
- return false;
- }
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- const columnTypes =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value.columnTypes || []
- : [];
- const existingTemplate = columnTypes.find(
- (item) => item.engine === Engine.POSTGRES
- );
- const originTemplate = existingTemplate
- ? create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: existingTemplate.engine,
- enabled: existingTemplate.enabled,
- types: existingTemplate.types || [],
- })
- : create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: Engine.POSTGRES,
- enabled: false,
- types: [],
- });
- const newTemplate = create(SchemaTemplateSetting_ColumnTypeSchema, {
- engine: Engine.POSTGRES,
- enabled: columnTypeTemplateForPostgreSQL.value.enabled,
- types: columnTypesForPostgreSQL.value
- .split("\n")
- .map((item) => item.trim())
- .filter(Boolean),
- });
- if (isEqual(originTemplate.enabled, newTemplate.enabled)) {
- if (!newTemplate.enabled) {
- return false;
- }
- if (isEqual(originTemplate.types, newTemplate.types)) {
- return false;
- }
- }
- return true;
-});
-
-const getOrFetchSchemaTemplate = async () => {
- const setting = await settingStore.getOrFetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- const columnTypes =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value.columnTypes || []
- : [];
- const mysqlColumnTypes = columnTypes.find(
- (item) => item.engine === Engine.MYSQL
- );
- const postgresqlColumnTypes = columnTypes.find(
- (item) => item.engine === Engine.POSTGRES
- );
- return {
- fieldTemplates:
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value.fieldTemplates || []
- : [],
- mysqlColumnTypes,
- postgresqlColumnTypes,
- };
-};
-
-onMounted(async () => {
- const { mysqlColumnTypes, postgresqlColumnTypes } =
- await getOrFetchSchemaTemplate();
- if (mysqlColumnTypes) {
- columnTypeTemplateForMySQL.value = cloneDeep(mysqlColumnTypes);
- columnTypesForMySQL.value =
- columnTypeTemplateForMySQL.value.types.join("\n");
- }
- if (postgresqlColumnTypes) {
- columnTypeTemplateForPostgreSQL.value = cloneDeep(postgresqlColumnTypes);
- columnTypesForPostgreSQL.value =
- columnTypeTemplateForPostgreSQL.value.types.join("\n");
- }
-});
-
-const handleSaveAllUnmatchedFieldTemplates = (
- fieldTemplates: SchemaTemplateSetting_FieldTemplate[]
-) => {
- if (fieldTemplates.length === 0) {
- return;
- }
-
- const engine = fieldTemplates[0].engine;
- if (engine === Engine.MYSQL) {
- columnTypesForMySQL.value =
- columnTypesForMySQL.value +
- "\n" +
- uniq(fieldTemplates.map((item) => item.column?.type || "")).join("\n");
- handleMySQLTypesChange();
- } else if (engine === Engine.POSTGRES) {
- columnTypesForPostgreSQL.value =
- columnTypesForPostgreSQL.value +
- "\n" +
- uniq(fieldTemplates.map((item) => item.column?.type || "")).join("\n");
- handlePostgreSQLTypesChange();
- }
- unmatchedFieldTemplates.value = [];
-};
-
-const handleMySQLEnabledChange = (event: InputEvent) => {
- const enabled = (event.target as HTMLInputElement).value === "true";
- columnTypeTemplateForMySQL.value.enabled = enabled;
- if (enabled) {
- if (columnTypeTemplateForMySQL.value.types.filter(Boolean).length === 0) {
- columnTypesForMySQL.value = getDataTypeSuggestionList(Engine.MYSQL).join(
- "\n"
- );
- }
- }
-};
-
-const handleMySQLTypesChange = async () => {
- columnTypesForMySQL.value = columnTypesForMySQL.value
- .toLowerCase()
- .split("\n")
- .map((item) => item.trim())
- .filter(Boolean)
- .join("\n");
- columnTypeTemplateForMySQL.value.types =
- columnTypesForMySQL.value.split("\n");
-
- const { fieldTemplates } = await getOrFetchSchemaTemplate();
- const mysqlFieldTemplates = uniq(
- fieldTemplates.filter(
- (item) => item.engine === Engine.MYSQL && item.column?.type
- )
- );
- const fieldTemplateTypesOfMySQL = uniq(
- mysqlFieldTemplates
- .map((item) => item.column?.type || "")
- .filter(Boolean)
- .map((item) => item.toLowerCase())
- );
- if (columnTypeTemplateForMySQL.value.enabled) {
- // Check if there is any field template that is not covered by the column types.
- if (columnTypeTemplateForMySQL.value.types.length === 0) {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: "Column types cannot be empty when enabled",
- });
- return;
- }
-
- // Check if there is any field template that is not covered by the column types.
- const uncoveredTypes = fieldTemplateTypesOfMySQL.filter(
- (item) =>
- !columnTypeTemplateForMySQL.value.types.includes(item.toLowerCase())
- );
- if (uncoveredTypes.length > 0) {
- unmatchedFieldTemplates.value = mysqlFieldTemplates.filter((item) =>
- uncoveredTypes.includes((item.column?.type || "").toLowerCase())
- );
- return;
- }
- }
-
- await upsertSchemaTemplateSetting(columnTypeTemplateForMySQL.value);
-
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: "Success to update column types",
- });
-};
-
-const handlePostgreSQLEnabledChange = (event: InputEvent) => {
- const enabled = (event.target as HTMLInputElement).value === "true";
- columnTypeTemplateForPostgreSQL.value.enabled = enabled;
- if (enabled) {
- if (
- columnTypeTemplateForPostgreSQL.value.types.filter(Boolean).length === 0
- ) {
- columnTypesForPostgreSQL.value = getDataTypeSuggestionList(
- Engine.POSTGRES
- ).join("\n");
- }
- }
-};
-
-const handlePostgreSQLTypesChange = async () => {
- columnTypesForPostgreSQL.value = columnTypesForPostgreSQL.value
- .toLowerCase()
- .split("\n")
- .map((item) => item.trim())
- .filter(Boolean)
- .join("\n");
- columnTypeTemplateForPostgreSQL.value.types =
- columnTypesForPostgreSQL.value.split("\n");
-
- const { fieldTemplates, postgresqlColumnTypes } =
- await getOrFetchSchemaTemplate();
- if (isEqual(columnTypeTemplateForPostgreSQL.value, postgresqlColumnTypes)) {
- return;
- }
-
- const postgresFieldTemplates = uniq(
- fieldTemplates.filter(
- (item) => item.engine === Engine.POSTGRES && item.column?.type
- )
- );
- const fieldTemplateTypesOfPostgreSQL = uniq(
- postgresFieldTemplates
- .map((item) => item.column?.type || "")
- .filter(Boolean)
- .map((item) => item.toLowerCase())
- );
- if (columnTypeTemplateForPostgreSQL.value.enabled) {
- // Check if there is any field template that is not covered by the column types.
- if (columnTypeTemplateForPostgreSQL.value.types.length === 0) {
- pushNotification({
- module: "bytebase",
- style: "CRITICAL",
- title: "Column types cannot be empty when enabled",
- });
- return;
- }
-
- // Check if there is any field template that is not covered by the column types.
- const uncoveredTypes = fieldTemplateTypesOfPostgreSQL.filter(
- (item) =>
- !columnTypeTemplateForPostgreSQL.value.types.includes(
- item.toLowerCase()
- )
- );
- if (uncoveredTypes.length > 0) {
- unmatchedFieldTemplates.value = postgresFieldTemplates.filter((item) =>
- uncoveredTypes.includes((item.column?.type || "").toLowerCase())
- );
- return;
- }
- }
-
- await upsertSchemaTemplateSetting(columnTypeTemplateForPostgreSQL.value);
-
- pushNotification({
- module: "bytebase",
- style: "SUCCESS",
- title: "Success to update column types",
- });
-};
-
-const upsertSchemaTemplateSetting = async (
- columnType: SchemaTemplateSetting_ColumnType
-) => {
- const setting = await settingStore.getOrFetchSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- const existingValue =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value
- : undefined;
- const schemaTemplateSettingValue = create(SchemaTemplateSettingSchema, {
- fieldTemplates: existingValue?.fieldTemplates || [],
- tableTemplates: existingValue?.tableTemplates || [],
- columnTypes: uniqBy(
- [columnType, ...(existingValue?.columnTypes || [])],
- "engine"
- ),
- });
- await settingStore.upsertSetting({
- name: Setting_SettingName.SCHEMA_TEMPLATE,
- value: create(SettingValueSchema, {
- value: {
- case: "schemaTemplateSettingValue",
- value: schemaTemplateSettingValue,
- },
- }),
- });
-};
-</script>
diff --git a/frontend/src/views/SchemaTemplate/ColumnTypesUpdateFailedModal.vue b/frontend/src/views/SchemaTemplate/ColumnTypesUpdateFailedModal.vue
deleted file mode 100644
index c770f0b5c7..0000000000
--- a/frontend/src/views/SchemaTemplate/ColumnTypesUpdateFailedModal.vue
+++ /dev/null
@@ -1,74 +0,0 @@
-<template>
- <BBModal
- :title="
- $t('schema-template.column-type-restriction.messages.unable-to-update')
- "
- class="w-lg! max-w-full!"
- @close="emits('close')"
- >
- <div class="w-full">
- <p class="mt-1 mb-2">
- {{
- $t(
- "schema-template.column-type-restriction.messages.following-column-types-are-used"
- )
- }}
- </p>
- <div
- v-for="unmatchedField in unmatchedFieldMap.keys()"
- :key="unmatchedField"
- class="w-full flex flex-row justify-start items-center mt-2"
- >
- <div class="mx-2 shrink-0">•</div>
- <span class="mr-1 shrink-0">{{ unmatchedField }}:</span>
- <div
- class="flex flex-row justify-start items-center flex-wrap break-all"
- >
- <span>{{ unmatchedFieldMap.get(unmatchedField)?.join(", ") }}</span>
- </div>
- </div>
- </div>
- <div class="mt-7 flex justify-end gap-x-2">
- <NButton @click.prevent="$emit('close')">
- {{ $t("schema-template.column-type-restriction.back-to-edit") }}
- </NButton>
- <NButton type="primary" @click="$emit('save-all', props.fieldTemplates)">
- {{ $t("schema-template.column-type-restriction.add-and-save") }}
- </NButton>
- </div>
- </BBModal>
-</template>
-
-<script lang="ts" setup>
-import { NButton } from "naive-ui";
-import { computed } from "vue";
-import { BBModal } from "@/bbkit";
-import type { SchemaTemplateSetting_FieldTemplate } from "@/types/proto-es/v1/setting_service_pb";
-
-const props = defineProps<{
- fieldTemplates: SchemaTemplateSetting_FieldTemplate[];
-}>();
-
-const emits = defineEmits<{
- (event: "close"): void;
- (
- event: "save-all",
- fieldTemplates: SchemaTemplateSetting_FieldTemplate[]
- ): void;
-}>();
-
-const unmatchedFieldMap = computed(() => {
- const fieldMap = new Map<string, string[]>();
- for (const fieldTemplate of props.fieldTemplates) {
- const field = fieldMap.get(fieldTemplate.column?.type || "");
- if (!field) {
- fieldMap.set(fieldTemplate.column?.type || "", [
- fieldTemplate.column?.name || "",
- ]);
- } else {
- field.push(fieldTemplate.column?.name || "");
- }
- }
- return fieldMap;
-});
-</script>
diff --git a/frontend/src/views/SchemaTemplate/FieldTemplates.vue b/frontend/src/views/SchemaTemplate/FieldTemplates.vue
deleted file mode 100644
index a859548a41..0000000000
--- a/frontend/src/views/SchemaTemplate/FieldTemplates.vue
+++ /dev/null
@@ -1,195 +0,0 @@
-<template>
- <div class="w-full flex flex-col gap-y-4 text-sm">
- <div v-if="!readonly" class="flex flex-col gap-y-4">
- <div class="flex items-center justify-between gap-x-6">
- <div class="flex-1 textinfolabel">
- {{ $t("schema-template.field-template.description") }}
- </div>
- </div>
- </div>
- <div class="flex items-center justify-between gap-x-2 my-4">
- <div class="flex flex-row items-center justify-start gap-x-4">
- <template v-if="showEngineFilter">
- <NCheckbox
- v-for="item in engineList"
- :key="item"
- :checked="state.selectedEngine.has(item)"
- @update:checked="toggleEngineCheck(item)"
- >
- <div class="flex items-center gap-x-1 text-sm text-gray-600">
- <EngineIcon :engine="item" custom-class="ml-0 mr-1" />
- <span
- class="items-center text-xs px-2 py-0.5 rounded-full bg-gray-200 text-gray-800"
- >
- {{ countTemplateByEngine(item) }}
- </span>
- </div>
- </NCheckbox>
- </template>
- </div>
- <div class="flex items-center gap-x-2">
- <div class="hidden md:block">
- <SearchBox
- v-model:value="state.searchText"
- :autofocus="true"
- :placeholder="$t('schema-template.search-by-name-or-comment')"
- />
- </div>
- <NButton
- type="primary"
- :disabled="readonly"
- @click="createSchemaTemplate"
- >
- <template #icon>
- <PlusIcon class="h-4 w-4" />
- </template>
- {{ $t("common.add") }}
- </NButton>
- </div>
- </div>
- <FieldTemplateView
- :engine="engine"
- :readonly="!!readonly"
- :template-list="filteredTemplateList"
- @view="editSchemaTemplate"
- @apply="$emit('apply', $event)"
- />
- </div>
- <Drawer v-model:show="state.showDrawer">
- <FieldTemplateForm
- :readonly="!!readonly"
- :create="!state.template.column?.name"
- :template="state.template"
- @dismiss="state.showDrawer = false"
- />
- </Drawer>
-</template>
-
-<script lang="ts" setup>
-import { create } from "@bufbuild/protobuf";
-import { PlusIcon } from "lucide-vue-next";
-import { NButton, NCheckbox } from "naive-ui";
-import { v1 as uuidv1 } from "uuid";
-import { computed, onMounted, reactive } from "vue";
-import { EngineIcon } from "@/components/Icon";
-import FieldTemplateForm from "@/components/SchemaTemplate/FieldTemplateForm.vue";
-import FieldTemplateView from "@/components/SchemaTemplate/FieldTemplateView.vue";
-import { engineList } from "@/components/SchemaTemplate/utils";
-import { Drawer, SearchBox } from "@/components/v2";
-import { useSettingV1Store } from "@/store";
-import { Engine } from "@/types/proto-es/v1/common_pb";
-import { ColumnCatalogSchema } from "@/types/proto-es/v1/database_catalog_service_pb";
-import { ColumnMetadataSchema } from "@/types/proto-es/v1/database_service_pb";
-import type { SchemaTemplateSetting_FieldTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSetting_FieldTemplateSchema,
- Setting_SettingName,
-} from "@/types/proto-es/v1/setting_service_pb";
-
-interface LocalState {
- template: SchemaTemplateSetting_FieldTemplate;
- showDrawer: boolean;
- searchText: string;
- selectedEngine: Set<Engine>;
-}
-
-const props = defineProps<{
- engine?: Engine;
- readonly?: boolean;
- showEngineFilter?: boolean;
-}>();
-
-defineEmits<{
- (event: "apply", item: SchemaTemplateSetting_FieldTemplate): void;
-}>();
-
-const initialTemplate = (): SchemaTemplateSetting_FieldTemplate =>
- create(SchemaTemplateSetting_FieldTemplateSchema, {
- id: uuidv1(),
- engine: props.engine ?? Engine.MYSQL,
- category: "",
- column: create(ColumnMetadataSchema, {
- name: "",
- type: "",
- nullable: false,
- comment: "",
- position: 0,
- characterSet: "",
- collation: "",
- }),
- catalog: create(ColumnCatalogSchema, {}),
- });
-
-const state = reactive<LocalState>({
- showDrawer: false,
- template: initialTemplate(),
- searchText: "",
- selectedEngine: new Set<Engine>(),
-});
-
-onMounted(() => {
- if (props.engine) {
- state.selectedEngine.add(props.engine);
- }
-});
-
-const createSchemaTemplate = () => {
- state.template = initialTemplate();
- state.showDrawer = true;
-};
-
-const editSchemaTemplate = (template: SchemaTemplateSetting_FieldTemplate) => {
- state.template = template;
- state.showDrawer = true;
-};
-
-const toggleEngineCheck = (engine: Engine) => {
- if (state.selectedEngine.has(engine)) {
- state.selectedEngine.delete(engine);
- } else {
- state.selectedEngine.add(engine);
- }
-};
-
-const settingStore = useSettingV1Store();
-
-const schemaTemplateList = computed(() => {
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- return setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? (setting.value.value.value.fieldTemplates ?? [])
- : [];
-});
-
-const countTemplateByEngine = (engine: Engine) => {
- return schemaTemplateList.value.filter(
- (template) => template.engine === engine
- ).length;
-};
-
-const filteredTemplateList = computed(() => {
- if (state.selectedEngine.size === 0) {
- return schemaTemplateList.value.filter(filterTemplateByKeyword);
- }
- return schemaTemplateList.value.filter(
- (template) =>
- state.selectedEngine.has(template.engine) &&
- filterTemplateByKeyword(template)
- );
-});
-
-const filterTemplateByKeyword = (
- template: SchemaTemplateSetting_FieldTemplate
-) => {
- const keyword = state.searchText.trim().toLowerCase();
- if (!keyword) return true;
- if (template.column?.name.toLowerCase().includes(keyword)) {
- return true;
- }
- if (template.column?.comment.toLowerCase().includes(keyword)) {
- return true;
- }
- return false;
-};
-</script>
diff --git a/frontend/src/views/SchemaTemplate/TableTemplates.vue b/frontend/src/views/SchemaTemplate/TableTemplates.vue
deleted file mode 100644
index dab242cce8..0000000000
--- a/frontend/src/views/SchemaTemplate/TableTemplates.vue
+++ /dev/null
@@ -1,185 +0,0 @@
-<template>
- <div class="w-full flex flex-col gap-y-4 text-sm">
- <div v-if="!readonly" class="flex flex-col gap-y-4">
- <div class="flex items-center justify-between gap-x-6">
- <div class="flex-1 textinfolabel">
- {{ $t("schema-template.table-template.description") }}
- </div>
- </div>
- </div>
- <div class="flex items-center justify-between gap-x-2 my-4">
- <div class="flex flex-row items-center justify-start gap-x-4">
- <template v-if="showEngineFilter">
- <NCheckbox
- v-for="item in engineList"
- :key="item"
- :checked="state.selectedEngine.has(item)"
- @update:checked="toggleEngineCheck(item)"
- >
- <div class="flex items-center gap-x-1 text-sm text-gray-600">
- <EngineIcon :engine="item" custom-class="ml-0 mr-1" />
- <span
- class="items-center text-xs px-2 py-0.5 rounded-full bg-gray-200 text-gray-800"
- >
- {{ countTemplateByEngine(item) }}
- </span>
- </div>
- </NCheckbox>
- </template>
- </div>
- <div class="flex items-center gap-x-2">
- <div class="hidden md:block">
- <SearchBox
- v-model:value="state.searchText"
- :autofocus="true"
- :placeholder="$t('schema-template.search-by-name-or-comment')"
- />
- </div>
- <NButton
- type="primary"
- :disabled="readonly"
- @click="createSchemaTemplate"
- >
- <template #icon>
- <PlusIcon class="h-4 w-4" />
- </template>
- {{ $t("common.add") }}
- </NButton>
- </div>
- </div>
- <TableTemplateView
- :engine="engine"
- :readonly="!!readonly"
- :template-list="filteredTemplateList"
- @view="editSchemaTemplate"
- @apply="$emit('apply', $event)"
- />
- </div>
- <Drawer v-model:show="state.showDrawer">
- <TableTemplateForm
- :readonly="!!readonly"
- :create="!state.template.table?.name"
- :template="state.template"
- @dismiss="state.showDrawer = false"
- />
- </Drawer>
-</template>
-
-<script lang="ts" setup>
-import { create as createProto } from "@bufbuild/protobuf";
-import { PlusIcon } from "lucide-vue-next";
-import { NButton, NCheckbox } from "naive-ui";
-import { v1 as uuidv1 } from "uuid";
-import { computed, onMounted, reactive } from "vue";
-import { EngineIcon } from "@/components/Icon";
-import TableTemplateForm from "@/components/SchemaTemplate/TableTemplateForm.vue";
-import TableTemplateView from "@/components/SchemaTemplate/TableTemplateView.vue";
-import { engineList } from "@/components/SchemaTemplate/utils";
-import { Drawer, SearchBox } from "@/components/v2";
-import { useSettingV1Store } from "@/store";
-import { Engine } from "@/types/proto-es/v1/common_pb";
-import type { SchemaTemplateSetting_TableTemplate } from "@/types/proto-es/v1/setting_service_pb";
-import {
- SchemaTemplateSetting_TableTemplateSchema,
- Setting_SettingName,
-} from "@/types/proto-es/v1/setting_service_pb";
-
-interface LocalState {
- template: SchemaTemplateSetting_TableTemplate;
- showDrawer: boolean;
- searchText: string;
- selectedEngine: Set<Engine>;
-}
-
-const props = defineProps<{
- engine?: Engine;
- readonly?: boolean;
- showEngineFilter?: boolean;
-}>();
-
-defineEmits<{
- (event: "apply", item: SchemaTemplateSetting_TableTemplate): void;
-}>();
-
-const initialTemplate = (): SchemaTemplateSetting_TableTemplate =>
- createProto(SchemaTemplateSetting_TableTemplateSchema, {
- id: uuidv1(),
- engine: props.engine ?? Engine.MYSQL,
- category: "",
- });
-
-const state = reactive<LocalState>({
- showDrawer: false,
- template: initialTemplate(),
- searchText: "",
- selectedEngine: new Set<Engine>(),
-});
-
-onMounted(() => {
- if (props.engine) {
- state.selectedEngine.add(props.engine);
- }
-});
-
-const createSchemaTemplate = () => {
- state.template = initialTemplate();
- state.showDrawer = true;
-};
-
-const editSchemaTemplate = (template: SchemaTemplateSetting_TableTemplate) => {
- state.template = template;
- state.showDrawer = true;
-};
-
-const toggleEngineCheck = (engine: Engine) => {
- if (state.selectedEngine.has(engine)) {
- state.selectedEngine.delete(engine);
- } else {
- state.selectedEngine.add(engine);
- }
-};
-
-const settingStore = useSettingV1Store();
-
-const schemaTemplateList = computed(() => {
- const setting = settingStore.getSettingByName(
- Setting_SettingName.SCHEMA_TEMPLATE
- );
- const settingValue =
- setting?.value?.value?.case === "schemaTemplateSettingValue"
- ? setting.value.value.value
- : undefined;
- return settingValue?.tableTemplates ?? [];
-});
-
-const countTemplateByEngine = (engine: Engine) => {
- return schemaTemplateList.value.filter(
- (template) => template.engine === engine
- ).length;
-};
-
-const filteredTemplateList = computed(() => {
- if (state.selectedEngine.size === 0) {
- return schemaTemplateList.value.filter(filterTemplateByKeyword);
- }
- return schemaTemplateList.value.filter(
- (template) =>
- state.selectedEngine.has(template.engine) &&
- filterTemplateByKeyword(template)
- );
-});
-
-const filterTemplateByKeyword = (
- template: SchemaTemplateSetting_TableTemplate
-) => {
- const keyword = state.searchText.trim().toLowerCase();
- if (!keyword) return true;
- if (template.table?.name.toLowerCase().includes(keyword)) {
- return true;
- }
- if (template.table?.comment.toLowerCase().includes(keyword)) {
- return true;
- }
- return false;
-};
-</script>
diff --git a/frontend/src/views/SettingWorkspaceSchemaTemplate.vue b/frontend/src/views/SettingWorkspaceSchemaTemplate.vue
deleted file mode 100644
index cc65e59160..0000000000
--- a/frontend/src/views/SettingWorkspaceSchemaTemplate.vue
+++ /dev/null
@@ -1,96 +0,0 @@
-<template>
- <div class="w-full flex flex-col gap-y-4">
- <FeatureAttention :feature="PlanFeature.FEATURE_SCHEMA_TEMPLATE" />
- <NTabs v-model:value="state.selectedTab" type="line">
- <NTabPane
- name="FIELD_TEMPLATE"
- :tab="$t('schema-template.field-template.self')"
- >
- <FieldTemplates
- :show-engine-filter="true"
- :readonly="!hasFeature || !allowEdit"
- />
- </NTabPane>
- <NTabPane
- name="TABLE_TEMPLATE"
- :tab="$t('schema-template.table-template.self')"
- >
- <TableTemplates
- :show-engine-filter="true"
- :readonly="!hasFeature || !allowEdit"
- />
- </NTabPane>
- <NTabPane
- name="COLUMN_TYPE_RESTRICTION"
- :tab="$t('schema-template.column-type-restriction.self')"
- >
- <ColumnTypes :readonly="!hasFeature || !allowEdit" />
- </NTabPane>
- </NTabs>
- </div>
-</template>
-
-<script lang="ts" setup>
-import { NTabPane, NTabs } from "naive-ui";
-import { reactive, watch } from "vue";
-import { useRoute, useRouter } from "vue-router";
-import { FeatureAttention } from "@/components/FeatureGuard";
-import { featureToRef } from "@/store";
-import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
-import ColumnTypes from "@/views/SchemaTemplate/ColumnTypes.vue";
-import FieldTemplates from "@/views/SchemaTemplate/FieldTemplates.vue";
-import TableTemplates from "@/views/SchemaTemplate/TableTemplates.vue";
-
-interface LocalState {
- selectedTab: "FIELD_TEMPLATE" | "COLUMN_TYPE_RESTRICTION" | "TABLE_TEMPLATE";
-}
-
-defineProps<{
- allowEdit: boolean;
-}>();
-
-const route = useRoute();
-const router = useRouter();
-const state = reactive<LocalState>({
- selectedTab: "FIELD_TEMPLATE",
-});
-
-const hasFeature = featureToRef(PlanFeature.FEATURE_SCHEMA_TEMPLATE);
-
-watch(
- () => route.hash,
- (hash) => {
- switch (hash) {
- case "#column-type-restriction":
- state.selectedTab = "COLUMN_TYPE_RESTRICTION";
- break;
- case "#table-template":
- state.selectedTab = "TABLE_TEMPLATE";
- break;
- default:
- state.selectedTab = "FIELD_TEMPLATE";
- break;
- }
- },
- {
- immediate: true,
- }
-);
-
-watch(
- () => state.selectedTab,
- (tab) => {
- switch (tab) {
- case "COLUMN_TYPE_RESTRICTION":
- router.push({ hash: "#column-type-restriction" });
- break;
- case "TABLE_TEMPLATE":
- router.push({ hash: "#table-template" });
- break;
- default:
- router.push({ hash: "" });
- break;
- }
- }
-);
-</script>
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index f3a3859457..ffeb7f366c 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -8729,22 +8729,6 @@ components:
- $ref: '#/components/schemas/Expr'
description: The parsed expression of the condition.
description: Binding associates members with a role and optional conditions.
- BoundingBox:
- type: object
- properties:
- xmin:
- type: number
- format: double
- ymin:
- type: number
- format: double
- xmax:
- type: number
- format: double
- ymax:
- type: number
- format: double
- description: BoundingBox defines the bounding box for spatial indexes.
Candidate_Content:
type: object
properties:
@@ -8892,16 +8876,6 @@ components:
- SDL
type: string
format: enum
- CheckConstraintMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name is the name of a check constraint.
- expression:
- type: string
- description: The expression is the expression of a check constraint.
- description: CheckConstraintMetadata is the metadata for check constraints.
CheckReleaseRequest:
required:
- parent
@@ -9003,91 +8977,6 @@ components:
- $ref: '#/components/schemas/ObjectSchema'
description: Object schema for complex column types like JSON.
description: Column metadata within a table.
- ColumnMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name is the name of a column.
- position:
- type: integer
- description: The position is the position in columns.
- format: int32
- hasDefault:
- type: boolean
- default:
- type: string
- description: The default value of column.
- defaultOnNull:
- type: boolean
- description: |-
- Oracle specific metadata.
- The default_on_null is the default on null of a column.
- onUpdate:
- type: string
- description: |-
- The on_update is the on update action of a column.
- For MySQL like databases, it's only supported for TIMESTAMP columns with
- CURRENT_TIMESTAMP as on update value.
- nullable:
- type: boolean
- description: The nullable is the nullable of a column.
- type:
- type: string
- description: The type is the type of a column.
- characterSet:
- type: string
- description: The character_set is the character_set of a column.
- collation:
- type: string
- description: The collation is the collation of a column.
- comment:
- type: string
- description: The comment is the comment of a column.
- generation:
- allOf:
- - $ref: '#/components/schemas/GenerationMetadata'
- description: The generation is the generation of a column.
- isIdentity:
- type: boolean
- identityGeneration:
- enum:
- - IDENTITY_GENERATION_UNSPECIFIED
- - ALWAYS
- - BY_DEFAULT
- type: string
- description: The identity_generation is for identity columns, PG only.
- format: enum
- identitySeed:
- type: string
- description: The identity_seed is for identity columns, MSSQL only.
- identityIncrement:
- type: string
- description: The identity_increment is for identity columns, MSSQL only.
- defaultConstraintName:
- type: string
- description: |-
- The default_constraint_name is the name of the default constraint, MSSQL only.
- In MSSQL, default values are implemented as named constraints. When modifying or
- dropping a column's default value, you must reference the constraint by name.
- This field stores the actual constraint name from the database.
-
- Example: A column definition like:
- CREATE TABLE employees (
- status NVARCHAR(20) DEFAULT 'active'
- )
-
- Will create a constraint with an auto-generated name like 'DF__employees__statu__3B75D760'
- or a user-defined name if specified:
- ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT 'active' FOR status
-
- To modify the default, you must first drop the existing constraint by name:
- ALTER TABLE employees DROP CONSTRAINT DF__employees__statu__3B75D760
- ALTER TABLE employees ADD CONSTRAINT DF_employees_status DEFAULT 'inactive' FOR status
-
- This field is populated when syncing from the database. When empty (e.g., when parsing
- from SQL files), the system cannot automatically drop the constraint.
- description: ColumnMetadata is the metadata for columns.
Constant:
type: object
properties:
@@ -9799,32 +9688,6 @@ components:
properties:
diff:
type: string
- DimensionalConfig:
- type: object
- properties:
- dimensions:
- type: integer
- description: Number of dimensions (2-4, default 2)
- format: int32
- dataType:
- type: string
- description: |-
- Spatial data type
- Examples: GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.
- operatorClass:
- type: string
- description: |-
- PostgreSQL operator class
- Examples: gist_geometry_ops_2d, gist_geometry_ops_nd, etc.
- layerGtype:
- type: string
- description: |-
- Oracle geometry type constraint
- Examples: POINT, LINE, POLYGON, COLLECTION
- parallelBuild:
- type: boolean
- description: Parallel index creation
- description: DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
EnvironmentSetting:
type: object
properties:
@@ -10249,55 +10112,6 @@ components:
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`.
- ForeignKeyMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name is the name of a foreign key.
- columns:
- type: array
- items:
- type: string
- description: The columns are the ordered referencing columns of a foreign key.
- referencedSchema:
- type: string
- description: |-
- 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.
- referencedTable:
- type: string
- description: The referenced_table is the referenced table name of a foreign key.
- referencedColumns:
- type: array
- items:
- type: string
- description: The referenced_columns are the ordered referenced columns of a foreign key.
- onDelete:
- type: string
- description: The on_delete is the on delete action of a foreign key.
- onUpdate:
- type: string
- description: The on_update is the on update action of a foreign key.
- matchType:
- type: string
- description: |-
- The match_type is the match type of a foreign key.
- The match_type is the PostgreSQL specific field.
- It's empty string for other databases.
- description: ForeignKeyMetadata is the metadata for foreign keys.
- GenerationMetadata:
- type: object
- properties:
- type:
- enum:
- - TYPE_UNSPECIFIED
- - VIRTUAL
- - STORED
- type: string
- format: enum
- expression:
- type: string
GetSchemaStringResponse:
type: object
properties:
@@ -10335,15 +10149,6 @@ components:
type: string
description: Duration after which the grant automatically expires.
description: GrantRequest contains details for requesting database access permissions.
- GridLevel:
- type: object
- properties:
- level:
- type: integer
- format: int32
- density:
- type: string
- description: GridLevel defines a grid level for spatial tessellation.
Group:
type: object
properties:
@@ -10451,80 +10256,6 @@ components:
- $ref: '#/components/schemas/OIDCIdentityProviderContext'
description: OpenID Connect authentication context.
description: Context for identity provider authentication.
- IndexMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name is the name of an index.
- expressions:
- type: array
- items:
- type: string
- description: |-
- The expressions are the ordered columns or expressions of an index.
- This could refer to a column or an expression.
- keyLength:
- type: array
- items:
- type: string
- description: |-
- The key_lengths are the ordered key lengths of an index.
- If the key length is not specified, it's -1.
- descending:
- type: array
- items:
- type: boolean
- description: The descending is the ordered descending of an index.
- type:
- type: string
- description: The type is the type of an index.
- unique:
- type: boolean
- description: The unique is whether the index is unique.
- primary:
- type: boolean
- description: The primary is whether the index is a primary key index.
- visible:
- type: boolean
- description: The visible is whether the index is visible.
- comment:
- type: string
- description: The comment is the comment of an index.
- definition:
- type: string
- description: The definition of an index.
- parentIndexSchema:
- type: string
- description: The schema name of the parent index.
- parentIndexName:
- type: string
- description: The index name of the parent index.
- granularity:
- type: string
- description: The number of granules in the block. It's a ClickHouse specific field.
- isConstraint:
- type: boolean
- description: |-
- It's a PostgreSQL specific field.
- The unique constraint and unique index are not the same thing in PostgreSQL.
- spatialConfig:
- allOf:
- - $ref: '#/components/schemas/SpatialIndexConfig'
- description: Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc.
- opclassNames:
- type: array
- items:
- type: string
- description: |-
- https://www.postgresql.org/docs/current/catalog-pg-opclass.html
- Name of the operator class for each column. (PostgreSQL specific).
- opclassDefaults:
- type: array
- items:
- type: boolean
- description: True if the operator class is the default. (PostgreSQL specific).
- description: IndexMetadata is the metadata for indexes.
Instance:
type: object
properties:
@@ -12784,142 +12515,6 @@ components:
$ref: '#/components/schemas/TableCatalog'
description: The tables in the schema.
description: Schema metadata within a database.
- SchemaTemplateSetting:
- type: object
- properties:
- fieldTemplates:
- type: array
- items:
- $ref: '#/components/schemas/SchemaTemplateSetting_FieldTemplate'
- columnTypes:
- type: array
- items:
- $ref: '#/components/schemas/SchemaTemplateSetting_ColumnType'
- tableTemplates:
- type: array
- items:
- $ref: '#/components/schemas/SchemaTemplateSetting_TableTemplate'
- SchemaTemplateSetting_ColumnType:
- type: object
- properties:
- engine:
- enum:
- - ENGINE_UNSPECIFIED
- - CLICKHOUSE
- - MYSQL
- - POSTGRES
- - SNOWFLAKE
- - SQLITE
- - TIDB
- - MONGODB
- - REDIS
- - ORACLE
- - SPANNER
- - MSSQL
- - REDSHIFT
- - MARIADB
- - OCEANBASE
- - STARROCKS
- - DORIS
- - HIVE
- - ELASTICSEARCH
- - BIGQUERY
- - DYNAMODB
- - DATABRICKS
- - COCKROACHDB
- - COSMOSDB
- - TRINO
- - CASSANDRA
- type: string
- format: enum
- enabled:
- type: boolean
- types:
- type: array
- items:
- type: string
- SchemaTemplateSetting_FieldTemplate:
- type: object
- properties:
- id:
- type: string
- engine:
- enum:
- - ENGINE_UNSPECIFIED
- - CLICKHOUSE
- - MYSQL
- - POSTGRES
- - SNOWFLAKE
- - SQLITE
- - TIDB
- - MONGODB
- - REDIS
- - ORACLE
- - SPANNER
- - MSSQL
- - REDSHIFT
- - MARIADB
- - OCEANBASE
- - STARROCKS
- - DORIS
- - HIVE
- - ELASTICSEARCH
- - BIGQUERY
- - DYNAMODB
- - DATABRICKS
- - COCKROACHDB
- - COSMOSDB
- - TRINO
- - CASSANDRA
- type: string
- format: enum
- category:
- type: string
- column:
- $ref: '#/components/schemas/ColumnMetadata'
- catalog:
- $ref: '#/components/schemas/ColumnCatalog'
- SchemaTemplateSetting_TableTemplate:
- type: object
- properties:
- id:
- type: string
- engine:
- enum:
- - ENGINE_UNSPECIFIED
- - CLICKHOUSE
- - MYSQL
- - POSTGRES
- - SNOWFLAKE
- - SQLITE
- - TIDB
- - MONGODB
- - REDIS
- - ORACLE
- - SPANNER
- - MSSQL
- - REDSHIFT
- - MARIADB
- - OCEANBASE
- - STARROCKS
- - DORIS
- - HIVE
- - ELASTICSEARCH
- - BIGQUERY
- - DYNAMODB
- - DATABRICKS
- - COCKROACHDB
- - COSMOSDB
- - TRINO
- - CASSANDRA
- type: string
- format: enum
- category:
- type: string
- table:
- $ref: '#/components/schemas/TableMetadata'
- catalog:
- $ref: '#/components/schemas/TableCatalog'
SearchAuditLogsRequest:
required:
- parent
@@ -13402,32 +12997,6 @@ components:
items:
$ref: '#/components/schemas/SheetCommand'
description: The start and end position of each command in the sheet statement.
- SpatialIndexConfig:
- type: object
- properties:
- method:
- type: string
- description: |-
- Index method/type (database-specific)
- Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST" (PostgreSQL), "MDSYS.SPATIAL_INDEX_V2" (Oracle)
- tessellation:
- allOf:
- - $ref: '#/components/schemas/TessellationConfig'
- description: Tessellation configuration (primarily SQL Server)
- storage:
- allOf:
- - $ref: '#/components/schemas/StorageConfig'
- description: Storage and performance parameters
- dimensional:
- allOf:
- - $ref: '#/components/schemas/DimensionalConfig'
- description: Dimensional and constraint parameters
- engineSpecific:
- type: object
- additionalProperties:
- type: string
- description: Database-specific parameters (stored as key-value pairs for extensibility)
- description: SpatialIndexConfig is the configuration for spatial indexes across different database engines.
Stage:
type: object
properties:
@@ -13469,45 +13038,6 @@ components:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
- StorageConfig:
- type: object
- properties:
- fillfactor:
- type: integer
- description: PostgreSQL parameters
- format: int32
- buffering:
- type: string
- tablespace:
- type: string
- description: Oracle parameters
- workTablespace:
- type: string
- sdoLevel:
- type: integer
- format: int32
- commitInterval:
- type: integer
- format: int32
- padIndex:
- type: boolean
- description: SQL Server parameters
- sortInTempdb:
- type: string
- dropExisting:
- type: boolean
- online:
- type: boolean
- allowRowLocks:
- type: boolean
- allowPageLocks:
- type: boolean
- maxdop:
- type: integer
- format: int32
- dataCompression:
- type: string
- description: StorageConfig defines storage and performance parameters for spatial indexes.
Subscription:
type: object
properties:
@@ -13605,156 +13135,6 @@ components:
$ref: '#/components/schemas/ColumnCatalog'
description: The columns in the table.
description: Column list for regular tables.
- TableMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name is the name of a table.
- columns:
- type: array
- items:
- $ref: '#/components/schemas/ColumnMetadata'
- description: The columns is the ordered list of columns in a table.
- indexes:
- type: array
- items:
- $ref: '#/components/schemas/IndexMetadata'
- description: The indexes is the list of indexes in a table.
- engine:
- type: string
- description: The engine is the engine of a table.
- collation:
- type: string
- description: The collation is the collation of a table.
- charset:
- type: string
- description: The character set of table.
- rowCount:
- type: string
- description: The row_count is the estimated number of rows of a table.
- dataSize:
- type: string
- description: The data_size is the estimated data size of a table.
- indexSize:
- type: string
- description: The index_size is the estimated index size of a table.
- dataFree:
- type: string
- description: The data_free is the estimated free data size of a table.
- createOptions:
- type: string
- description: The create_options is the create option of a table.
- comment:
- type: string
- description: The comment is the comment of a table.
- foreignKeys:
- type: array
- items:
- $ref: '#/components/schemas/ForeignKeyMetadata'
- description: The foreign_keys is the list of foreign keys in a table.
- partitions:
- type: array
- items:
- $ref: '#/components/schemas/TablePartitionMetadata'
- description: The partitions is the list of partitions in a table.
- checkConstraints:
- type: array
- items:
- $ref: '#/components/schemas/CheckConstraintMetadata'
- description: The check_constraints is the list of check constraints in a table.
- owner:
- type: string
- description: The owner of the table.
- sortingKeys:
- type: array
- items:
- type: string
- description: |-
- 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:
- type: array
- items:
- $ref: '#/components/schemas/TriggerMetadata'
- description: The triggers is the list of triggers associated with the table.
- skipDump:
- type: boolean
- description: Whether to skip this table during schema dump operations.
- shardingInfo:
- type: string
- description: https://docs.pingcap.com/tidb/stable/information-schema-tables/
- primaryKeyType:
- type: string
- description: |-
- https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes
- CLUSTERED or NONCLUSTERED.
- description: TableMetadata is the metadata for tables.
- TablePartitionMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name is the name of a table partition.
- type:
- enum:
- - TYPE_UNSPECIFIED
- - RANGE
- - RANGE_COLUMNS
- - LIST
- - LIST_COLUMNS
- - HASH
- - LINEAR_HASH
- - KEY
- - LINEAR_KEY
- type: string
- description: The type of a table partition.
- format: enum
- expression:
- type: string
- description: |-
- 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:
- type: string
- description: |-
- The value is the value of a table partition.
- For MySQL, the value is for RANGE and LIST partition types,
- - For a RANGE partition, it contains the value set in the partition's
- VALUES LESS THAN clause, which can be either an integer or MAXVALUE.
- - For a LIST partition, this column contains the values defined in the
- partition's VALUES IN clause, which is a list of comma-separated integer
- values.
- - For others, it's an empty string.
- useDefault:
- type: string
- description: |-
- The use_default is whether the users use the default partition, it stores
- the different value for different database engines. For MySQL, it's [INT]
- type, 0 means not use default partition, otherwise, it's equals to number
- in syntax [SUB]PARTITION {number}.
- subpartitions:
- type: array
- items:
- $ref: '#/components/schemas/TablePartitionMetadata'
- description: The subpartitions is the list of subpartitions in a table partition.
- indexes:
- type: array
- items:
- $ref: '#/components/schemas/IndexMetadata'
- checkConstraints:
- type: array
- items:
- $ref: '#/components/schemas/CheckConstraintMetadata'
- description: TablePartitionMetadata is the metadata for table partitions.
Task:
type: object
properties:
@@ -14075,28 +13455,6 @@ components:
description: The type of database change (MIGRATE or SDL).
format: enum
description: Payload for updating a database schema.
- TessellationConfig:
- type: object
- properties:
- scheme:
- type: string
- description: |-
- Tessellation scheme
- Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID
- boundingBox:
- allOf:
- - $ref: '#/components/schemas/BoundingBox'
- description: Bounding box for GEOMETRY indexes (SQL Server)
- gridLevels:
- type: array
- items:
- $ref: '#/components/schemas/GridLevel'
- description: Grid level configuration (SQL Server)
- cellsPerObject:
- type: integer
- description: Cells per object (SQL Server)
- format: int32
- description: TessellationConfig defines tessellation parameters for spatial indexes.
TestIdentityProviderRequest:
type: object
properties:
@@ -14144,31 +13502,6 @@ components:
error:
type: string
description: The result of the test, empty if the test is successful.
- TriggerMetadata:
- type: object
- properties:
- name:
- type: string
- description: The name of the trigger.
- event:
- type: string
- description: The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE.
- timing:
- type: string
- description: The timing of when the trigger fires, such as BEFORE or AFTER.
- body:
- type: string
- description: The body of the trigger.
- sqlMode:
- type: string
- characterSetClient:
- type: string
- collationConnection:
- type: string
- comment:
- type: string
- skipDump:
- type: boolean
UndeleteInstanceRequest:
required:
- name
@@ -14369,8 +13702,6 @@ components:
description: reserved 4; // was AgentPluginSetting agent_plugin_setting_value
workspaceApprovalSettingValue:
$ref: '#/components/schemas/WorkspaceApprovalSetting'
- schemaTemplateSettingValue:
- $ref: '#/components/schemas/SchemaTemplateSetting'
dataClassificationSettingValue:
$ref: '#/components/schemas/DataClassificationSetting'
semanticTypeSettingValue:
diff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.md
index 1857599e00..5a70586b51 100644
--- a/proto/gen/grpc-doc/store/README.md
+++ b/proto/gen/grpc-doc/store/README.md
@@ -278,10 +278,6 @@
- [EnvironmentSetting.Environment.TagsEntry](#bytebase-store-EnvironmentSetting-Environment-TagsEntry)
- [PasswordRestrictionSetting](#bytebase-store-PasswordRestrictionSetting)
- [SCIMSetting](#bytebase-store-SCIMSetting)
- - [SchemaTemplateSetting](#bytebase-store-SchemaTemplateSetting)
- - [SchemaTemplateSetting.ColumnType](#bytebase-store-SchemaTemplateSetting-ColumnType)
- - [SchemaTemplateSetting.FieldTemplate](#bytebase-store-SchemaTemplateSetting-FieldTemplate)
- - [SchemaTemplateSetting.TableTemplate](#bytebase-store-SchemaTemplateSetting-TableTemplate)
- [SemanticTypeSetting](#bytebase-store-SemanticTypeSetting)
- [SemanticTypeSetting.SemanticType](#bytebase-store-SemanticTypeSetting-SemanticType)
- [WorkspaceApprovalSetting](#bytebase-store-WorkspaceApprovalSetting)
@@ -4533,78 +4529,6 @@ ISSUE_CREATE represents creating an issue. |
-<a name="bytebase-store-SchemaTemplateSetting"></a>
-
-### SchemaTemplateSetting
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| field_templates | [SchemaTemplateSetting.FieldTemplate](#bytebase-store-SchemaTemplateSetting-FieldTemplate) | repeated | |
-| column_types | [SchemaTemplateSetting.ColumnType](#bytebase-store-SchemaTemplateSetting-ColumnType) | repeated | |
-| table_templates | [SchemaTemplateSetting.TableTemplate](#bytebase-store-SchemaTemplateSetting-TableTemplate) | repeated | |
-
-
-
-
-
-
-<a name="bytebase-store-SchemaTemplateSetting-ColumnType"></a>
-
-### SchemaTemplateSetting.ColumnType
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| engine | [Engine](#bytebase-store-Engine) | | |
-| enabled | [bool](#bool) | | |
-| types | [string](#string) | repeated | |
-
-
-
-
-
-
-<a name="bytebase-store-SchemaTemplateSetting-FieldTemplate"></a>
-
-### SchemaTemplateSetting.FieldTemplate
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| engine | [Engine](#bytebase-store-Engine) | | |
-| category | [string](#string) | | |
-| column | [ColumnMetadata](#bytebase-store-ColumnMetadata) | | |
-| catalog | [ColumnCatalog](#bytebase-store-ColumnCatalog) | | |
-
-
-
-
-
-
-<a name="bytebase-store-SchemaTemplateSetting-TableTemplate"></a>
-
-### SchemaTemplateSetting.TableTemplate
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| engine | [Engine](#bytebase-store-Engine) | | |
-| category | [string](#string) | | |
-| table | [TableMetadata](#bytebase-store-TableMetadata) | | |
-| catalog | [TableCatalog](#bytebase-store-TableCatalog) | | |
-
-
-
-
-
-
<a name="bytebase-store-SemanticTypeSetting"></a>
### SemanticTypeSetting
@@ -4768,12 +4692,10 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.
| WORKSPACE_ID | 3 | |
| WORKSPACE_PROFILE | 4 | |
| WORKSPACE_APPROVAL | 5 | |
-| WORKSPACE_EXTERNAL_APPROVAL | 6 | |
| ENTERPRISE_LICENSE | 7 | |
| APP_IM | 8 | |
| WATERMARK | 9 | |
| AI | 10 | |
-| SCHEMA_TEMPLATE | 13 | |
| DATA_CLASSIFICATION | 14 | |
| SEMANTIC_TYPES | 15 | |
| SCIM | 17 | |
diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.html
index 4fbc575070..7e0cdf3f58 100644
--- a/proto/gen/grpc-doc/store/index.html
+++ b/proto/gen/grpc-doc/store/index.html
@@ -1290,22 +1290,6 @@
<a href="#bytebase.store.SCIMSetting"><span class="badge">M</span>SCIMSetting</a>
</li>
- <li>
- <a href="#bytebase.store.SchemaTemplateSetting"><span class="badge">M</span>SchemaTemplateSetting</a>
- </li>
-
- <li>
- <a href="#bytebase.store.SchemaTemplateSetting.ColumnType"><span class="badge">M</span>SchemaTemplateSetting.ColumnType</a>
- </li>
-
- <li>
- <a href="#bytebase.store.SchemaTemplateSetting.FieldTemplate"><span class="badge">M</span>SchemaTemplateSetting.FieldTemplate</a>
- </li>
-
- <li>
- <a href="#bytebase.store.SchemaTemplateSetting.TableTemplate"><span class="badge">M</span>SchemaTemplateSetting.TableTemplate</a>
- </li>
-
<li>
<a href="#bytebase.store.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
</li>
@@ -11932,186 +11916,6 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.store.SchemaTemplateSetting">SchemaTemplateSetting</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>field_templates</td>
- <td><a href="#bytebase.store.SchemaTemplateSetting.FieldTemplate">SchemaTemplateSetting.FieldTemplate</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>column_types</td>
- <td><a href="#bytebase.store.SchemaTemplateSetting.ColumnType">SchemaTemplateSetting.ColumnType</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>table_templates</td>
- <td><a href="#bytebase.store.SchemaTemplateSetting.TableTemplate">SchemaTemplateSetting.TableTemplate</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.store.SchemaTemplateSetting.ColumnType">SchemaTemplateSetting.ColumnType</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>engine</td>
- <td><a href="#bytebase.store.Engine">Engine</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>enabled</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>types</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.store.SchemaTemplateSetting.FieldTemplate">SchemaTemplateSetting.FieldTemplate</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#bytebase.store.Engine">Engine</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>category</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>column</td>
- <td><a href="#bytebase.store.ColumnMetadata">ColumnMetadata</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>catalog</td>
- <td><a href="#bytebase.store.ColumnCatalog">ColumnCatalog</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.store.SchemaTemplateSetting.TableTemplate">SchemaTemplateSetting.TableTemplate</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>engine</td>
- <td><a href="#bytebase.store.Engine">Engine</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>category</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>table</td>
- <td><a href="#bytebase.store.TableMetadata">TableMetadata</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>catalog</td>
- <td><a href="#bytebase.store.TableCatalog">TableCatalog</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
<h3 id="bytebase.store.SemanticTypeSetting">SemanticTypeSetting</h3>
<p></p>
@@ -12540,12 +12344,6 @@ Default to this mode.</p></td>
<td><p></p></td>
</tr>
- <tr>
- <td>WORKSPACE_EXTERNAL_APPROVAL</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
<tr>
<td>ENTERPRISE_LICENSE</td>
<td>7</td>
@@ -12570,12 +12368,6 @@ Default to this mode.</p></td>
<td><p></p></td>
</tr>
- <tr>
- <td>SCHEMA_TEMPLATE</td>
- <td>13</td>
- <td><p></p></td>
- </tr>
-
<tr>
<td>DATA_CLASSIFICATION</td>
<td>14</td>
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index c16d84364c..aa891cd432 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -23,155 +23,6 @@
- [State](#bytebase-v1-State)
- [VCSType](#bytebase-v1-VCSType)
-- [v1/database_catalog_service.proto](#v1_database_catalog_service-proto)
- - [ColumnCatalog](#bytebase-v1-ColumnCatalog)
- - [ColumnCatalog.LabelsEntry](#bytebase-v1-ColumnCatalog-LabelsEntry)
- - [DatabaseCatalog](#bytebase-v1-DatabaseCatalog)
- - [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest)
- - [ObjectSchema](#bytebase-v1-ObjectSchema)
- - [ObjectSchema.ArrayKind](#bytebase-v1-ObjectSchema-ArrayKind)
- - [ObjectSchema.StructKind](#bytebase-v1-ObjectSchema-StructKind)
- - [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry)
- - [SchemaCatalog](#bytebase-v1-SchemaCatalog)
- - [TableCatalog](#bytebase-v1-TableCatalog)
- - [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns)
- - [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest)
-
- - [ObjectSchema.Type](#bytebase-v1-ObjectSchema-Type)
-
- - [DatabaseCatalogService](#bytebase-v1-DatabaseCatalogService)
-
-- [v1/instance_role_service.proto](#v1_instance_role_service-proto)
- - [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest)
- - [InstanceRole](#bytebase-v1-InstanceRole)
- - [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest)
- - [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse)
-
- - [InstanceRoleService](#bytebase-v1-InstanceRoleService)
-
-- [v1/instance_service.proto](#v1_instance_service-proto)
- - [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest)
- - [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest)
- - [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse)
- - [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest)
- - [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse)
- - [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest)
- - [DataSource](#bytebase-v1-DataSource)
- - [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential)
- - [DataSource.Address](#bytebase-v1-DataSource-Address)
- - [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential)
- - [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry)
- - [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential)
- - [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret)
- - [DataSourceExternalSecret.AppRoleAuthOption](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption)
- - [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest)
- - [GetInstanceRequest](#bytebase-v1-GetInstanceRequest)
- - [Instance](#bytebase-v1-Instance)
- - [Instance.LabelsEntry](#bytebase-v1-Instance-LabelsEntry)
- - [InstanceResource](#bytebase-v1-InstanceResource)
- - [KerberosConfig](#bytebase-v1-KerberosConfig)
- - [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest)
- - [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse)
- - [ListInstancesRequest](#bytebase-v1-ListInstancesRequest)
- - [ListInstancesResponse](#bytebase-v1-ListInstancesResponse)
- - [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest)
- - [SASLConfig](#bytebase-v1-SASLConfig)
- - [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest)
- - [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse)
- - [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest)
- - [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest)
- - [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest)
-
- - [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType)
- - [DataSource.RedisType](#bytebase-v1-DataSource-RedisType)
- - [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType)
- - [DataSourceExternalSecret.AuthType](#bytebase-v1-DataSourceExternalSecret-AuthType)
- - [DataSourceExternalSecret.SecretType](#bytebase-v1-DataSourceExternalSecret-SecretType)
- - [DataSourceType](#bytebase-v1-DataSourceType)
-
- - [InstanceService](#bytebase-v1-InstanceService)
-
-- [v1/database_service.proto](#v1_database_service-proto)
- - [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest)
- - [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse)
- - [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest)
- - [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse)
- - [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest)
- - [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse)
- - [BoundingBox](#bytebase-v1-BoundingBox)
- - [ChangedResourceDatabase](#bytebase-v1-ChangedResourceDatabase)
- - [ChangedResourceFunction](#bytebase-v1-ChangedResourceFunction)
- - [ChangedResourceProcedure](#bytebase-v1-ChangedResourceProcedure)
- - [ChangedResourceSchema](#bytebase-v1-ChangedResourceSchema)
- - [ChangedResourceTable](#bytebase-v1-ChangedResourceTable)
- - [ChangedResourceView](#bytebase-v1-ChangedResourceView)
- - [ChangedResources](#bytebase-v1-ChangedResources)
- - [Changelog](#bytebase-v1-Changelog)
- - [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata)
- - [ColumnMetadata](#bytebase-v1-ColumnMetadata)
- - [Database](#bytebase-v1-Database)
- - [Database.LabelsEntry](#bytebase-v1-Database-LabelsEntry)
- - [DatabaseMetadata](#bytebase-v1-DatabaseMetadata)
- - [DatabaseSDLSchema](#bytebase-v1-DatabaseSDLSchema)
- - [DatabaseSchema](#bytebase-v1-DatabaseSchema)
- - [DependencyColumn](#bytebase-v1-DependencyColumn)
- - [DependencyTable](#bytebase-v1-DependencyTable)
- - [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest)
- - [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse)
- - [DimensionConstraint](#bytebase-v1-DimensionConstraint)
- - [DimensionalConfig](#bytebase-v1-DimensionalConfig)
- - [EnumTypeMetadata](#bytebase-v1-EnumTypeMetadata)
- - [EventMetadata](#bytebase-v1-EventMetadata)
- - [ExtensionMetadata](#bytebase-v1-ExtensionMetadata)
- - [ExternalTableMetadata](#bytebase-v1-ExternalTableMetadata)
- - [ForeignKeyMetadata](#bytebase-v1-ForeignKeyMetadata)
- - [FunctionMetadata](#bytebase-v1-FunctionMetadata)
- - [GenerationMetadata](#bytebase-v1-GenerationMetadata)
- - [GetChangelogRequest](#bytebase-v1-GetChangelogRequest)
- - [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest)
- - [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest)
- - [GetDatabaseSDLSchemaRequest](#bytebase-v1-GetDatabaseSDLSchemaRequest)
- - [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest)
- - [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest)
- - [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse)
- - [GridLevel](#bytebase-v1-GridLevel)
- - [IndexMetadata](#bytebase-v1-IndexMetadata)
- - [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest)
- - [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse)
- - [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest)
- - [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse)
- - [MaterializedViewMetadata](#bytebase-v1-MaterializedViewMetadata)
- - [PackageMetadata](#bytebase-v1-PackageMetadata)
- - [ProcedureMetadata](#bytebase-v1-ProcedureMetadata)
- - [SchemaMetadata](#bytebase-v1-SchemaMetadata)
- - [SequenceMetadata](#bytebase-v1-SequenceMetadata)
- - [SpatialIndexConfig](#bytebase-v1-SpatialIndexConfig)
- - [StorageConfig](#bytebase-v1-StorageConfig)
- - [StreamMetadata](#bytebase-v1-StreamMetadata)
- - [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest)
- - [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse)
- - [TableMetadata](#bytebase-v1-TableMetadata)
- - [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata)
- - [TaskMetadata](#bytebase-v1-TaskMetadata)
- - [TessellationConfig](#bytebase-v1-TessellationConfig)
- - [TriggerMetadata](#bytebase-v1-TriggerMetadata)
- - [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest)
- - [ViewMetadata](#bytebase-v1-ViewMetadata)
-
- - [Changelog.Status](#bytebase-v1-Changelog-Status)
- - [Changelog.Type](#bytebase-v1-Changelog-Type)
- - [ChangelogView](#bytebase-v1-ChangelogView)
- - [ColumnMetadata.IdentityGeneration](#bytebase-v1-ColumnMetadata-IdentityGeneration)
- - [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type)
- - [GetDatabaseSDLSchemaRequest.SDLFormat](#bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat)
- - [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType)
- - [StreamMetadata.Mode](#bytebase-v1-StreamMetadata-Mode)
- - [StreamMetadata.Type](#bytebase-v1-StreamMetadata-Type)
- - [TablePartitionMetadata.Type](#bytebase-v1-TablePartitionMetadata-Type)
- - [TaskMetadata.State](#bytebase-v1-TaskMetadata-State)
-
- - [DatabaseService](#bytebase-v1-DatabaseService)
-
- [v1/issue_service.proto](#v1_issue_service-proto)
- [ApprovalFlow](#bytebase-v1-ApprovalFlow)
- [ApprovalTemplate](#bytebase-v1-ApprovalTemplate)
@@ -283,10 +134,6 @@
- [ListSettingsResponse](#bytebase-v1-ListSettingsResponse)
- [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting)
- [SCIMSetting](#bytebase-v1-SCIMSetting)
- - [SchemaTemplateSetting](#bytebase-v1-SchemaTemplateSetting)
- - [SchemaTemplateSetting.ColumnType](#bytebase-v1-SchemaTemplateSetting-ColumnType)
- - [SchemaTemplateSetting.FieldTemplate](#bytebase-v1-SchemaTemplateSetting-FieldTemplate)
- - [SchemaTemplateSetting.TableTemplate](#bytebase-v1-SchemaTemplateSetting-TableTemplate)
- [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting)
- [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType)
- [Setting](#bytebase-v1-Setting)
@@ -365,6 +212,24 @@
- [CelService](#bytebase-v1-CelService)
+- [v1/database_catalog_service.proto](#v1_database_catalog_service-proto)
+ - [ColumnCatalog](#bytebase-v1-ColumnCatalog)
+ - [ColumnCatalog.LabelsEntry](#bytebase-v1-ColumnCatalog-LabelsEntry)
+ - [DatabaseCatalog](#bytebase-v1-DatabaseCatalog)
+ - [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest)
+ - [ObjectSchema](#bytebase-v1-ObjectSchema)
+ - [ObjectSchema.ArrayKind](#bytebase-v1-ObjectSchema-ArrayKind)
+ - [ObjectSchema.StructKind](#bytebase-v1-ObjectSchema-StructKind)
+ - [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry)
+ - [SchemaCatalog](#bytebase-v1-SchemaCatalog)
+ - [TableCatalog](#bytebase-v1-TableCatalog)
+ - [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns)
+ - [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest)
+
+ - [ObjectSchema.Type](#bytebase-v1-ObjectSchema-Type)
+
+ - [DatabaseCatalogService](#bytebase-v1-DatabaseCatalogService)
+
- [v1/database_group_service.proto](#v1_database_group_service-proto)
- [CreateDatabaseGroupRequest](#bytebase-v1-CreateDatabaseGroupRequest)
- [DatabaseGroup](#bytebase-v1-DatabaseGroup)
@@ -379,55 +244,186 @@
- [DatabaseGroupService](#bytebase-v1-DatabaseGroupService)
-- [v1/group_service.proto](#v1_group_service-proto)
- - [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest)
- - [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse)
- - [CreateGroupRequest](#bytebase-v1-CreateGroupRequest)
- - [DeleteGroupRequest](#bytebase-v1-DeleteGroupRequest)
- - [GetGroupRequest](#bytebase-v1-GetGroupRequest)
- - [Group](#bytebase-v1-Group)
- - [GroupMember](#bytebase-v1-GroupMember)
- - [ListGroupsRequest](#bytebase-v1-ListGroupsRequest)
- - [ListGroupsResponse](#bytebase-v1-ListGroupsResponse)
- - [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest)
-
- - [GroupMember.Role](#bytebase-v1-GroupMember-Role)
+- [v1/instance_role_service.proto](#v1_instance_role_service-proto)
+ - [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest)
+ - [InstanceRole](#bytebase-v1-InstanceRole)
+ - [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest)
+ - [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse)
- - [GroupService](#bytebase-v1-GroupService)
+ - [InstanceRoleService](#bytebase-v1-InstanceRoleService)
-- [v1/idp_service.proto](#v1_idp_service-proto)
- - [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest)
- - [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest)
- - [FieldMapping](#bytebase-v1-FieldMapping)
- - [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest)
- - [IdentityProvider](#bytebase-v1-IdentityProvider)
- - [IdentityProviderConfig](#bytebase-v1-IdentityProviderConfig)
- - [LDAPIdentityProviderConfig](#bytebase-v1-LDAPIdentityProviderConfig)
- - [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest)
- - [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse)
- - [OAuth2IdentityProviderConfig](#bytebase-v1-OAuth2IdentityProviderConfig)
- - [OAuth2IdentityProviderTestRequestContext](#bytebase-v1-OAuth2IdentityProviderTestRequestContext)
- - [OIDCIdentityProviderConfig](#bytebase-v1-OIDCIdentityProviderConfig)
- - [OIDCIdentityProviderTestRequestContext](#bytebase-v1-OIDCIdentityProviderTestRequestContext)
- - [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest)
- - [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse)
- - [TestIdentityProviderResponse.ClaimsEntry](#bytebase-v1-TestIdentityProviderResponse-ClaimsEntry)
- - [TestIdentityProviderResponse.UserInfoEntry](#bytebase-v1-TestIdentityProviderResponse-UserInfoEntry)
- - [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest)
+- [v1/instance_service.proto](#v1_instance_service-proto)
+ - [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest)
+ - [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest)
+ - [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse)
+ - [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest)
+ - [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse)
+ - [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest)
+ - [DataSource](#bytebase-v1-DataSource)
+ - [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential)
+ - [DataSource.Address](#bytebase-v1-DataSource-Address)
+ - [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential)
+ - [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry)
+ - [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential)
+ - [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret)
+ - [DataSourceExternalSecret.AppRoleAuthOption](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption)
+ - [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest)
+ - [GetInstanceRequest](#bytebase-v1-GetInstanceRequest)
+ - [Instance](#bytebase-v1-Instance)
+ - [Instance.LabelsEntry](#bytebase-v1-Instance-LabelsEntry)
+ - [InstanceResource](#bytebase-v1-InstanceResource)
+ - [KerberosConfig](#bytebase-v1-KerberosConfig)
+ - [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest)
+ - [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse)
+ - [ListInstancesRequest](#bytebase-v1-ListInstancesRequest)
+ - [ListInstancesResponse](#bytebase-v1-ListInstancesResponse)
+ - [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest)
+ - [SASLConfig](#bytebase-v1-SASLConfig)
+ - [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest)
+ - [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse)
+ - [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest)
+ - [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest)
+ - [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest)
- - [IdentityProviderType](#bytebase-v1-IdentityProviderType)
- - [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol)
- - [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle)
+ - [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType)
+ - [DataSource.RedisType](#bytebase-v1-DataSource-RedisType)
+ - [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType)
+ - [DataSourceExternalSecret.AuthType](#bytebase-v1-DataSourceExternalSecret-AuthType)
+ - [DataSourceExternalSecret.SecretType](#bytebase-v1-DataSourceExternalSecret-SecretType)
+ - [DataSourceType](#bytebase-v1-DataSourceType)
- - [IdentityProviderService](#bytebase-v1-IdentityProviderService)
+ - [InstanceService](#bytebase-v1-InstanceService)
-- [v1/org_policy_service.proto](#v1_org_policy_service-proto)
- - [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest)
- - [DataSourceQueryPolicy](#bytebase-v1-DataSourceQueryPolicy)
- - [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest)
- - [GetPolicyRequest](#bytebase-v1-GetPolicyRequest)
- - [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest)
- - [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse)
+- [v1/database_service.proto](#v1_database_service-proto)
+ - [BatchGetDatabasesRequest](#bytebase-v1-BatchGetDatabasesRequest)
+ - [BatchGetDatabasesResponse](#bytebase-v1-BatchGetDatabasesResponse)
+ - [BatchSyncDatabasesRequest](#bytebase-v1-BatchSyncDatabasesRequest)
+ - [BatchSyncDatabasesResponse](#bytebase-v1-BatchSyncDatabasesResponse)
+ - [BatchUpdateDatabasesRequest](#bytebase-v1-BatchUpdateDatabasesRequest)
+ - [BatchUpdateDatabasesResponse](#bytebase-v1-BatchUpdateDatabasesResponse)
+ - [BoundingBox](#bytebase-v1-BoundingBox)
+ - [ChangedResourceDatabase](#bytebase-v1-ChangedResourceDatabase)
+ - [ChangedResourceFunction](#bytebase-v1-ChangedResourceFunction)
+ - [ChangedResourceProcedure](#bytebase-v1-ChangedResourceProcedure)
+ - [ChangedResourceSchema](#bytebase-v1-ChangedResourceSchema)
+ - [ChangedResourceTable](#bytebase-v1-ChangedResourceTable)
+ - [ChangedResourceView](#bytebase-v1-ChangedResourceView)
+ - [ChangedResources](#bytebase-v1-ChangedResources)
+ - [Changelog](#bytebase-v1-Changelog)
+ - [CheckConstraintMetadata](#bytebase-v1-CheckConstraintMetadata)
+ - [ColumnMetadata](#bytebase-v1-ColumnMetadata)
+ - [Database](#bytebase-v1-Database)
+ - [Database.LabelsEntry](#bytebase-v1-Database-LabelsEntry)
+ - [DatabaseMetadata](#bytebase-v1-DatabaseMetadata)
+ - [DatabaseSDLSchema](#bytebase-v1-DatabaseSDLSchema)
+ - [DatabaseSchema](#bytebase-v1-DatabaseSchema)
+ - [DependencyColumn](#bytebase-v1-DependencyColumn)
+ - [DependencyTable](#bytebase-v1-DependencyTable)
+ - [DiffSchemaRequest](#bytebase-v1-DiffSchemaRequest)
+ - [DiffSchemaResponse](#bytebase-v1-DiffSchemaResponse)
+ - [DimensionConstraint](#bytebase-v1-DimensionConstraint)
+ - [DimensionalConfig](#bytebase-v1-DimensionalConfig)
+ - [EnumTypeMetadata](#bytebase-v1-EnumTypeMetadata)
+ - [EventMetadata](#bytebase-v1-EventMetadata)
+ - [ExtensionMetadata](#bytebase-v1-ExtensionMetadata)
+ - [ExternalTableMetadata](#bytebase-v1-ExternalTableMetadata)
+ - [ForeignKeyMetadata](#bytebase-v1-ForeignKeyMetadata)
+ - [FunctionMetadata](#bytebase-v1-FunctionMetadata)
+ - [GenerationMetadata](#bytebase-v1-GenerationMetadata)
+ - [GetChangelogRequest](#bytebase-v1-GetChangelogRequest)
+ - [GetDatabaseMetadataRequest](#bytebase-v1-GetDatabaseMetadataRequest)
+ - [GetDatabaseRequest](#bytebase-v1-GetDatabaseRequest)
+ - [GetDatabaseSDLSchemaRequest](#bytebase-v1-GetDatabaseSDLSchemaRequest)
+ - [GetDatabaseSchemaRequest](#bytebase-v1-GetDatabaseSchemaRequest)
+ - [GetSchemaStringRequest](#bytebase-v1-GetSchemaStringRequest)
+ - [GetSchemaStringResponse](#bytebase-v1-GetSchemaStringResponse)
+ - [GridLevel](#bytebase-v1-GridLevel)
+ - [IndexMetadata](#bytebase-v1-IndexMetadata)
+ - [ListChangelogsRequest](#bytebase-v1-ListChangelogsRequest)
+ - [ListChangelogsResponse](#bytebase-v1-ListChangelogsResponse)
+ - [ListDatabasesRequest](#bytebase-v1-ListDatabasesRequest)
+ - [ListDatabasesResponse](#bytebase-v1-ListDatabasesResponse)
+ - [MaterializedViewMetadata](#bytebase-v1-MaterializedViewMetadata)
+ - [PackageMetadata](#bytebase-v1-PackageMetadata)
+ - [ProcedureMetadata](#bytebase-v1-ProcedureMetadata)
+ - [SchemaMetadata](#bytebase-v1-SchemaMetadata)
+ - [SequenceMetadata](#bytebase-v1-SequenceMetadata)
+ - [SpatialIndexConfig](#bytebase-v1-SpatialIndexConfig)
+ - [StorageConfig](#bytebase-v1-StorageConfig)
+ - [StreamMetadata](#bytebase-v1-StreamMetadata)
+ - [SyncDatabaseRequest](#bytebase-v1-SyncDatabaseRequest)
+ - [SyncDatabaseResponse](#bytebase-v1-SyncDatabaseResponse)
+ - [TableMetadata](#bytebase-v1-TableMetadata)
+ - [TablePartitionMetadata](#bytebase-v1-TablePartitionMetadata)
+ - [TaskMetadata](#bytebase-v1-TaskMetadata)
+ - [TessellationConfig](#bytebase-v1-TessellationConfig)
+ - [TriggerMetadata](#bytebase-v1-TriggerMetadata)
+ - [UpdateDatabaseRequest](#bytebase-v1-UpdateDatabaseRequest)
+ - [ViewMetadata](#bytebase-v1-ViewMetadata)
+
+ - [Changelog.Status](#bytebase-v1-Changelog-Status)
+ - [Changelog.Type](#bytebase-v1-Changelog-Type)
+ - [ChangelogView](#bytebase-v1-ChangelogView)
+ - [ColumnMetadata.IdentityGeneration](#bytebase-v1-ColumnMetadata-IdentityGeneration)
+ - [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type)
+ - [GetDatabaseSDLSchemaRequest.SDLFormat](#bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat)
+ - [GetSchemaStringRequest.ObjectType](#bytebase-v1-GetSchemaStringRequest-ObjectType)
+ - [StreamMetadata.Mode](#bytebase-v1-StreamMetadata-Mode)
+ - [StreamMetadata.Type](#bytebase-v1-StreamMetadata-Type)
+ - [TablePartitionMetadata.Type](#bytebase-v1-TablePartitionMetadata-Type)
+ - [TaskMetadata.State](#bytebase-v1-TaskMetadata-State)
+
+ - [DatabaseService](#bytebase-v1-DatabaseService)
+
+- [v1/group_service.proto](#v1_group_service-proto)
+ - [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest)
+ - [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse)
+ - [CreateGroupRequest](#bytebase-v1-CreateGroupRequest)
+ - [DeleteGroupRequest](#bytebase-v1-DeleteGroupRequest)
+ - [GetGroupRequest](#bytebase-v1-GetGroupRequest)
+ - [Group](#bytebase-v1-Group)
+ - [GroupMember](#bytebase-v1-GroupMember)
+ - [ListGroupsRequest](#bytebase-v1-ListGroupsRequest)
+ - [ListGroupsResponse](#bytebase-v1-ListGroupsResponse)
+ - [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest)
+
+ - [GroupMember.Role](#bytebase-v1-GroupMember-Role)
+
+ - [GroupService](#bytebase-v1-GroupService)
+
+- [v1/idp_service.proto](#v1_idp_service-proto)
+ - [CreateIdentityProviderRequest](#bytebase-v1-CreateIdentityProviderRequest)
+ - [DeleteIdentityProviderRequest](#bytebase-v1-DeleteIdentityProviderRequest)
+ - [FieldMapping](#bytebase-v1-FieldMapping)
+ - [GetIdentityProviderRequest](#bytebase-v1-GetIdentityProviderRequest)
+ - [IdentityProvider](#bytebase-v1-IdentityProvider)
+ - [IdentityProviderConfig](#bytebase-v1-IdentityProviderConfig)
+ - [LDAPIdentityProviderConfig](#bytebase-v1-LDAPIdentityProviderConfig)
+ - [ListIdentityProvidersRequest](#bytebase-v1-ListIdentityProvidersRequest)
+ - [ListIdentityProvidersResponse](#bytebase-v1-ListIdentityProvidersResponse)
+ - [OAuth2IdentityProviderConfig](#bytebase-v1-OAuth2IdentityProviderConfig)
+ - [OAuth2IdentityProviderTestRequestContext](#bytebase-v1-OAuth2IdentityProviderTestRequestContext)
+ - [OIDCIdentityProviderConfig](#bytebase-v1-OIDCIdentityProviderConfig)
+ - [OIDCIdentityProviderTestRequestContext](#bytebase-v1-OIDCIdentityProviderTestRequestContext)
+ - [TestIdentityProviderRequest](#bytebase-v1-TestIdentityProviderRequest)
+ - [TestIdentityProviderResponse](#bytebase-v1-TestIdentityProviderResponse)
+ - [TestIdentityProviderResponse.ClaimsEntry](#bytebase-v1-TestIdentityProviderResponse-ClaimsEntry)
+ - [TestIdentityProviderResponse.UserInfoEntry](#bytebase-v1-TestIdentityProviderResponse-UserInfoEntry)
+ - [UpdateIdentityProviderRequest](#bytebase-v1-UpdateIdentityProviderRequest)
+
+ - [IdentityProviderType](#bytebase-v1-IdentityProviderType)
+ - [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol)
+ - [OAuth2AuthStyle](#bytebase-v1-OAuth2AuthStyle)
+
+ - [IdentityProviderService](#bytebase-v1-IdentityProviderService)
+
+- [v1/org_policy_service.proto](#v1_org_policy_service-proto)
+ - [CreatePolicyRequest](#bytebase-v1-CreatePolicyRequest)
+ - [DataSourceQueryPolicy](#bytebase-v1-DataSourceQueryPolicy)
+ - [DeletePolicyRequest](#bytebase-v1-DeletePolicyRequest)
+ - [GetPolicyRequest](#bytebase-v1-GetPolicyRequest)
+ - [ListPoliciesRequest](#bytebase-v1-ListPoliciesRequest)
+ - [ListPoliciesResponse](#bytebase-v1-ListPoliciesResponse)
- [MaskingExceptionPolicy](#bytebase-v1-MaskingExceptionPolicy)
- [MaskingExceptionPolicy.MaskingException](#bytebase-v1-MaskingExceptionPolicy-MaskingException)
- [MaskingRulePolicy](#bytebase-v1-MaskingRulePolicy)
@@ -900,2470 +896,2256 @@ Version control system type.
-<a name="v1_database_catalog_service-proto"></a>
+<a name="v1_issue_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/database_catalog_service.proto
+## v1/issue_service.proto
-<a name="bytebase-v1-ColumnCatalog"></a>
+<a name="bytebase-v1-ApprovalFlow"></a>
+
+### ApprovalFlow
-### 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. |
+| roles | [string](#string) | repeated | The roles required for approval in order. |
-<a name="bytebase-v1-ColumnCatalog-LabelsEntry"></a>
+<a name="bytebase-v1-ApprovalTemplate"></a>
-### ColumnCatalog.LabelsEntry
+### ApprovalTemplate
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| flow | [ApprovalFlow](#bytebase-v1-ApprovalFlow) | | The approval flow definition. |
+| title | [string](#string) | | The title of the approval template. |
+| description | [string](#string) | | The description of the approval template. |
-<a name="bytebase-v1-DatabaseCatalog"></a>
+<a name="bytebase-v1-ApproveIssueRequest"></a>
+
+### ApproveIssueRequest
-### DatabaseCatalog
-Catalog metadata for a database including schemas, tables, and columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog |
-| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | The schemas in the database. |
+| 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-GetDatabaseCatalogRequest"></a>
+<a name="bytebase-v1-BatchUpdateIssuesStatusRequest"></a>
+
+### BatchUpdateIssuesStatusRequest
-### GetDatabaseCatalogRequest
-Request message for getting a database catalog.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |
+| 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-ObjectSchema"></a>
+<a name="bytebase-v1-BatchUpdateIssuesStatusResponse"></a>
-### ObjectSchema
-Schema definition for object-type columns.
+### BatchUpdateIssuesStatusResponse
-| 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-CreateIssueCommentRequest"></a>
-<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>
+### CreateIssueCommentRequest
-### ObjectSchema.ArrayKind
-Array type with element schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |
+| 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-ObjectSchema-StructKind"></a>
+<a name="bytebase-v1-CreateIssueRequest"></a>
+
+### CreateIssueRequest
-### 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. |
+| 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-ObjectSchema-StructKind-PropertiesEntry"></a>
+<a name="bytebase-v1-GetIssueRequest"></a>
-### ObjectSchema.StructKind.PropertiesEntry
+### GetIssueRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |
+| 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-SchemaCatalog"></a>
+<a name="bytebase-v1-GrantRequest"></a>
+
+### GrantRequest
-### SchemaCatalog
-Schema metadata within a database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The schema name. |
-| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |
+| 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-TableCatalog"></a>
+<a name="bytebase-v1-Issue"></a>
+
+### Issue
-### TableCatalog
-Table metadata within a schema.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The table name. |
-| columns | [TableCatalog.Columns](#bytebase-v1-TableCatalog-Columns) | | Regular table columns. |
-| object_schema | [ObjectSchema](#bytebase-v1-ObjectSchema) | | Object schema for JSON/XML columns. |
-| classification | [string](#string) | | The data classification level for this table. |
+| 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} |
+| rollout | [string](#string) | | The rollout associated with the issue. Can be empty. Format: projects/{project}/rollouts/{rollout} |
+| grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. |
+| releasers | [string](#string) | repeated | The releasers of the pending stage of the issue rollout, judging from the rollout policy. Format: - roles/workspaceOwner - roles/workspaceDBA - roles/projectOwner - roles/projectReleaser |
+| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. |
+| task_status_count | [Issue.TaskStatusCountEntry](#bytebase-v1-Issue-TaskStatusCountEntry) | repeated | The status count of the issue. Keys are the following: - NOT_STARTED - SKIPPED - PENDING - RUNNING - DONE - FAILED - CANCELED |
+| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. |
+| approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | |
+| approval_status_error | [string](#string) | | Only populated when approval_status == ERROR |
-<a name="bytebase-v1-TableCatalog-Columns"></a>
+<a name="bytebase-v1-Issue-Approver"></a>
-### TableCatalog.Columns
-Column list for regular tables.
+### Issue.Approver
+Approvers and their approval status for the issue.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |
+| status | [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status) | | The new status. |
+| principal | [string](#string) | | Format: users/[email protected] |
-<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>
+<a name="bytebase-v1-Issue-TaskStatusCountEntry"></a>
+
+### Issue.TaskStatusCountEntry
-### UpdateDatabaseCatalogRequest
-Request message for updating a database catalog.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| catalog | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | | The database catalog to update.
+| key | [string](#string) | | |
+| value | [int32](#int32) | | |
-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-IssueComment"></a>
+### IssueComment
+A comment on an issue.
-<a name="bytebase-v1-ObjectSchema-Type"></a>
-### ObjectSchema.Type
-Object schema data types.
+| 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. |
+| stage_end | [IssueComment.StageEnd](#bytebase-v1-IssueComment-StageEnd) | | Stage end event. |
+| task_update | [IssueComment.TaskUpdate](#bytebase-v1-IssueComment-TaskUpdate) | | Task update event. |
+| task_prior_backup | [IssueComment.TaskPriorBackup](#bytebase-v1-IssueComment-TaskPriorBackup) | | Task prior backup event. |
-| 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-DatabaseCatalogService"></a>
+<a name="bytebase-v1-IssueComment-Approval"></a>
-### DatabaseCatalogService
-DatabaseCatalogService manages database schema metadata and classification.
+### IssueComment.Approval
+Approval event information.
-| 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 |
+| ----- | ---- | ----- | ----------- |
+| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |
-<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-IssueComment-IssueUpdate"></a>
-<a name="bytebase-v1-GetInstanceRoleRequest"></a>
+### IssueComment.IssueUpdate
+Issue update event information.
-### GetInstanceRoleRequest
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| from_title | [string](#string) | optional | |
+| to_title | [string](#string) | optional | |
+| from_description | [string](#string) | optional | |
+| to_description | [string](#string) | optional | |
+| from_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
+| to_status | [IssueStatus](#bytebase-v1-IssueStatus) | optional | |
+| from_labels | [string](#string) | repeated | |
+| to_labels | [string](#string) | repeated | |
+
+
+
+<a name="bytebase-v1-IssueComment-StageEnd"></a>
+
+### IssueComment.StageEnd
+Stage end event information.
+
+
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the role to retrieve. Format: instances/{instance}/roles/{role name} The role name is the unique name for the role. |
+| stage | [string](#string) | | The stage that ended. |
-<a name="bytebase-v1-InstanceRole"></a>
+<a name="bytebase-v1-IssueComment-TaskPriorBackup"></a>
-### InstanceRole
-InstanceRole is the API message for instance role.
+### IssueComment.TaskPriorBackup
+Task prior backup event information.
| 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 |
+| task | [string](#string) | | The task for which backup was performed. |
+| tables | [IssueComment.TaskPriorBackup.Table](#bytebase-v1-IssueComment-TaskPriorBackup-Table) | repeated | The tables that were backed up. |
+| original_line | [int32](#int32) | optional | The original line number in the statement. |
+| database | [string](#string) | | The database that was backed up. |
+| error | [string](#string) | | Error message if backup failed. |
-<a name="bytebase-v1-ListInstanceRolesRequest"></a>
+<a name="bytebase-v1-IssueComment-TaskPriorBackup-Table"></a>
-### ListInstanceRolesRequest
+### IssueComment.TaskPriorBackup.Table
+Table identification.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| schema | [string](#string) | | The schema name. |
+| table | [string](#string) | | The table name. |
+
+
+
+
+
+
+<a name="bytebase-v1-IssueComment-TaskUpdate"></a>
+
+### IssueComment.TaskUpdate
+Task update event information.
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| tasks | [string](#string) | repeated | The tasks that were updated. |
+| from_sheet | [string](#string) | optional | Format: projects/{project}/sheets/{sheet} |
+| to_sheet | [string](#string) | optional | Format: projects/{project}/sheets/{sheet} |
+| to_status | [IssueComment.TaskUpdate.Status](#bytebase-v1-IssueComment-TaskUpdate-Status) | optional | |
+
+
+
+
+
+
+<a name="bytebase-v1-ListIssueCommentsRequest"></a>
+
+### ListIssueCommentsRequest
| 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.
+| 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 `ListInstanceRoles` must match the call that provided the page token. |
-| refresh | [bool](#bool) | | Refresh will refresh and return the latest data. |
+When paginating, all other parameters provided to `ListIssueComments` must match the call that provided the page token. |
-<a name="bytebase-v1-ListInstanceRolesResponse"></a>
+<a name="bytebase-v1-ListIssueCommentsResponse"></a>
-### ListInstanceRolesResponse
+### ListIssueCommentsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | The roles from the specified request. |
+| issue_comments | [IssueComment](#bytebase-v1-IssueComment) | repeated | The issue comments from the specified request. |
| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
-
+<a name="bytebase-v1-ListIssuesRequest"></a>
-
+### ListIssuesRequest
-<a name="bytebase-v1-InstanceRoleService"></a>
-### InstanceRoleService
-InstanceRoleService manages database roles within instances.
+| 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.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetInstanceRole | [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest) | [InstanceRole](#bytebase-v1-InstanceRole) | Gets a database role from an instance. Permissions required: bb.instanceRoles.get |
-| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |
+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. - task_type: support &#34;==&#34; operator, the value can be &#34;DDL&#34;, &#34;DML&#34; or &#34;DATA_EXPORT&#34; - instance: the instance full name in the &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - database: the database full name in the &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator. - environment: the database full name in the &#34;environments/{name}&#34; format, support &#34;==&#34; operator. - 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; instance == &#34;instances/sample&#34; &amp;&amp; labels in [&#34;label1&#34;, &#34;label2&#34;] create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; environment == &#34;environments/test&#34; |
+| query | [string](#string) | | Query is the query statement. |
-<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-ListIssuesResponse"></a>
-### AddDataSourceRequest
+### ListIssuesResponse
| 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. |
+| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-BatchSyncInstancesRequest"></a>
+<a name="bytebase-v1-RejectIssueRequest"></a>
-### BatchSyncInstancesRequest
+### RejectIssueRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| requests | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | repeated | The request message specifying the instances to sync. A maximum of 1000 instances can be synced in a batch. |
+| name | [string](#string) | | The name of the issue to add a rejection. Format: projects/{project}/issues/{issue} |
+| comment | [string](#string) | | The comment explaining the rejection decision. |
-<a name="bytebase-v1-BatchSyncInstancesResponse"></a>
+<a name="bytebase-v1-RequestIssueRequest"></a>
+
+### RequestIssueRequest
-### BatchSyncInstancesResponse
+| 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-BatchUpdateInstancesRequest"></a>
-### BatchUpdateInstancesRequest
+<a name="bytebase-v1-SearchIssuesRequest"></a>
+
+### SearchIssuesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |
+| parent | [string](#string) | | The parent, which owns this collection of issues. Format: projects/{project} Use &#34;projects/-&#34; to list all issues from all projects. |
+| page_size | [int32](#int32) | | The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 10 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchIssues` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `SearchIssues` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter issues returned in the list. Check the filter field in the ListIssuesRequest message. |
+| query | [string](#string) | | Query is the query statement. |
-<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>
+<a name="bytebase-v1-SearchIssuesResponse"></a>
-### BatchUpdateInstancesResponse
+### SearchIssuesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instances | [Instance](#bytebase-v1-Instance) | repeated | |
+| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-CreateInstanceRequest"></a>
+<a name="bytebase-v1-UpdateIssueCommentRequest"></a>
-### CreateInstanceRequest
+### UpdateIssueCommentRequest
| 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. |
+| 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-DataSource"></a>
+<a name="bytebase-v1-UpdateIssueRequest"></a>
-### DataSource
+### UpdateIssueRequest
| 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. |
-| external_secret | [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret) | | |
-| authentication_type | [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType) | | |
-| azure_credential | [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential) | | |
-| aws_credential | [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential) | | |
-| gcp_credential | [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential) | | |
-| sasl_config | [SASLConfig](#bytebase-v1-SASLConfig) | | |
-| additional_addresses | [DataSource.Address](#bytebase-v1-DataSource-Address) | repeated | additional_addresses is used for MongoDB replica set. |
-| direct_connection | [bool](#bool) | | direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. |
-| region | [string](#string) | | region is the location of where the DB is, works for AWS RDS. For example, us-east-1. |
-| warehouse_id | [string](#string) | | warehouse_id is used by Databricks. |
-| master_name | [string](#string) | | master_name is the master name used by connecting redis-master via redis sentinel. |
-| master_username | [string](#string) | | master_username and master_password are master credentials used by redis sentinel mode. |
-| master_password | [string](#string) | | |
-| redis_type | [DataSource.RedisType](#bytebase-v1-DataSource-RedisType) | | |
-| cluster | [string](#string) | | Cluster is the cluster name for the data source. Used by CockroachDB. |
-| extra_connection_parameters | [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry) | repeated | Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write |
-
-
-
-
-
-
-<a name="bytebase-v1-DataSource-AWSCredential"></a>
-
-### DataSource.AWSCredential
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| access_key_id | [string](#string) | | |
-| secret_access_key | [string](#string) | | |
-| session_token | [string](#string) | | |
-| role_arn | [string](#string) | | ARN of IAM role to assume for cross-account access. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html |
-| external_id | [string](#string) | | Optional external ID for additional security when assuming role. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html |
-
-
-
-
-
-
-<a name="bytebase-v1-DataSource-Address"></a>
-
-### DataSource.Address
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| host | [string](#string) | | |
-| port | [string](#string) | | |
-
-
-
-
-
-
-<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-DataSource-ExtraConnectionParametersEntry"></a>
-
-### DataSource.ExtraConnectionParametersEntry
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
-
-
-
-
-
-
-<a name="bytebase-v1-DataSource-GCPCredential"></a>
-
-### DataSource.GCPCredential
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| content | [string](#string) | | |
-
-
-
-
-
-
-<a name="bytebase-v1-DataSourceExternalSecret"></a>
-
-### DataSourceExternalSecret
-
-
-
-| 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-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-DeleteInstanceRequest"></a>
-
-### DeleteInstanceRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to delete. Format: instances/{instance} |
-| force | [bool](#bool) | | If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. |
-| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted instance and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted instances. The instance must already be soft-deleted for this to work. |
-
-
-
-
-
-
-<a name="bytebase-v1-GetInstanceRequest"></a>
-
-### GetInstanceRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |
-
-
-
-
-
-
-<a name="bytebase-v1-Instance"></a>
-
-### Instance
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |
-| title | [string](#string) | | The display title of the instance. |
-| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
-| engine_version | [string](#string) | | The version of the database engine. |
-| external_link | [string](#string) | | External URL to the database instance console. |
-| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. |
-| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-| activation | [bool](#bool) | | Whether the instance is activated for use. |
-| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. |
-| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |
-| maximum_connections | [int32](#int32) | | The maximum number of connections. The default is 10 if the value is unset or zero. |
-| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas &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
+| 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. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+
+<a name="bytebase-v1-Issue-ApprovalStatus"></a>
-<a name="bytebase-v1-InstanceResource"></a>
+### Issue.ApprovalStatus
+The overall approval status for the issue.
-### InstanceResource
+| 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. |
+| ERROR | 6 | Error occurred during approval evaluation. |
-| 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-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-KerberosConfig"></a>
+### Issue.Type
+The type of issue.
-### KerberosConfig
+| 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 |
-| ----- | ---- | ----- | ----------- |
-| 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-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-IssueComment-TaskUpdate-Status"></a>
-<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>
+### IssueComment.TaskUpdate.Status
+Task status values.
-### ListInstanceDatabaseRequest
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | Unspecified status. |
+| PENDING | 1 | Task is pending. |
+| RUNNING | 2 | Task is running. |
+| DONE | 3 | Task is done. |
+| FAILED | 4 | Task failed. |
+| SKIPPED | 5 | Task was skipped. |
+| CANCELED | 6 | Task was canceled. |
-| 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. |
+<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-ListInstanceDatabaseResponse"></a>
-### ListInstanceDatabaseResponse
+<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) |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| databases | [string](#string) | repeated | All database name list in the instance. |
+
+<a name="v1_iam_policy-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/iam_policy.proto
-<a name="bytebase-v1-ListInstancesRequest"></a>
-### ListInstancesRequest
+<a name="bytebase-v1-Binding"></a>
+### Binding
+Binding associates members with a role and optional conditions.
| 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.
+| 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
-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; |
+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-ListInstancesResponse"></a>
-### ListInstancesResponse
+<a name="bytebase-v1-BindingDelta"></a>
+### BindingDelta
+A single change to a binding.
| 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. |
-
+| 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-RemoveDataSourceRequest"></a>
-### RemoveDataSourceRequest
+<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 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. |
-
+| resource | [string](#string) | | The name of the resource to get the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
-<a name="bytebase-v1-SASLConfig"></a>
-### SASLConfig
+<a name="bytebase-v1-IamPolicy"></a>
+### IamPolicy
+IAM policy that binds members to roles.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |
-
+| 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-SyncInstanceRequest"></a>
-### SyncInstanceRequest
+<a name="bytebase-v1-PolicyDelta"></a>
+### PolicyDelta
+Describes changes between two IAM policies.
| 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. |
-
+| binding_deltas | [BindingDelta](#bytebase-v1-BindingDelta) | repeated | The delta for Bindings between two policies. |
-<a name="bytebase-v1-SyncInstanceResponse"></a>
-### SyncInstanceResponse
+<a name="bytebase-v1-SetIamPolicyRequest"></a>
+### SetIamPolicyRequest
+Request message for setting an IAM policy.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [string](#string) | repeated | All database name list in the instance. |
+| 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-UndeleteInstanceRequest"></a>
-### UndeleteInstanceRequest
+<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. |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |
+
+
+
+<a name="v1_project_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
-<a name="bytebase-v1-UpdateDataSourceRequest"></a>
+## v1/project_service.proto
-### UpdateDataSourceRequest
+<a name="bytebase-v1-Activity"></a>
-| 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. |
+### Activity
+Activity types for webhook notifications.
-<a name="bytebase-v1-UpdateInstanceRequest"></a>
+<a name="bytebase-v1-AddWebhookRequest"></a>
-### UpdateInstanceRequest
+### AddWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.
+| 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. |
-The instance&#39;s `name` field is used to identify the instance to update. Format: instances/{instance} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the instance is not found, a new instance will be created. In this situation, `update_mask` is ignored. |
-
+<a name="bytebase-v1-BatchDeleteProjectsRequest"></a>
+### BatchDeleteProjectsRequest
-<a name="bytebase-v1-DataSource-AuthenticationType"></a>
-### DataSource.AuthenticationType
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| names | [string](#string) | repeated | The names of the projects to delete. Format: projects/{project} |
+| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| AUTHENTICATION_UNSPECIFIED | 0 | |
-| PASSWORD | 1 | |
-| GOOGLE_CLOUD_SQL_IAM | 2 | |
-| AWS_RDS_IAM | 3 | |
-| AZURE_IAM | 4 | |
-<a name="bytebase-v1-DataSource-RedisType"></a>
-### DataSource.RedisType
+<a name="bytebase-v1-BatchGetIamPolicyRequest"></a>
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| REDIS_TYPE_UNSPECIFIED | 0 | |
-| STANDALONE | 1 | |
-| SENTINEL | 2 | |
-| CLUSTER | 3 | |
+### BatchGetIamPolicyRequest
-<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| scope | [string](#string) | | The scope of the batch get. Typically it&#39;s &#34;projects/-&#34;. |
+| names | [string](#string) | repeated | |
-### DataSourceExternalSecret.AppRoleAuthOption.SecretType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
-| PLAIN | 1 | Plain text secret. |
-| ENVIRONMENT | 2 | Secret from environment variable. |
-<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></a>
+<a name="bytebase-v1-BatchGetIamPolicyResponse"></a>
-### DataSourceExternalSecret.AuthType
+### BatchGetIamPolicyResponse
-| 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 |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| policy_results | [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult) | repeated | The policy results for each requested project. |
-<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>
-### DataSourceExternalSecret.SecretType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
-| VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 |
-| AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html |
-| GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |
+<a name="bytebase-v1-BatchGetIamPolicyResponse-PolicyResult"></a>
+### BatchGetIamPolicyResponse.PolicyResult
+Result for a single project&#39;s IAM policy.
-<a name="bytebase-v1-DataSourceType"></a>
-### DataSourceType
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| project | [string](#string) | | The project resource name. |
+| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | The IAM policy for the project. |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| DATA_SOURCE_UNSPECIFIED | 0 | Unspecified data source type. |
-| ADMIN | 1 | Admin data source with write permissions. |
-| READ_ONLY | 2 | Read-only data source for query operations. |
-
-
+<a name="bytebase-v1-CreateProjectRequest"></a>
-<a name="bytebase-v1-InstanceService"></a>
+### CreateProjectRequest
-### InstanceService
-InstanceService manages database instances and their connections.
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetInstance | [GetInstanceRequest](#bytebase-v1-GetInstanceRequest) | [Instance](#bytebase-v1-Instance) | Gets a database instance by name. Permissions required: bb.instances.get |
-| ListInstances | [ListInstancesRequest](#bytebase-v1-ListInstancesRequest) | [ListInstancesResponse](#bytebase-v1-ListInstancesResponse) | Lists all database instances. Permissions required: bb.instances.list |
-| CreateInstance | [CreateInstanceRequest](#bytebase-v1-CreateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Creates a new database instance. Permissions required: bb.instances.create |
-| UpdateInstance | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | [Instance](#bytebase-v1-Instance) | Updates a database instance. Permissions required: bb.instances.update |
-| DeleteInstance | [DeleteInstanceRequest](#bytebase-v1-DeleteInstanceRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete |
-| UndeleteInstance | [UndeleteInstanceRequest](#bytebase-v1-UndeleteInstanceRequest) | [Instance](#bytebase-v1-Instance) | Restores a soft-deleted database instance. Permissions required: bb.instances.undelete |
-| SyncInstance | [SyncInstanceRequest](#bytebase-v1-SyncInstanceRequest) | [SyncInstanceResponse](#bytebase-v1-SyncInstanceResponse) | Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync |
-| ListInstanceDatabase | [ListInstanceDatabaseRequest](#bytebase-v1-ListInstanceDatabaseRequest) | [ListInstanceDatabaseResponse](#bytebase-v1-ListInstanceDatabaseResponse) | Lists all databases within an instance without creating them. Permissions required: bb.instances.get |
-| BatchSyncInstances | [BatchSyncInstancesRequest](#bytebase-v1-BatchSyncInstancesRequest) | [BatchSyncInstancesResponse](#bytebase-v1-BatchSyncInstancesResponse) | Syncs multiple instances in a single request. Permissions required: bb.instances.sync |
-| BatchUpdateInstances | [BatchUpdateInstancesRequest](#bytebase-v1-BatchUpdateInstancesRequest) | [BatchUpdateInstancesResponse](#bytebase-v1-BatchUpdateInstancesResponse) | Updates multiple instances in a single request. Permissions required: bb.instances.update |
-| AddDataSource | [AddDataSourceRequest](#bytebase-v1-AddDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Adds a read-only data source to an instance. Permissions required: bb.instances.update |
-| RemoveDataSource | [RemoveDataSourceRequest](#bytebase-v1-RemoveDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Removes a read-only data source from an instance. Permissions required: bb.instances.update |
-| UpdateDataSource | [UpdateDataSourceRequest](#bytebase-v1-UpdateDataSourceRequest) | [Instance](#bytebase-v1-Instance) | Updates a data source configuration. Permissions required: bb.instances.update |
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| 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="v1_database_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/database_service.proto
-<a name="bytebase-v1-BatchGetDatabasesRequest"></a>
+<a name="bytebase-v1-DeleteProjectRequest"></a>
-### BatchGetDatabasesRequest
+### DeleteProjectRequest
| 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. |
+| name | [string](#string) | | The name of the project to delete. Format: projects/{project} |
+| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
+| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted project and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted projects. The project must already be soft-deleted for this to work. |
-<a name="bytebase-v1-BatchGetDatabasesResponse"></a>
+<a name="bytebase-v1-GetProjectRequest"></a>
-### BatchGetDatabasesResponse
+### GetProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-
+| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |
-<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>
-### BatchSyncDatabasesRequest
+<a name="bytebase-v1-Label"></a>
+### Label
+A label for categorizing and organizing issues.
| 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. |
+| 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-BatchSyncDatabasesResponse"></a>
+<a name="bytebase-v1-ListProjectsRequest"></a>
+
+### ListProjectsRequest
+
+
-### BatchSyncDatabasesResponse
+| 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;). |
-<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>
+<a name="bytebase-v1-ListProjectsResponse"></a>
-### BatchUpdateDatabasesRequest
+### ListProjectsResponse
| 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. |
+| 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-BatchUpdateDatabasesResponse"></a>
+<a name="bytebase-v1-Project"></a>
-### BatchUpdateDatabasesResponse
+### Project
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |
+| 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. |
+| allow_modify_statement | [bool](#bool) | | Allow modifying SQL statements after issue is created. |
+| auto_resolve_issue | [bool](#bool) | | Enable automatic issue resolution when tasks complete. |
+| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |
+| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |
+| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |
+| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include &#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. |
-<a name="bytebase-v1-BoundingBox"></a>
+<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>
-### BoundingBox
-BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.
+### Project.ExecutionRetryPolicy
+Execution retry policy configuration.
| 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 |
+| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |
-<a name="bytebase-v1-ChangedResourceDatabase"></a>
+<a name="bytebase-v1-Project-LabelsEntry"></a>
-### ChangedResourceDatabase
+### Project.LabelsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | |
-| schemas | [ChangedResourceSchema](#bytebase-v1-ChangedResourceSchema) | repeated | |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-ChangedResourceFunction"></a>
+<a name="bytebase-v1-RemoveWebhookRequest"></a>
-### ChangedResourceFunction
+### RemoveWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | |
-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
+| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |
-<a name="bytebase-v1-ChangedResourceProcedure"></a>
+<a name="bytebase-v1-SearchProjectsRequest"></a>
-### ChangedResourceProcedure
+### SearchProjectsRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | |
-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
+| 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. |
-<a name="bytebase-v1-ChangedResourceSchema"></a>
-### ChangedResourceSchema
+<a name="bytebase-v1-SearchProjectsResponse"></a>
+
+### SearchProjectsResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | |
-| tables | [ChangedResourceTable](#bytebase-v1-ChangedResourceTable) | repeated | |
-| views | [ChangedResourceView](#bytebase-v1-ChangedResourceView) | repeated | |
-| functions | [ChangedResourceFunction](#bytebase-v1-ChangedResourceFunction) | repeated | |
-| procedures | [ChangedResourceProcedure](#bytebase-v1-ChangedResourceProcedure) | repeated | |
+| 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-ChangedResourceTable"></a>
+<a name="bytebase-v1-TestWebhookRequest"></a>
-### ChangedResourceTable
+### TestWebhookRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | |
-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
+| 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-ChangedResourceView"></a>
+<a name="bytebase-v1-TestWebhookResponse"></a>
-### ChangedResourceView
+### TestWebhookResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | |
-| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
+| error | [string](#string) | | The result of the test, empty if the test is successful. |
-<a name="bytebase-v1-ChangedResources"></a>
+<a name="bytebase-v1-UndeleteProjectRequest"></a>
-### ChangedResources
+### UndeleteProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [ChangedResourceDatabase](#bytebase-v1-ChangedResourceDatabase) | repeated | |
+| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |
-<a name="bytebase-v1-Changelog"></a>
+<a name="bytebase-v1-UpdateProjectRequest"></a>
-### Changelog
+### UpdateProjectRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
-| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |
-| statement | [string](#string) | | The statement is used for preview purpose. |
-| statement_size | [int64](#int64) | | |
-| statement_sheet | [string](#string) | | The name of the sheet resource. Format: projects/{project}/sheets/{sheet} |
-| schema | [string](#string) | | |
-| schema_size | [int64](#int64) | | |
-| prev_schema | [string](#string) | | |
-| prev_schema_size | [int64](#int64) | | |
-| issue | [string](#string) | | Format: projects/{project}/issues/{issue} |
-| task_run | [string](#string) | | Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
-| version | [string](#string) | | Could be empty |
-| revision | [string](#string) | | Could be empty Or present but not found if deleted |
-| changed_resources | [ChangedResources](#bytebase-v1-ChangedResources) | | |
-| type | [Changelog.Type](#bytebase-v1-Changelog-Type) | | |
+| 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-CheckConstraintMetadata"></a>
-### CheckConstraintMetadata
-CheckConstraintMetadata is the metadata for check constraints.
+<a name="bytebase-v1-UpdateWebhookRequest"></a>
+
+### UpdateWebhookRequest
+
| 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. |
+| 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-ColumnMetadata"></a>
+<a name="bytebase-v1-Webhook"></a>
+
+### Webhook
-### ColumnMetadata
-ColumnMetadata is the metadata for columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a column. |
-| position | [int32](#int32) | | The position is the position in columns. |
-| has_default | [bool](#bool) | | |
-| default | [string](#string) | | The default value of column. |
-| default_on_null | [bool](#bool) | | Oracle specific metadata. The default_on_null is the default on null of a column. |
-| on_update | [string](#string) | | The on_update is the on update action of a column. For MySQL like databases, it&#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.
+| name | [string](#string) | | name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook} |
+| type | [Webhook.Type](#bytebase-v1-Webhook-Type) | | type is the type of the webhook. |
+| title | [string](#string) | | title is the title of the webhook. |
+| url | [string](#string) | | url is the url of the webhook, should be unique within the project. |
+| direct_message | [bool](#bool) | | if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work. |
+| notification_types | [Activity.Type](#bytebase-v1-Activity-Type) | repeated | notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following: - ISSUE_CREATE - ISSUE_COMMENT_CREATE - ISSUE_FIELD_UPDATE - ISSUE_STATUS_UPDATE - ISSUE_APPROVAL_NOTIFY - ISSUE_PIPELINE_STAGE_STATUS_UPDATE - ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE - NOTIFY_ISSUE_APPROVED - NOTIFY_PIPELINE_ROLLOUT |
-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-Activity-Type"></a>
+### Activity.Type
+Activity type enumeration.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| NOTIFY_ISSUE_APPROVED | 23 | Notifications via webhooks.
+NOTIFY_ISSUE_APPROVED represents the issue approved notification. |
+| NOTIFY_PIPELINE_ROLLOUT | 24 | NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification. |
+| ISSUE_CREATE | 1 | Issue related activity types.
+ISSUE_CREATE represents creating an issue. |
+| ISSUE_COMMENT_CREATE | 2 | ISSUE_COMMENT_CREATE represents commenting on an issue. |
+| ISSUE_FIELD_UPDATE | 3 | ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc. |
+| ISSUE_STATUS_UPDATE | 4 | ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now. |
+| ISSUE_APPROVAL_NOTIFY | 21 | ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval. |
+| ISSUE_PIPELINE_STAGE_STATUS_UPDATE | 5 | ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now. |
+| ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE | 22 | ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED. |
-<a name="bytebase-v1-Database"></a>
-### Database
+<a name="bytebase-v1-Webhook-Type"></a>
+### Webhook.Type
+Webhook integration type.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database. Format: instances/{instance}/databases/{database} {database} is the database name in the instance. |
-| state | [State](#bytebase-v1-State) | | The existence of a database. |
-| successful_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The latest synchronization time. |
-| project | [string](#string) | | The project for a database. Format: projects/{project} |
-| schema_version | [string](#string) | | The version of database schema. |
-| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
-| effective_environment | [string](#string) | optional | The effective environment based on environment tag above and environment tag on the instance. Inheritance follows https://cloud.google.com/resource-manager/docs/tags/tags-overview. |
-| labels | [Database.LabelsEntry](#bytebase-v1-Database-LabelsEntry) | repeated | Labels will be used for deployment and policy control. |
-| instance_resource | [InstanceResource](#bytebase-v1-InstanceResource) | | The instance resource. |
-| backup_available | [bool](#bool) | | The database is available for DML prior backup. |
-| drifted | [bool](#bool) | | The schema is drifted from the source of truth. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | Unspecified type. |
+| SLACK | 1 | Slack integration. |
+| DISCORD | 2 | Discord integration. |
+| TEAMS | 3 | Microsoft Teams integration. |
+| DINGTALK | 4 | DingTalk integration. |
+| FEISHU | 5 | Feishu integration. |
+| WECOM | 6 | WeCom (WeChat Work) integration. |
+| LARK | 8 | Lark integration. |
+
+
+<a name="bytebase-v1-ProjectService"></a>
-<a name="bytebase-v1-Database-LabelsEntry"></a>
+### ProjectService
+ProjectService manages projects that group databases and changes.
-### Database.LabelsEntry
+| 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 |
+| 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 |
+| BatchGetIamPolicy | [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest) | [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse) | Deprecated. No permission check implemented. Permissions required: None |
+| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |
+| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |
+| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |
+| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |
+| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+<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-DatabaseMetadata"></a>
+### AISetting
-### DatabaseMetadata
-DatabaseMetadata is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The database metadata name.
+| enabled | [bool](#bool) | | |
+| provider | [AISetting.Provider](#bytebase-v1-AISetting-Provider) | | |
+| endpoint | [string](#string) | | |
+| api_key | [string](#string) | | |
+| model | [string](#string) | | |
+| version | [string](#string) | | |
-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-Algorithm"></a>
-<a name="bytebase-v1-DatabaseSDLSchema"></a>
+### Algorithm
-### DatabaseSDLSchema
-DatabaseSDLSchema contains the schema in SDL format.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [bytes](#bytes) | | The SDL schema content. - For SINGLE_FILE format: contains the complete SDL schema as a text string. - For MULTI_FILE format: contains the ZIP archive as binary data. |
-| content_type | [string](#string) | | The MIME type of the schema content. Indicates how the client should interpret the schema field. Examples: - &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format - &#34;application/zip&#34; for MULTI_FILE format |
+| 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-DatabaseSchema"></a>
+<a name="bytebase-v1-Algorithm-FullMask"></a>
+
+### Algorithm.FullMask
-### DatabaseSchema
-DatabaseSchema is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema dump from database. |
+| 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-DependencyColumn"></a>
+<a name="bytebase-v1-Algorithm-InnerOuterMask"></a>
+
+### Algorithm.InnerOuterMask
-### 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. |
+| prefix_len | [int32](#int32) | | |
+| suffix_len | [int32](#int32) | | |
+| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |
+| substitution | [string](#string) | | |
-<a name="bytebase-v1-DependencyTable"></a>
+<a name="bytebase-v1-Algorithm-MD5Mask"></a>
-### DependencyTable
+### Algorithm.MD5Mask
| 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. |
+| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |
-<a name="bytebase-v1-DiffSchemaRequest"></a>
+<a name="bytebase-v1-Algorithm-RangeMask"></a>
-### DiffSchemaRequest
+### Algorithm.RangeMask
| 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} |
+| slices | [Algorithm.RangeMask.Slice](#bytebase-v1-Algorithm-RangeMask-Slice) | repeated | We store it as a repeated field to face the fact that the original value may have multiple parts should be masked. But frontend can be started with a single rule easily. |
-<a name="bytebase-v1-DiffSchemaResponse"></a>
+<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>
-### DiffSchemaResponse
+### Algorithm.RangeMask.Slice
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| diff | [string](#string) | | |
+| start | [int32](#int32) | | start is the start index of the original value, start from 0 and should be less than stop. |
+| end | [int32](#int32) | | stop is the stop index of the original value, should be less than the length of the original value. |
+| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |
-<a name="bytebase-v1-DimensionConstraint"></a>
+<a name="bytebase-v1-Announcement"></a>
+
+### Announcement
-### 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 |
+| 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-DimensionalConfig"></a>
+<a name="bytebase-v1-AppIMSetting"></a>
+
+### AppIMSetting
-### DimensionalConfig
-DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| dimensions | [int32](#int32) | | Number of dimensions (2-4, default 2) |
-| data_type | [string](#string) | | Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) |
-| srid | [int32](#int32) | | Spatial reference system identifier (SRID) |
-| constraints | [DimensionConstraint](#bytebase-v1-DimensionConstraint) | repeated | Coordinate system constraints |
+| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |
-<a name="bytebase-v1-EnumTypeMetadata"></a>
+<a name="bytebase-v1-AppIMSetting-DingTalk"></a>
-### EnumTypeMetadata
+### AppIMSetting.DingTalk
| 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. |
+| client_id | [string](#string) | | |
+| client_secret | [string](#string) | | |
+| robot_code | [string](#string) | | |
-<a name="bytebase-v1-EventMetadata"></a>
+<a name="bytebase-v1-AppIMSetting-Feishu"></a>
-### EventMetadata
+### AppIMSetting.Feishu
| 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. |
+| app_id | [string](#string) | | |
+| app_secret | [string](#string) | | |
-<a name="bytebase-v1-ExtensionMetadata"></a>
+<a name="bytebase-v1-AppIMSetting-IMSetting"></a>
+
+### AppIMSetting.IMSetting
-### ExtensionMetadata
-ExtensionMetadata is the metadata for extensions.
| 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. |
+| type | [Webhook.Type](#bytebase-v1-Webhook-Type) | | |
+| 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) | | |
-<a name="bytebase-v1-ExternalTableMetadata"></a>
+<a name="bytebase-v1-AppIMSetting-Lark"></a>
-### ExternalTableMetadata
+### AppIMSetting.Lark
| 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. |
+| app_id | [string](#string) | | |
+| app_secret | [string](#string) | | |
-<a name="bytebase-v1-ForeignKeyMetadata"></a>
+<a name="bytebase-v1-AppIMSetting-Slack"></a>
+
+### AppIMSetting.Slack
-### ForeignKeyMetadata
-ForeignKeyMetadata is the metadata for foreign keys.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name is the name of a foreign key. |
-| columns | [string](#string) | repeated | The columns are the ordered referencing columns of a foreign key. |
-| referenced_schema | [string](#string) | | The referenced_schema is the referenced schema name of a foreign key. It is an empty string for databases without such concept such as MySQL. |
-| referenced_table | [string](#string) | | The referenced_table is the referenced table name of a foreign key. |
-| referenced_columns | [string](#string) | repeated | The referenced_columns are the ordered referenced columns of a foreign key. |
-| on_delete | [string](#string) | | The on_delete is the on delete action of a foreign key. |
-| on_update | [string](#string) | | The on_update is the on update action of a foreign key. |
-| match_type | [string](#string) | | The match_type is the match type of a foreign key. The match_type is the PostgreSQL specific field. It&#39;s empty string for other databases. |
+| token | [string](#string) | | |
-<a name="bytebase-v1-FunctionMetadata"></a>
+<a name="bytebase-v1-AppIMSetting-Wecom"></a>
+
+### AppIMSetting.Wecom
-### 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) | | |
+| corp_id | [string](#string) | | |
+| agent_id | [string](#string) | | |
+| secret | [string](#string) | | |
-<a name="bytebase-v1-GenerationMetadata"></a>
+<a name="bytebase-v1-DataClassificationSetting"></a>
-### GenerationMetadata
+### DataClassificationSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |
-| expression | [string](#string) | | |
+| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |
-<a name="bytebase-v1-GetChangelogRequest"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>
-### GetChangelogRequest
+### DataClassificationSetting.DataClassificationConfig
| 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) | | |
+| 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-GetDatabaseMetadataRequest"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>
-### GetDatabaseMetadataRequest
+### DataClassificationSetting.DataClassificationConfig.ClassificationEntry
| 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.
-
-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. |
+| key | [string](#string) | | |
+| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |
-<a name="bytebase-v1-GetDatabaseRequest"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>
-### GetDatabaseRequest
+### DataClassificationSetting.DataClassificationConfig.DataClassification
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve. Format: instances/{instance}/databases/{database} |
+| 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-GetDatabaseSDLSchemaRequest"></a>
+<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>
-### GetDatabaseSDLSchemaRequest
+### DataClassificationSetting.DataClassificationConfig.Level
| 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. |
+| id | [string](#string) | | |
+| title | [string](#string) | | |
+| description | [string](#string) | | |
-<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>
+<a name="bytebase-v1-EnvironmentSetting"></a>
-### GetDatabaseSchemaRequest
+### EnvironmentSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |
+| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |
-<a name="bytebase-v1-GetSchemaStringRequest"></a>
+<a name="bytebase-v1-EnvironmentSetting-Environment"></a>
-### GetSchemaStringRequest
+### EnvironmentSetting.Environment
| 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. |
+| 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-GetSchemaStringResponse"></a>
+<a name="bytebase-v1-EnvironmentSetting-Environment-TagsEntry"></a>
-### GetSchemaStringResponse
+### EnvironmentSetting.Environment.TagsEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema_string | [string](#string) | | |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-GridLevel"></a>
+<a name="bytebase-v1-GetSettingRequest"></a>
-### GridLevel
-GridLevel defines a tessellation grid level with its density.
+### GetSettingRequest
+The request message for getting a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |
-| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |
+| name | [string](#string) | | The resource name of the setting. |
-<a name="bytebase-v1-IndexMetadata"></a>
+<a name="bytebase-v1-GetSettingResponse"></a>
-### IndexMetadata
-IndexMetadata is the metadata for indexes.
+### GetSettingResponse
+The response message for getting a setting.
| 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). |
+| setting | [Setting](#bytebase-v1-Setting) | | |
-<a name="bytebase-v1-ListChangelogsRequest"></a>
+<a name="bytebase-v1-ListSettingsRequest"></a>
-### ListChangelogsRequest
+### ListSettingsRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent of the changelogs. Format: instances/{instance}/databases/{database} |
-| page_size | [int32](#int32) | | The maximum number of changelogs to return. The service may return fewer than this value. If unspecified, at most 10 changelogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from the previous call. Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided must match the call that provided the page token. |
-| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
-| filter | [string](#string) | | The filter of the changelogs. follow the [ebnf](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) syntax. Support filter by type, source or table. For example: table = &#34;tableExists(&#39;{database}&#39;, &#39;{schema}&#39;, &#39;{table}&#39;)&#34; table = &#34;tableExists(&#39;db&#39;, &#39;public&#39;, &#39;table1&#39;) || tableExists(&#39;db&#39;, &#39;public&#39;, &#39;table2&#39;)&#34;
-The table filter follow the CEL syntax. currently, we have one function for CEL: - tableExists(database, schema, table): return true if the table exists in changed resources.
-examples: Use tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;) to filter the changelogs which have the table &#34;table1&#34; in the schema &#34;public&#34; of the database &#34;db&#34;. For MySQL, the schema is always &#34;&#34;, such as tableExists(&#34;db&#34;, &#34;&#34;, &#34;table1&#34;).
-Combine multiple functions with &#34;&amp;&amp;&#34; and &#34;||&#34;, we MUST use the Disjunctive Normal Form(DNF). In other words, the CEL expression consists of several parts connected by OR operators. For example, the following expression is valid: ( tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;) &amp;&amp; tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table2&#34;) ) || ( tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table3&#34;) ) |
+<a name="bytebase-v1-ListSettingsResponse"></a>
+### ListSettingsResponse
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |
-<a name="bytebase-v1-ListChangelogsResponse"></a>
-### ListChangelogsResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| changelogs | [Changelog](#bytebase-v1-Changelog) | repeated | The list of changelogs. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+<a name="bytebase-v1-PasswordRestrictionSetting"></a>
+### PasswordRestrictionSetting
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| min_length | [int32](#int32) | | min_length is the minimum length for password, should no less than 8. |
+| require_number | [bool](#bool) | | require_number requires the password must contains at least one number. |
+| require_letter | [bool](#bool) | | require_letter requires the password must contains at least one letter, regardless of upper case or lower case |
+| require_uppercase_letter | [bool](#bool) | | require_uppercase_letter requires the password must contains at least one upper case letter. |
+| require_special_character | [bool](#bool) | | require_special_character requires the password must contains at least one special character. |
+| require_reset_password_for_first_login | [bool](#bool) | | require_reset_password_for_first_login requires users to reset their password after the 1st login. |
+| password_rotation | [google.protobuf.Duration](#google-protobuf-Duration) | | password_rotation requires users to reset their password after the duration. |
-<a name="bytebase-v1-ListDatabasesRequest"></a>
-### ListDatabasesRequest
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | - projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission. - workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission. - instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission |
-| page_size | [int32](#int32) | | The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.
+<a name="bytebase-v1-SCIMSetting"></a>
-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
+### SCIMSetting
-Supported filter: - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - name: the database name, support &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator. - drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator. - table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator. - labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
-For example: environment == &#34;environments/{environment resource id}&#34; environment == &#34;&#34; (find databases which environment is not set) project == &#34;projects/{project resource id}&#34; instance == &#34;instances/{instance resource id}&#34; name.matches(&#34;database name&#34;) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) exclude_unassigned == true drifted == true table == &#34;sample&#34; table.matches(&#34;sam&#34;) labels.environment == &#34;production&#34; labels.region == &#34;asia&#34; labels.region in [&#34;asia&#34;, &#34;europe&#34;]
-You can combine filter conditions like: environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) |
-| show_deleted | [bool](#bool) | | Show deleted database if specified. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| token | [string](#string) | | |
-<a name="bytebase-v1-ListDatabasesResponse"></a>
+<a name="bytebase-v1-SemanticTypeSetting"></a>
-### ListDatabasesResponse
+### SemanticTypeSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |
-<a name="bytebase-v1-MaterializedViewMetadata"></a>
+<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>
+
+### SemanticTypeSetting.SemanticType
-### 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) | | |
+| 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-PackageMetadata"></a>
+<a name="bytebase-v1-Setting"></a>
-### PackageMetadata
-PackageMetadata is the metadata for packages.
+### Setting
+The schema of setting.
| 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 resource name of the setting. Must be one of the following forms:
+- `setting/{setting}` For example, &#34;settings/bb.branding.logo&#34; |
+| value | [Value](#bytebase-v1-Value) | | The configuration value of the setting. |
-<a name="bytebase-v1-ProcedureMetadata"></a>
-### ProcedureMetadata
-ProcedureMetadata is the metadata for procedures.
+<a name="bytebase-v1-UpdateSettingRequest"></a>
+
+### UpdateSettingRequest
+The request message for updating or creating a setting.
| 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) | | |
+| 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-SchemaMetadata"></a>
+<a name="bytebase-v1-Value"></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.
+### Value
+The data in setting value.
| 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. |
+| string_value | [string](#string) | | Defines this value as being a string value. |
+| app_im_setting_value | [AppIMSetting](#bytebase-v1-AppIMSetting) | | |
+| workspace_profile_setting_value | [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting) | | reserved 4; // was AgentPluginSetting agent_plugin_setting_value |
+| workspace_approval_setting_value | [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting) | | |
+| data_classification_setting_value | [DataClassificationSetting](#bytebase-v1-DataClassificationSetting) | | |
+| semantic_type_setting_value | [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting) | | |
+| scim_setting | [SCIMSetting](#bytebase-v1-SCIMSetting) | | |
+| password_restriction_setting | [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting) | | |
+| ai_setting | [AISetting](#bytebase-v1-AISetting) | | |
+| environment_setting | [EnvironmentSetting](#bytebase-v1-EnvironmentSetting) | | |
-<a name="bytebase-v1-SequenceMetadata"></a>
+<a name="bytebase-v1-WorkspaceApprovalSetting"></a>
-### SequenceMetadata
+### WorkspaceApprovalSetting
| 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. |
+| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |
-<a name="bytebase-v1-SpatialIndexConfig"></a>
+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>
+
+### WorkspaceApprovalSetting.Rule
-### 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 |
+| template | [ApprovalTemplate](#bytebase-v1-ApprovalTemplate) | | |
+| condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with the rule. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+The `source` field filters which rules apply. The `condition` field then evaluates with full context.
+All supported variables: statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values. statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
+When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*) When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
+For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100 resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; |
+| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |
-<a name="bytebase-v1-StorageConfig"></a>
-### StorageConfig
-StorageConfig defines storage and performance parameters for spatial indexes.
+
+
+
+<a name="bytebase-v1-WorkspaceProfileSetting"></a>
+
+### WorkspaceProfileSetting
+
| 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 |
+| external_url | [string](#string) | | The external URL is used for sso authentication callback. |
+| disallow_signup | [bool](#bool) | | Disallow self-service signup, users can only be invited by the owner. |
+| require_2fa | [bool](#bool) | | Require 2FA for all users. |
+| token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for token. |
+| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
+| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
+| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
+| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
+| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
+| disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |
+| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
+| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &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. |
+
-<a name="bytebase-v1-StreamMetadata"></a>
-### StreamMetadata
+<a name="bytebase-v1-AISetting-Provider"></a>
+### AISetting.Provider
-| 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. |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| PROVIDER_UNSPECIFIED | 0 | |
+| OPEN_AI | 1 | |
+| CLAUDE | 2 | |
+| GEMINI | 3 | |
+| AZURE_OPENAI | 4 | |
+<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>
+### Algorithm.InnerOuterMask.MaskType
-<a name="bytebase-v1-SyncDatabaseRequest"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| MASK_TYPE_UNSPECIFIED | 0 | |
+| INNER | 1 | |
+| OUTER | 2 | |
-### SyncDatabaseRequest
+<a name="bytebase-v1-Announcement-AlertLevel"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |
+### 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-SyncDatabaseResponse"></a>
-### SyncDatabaseResponse
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DATABASE_CHANGE_MODE_UNSPECIFIED | 0 | |
+| PIPELINE | 1 | A more advanced database change process, including custom approval workflows and other advanced features. Default to this mode. |
+| EDITOR | 2 | A simple database change process in SQL editor. Users can execute SQL directly. |
+<a name="bytebase-v1-Setting-SettingName"></a>
+### Setting.SettingName
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SETTING_NAME_UNSPECIFIED | 0 | |
+| AUTH_SECRET | 1 | |
+| BRANDING_LOGO | 2 | |
+| WORKSPACE_ID | 3 | |
+| WORKSPACE_PROFILE | 4 | |
+| WORKSPACE_APPROVAL | 5 | |
+| ENTERPRISE_LICENSE | 7 | |
+| APP_IM | 8 | |
+| WATERMARK | 9 | |
+| AI | 10 | |
+| DATA_CLASSIFICATION | 14 | |
+| SEMANTIC_TYPES | 15 | |
+| SCIM | 17 | |
+| PASSWORD_RESTRICTION | 18 | |
+| ENVIRONMENT | 19 | |
-<a name="bytebase-v1-TableMetadata"></a>
-### TableMetadata
-TableMetadata is the metadata for tables.
+<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>
-| 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. |
+### WorkspaceApprovalSetting.Rule.Source
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SOURCE_UNSPECIFIED | 0 | |
+| CHANGE_DATABASE | 1 | |
+| CREATE_DATABASE | 2 | |
+| EXPORT_DATA | 3 | |
+| REQUEST_ROLE | 4 | |
+
+
-<a name="bytebase-v1-TablePartitionMetadata"></a>
-### TablePartitionMetadata
-TablePartitionMetadata is the metadata for table partitions.
+<a name="bytebase-v1-SettingService"></a>
+### SettingService
+SettingService manages workspace-level settings and configurations.
-| 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 | |
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| ListSettings | [ListSettingsRequest](#bytebase-v1-ListSettingsRequest) | [ListSettingsResponse](#bytebase-v1-ListSettingsResponse) | Lists all workspace settings. Permissions required: bb.settings.list |
+| GetSetting | [GetSettingRequest](#bytebase-v1-GetSettingRequest) | [Setting](#bytebase-v1-Setting) | Retrieves a workspace setting by name. Permissions required: bb.settings.get |
+| UpdateSetting | [UpdateSettingRequest](#bytebase-v1-UpdateSettingRequest) | [Setting](#bytebase-v1-Setting) | Updates a workspace setting. Permissions required: bb.settings.set |
+
+
+<a name="v1_user_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/user_service.proto
-<a name="bytebase-v1-TaskMetadata"></a>
+<a name="bytebase-v1-BatchGetUsersRequest"></a>
-### TaskMetadata
+### BatchGetUsersRequest
| 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. |
+| names | [string](#string) | repeated | The user names to retrieve. Format: users/{user uid or user email} |
-<a name="bytebase-v1-TessellationConfig"></a>
+<a name="bytebase-v1-BatchGetUsersResponse"></a>
+
+### BatchGetUsersResponse
-### 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) |
+| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
-<a name="bytebase-v1-TriggerMetadata"></a>
+<a name="bytebase-v1-CreateUserRequest"></a>
-### TriggerMetadata
+### CreateUserRequest
| 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. |
+| user | [User](#bytebase-v1-User) | | The user to create. |
-<a name="bytebase-v1-UpdateDatabaseRequest"></a>
+<a name="bytebase-v1-DeleteUserRequest"></a>
-### UpdateDatabaseRequest
+### DeleteUserRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| database | [Database](#bytebase-v1-Database) | | The database to update.
+| name | [string](#string) | | The name of the user to delete. Format: users/{user} |
-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-GetUserRequest"></a>
-<a name="bytebase-v1-ViewMetadata"></a>
+### GetUserRequest
-### 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 user to retrieve. Format: users/{user uid or user email} |
-
+<a name="bytebase-v1-ListUsersRequest"></a>
-<a name="bytebase-v1-Changelog-Status"></a>
+### ListUsersRequest
-### Changelog.Status
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | |
-| PENDING | 1 | |
-| DONE | 2 | |
-| FAILED | 3 | |
+| 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.
-<a name="bytebase-v1-Changelog-Type"></a>
+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; |
-### Changelog.Type
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| BASELINE | 1 | |
-| MIGRATE | 2 | |
-| SDL | 3 | |
-<a name="bytebase-v1-ChangelogView"></a>
+<a name="bytebase-v1-ListUsersResponse"></a>
-### ChangelogView
+### ListUsersResponse
-| 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 | |
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-ColumnMetadata-IdentityGeneration"></a>
-### ColumnMetadata.IdentityGeneration
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| IDENTITY_GENERATION_UNSPECIFIED | 0 | |
-| ALWAYS | 1 | |
-| BY_DEFAULT | 2 | |
+<a name="bytebase-v1-UndeleteUserRequest"></a>
+
+### UndeleteUserRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the deleted user. Format: users/{user} |
-<a name="bytebase-v1-GenerationMetadata-Type"></a>
-### GenerationMetadata.Type
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| VIRTUAL | 1 | |
-| STORED | 2 | |
+<a name="bytebase-v1-UpdateUserRequest"></a>
+### UpdateUserRequest
-<a name="bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat"></a>
-### GetDatabaseSDLSchemaRequest.SDLFormat
-SDLFormat specifies the output format for SDL schema.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| user | [User](#bytebase-v1-User) | | The user to update.
-| 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.). |
+The user&#39;s `name` field is used to identify the user to update. Format: users/{user} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#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-GetSchemaStringRequest-ObjectType"></a>
-### GetSchemaStringRequest.ObjectType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| OBJECT_TYPE_UNSPECIFIED | 0 | |
-| DATABASE | 1 | |
-| SCHEMA | 2 | |
-| TABLE | 3 | |
-| VIEW | 4 | |
-| MATERIALIZED_VIEW | 5 | |
-| FUNCTION | 6 | |
-| PROCEDURE | 7 | |
-| SEQUENCE | 8 | |
+<a name="bytebase-v1-User"></a>
+### User
-<a name="bytebase-v1-StreamMetadata-Mode"></a>
-### StreamMetadata.Mode
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the user. Format: users/{user}. {user} is a system-generated unique ID. |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |
+| email | [string](#string) | | The email address of the user, used for login and notifications. |
+| title | [string](#string) | | The display title or full name of the user. |
+| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |
+| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |
+| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. |
+| mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. |
+| temp_otp_secret | [string](#string) | | Temporary OTP secret used during MFA setup and regeneration. |
+| temp_recovery_codes | [string](#string) | repeated | Temporary recovery codes used during MFA setup and regeneration. |
+| temp_otp_secret_created_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. |
+| phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |
+| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. |
+| groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| MODE_UNSPECIFIED | 0 | |
-| DEFAULT | 1 | |
-| APPEND_ONLY | 2 | |
-| INSERT_ONLY | 3 | |
-<a name="bytebase-v1-StreamMetadata-Type"></a>
-### StreamMetadata.Type
+<a name="bytebase-v1-User-Profile"></a>
+### User.Profile
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | |
-| DELTA | 1 | |
+| 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. |
-<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-TaskMetadata-State"></a>
-### TaskMetadata.State
+<a name="bytebase-v1-UserType"></a>
+
+### UserType
| Name | Number | Description |
| ---- | ------ | ----------- |
-| STATE_UNSPECIFIED | 0 | |
-| STARTED | 1 | |
-| SUSPENDED | 2 | |
+| 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. |
@@ -3371,782 +3153,769 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)
-<a name="bytebase-v1-DatabaseService"></a>
+<a name="bytebase-v1-UserService"></a>
-### DatabaseService
-DatabaseService manages databases and their schemas.
+### UserService
+UserService manages user accounts and authentication.
| 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 |
+| GetUser | [GetUserRequest](#bytebase-v1-GetUserRequest) | [User](#bytebase-v1-User) | Get the user. Any authenticated user can get the user. Permissions required: bb.users.get |
+| BatchGetUsers | [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest) | [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse) | Get the users in batch. Any authenticated user can batch get users. Permissions required: bb.users.get |
+| GetCurrentUser | [.google.protobuf.Empty](#google-protobuf-Empty) | [User](#bytebase-v1-User) | Get the current authenticated user. Permissions required: None |
+| ListUsers | [ListUsersRequest](#bytebase-v1-ListUsersRequest) | [ListUsersResponse](#bytebase-v1-ListUsersResponse) | List all users. Any authenticated user can list users. Permissions required: bb.users.list |
+| CreateUser | [CreateUserRequest](#bytebase-v1-CreateUserRequest) | [User](#bytebase-v1-User) | Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up. Permissions required: bb.users.create (only when Disallow Signup is enabled) |
+| UpdateUser | [UpdateUserRequest](#bytebase-v1-UpdateUserRequest) | [User](#bytebase-v1-User) | Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user. Permissions required: bb.users.update (or self) |
+| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |
+| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |
-<a name="v1_issue_service-proto"></a>
+<a name="v1_actuator_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
-## v1/issue_service.proto
-
+## v1/actuator_service.proto
-<a name="bytebase-v1-ApprovalFlow"></a>
-### ApprovalFlow
+<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 |
| ----- | ---- | ----- | ----------- |
-| roles | [string](#string) | repeated | The roles required for approval in order. |
-
+| version | [string](#string) | | The Bytebase server version. |
+| git_commit | [string](#string) | | The git commit hash of the build. |
+| readonly | [bool](#bool) | | Whether the Bytebase instance is running in read-only mode. |
+| saas | [bool](#bool) | | Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. |
+| demo | [bool](#bool) | | Whether the Bytebase instance is running in demo mode. |
+| host | [string](#string) | | The host address of the Bytebase instance. |
+| port | [string](#string) | | The port number of the Bytebase instance. |
+| external_url | [string](#string) | | The external URL where users or webhook callbacks access Bytebase. |
+| need_admin_setup | [bool](#bool) | | Whether the Bytebase instance requires initial admin setup. |
+| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |
+| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |
+| require_2fa | [bool](#bool) | | Whether two-factor authentication is required for all users. |
+| workspace_id | [string](#string) | | The unique identifier for the workspace. |
+| debug | [bool](#bool) | | Whether debug mode is enabled. |
+| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |
+| disallow_password_signin | [bool](#bool) | | Whether password-based signin is disabled (except for workspace admins). |
+| password_restriction | [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting) | | Password complexity and restriction requirements. |
+| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |
+| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |
+| activated_instance_count | [int32](#int32) | | The number of activated database instances. |
+| total_instance_count | [int32](#int32) | | The total number of database instances. |
+| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |
+| external_url_from_flag | [bool](#bool) | | Whether the external URL is set via command-line flag (and thus cannot be changed via UI). |
-<a name="bytebase-v1-ApprovalTemplate"></a>
-### ApprovalTemplate
+<a name="bytebase-v1-ActuatorInfo-StatUser"></a>
+### ActuatorInfo.StatUser
+User statistics by type and state.
| 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. |
+| 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-ApproveIssueRequest"></a>
+<a name="bytebase-v1-DeleteCacheRequest"></a>
-### ApproveIssueRequest
+### DeleteCacheRequest
+Request message for deleting cache.
-| 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. |
+<a name="bytebase-v1-GetActuatorInfoRequest"></a>
+### GetActuatorInfoRequest
+Request message for getting actuator information.
-<a name="bytebase-v1-BatchUpdateIssuesStatusRequest"></a>
-### BatchUpdateIssuesStatusRequest
-| 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. |
+<a name="bytebase-v1-GetResourcePackageRequest"></a>
+### GetResourcePackageRequest
+Request message for getting branding resources.
-<a name="bytebase-v1-BatchUpdateIssuesStatusResponse"></a>
-### BatchUpdateIssuesStatusResponse
+<a name="bytebase-v1-ResourcePackage"></a>
+
+### ResourcePackage
+Custom branding resources for the Bytebase instance.
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| logo | [bytes](#bytes) | | The branding logo. |
-<a name="bytebase-v1-CreateIssueCommentRequest"></a>
+<a name="bytebase-v1-SetupSampleRequest"></a>
-### CreateIssueCommentRequest
+### SetupSampleRequest
+Request message for setting up sample data.
+
+
+
+
+
+
+<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>
+### UpdateActuatorInfoRequest
+Request message for updating actuator information.
| 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. |
+| actuator | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | | The actuator to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the actuator is not found, a new actuator will be created. In this situation, `update_mask` is ignored. |
+
-<a name="bytebase-v1-CreateIssueRequest"></a>
+
-### CreateIssueRequest
+
+
+
+<a name="bytebase-v1-ActuatorService"></a>
+### ActuatorService
+ActuatorService manages system health and operational information.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetActuatorInfo | [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Gets system information and health status of the Bytebase instance. Permissions required: None |
+| UpdateActuatorInfo | [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Updates system configuration settings for the Bytebase instance. Permissions required: bb.settings.set |
+| SetupSample | [SetupSampleRequest](#bytebase-v1-SetupSampleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Sets up sample data for demonstration and testing purposes. Permissions required: bb.projects.create |
+| DeleteCache | [DeleteCacheRequest](#bytebase-v1-DeleteCacheRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Clears the system cache to force data refresh. Permissions required: None |
+| GetResourcePackage | [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest) | [ResourcePackage](#bytebase-v1-ResourcePackage) | Gets custom branding resources such as logos. Permissions required: None |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| 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="v1_audit_log_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/audit_log_service.proto
-<a name="bytebase-v1-GetIssueRequest"></a>
-### GetIssueRequest
+<a name="bytebase-v1-AuditData"></a>
+### AuditData
+Additional audit data specific to certain operations.
| 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. |
-
+| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |
-<a name="bytebase-v1-GrantRequest"></a>
-### GrantRequest
+<a name="bytebase-v1-AuditLog"></a>
+### AuditLog
+Audit log entry recording system activity or API call.
| 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 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-Issue"></a>
-### Issue
+<a name="bytebase-v1-ExportAuditLogsRequest"></a>
+### ExportAuditLogsRequest
+Request message for exporting audit logs.
| 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} |
-| rollout | [string](#string) | | The rollout associated with the issue. Can be empty. Format: projects/{project}/rollouts/{rollout} |
-| grant_request | [GrantRequest](#bytebase-v1-GrantRequest) | | Used if the issue type is GRANT_REQUEST. |
-| releasers | [string](#string) | repeated | The releasers of the pending stage of the issue rollout, judging from the rollout policy. Format: - roles/workspaceOwner - roles/workspaceDBA - roles/projectOwner - roles/projectReleaser |
-| risk_level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level of the issue. |
-| task_status_count | [Issue.TaskStatusCountEntry](#bytebase-v1-Issue-TaskStatusCountEntry) | repeated | The status count of the issue. Keys are the following: - NOT_STARTED - SKIPPED - PENDING - RUNNING - DONE - FAILED - CANCELED |
-| labels | [string](#string) | repeated | Labels attached to the issue for categorization and filtering. |
-| approval_status | [Issue.ApprovalStatus](#bytebase-v1-Issue-ApprovalStatus) | | |
-| approval_status_error | [string](#string) | | Only populated when approval_status == ERROR |
+| parent | [string](#string) | | |
+| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. Check the filter field in the SearchAuditLogsRequest message. |
+| order_by | [string](#string) | | The order by of the log. Only support order by create_time. For example: - order_by = &#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-Issue-Approver"></a>
+<a name="bytebase-v1-ExportAuditLogsResponse"></a>
-### Issue.Approver
-Approvers and their approval status for the issue.
+### ExportAuditLogsResponse
+Response message for exporting audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [Issue.Approver.Status](#bytebase-v1-Issue-Approver-Status) | | The new status. |
-| principal | [string](#string) | | Format: users/[email protected] |
-
+| 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-Issue-TaskStatusCountEntry"></a>
-### Issue.TaskStatusCountEntry
+<a name="bytebase-v1-RequestMetadata"></a>
+### RequestMetadata
+Metadata about the incoming request.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [int32](#int32) | | |
+| 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-IssueComment"></a>
+<a name="bytebase-v1-SearchAuditLogsRequest"></a>
-### IssueComment
-A comment on an issue.
+### SearchAuditLogsRequest
+Request message for searching audit logs.
| 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. |
-| stage_end | [IssueComment.StageEnd](#bytebase-v1-IssueComment-StageEnd) | | Stage end event. |
-| task_update | [IssueComment.TaskUpdate](#bytebase-v1-IssueComment-TaskUpdate) | | Task update event. |
-| task_prior_backup | [IssueComment.TaskPriorBackup](#bytebase-v1-IssueComment-TaskPriorBackup) | | Task prior backup event. |
+| 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. 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-IssueComment-Approval"></a>
+<a name="bytebase-v1-SearchAuditLogsResponse"></a>
-### IssueComment.Approval
-Approval event information.
+### SearchAuditLogsResponse
+Response message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [IssueComment.Approval.Status](#bytebase-v1-IssueComment-Approval-Status) | | The approval status. |
+| audit_logs | [AuditLog](#bytebase-v1-AuditLog) | repeated | |
+| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
+
-<a name="bytebase-v1-IssueComment-IssueUpdate"></a>
-### IssueComment.IssueUpdate
-Issue update event information.
+<a name="bytebase-v1-AuditLog-Severity"></a>
+### AuditLog.Severity
+Severity level for audit log entries.
-| 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 |
+| ---- | ------ | ----------- |
+| 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-AuditLogService"></a>
-<a name="bytebase-v1-IssueComment-StageEnd"></a>
+### AuditLogService
+AuditLogService manages audit logs for system activities and API calls.
-### IssueComment.StageEnd
-Stage end event information.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| SearchAuditLogs | [SearchAuditLogsRequest](#bytebase-v1-SearchAuditLogsRequest) | [SearchAuditLogsResponse](#bytebase-v1-SearchAuditLogsResponse) | Searches audit logs with optional filtering and pagination. Permissions required: bb.auditLogs.search |
+| ExportAuditLogs | [ExportAuditLogsRequest](#bytebase-v1-ExportAuditLogsRequest) | [ExportAuditLogsResponse](#bytebase-v1-ExportAuditLogsResponse) | Exports audit logs in a specified format for external analysis. Permissions required: bb.auditLogs.export |
+
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| stage | [string](#string) | | The stage that ended. |
+<a name="v1_auth_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/auth_service.proto
-<a name="bytebase-v1-IssueComment-TaskPriorBackup"></a>
+<a name="bytebase-v1-IdentityProviderContext"></a>
-### IssueComment.TaskPriorBackup
-Task prior backup event information.
+### IdentityProviderContext
+Context for identity provider authentication.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| task | [string](#string) | | The task for which backup was performed. |
-| tables | [IssueComment.TaskPriorBackup.Table](#bytebase-v1-IssueComment-TaskPriorBackup-Table) | repeated | The tables that were backed up. |
-| original_line | [int32](#int32) | optional | The original line number in the statement. |
-| database | [string](#string) | | The database that was backed up. |
-| error | [string](#string) | | Error message if backup failed. |
+| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |
+| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |
-<a name="bytebase-v1-IssueComment-TaskPriorBackup-Table"></a>
+<a name="bytebase-v1-LoginRequest"></a>
+
+### LoginRequest
-### IssueComment.TaskPriorBackup.Table
-Table identification.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| schema | [string](#string) | | The schema name. |
-| table | [string](#string) | | The table name. |
+| email | [string](#string) | | User&#39;s email address. |
+| password | [string](#string) | | User&#39;s password for authentication. |
+| web | [bool](#bool) | | If web is set, we will set access token, refresh token, and user to the cookie. |
+| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
+| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is using to get the user information from identity provider. |
+| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#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-IssueComment-TaskUpdate"></a>
+<a name="bytebase-v1-LoginResponse"></a>
+
+### LoginResponse
-### IssueComment.TaskUpdate
-Task update event information.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| tasks | [string](#string) | repeated | The tasks that were updated. |
-| from_sheet | [string](#string) | optional | Format: projects/{project}/sheets/{sheet} |
-| to_sheet | [string](#string) | optional | Format: projects/{project}/sheets/{sheet} |
-| to_status | [IssueComment.TaskUpdate.Status](#bytebase-v1-IssueComment-TaskUpdate-Status) | optional | |
-
-
-
-
-
+| token | [string](#string) | | Access token for authenticated requests. |
+| mfa_temp_token | [string](#string) | optional | Temporary token for MFA verification. |
+| require_reset_password | [bool](#bool) | | Whether user must reset password before continuing. |
+| user | [User](#bytebase-v1-User) | | The user from the successful login. |
-<a name="bytebase-v1-ListIssueCommentsRequest"></a>
-### ListIssueCommentsRequest
-| 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-LogoutRequest"></a>
+### LogoutRequest
+Request to logout current user session.
-<a name="bytebase-v1-ListIssueCommentsResponse"></a>
-### ListIssueCommentsResponse
+<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>
+### OAuth2IdentityProviderContext
+OAuth2 authentication context.
| 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. |
-
+| code | [string](#string) | | Authorization code from OAuth2 provider. |
-<a name="bytebase-v1-ListIssuesRequest"></a>
-### ListIssuesRequest
+<a name="bytebase-v1-OIDCIdentityProviderContext"></a>
+### OIDCIdentityProviderContext
+OpenID Connect authentication context.
| 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
+| code | [string](#string) | | Authorization code from OIDC provider. |
-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. - task_type: support &#34;==&#34; operator, the value can be &#34;DDL&#34;, &#34;DML&#34; or &#34;DATA_EXPORT&#34; - instance: the instance full name in the &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - database: the database full name in the &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator. - environment: the database full name in the &#34;environments/{name}&#34; format, support &#34;==&#34; operator. - 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; instance == &#34;instances/sample&#34; &amp;&amp; labels in [&#34;label1&#34;, &#34;label2&#34;] create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34; environment == &#34;environments/test&#34; |
-| query | [string](#string) | | Query is the query statement. |
+
+
+
-<a name="bytebase-v1-ListIssuesResponse"></a>
-### ListIssuesResponse
+<a name="bytebase-v1-AuthService"></a>
+### AuthService
+AuthService handles user authentication operations.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |
+| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| issues | [Issue](#bytebase-v1-Issue) | repeated | The issues from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+
+<a name="v1_cel_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/cel_service.proto
-<a name="bytebase-v1-RejectIssueRequest"></a>
-### RejectIssueRequest
+<a name="bytebase-v1-BatchDeparseRequest"></a>
+### BatchDeparseRequest
+Request message for batch deparsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the issue to add a rejection. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the rejection decision. |
-
+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |
-<a name="bytebase-v1-RequestIssueRequest"></a>
-### RequestIssueRequest
+<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 issue to request a issue. Format: projects/{project}/issues/{issue} |
-| comment | [string](#string) | | The comment explaining the request. |
-
+| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |
-<a name="bytebase-v1-SearchIssuesRequest"></a>
-### SearchIssuesRequest
+<a name="bytebase-v1-BatchParseRequest"></a>
+### BatchParseRequest
+Request message for batch parsing CEL expressions.
| 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. |
-
+| expressions | [string](#string) | repeated | The CEL expression strings to parse. |
-<a name="bytebase-v1-SearchIssuesResponse"></a>
-### SearchIssuesResponse
+<a name="bytebase-v1-BatchParseResponse"></a>
+### BatchParseResponse
+Response message for batch parsing CEL expressions.
| 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. |
+| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |
+
-<a name="bytebase-v1-UpdateIssueCommentRequest"></a>
+
-### UpdateIssueCommentRequest
+
+<a name="bytebase-v1-CelService"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The issue name Format: projects/{project}/issues/{issue} |
-| issue_comment | [IssueComment](#bytebase-v1-IssueComment) | | The comment to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the issue comment is not found, a new issue comment will be created. In this situation, `update_mask` is ignored. |
+### CelService
+CelService manages CEL (Common Expression Language) parsing and formatting operations.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| BatchParse | [BatchParseRequest](#bytebase-v1-BatchParseRequest) | [BatchParseResponse](#bytebase-v1-BatchParseResponse) | Parses multiple CEL expression strings into AST representations. Permissions required: None |
+| BatchDeparse | [BatchDeparseRequest](#bytebase-v1-BatchDeparseRequest) | [BatchDeparseResponse](#bytebase-v1-BatchDeparseResponse) | Converts multiple CEL AST representations back into expression strings. Permissions required: None |
+
+
+<a name="v1_database_catalog_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/database_catalog_service.proto
-<a name="bytebase-v1-UpdateIssueRequest"></a>
-### UpdateIssueRequest
+<a name="bytebase-v1-ColumnCatalog"></a>
+### ColumnCatalog
+Column metadata within a table.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| issue | [Issue](#bytebase-v1-Issue) | | The issue to update.
+| 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. |
-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-ColumnCatalog-LabelsEntry"></a>
+### ColumnCatalog.LabelsEntry
-<a name="bytebase-v1-Issue-ApprovalStatus"></a>
-### Issue.ApprovalStatus
-The overall approval status for the issue.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| APPROVAL_STATUS_UNSPECIFIED | 0 | Unspecified approval status. |
-| CHECKING | 1 | Approval checks are being evaluated. |
-| PENDING | 2 | Approval is pending. |
-| APPROVED | 3 | Issue has been approved. |
-| REJECTED | 4 | Issue has been rejected. |
-| SKIPPED | 5 | Approval was skipped. |
-| ERROR | 6 | Error occurred during approval evaluation. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<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-DatabaseCatalog"></a>
+
+### DatabaseCatalog
+Catalog metadata for a database including schemas, tables, and columns.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database catalog. Format: instances/{instance}/databases/{database}/catalog |
+| schemas | [SchemaCatalog](#bytebase-v1-SchemaCatalog) | repeated | The schemas in the database. |
-<a name="bytebase-v1-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-GetDatabaseCatalogRequest"></a>
-### IssueComment.Approval.Status
-Approval status values.
+### GetDatabaseCatalogRequest
+Request message for getting a database catalog.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Approval pending. |
-| APPROVED | 2 | Approved. |
-| REJECTED | 3 | Rejected. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database catalog to retrieve. Format: instances/{instance}/databases/{database}/catalog |
-<a name="bytebase-v1-IssueComment-TaskUpdate-Status"></a>
-### IssueComment.TaskUpdate.Status
-Task status values.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| STATUS_UNSPECIFIED | 0 | Unspecified status. |
-| PENDING | 1 | Task is pending. |
-| RUNNING | 2 | Task is running. |
-| DONE | 3 | Task is done. |
-| FAILED | 4 | Task failed. |
-| SKIPPED | 5 | Task was skipped. |
-| CANCELED | 6 | Task was canceled. |
+<a name="bytebase-v1-ObjectSchema"></a>
-<a name="bytebase-v1-IssueStatus"></a>
+### ObjectSchema
+Schema definition for object-type columns.
-### 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. |
+| 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-IssueService"></a>
-### IssueService
-IssueService manages issues for tracking database changes and tasks.
+<a name="bytebase-v1-ObjectSchema-ArrayKind"></a>
-| 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) |
+### ObjectSchema.ArrayKind
+Array type with element schema.
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| kind | [ObjectSchema](#bytebase-v1-ObjectSchema) | | The schema of array elements. |
-<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-ObjectSchema-StructKind"></a>
-### Binding
-Binding associates members with a role and optional conditions.
+### ObjectSchema.StructKind
+Structure type with named properties.
| 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;)`.
+| properties | [ObjectSchema.StructKind.PropertiesEntry](#bytebase-v1-ObjectSchema-StructKind-PropertiesEntry) | repeated | Properties of the struct. |
-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-ObjectSchema-StructKind-PropertiesEntry"></a>
-<a name="bytebase-v1-BindingDelta"></a>
+### ObjectSchema.StructKind.PropertiesEntry
-### 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. |
+| key | [string](#string) | | |
+| value | [ObjectSchema](#bytebase-v1-ObjectSchema) | | |
-<a name="bytebase-v1-GetIamPolicyRequest"></a>
+<a name="bytebase-v1-SchemaCatalog"></a>
-### GetIamPolicyRequest
-Request message for getting an IAM policy.
+### SchemaCatalog
+Schema metadata within a database.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| resource | [string](#string) | | The name of the resource to get the IAM policy. Format: projects/{project} Format: workspaces/{workspace} |
+| name | [string](#string) | | The schema name. |
+| tables | [TableCatalog](#bytebase-v1-TableCatalog) | repeated | The tables in the schema. |
-<a name="bytebase-v1-IamPolicy"></a>
+<a name="bytebase-v1-TableCatalog"></a>
-### IamPolicy
-IAM policy that binds members to roles.
+### TableCatalog
+Table metadata within a schema.
| 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. |
+| 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-PolicyDelta"></a>
+<a name="bytebase-v1-TableCatalog-Columns"></a>
-### PolicyDelta
-Describes changes between two IAM policies.
+### TableCatalog.Columns
+Column list for regular tables.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| binding_deltas | [BindingDelta](#bytebase-v1-BindingDelta) | repeated | The delta for Bindings between two policies. |
+| columns | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | repeated | The columns in the table. |
-<a name="bytebase-v1-SetIamPolicyRequest"></a>
+<a name="bytebase-v1-UpdateDatabaseCatalogRequest"></a>
-### SetIamPolicyRequest
-Request message for setting an IAM policy.
+### UpdateDatabaseCatalogRequest
+Request message for updating a database catalog.
| 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. |
+| 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. |
@@ -4155,2302 +3924,2445 @@ Request message for setting an IAM policy.
-<a name="bytebase-v1-BindingDelta-Action"></a>
+<a name="bytebase-v1-ObjectSchema-Type"></a>
-### BindingDelta.Action
-Type of action performed on a binding.
+### ObjectSchema.Type
+Object schema data types.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| ACTION_UNSPECIFIED | 0 | Unspecified action. |
-| ADD | 1 | Add a binding. |
-| REMOVE | 2 | Remove a binding. |
-
+| 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-DatabaseCatalogService"></a>
-<a name="v1_project_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-
-## v1/project_service.proto
-
-
+### DatabaseCatalogService
+DatabaseCatalogService manages database schema metadata and classification.
-<a name="bytebase-v1-Activity"></a>
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetDatabaseCatalog | [GetDatabaseCatalogRequest](#bytebase-v1-GetDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Gets the catalog metadata for a database. Permissions required: bb.databaseCatalogs.get |
+| UpdateDatabaseCatalog | [UpdateDatabaseCatalogRequest](#bytebase-v1-UpdateDatabaseCatalogRequest) | [DatabaseCatalog](#bytebase-v1-DatabaseCatalog) | Updates catalog metadata such as classifications and labels. Permissions required: bb.databaseCatalogs.update |
-### Activity
-Activity types for webhook notifications.
+
+<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-AddWebhookRequest"></a>
-### AddWebhookRequest
+<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>
+### CreateDatabaseGroupRequest
+Request message for creating a database group.
| 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. |
+| 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-BatchDeleteProjectsRequest"></a>
-### BatchDeleteProjectsRequest
+<a name="bytebase-v1-DatabaseGroup"></a>
+### DatabaseGroup
+A group of databases matched by expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The names of the projects to delete. Format: projects/{project} |
-| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
-
-
-
-
-
-
-<a name="bytebase-v1-BatchGetIamPolicyRequest"></a>
-
-### BatchGetIamPolicyRequest
-
-
+| 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
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| scope | [string](#string) | | The scope of the batch get. Typically it&#39;s &#34;projects/-&#34;. |
-| names | [string](#string) | repeated | |
+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-BatchGetIamPolicyResponse"></a>
-### BatchGetIamPolicyResponse
+<a name="bytebase-v1-DatabaseGroup-Database"></a>
+### DatabaseGroup.Database
+A database within a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policy_results | [BatchGetIamPolicyResponse.PolicyResult](#bytebase-v1-BatchGetIamPolicyResponse-PolicyResult) | repeated | The policy results for each requested project. |
+| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |
-<a name="bytebase-v1-BatchGetIamPolicyResponse-PolicyResult"></a>
+<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>
-### BatchGetIamPolicyResponse.PolicyResult
-Result for a single project&#39;s IAM policy.
+### DeleteDatabaseGroupRequest
+Request message for deleting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| project | [string](#string) | | The project resource name. |
-| policy | [IamPolicy](#bytebase-v1-IamPolicy) | | The IAM policy for the project. |
-
+| name | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |
-<a name="bytebase-v1-CreateProjectRequest"></a>
-### CreateProjectRequest
+<a name="bytebase-v1-GetDatabaseGroupRequest"></a>
+### GetDatabaseGroupRequest
+Request message for getting a database group.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| project | [Project](#bytebase-v1-Project) | | The project to create. |
-| project_id | [string](#string) | | The ID to use for the project, which will become the final component of the project&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
-
+| name | [string](#string) | | The name of the 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-DeleteProjectRequest"></a>
-### DeleteProjectRequest
+<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>
+### ListDatabaseGroupsRequest
+Request message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project to delete. Format: projects/{project} |
-| force | [bool](#bool) | | If set to true, any databases from this project will be moved to default project. Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project. Open issues will remain open but associated with the deleted project. If set to false, the operation will fail if the project has databases or open issues. |
-| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted project and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted projects. The project must already be soft-deleted for this to work. |
-
+| 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-GetProjectRequest"></a>
-### GetProjectRequest
+<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>
+### ListDatabaseGroupsResponse
+Response message for listing database groups.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the project to retrieve. Format: projects/{project} |
+| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |
-<a name="bytebase-v1-Label"></a>
+<a name="bytebase-v1-UpdateDatabaseGroupRequest"></a>
-### Label
-A label for categorizing and organizing issues.
+### UpdateDatabaseGroupRequest
+Request message for updating a database group.
| 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. |
-
-
+| 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-ListProjectsRequest"></a>
-### ListProjectsRequest
+
-| 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.
+<a name="bytebase-v1-DatabaseGroupView"></a>
-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;). |
+### 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-ListProjectsResponse"></a>
+<a name="bytebase-v1-DatabaseGroupService"></a>
-### ListProjectsResponse
+### 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 |
-| ----- | ---- | ----- | ----------- |
-| 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="v1_instance_role_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/instance_role_service.proto
-<a name="bytebase-v1-Project"></a>
+<a name="bytebase-v1-GetInstanceRoleRequest"></a>
-### Project
+### GetInstanceRoleRequest
| 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. |
-| allow_modify_statement | [bool](#bool) | | Allow modifying SQL statements after issue is created. |
-| auto_resolve_issue | [bool](#bool) | | Enable automatic issue resolution when tasks complete. |
-| enforce_issue_title | [bool](#bool) | | Enforce issue title to be created by user instead of generated by Bytebase. |
-| auto_enable_backup | [bool](#bool) | | Whether to automatically enable backup for database changes. |
-| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue with data migration. |
-| postgres_database_tenant_mode | [bool](#bool) | | Whether to enable database tenant mode for PostgreSQL. If enabled, issues will include &#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. |
+| name | [string](#string) | | The name of the role to retrieve. Format: instances/{instance}/roles/{role name} The role name is the unique name for the role. |
-<a name="bytebase-v1-Project-ExecutionRetryPolicy"></a>
+<a name="bytebase-v1-InstanceRole"></a>
-### Project.ExecutionRetryPolicy
-Execution retry policy configuration.
+### InstanceRole
+InstanceRole is the API message for instance role.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| maximum_retries | [int32](#int32) | | The maximum number of retries for lock timeout errors. |
+| 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-Project-LabelsEntry"></a>
+<a name="bytebase-v1-ListInstanceRolesRequest"></a>
-### Project.LabelsEntry
+### ListInstanceRolesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| parent | [string](#string) | | The parent, which owns this collection of roles. Format: instances/{instance} |
+| page_size | [int32](#int32) | | Not used. The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 10 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | Not used. A page token, received from a previous `ListInstanceRoles` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListInstanceRoles` must match the call that provided the page token. |
+| refresh | [bool](#bool) | | Refresh will refresh and return the latest data. |
-<a name="bytebase-v1-RemoveWebhookRequest"></a>
+<a name="bytebase-v1-ListInstanceRolesResponse"></a>
-### RemoveWebhookRequest
+### ListInstanceRolesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| webhook | [Webhook](#bytebase-v1-Webhook) | | The webhook to remove. Identified by its url. |
+| 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-SearchProjectsRequest"></a>
+
-### SearchProjectsRequest
+
+<a name="bytebase-v1-InstanceRoleService"></a>
-| 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
+### InstanceRoleService
+InstanceRoleService manages database roles within instances.
-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.
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| GetInstanceRole | [GetInstanceRoleRequest](#bytebase-v1-GetInstanceRoleRequest) | [InstanceRole](#bytebase-v1-InstanceRole) | Gets a database role from an instance. Permissions required: bb.instanceRoles.get |
+| ListInstanceRoles | [ListInstanceRolesRequest](#bytebase-v1-ListInstanceRolesRequest) | [ListInstanceRolesResponse](#bytebase-v1-ListInstanceRolesResponse) | Lists all database roles in an instance. Permissions required: bb.instanceRoles.list |
-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. |
+<a name="v1_instance_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/instance_service.proto
-<a name="bytebase-v1-SearchProjectsResponse"></a>
+<a name="bytebase-v1-AddDataSourceRequest"></a>
-### SearchProjectsResponse
+### AddDataSourceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| projects | [Project](#bytebase-v1-Project) | repeated | The projects from the specified request. |
-| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
+| name | [string](#string) | | The 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-TestWebhookRequest"></a>
+<a name="bytebase-v1-BatchSyncInstancesRequest"></a>
-### TestWebhookRequest
+### BatchSyncInstancesRequest
| 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. |
-
-
+| 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-TestWebhookResponse"></a>
-### TestWebhookResponse
+<a name="bytebase-v1-BatchSyncInstancesResponse"></a>
+### BatchSyncInstancesResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| error | [string](#string) | | The result of the test, empty if the test is successful. |
-<a name="bytebase-v1-UndeleteProjectRequest"></a>
+<a name="bytebase-v1-BatchUpdateInstancesRequest"></a>
-### UndeleteProjectRequest
+### BatchUpdateInstancesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted project. Format: projects/{project} |
+| requests | [UpdateInstanceRequest](#bytebase-v1-UpdateInstanceRequest) | repeated | The request message specifying the resources to update. |
-<a name="bytebase-v1-UpdateProjectRequest"></a>
+<a name="bytebase-v1-BatchUpdateInstancesResponse"></a>
-### UpdateProjectRequest
+### BatchUpdateInstancesResponse
| 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. |
+| instances | [Instance](#bytebase-v1-Instance) | repeated | |
-<a name="bytebase-v1-UpdateWebhookRequest"></a>
+<a name="bytebase-v1-CreateInstanceRequest"></a>
-### UpdateWebhookRequest
+### CreateInstanceRequest
| 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. |
+| 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-Webhook"></a>
+<a name="bytebase-v1-DataSource"></a>
-### Webhook
+### DataSource
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook} |
-| type | [Webhook.Type](#bytebase-v1-Webhook-Type) | | type is the type of the webhook. |
-| title | [string](#string) | | title is the title of the webhook. |
-| url | [string](#string) | | url is the url of the webhook, should be unique within the project. |
-| direct_message | [bool](#bool) | | if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work. |
-| notification_types | [Activity.Type](#bytebase-v1-Activity-Type) | repeated | notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following: - ISSUE_CREATE - ISSUE_COMMENT_CREATE - ISSUE_FIELD_UPDATE - ISSUE_STATUS_UPDATE - ISSUE_APPROVAL_NOTIFY - ISSUE_PIPELINE_STAGE_STATUS_UPDATE - ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE - NOTIFY_ISSUE_APPROVED - NOTIFY_PIPELINE_ROLLOUT |
+| 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. |
+| external_secret | [DataSourceExternalSecret](#bytebase-v1-DataSourceExternalSecret) | | |
+| authentication_type | [DataSource.AuthenticationType](#bytebase-v1-DataSource-AuthenticationType) | | |
+| azure_credential | [DataSource.AzureCredential](#bytebase-v1-DataSource-AzureCredential) | | |
+| aws_credential | [DataSource.AWSCredential](#bytebase-v1-DataSource-AWSCredential) | | |
+| gcp_credential | [DataSource.GCPCredential](#bytebase-v1-DataSource-GCPCredential) | | |
+| sasl_config | [SASLConfig](#bytebase-v1-SASLConfig) | | |
+| additional_addresses | [DataSource.Address](#bytebase-v1-DataSource-Address) | repeated | additional_addresses is used for MongoDB replica set. |
+| direct_connection | [bool](#bool) | | direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. |
+| region | [string](#string) | | region is the location of where the DB is, works for AWS RDS. For example, us-east-1. |
+| warehouse_id | [string](#string) | | warehouse_id is used by Databricks. |
+| master_name | [string](#string) | | master_name is the master name used by connecting redis-master via redis sentinel. |
+| master_username | [string](#string) | | master_username and master_password are master credentials used by redis sentinel mode. |
+| master_password | [string](#string) | | |
+| redis_type | [DataSource.RedisType](#bytebase-v1-DataSource-RedisType) | | |
+| cluster | [string](#string) | | Cluster is the cluster name for the data source. Used by CockroachDB. |
+| extra_connection_parameters | [DataSource.ExtraConnectionParametersEntry](#bytebase-v1-DataSource-ExtraConnectionParametersEntry) | repeated | Extra connection parameters for the database connection. For PostgreSQL HA, this can be used to set target_session_attrs=read-write |
-
+<a name="bytebase-v1-DataSource-AWSCredential"></a>
-<a name="bytebase-v1-Activity-Type"></a>
+### DataSource.AWSCredential
-### Activity.Type
-Activity type enumeration.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| NOTIFY_ISSUE_APPROVED | 23 | Notifications via webhooks.
-NOTIFY_ISSUE_APPROVED represents the issue approved notification. |
-| NOTIFY_PIPELINE_ROLLOUT | 24 | NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification. |
-| ISSUE_CREATE | 1 | Issue related activity types.
+| 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 |
-ISSUE_CREATE represents creating an issue. |
-| ISSUE_COMMENT_CREATE | 2 | ISSUE_COMMENT_CREATE represents commenting on an issue. |
-| ISSUE_FIELD_UPDATE | 3 | ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc. |
-| ISSUE_STATUS_UPDATE | 4 | ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now. |
-| ISSUE_APPROVAL_NOTIFY | 21 | ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval. |
-| ISSUE_PIPELINE_STAGE_STATUS_UPDATE | 5 | ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now. |
-| ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE | 22 | ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED. |
-<a name="bytebase-v1-Webhook-Type"></a>
-### Webhook.Type
-Webhook integration type.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| TYPE_UNSPECIFIED | 0 | Unspecified type. |
-| SLACK | 1 | Slack integration. |
-| DISCORD | 2 | Discord integration. |
-| TEAMS | 3 | Microsoft Teams integration. |
-| DINGTALK | 4 | DingTalk integration. |
-| FEISHU | 5 | Feishu integration. |
-| WECOM | 6 | WeCom (WeChat Work) integration. |
-| LARK | 8 | Lark integration. |
+<a name="bytebase-v1-DataSource-Address"></a>
+### DataSource.Address
-
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| host | [string](#string) | | |
+| port | [string](#string) | | |
-<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 |
-| 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 |
-| BatchGetIamPolicy | [BatchGetIamPolicyRequest](#bytebase-v1-BatchGetIamPolicyRequest) | [BatchGetIamPolicyResponse](#bytebase-v1-BatchGetIamPolicyResponse) | Deprecated. No permission check implemented. Permissions required: None |
-| SetIamPolicy | [SetIamPolicyRequest](#bytebase-v1-SetIamPolicyRequest) | [IamPolicy](#bytebase-v1-IamPolicy) | Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy |
-| AddWebhook | [AddWebhookRequest](#bytebase-v1-AddWebhookRequest) | [Project](#bytebase-v1-Project) | Adds a webhook to a project for notifications. Permissions required: bb.projects.update |
-| UpdateWebhook | [UpdateWebhookRequest](#bytebase-v1-UpdateWebhookRequest) | [Project](#bytebase-v1-Project) | Updates an existing webhook configuration. Permissions required: bb.projects.update |
-| RemoveWebhook | [RemoveWebhookRequest](#bytebase-v1-RemoveWebhookRequest) | [Project](#bytebase-v1-Project) | Removes a webhook from a project. Permissions required: bb.projects.update |
-| TestWebhook | [TestWebhookRequest](#bytebase-v1-TestWebhookRequest) | [TestWebhookResponse](#bytebase-v1-TestWebhookResponse) | Tests a webhook by sending a test notification. Permissions required: bb.projects.update |
-
+<a name="bytebase-v1-DataSource-AzureCredential"></a>
-<a name="v1_setting_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
+### DataSource.AzureCredential
-## v1/setting_service.proto
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| tenant_id | [string](#string) | | |
+| client_id | [string](#string) | | |
+| client_secret | [string](#string) | | |
+
-<a name="bytebase-v1-AISetting"></a>
-### AISetting
+
+
+
+<a name="bytebase-v1-DataSource-ExtraConnectionParametersEntry"></a>
+
+### DataSource.ExtraConnectionParametersEntry
| 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) | | |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-Algorithm"></a>
+<a name="bytebase-v1-DataSource-GCPCredential"></a>
-### Algorithm
+### DataSource.GCPCredential
| 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) | | |
+| content | [string](#string) | | |
-<a name="bytebase-v1-Algorithm-FullMask"></a>
+<a name="bytebase-v1-DataSourceExternalSecret"></a>
-### Algorithm.FullMask
+### DataSourceExternalSecret
| 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. |
+| 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-Algorithm-InnerOuterMask"></a>
+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption"></a>
-### Algorithm.InnerOuterMask
+### DataSourceExternalSecret.AppRoleAuthOption
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| prefix_len | [int32](#int32) | | |
-| suffix_len | [int32](#int32) | | |
-| type | [Algorithm.InnerOuterMask.MaskType](#bytebase-v1-Algorithm-InnerOuterMask-MaskType) | | |
-| substitution | [string](#string) | | |
+| 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-Algorithm-MD5Mask"></a>
+<a name="bytebase-v1-DeleteInstanceRequest"></a>
-### Algorithm.MD5Mask
+### DeleteInstanceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| salt | [string](#string) | | salt is the salt value to generate a different hash that with the word alone. |
+| name | [string](#string) | | The name of the instance to delete. Format: instances/{instance} |
+| force | [bool](#bool) | | If set to true, any databases and sheets from this project will also be moved to default project, and all open issues will be closed. |
+| purge | [bool](#bool) | | If set to true, permanently purge the soft-deleted instance and all related resources. This operation is irreversible. Following AIP-165, this should only be used for administrative cleanup of old soft-deleted instances. The instance must already be soft-deleted for this to work. |
-<a name="bytebase-v1-Algorithm-RangeMask"></a>
+<a name="bytebase-v1-GetInstanceRequest"></a>
-### Algorithm.RangeMask
+### GetInstanceRequest
| 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. |
+| name | [string](#string) | | The name of the instance to retrieve. Format: instances/{instance} |
-<a name="bytebase-v1-Algorithm-RangeMask-Slice"></a>
+<a name="bytebase-v1-Instance"></a>
-### Algorithm.RangeMask.Slice
+### Instance
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| start | [int32](#int32) | | start is the start index of the original value, start from 0 and should be less than stop. |
-| end | [int32](#int32) | | stop is the stop index of the original value, should be less than the length of the original value. |
-| substitution | [string](#string) | | substitution is the string used to replace the OriginalValue[start:end). |
+| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
+| state | [State](#bytebase-v1-State) | | The lifecycle state of the instance. |
+| title | [string](#string) | | The display title of the instance. |
+| engine | [Engine](#bytebase-v1-Engine) | | The database engine type. |
+| engine_version | [string](#string) | | The version of the database engine. |
+| external_link | [string](#string) | | External URL to the database instance console. |
+| data_sources | [DataSource](#bytebase-v1-DataSource) | repeated | Data source configurations for connecting to the instance. |
+| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
+| activation | [bool](#bool) | | Whether the instance is activated for use. |
+| roles | [InstanceRole](#bytebase-v1-InstanceRole) | repeated | Database roles available in this instance. |
+| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |
+| maximum_connections | [int32](#int32) | | The maximum number of connections. The default is 10 if the value is unset or zero. |
+| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas &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-Announcement"></a>
+<a name="bytebase-v1-Instance-LabelsEntry"></a>
-### Announcement
+### Instance.LabelsEntry
| 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 |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-<a name="bytebase-v1-AppIMSetting"></a>
+<a name="bytebase-v1-InstanceResource"></a>
-### AppIMSetting
+### InstanceResource
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| settings | [AppIMSetting.IMSetting](#bytebase-v1-AppIMSetting-IMSetting) | repeated | |
+| 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-AppIMSetting-DingTalk"></a>
+<a name="bytebase-v1-KerberosConfig"></a>
-### AppIMSetting.DingTalk
+### KerberosConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| client_id | [string](#string) | | |
-| client_secret | [string](#string) | | |
-| robot_code | [string](#string) | | |
+| 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-AppIMSetting-Feishu"></a>
+<a name="bytebase-v1-ListInstanceDatabaseRequest"></a>
-### AppIMSetting.Feishu
+### ListInstanceDatabaseRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| app_id | [string](#string) | | |
-| app_secret | [string](#string) | | |
+| name | [string](#string) | | The name of the instance. Format: instances/{instance} |
+| instance | [Instance](#bytebase-v1-Instance) | optional | The target instance. We need to set this field if the target instance is not created yet. |
-<a name="bytebase-v1-AppIMSetting-IMSetting"></a>
+<a name="bytebase-v1-ListInstanceDatabaseResponse"></a>
-### AppIMSetting.IMSetting
+### ListInstanceDatabaseResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| type | [Webhook.Type](#bytebase-v1-Webhook-Type) | | |
-| 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) | | |
+| databases | [string](#string) | repeated | All database name list in the instance. |
-<a name="bytebase-v1-AppIMSetting-Lark"></a>
+<a name="bytebase-v1-ListInstancesRequest"></a>
-### AppIMSetting.Lark
+### ListInstancesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| app_id | [string](#string) | | |
-| app_secret | [string](#string) | | |
+| page_size | [int32](#int32) | | The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 10 instances will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListInstances` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListInstances` must match the call that provided the page token. |
+| show_deleted | [bool](#bool) | | Show deleted instances if specified. |
+| filter | [string](#string) | | Filter the instance. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filters: - name: the instance name, support &#34;==&#34; and &#34;.matches()&#34; operator. - resource_id: the instance id, support &#34;==&#34; and &#34;.matches()&#34; operator. - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - state: the instance state, check State enum for values, support &#34;==&#34; operator. - engine: the instance engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - host: the instance host, support &#34;==&#34; and &#34;.matches()&#34; operator. - port: the instance port, support &#34;==&#34; and &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - labels.{key}: the instance label, support &#34;==&#34; and &#34;in&#34; operators.
+For example: name == &#34;sample instance&#34; name.matches(&#34;sample&#34;) resource_id == &#34;sample-instance&#34; resource_id.matches(&#34;sample&#34;) state == &#34;DELETED&#34; environment == &#34;environments/test&#34; environment == &#34;&#34; (find instances which environment is not set) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) host == &#34;127.0.0.1&#34; host.matches(&#34;127.0&#34;) port == &#34;54321&#34; port.matches(&#34;543&#34;) labels.org_group == &#34;infrastructure&#34; labels.environment in [&#34;prod&#34;, &#34;production&#34;] project == &#34;projects/sample-project&#34; You can combine filter conditions like: name.matches(&#34;sample&#34;) &amp;&amp; environment == &#34;environments/test&#34; host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; |
-<a name="bytebase-v1-AppIMSetting-Slack"></a>
-### AppIMSetting.Slack
+<a name="bytebase-v1-ListInstancesResponse"></a>
+
+### ListInstancesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | |
+| 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-AppIMSetting-Wecom"></a>
+<a name="bytebase-v1-RemoveDataSourceRequest"></a>
-### AppIMSetting.Wecom
+### RemoveDataSourceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| corp_id | [string](#string) | | |
-| agent_id | [string](#string) | | |
-| secret | [string](#string) | | |
+| 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-DataClassificationSetting"></a>
+<a name="bytebase-v1-SASLConfig"></a>
-### DataClassificationSetting
+### SASLConfig
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| configs | [DataClassificationSetting.DataClassificationConfig](#bytebase-v1-DataClassificationSetting-DataClassificationConfig) | repeated | |
+| krb_config | [KerberosConfig](#bytebase-v1-KerberosConfig) | | Kerberos authentication configuration. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig"></a>
+<a name="bytebase-v1-SyncInstanceRequest"></a>
-### DataClassificationSetting.DataClassificationConfig
+### SyncInstanceRequest
| 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) | | 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-DataClassificationSetting-DataClassificationConfig-ClassificationEntry"></a>
+<a name="bytebase-v1-SyncInstanceResponse"></a>
-### DataClassificationSetting.DataClassificationConfig.ClassificationEntry
+### SyncInstanceResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [DataClassificationSetting.DataClassificationConfig.DataClassification](#bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification) | | |
+| databases | [string](#string) | repeated | All database name list in the instance. |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-DataClassification"></a>
+<a name="bytebase-v1-UndeleteInstanceRequest"></a>
-### DataClassificationSetting.DataClassificationConfig.DataClassification
+### UndeleteInstanceRequest
| 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 | |
+| name | [string](#string) | | The name of the deleted instance. Format: instances/{instance} |
-<a name="bytebase-v1-DataClassificationSetting-DataClassificationConfig-Level"></a>
+<a name="bytebase-v1-UpdateDataSourceRequest"></a>
-### DataClassificationSetting.DataClassificationConfig.Level
+### UpdateDataSourceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| title | [string](#string) | | |
-| description | [string](#string) | | |
+| name | [string](#string) | | The name of the instance to update a data source. Format: instances/{instance} |
+| data_source | [DataSource](#bytebase-v1-DataSource) | | Identified by data source ID. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| validate_only | [bool](#bool) | | Validate only also tests the data source connection. |
+| allow_missing | [bool](#bool) | | If set to true, and the data source is not found, a new data source will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-EnvironmentSetting"></a>
+<a name="bytebase-v1-UpdateInstanceRequest"></a>
-### EnvironmentSetting
+### UpdateInstanceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| environments | [EnvironmentSetting.Environment](#bytebase-v1-EnvironmentSetting-Environment) | repeated | |
+| instance | [Instance](#bytebase-v1-Instance) | | The instance to update.
+The instance&#39;s `name` field is used to identify the instance to update. Format: instances/{instance} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
+| allow_missing | [bool](#bool) | | If set to true, and the instance is not found, a new instance will be created. In this situation, `update_mask` is ignored. |
-<a name="bytebase-v1-EnvironmentSetting-Environment"></a>
+
-### EnvironmentSetting.Environment
+<a name="bytebase-v1-DataSource-AuthenticationType"></a>
+
+### DataSource.AuthenticationType
-| 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) | | |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| AUTHENTICATION_UNSPECIFIED | 0 | |
+| PASSWORD | 1 | |
+| GOOGLE_CLOUD_SQL_IAM | 2 | |
+| AWS_RDS_IAM | 3 | |
+| AZURE_IAM | 4 | |
+
+<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-EnvironmentSetting-Environment-TagsEntry"></a>
-### EnvironmentSetting.Environment.TagsEntry
+<a name="bytebase-v1-DataSourceExternalSecret-AppRoleAuthOption-SecretType"></a>
+### DataSourceExternalSecret.AppRoleAuthOption.SecretType
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| key | [string](#string) | | |
-| value | [string](#string) | | |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
+| PLAIN | 1 | Plain text secret. |
+| ENVIRONMENT | 2 | Secret from environment variable. |
+<a name="bytebase-v1-DataSourceExternalSecret-AuthType"></a>
+### DataSourceExternalSecret.AuthType
-<a name="bytebase-v1-GetSettingRequest"></a>
-### GetSettingRequest
-The request message for getting a setting.
+| 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 |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the setting. |
+<a name="bytebase-v1-DataSourceExternalSecret-SecretType"></a>
+
+### DataSourceExternalSecret.SecretType
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SECRET_TYPE_UNSPECIFIED | 0 | Unspecified secret type. |
+| VAULT_KV_V2 | 1 | ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2 |
+| AWS_SECRETS_MANAGER | 2 | ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html |
+| GCP_SECRET_MANAGER | 3 | ref: https://cloud.google.com/secret-manager/docs |
-<a name="bytebase-v1-GetSettingResponse"></a>
+<a name="bytebase-v1-DataSourceType"></a>
-### GetSettingResponse
-The response message for getting a setting.
+### DataSourceType
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| setting | [Setting](#bytebase-v1-Setting) | | |
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| DATA_SOURCE_UNSPECIFIED | 0 | Unspecified data source type. |
+| ADMIN | 1 | Admin data source with write permissions. |
+| READ_ONLY | 2 | Read-only data source for query operations. |
+
+
+<a name="bytebase-v1-InstanceService"></a>
-<a name="bytebase-v1-ListSettingsRequest"></a>
+### InstanceService
+InstanceService manages database instances and their connections.
-### ListSettingsRequest
+| 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="v1_database_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+## v1/database_service.proto
-<a name="bytebase-v1-ListSettingsResponse"></a>
+<a name="bytebase-v1-BatchGetDatabasesRequest"></a>
-### ListSettingsResponse
+### BatchGetDatabasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| settings | [Setting](#bytebase-v1-Setting) | repeated | The settings from the specified request. |
+| 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-PasswordRestrictionSetting"></a>
+<a name="bytebase-v1-BatchGetDatabasesResponse"></a>
-### PasswordRestrictionSetting
+### BatchGetDatabasesResponse
| 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. |
+| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
-<a name="bytebase-v1-SCIMSetting"></a>
+<a name="bytebase-v1-BatchSyncDatabasesRequest"></a>
-### SCIMSetting
+### BatchSyncDatabasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | |
-
-
+| parent | [string](#string) | | The parent resource shared by all databases being updated. Format: instances/{instance} If the operation spans parents, a dash (-) may be accepted as a wildcard. |
+| names | [string](#string) | repeated | The list of database names to sync. |
-<a name="bytebase-v1-SchemaTemplateSetting"></a>
-### SchemaTemplateSetting
+<a name="bytebase-v1-BatchSyncDatabasesResponse"></a>
+### BatchSyncDatabasesResponse
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| field_templates | [SchemaTemplateSetting.FieldTemplate](#bytebase-v1-SchemaTemplateSetting-FieldTemplate) | repeated | |
-| column_types | [SchemaTemplateSetting.ColumnType](#bytebase-v1-SchemaTemplateSetting-ColumnType) | repeated | |
-| table_templates | [SchemaTemplateSetting.TableTemplate](#bytebase-v1-SchemaTemplateSetting-TableTemplate) | repeated | |
-<a name="bytebase-v1-SchemaTemplateSetting-ColumnType"></a>
+<a name="bytebase-v1-BatchUpdateDatabasesRequest"></a>
-### SchemaTemplateSetting.ColumnType
+### BatchUpdateDatabasesRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| engine | [Engine](#bytebase-v1-Engine) | | |
-| enabled | [bool](#bool) | | |
-| types | [string](#string) | repeated | |
+| 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-SchemaTemplateSetting-FieldTemplate"></a>
+<a name="bytebase-v1-BatchUpdateDatabasesResponse"></a>
-### SchemaTemplateSetting.FieldTemplate
+### BatchUpdateDatabasesResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| engine | [Engine](#bytebase-v1-Engine) | | |
-| category | [string](#string) | | |
-| column | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | | |
-| catalog | [ColumnCatalog](#bytebase-v1-ColumnCatalog) | | |
-
+| databases | [Database](#bytebase-v1-Database) | repeated | Databases updated. |
-<a name="bytebase-v1-SchemaTemplateSetting-TableTemplate"></a>
-### SchemaTemplateSetting.TableTemplate
+<a name="bytebase-v1-BoundingBox"></a>
+### BoundingBox
+BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | |
-| engine | [Engine](#bytebase-v1-Engine) | | |
-| category | [string](#string) | | |
-| table | [TableMetadata](#bytebase-v1-TableMetadata) | | |
-| catalog | [TableCatalog](#bytebase-v1-TableCatalog) | | |
+| 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-SemanticTypeSetting"></a>
+<a name="bytebase-v1-ChangedResourceDatabase"></a>
-### SemanticTypeSetting
+### ChangedResourceDatabase
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| types | [SemanticTypeSetting.SemanticType](#bytebase-v1-SemanticTypeSetting-SemanticType) | repeated | |
+| name | [string](#string) | | |
+| schemas | [ChangedResourceSchema](#bytebase-v1-ChangedResourceSchema) | repeated | |
-<a name="bytebase-v1-SemanticTypeSetting-SemanticType"></a>
+<a name="bytebase-v1-ChangedResourceFunction"></a>
-### SemanticTypeSetting.SemanticType
+### ChangedResourceFunction
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| id | [string](#string) | | id is the uuid for semantic type. |
-| title | [string](#string) | | the title of the semantic type, it should not be empty. |
-| description | [string](#string) | | the description of the semantic type, it can be empty. |
-| algorithm | [Algorithm](#bytebase-v1-Algorithm) | | |
-| icon | [string](#string) | | icon is the icon for semantic type, it can be emoji or base64 encoded image. |
+| name | [string](#string) | | |
+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
-<a name="bytebase-v1-Setting"></a>
+<a name="bytebase-v1-ChangedResourceProcedure"></a>
+
+### ChangedResourceProcedure
-### Setting
-The schema of setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the setting. Must be one of the following forms:
+| name | [string](#string) | | |
+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
-- `setting/{setting}` For example, &#34;settings/bb.branding.logo&#34; |
-| value | [Value](#bytebase-v1-Value) | | The configuration value of the setting. |
+<a name="bytebase-v1-ChangedResourceSchema"></a>
-<a name="bytebase-v1-UpdateSettingRequest"></a>
+### ChangedResourceSchema
-### UpdateSettingRequest
-The request message for updating or creating a setting.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| setting | [Setting](#bytebase-v1-Setting) | | The setting to update. |
-| validate_only | [bool](#bool) | | validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true. |
-| allow_missing | [bool](#bool) | | |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | |
+| name | [string](#string) | | |
+| tables | [ChangedResourceTable](#bytebase-v1-ChangedResourceTable) | repeated | |
+| views | [ChangedResourceView](#bytebase-v1-ChangedResourceView) | repeated | |
+| functions | [ChangedResourceFunction](#bytebase-v1-ChangedResourceFunction) | repeated | |
+| procedures | [ChangedResourceProcedure](#bytebase-v1-ChangedResourceProcedure) | repeated | |
-<a name="bytebase-v1-Value"></a>
+<a name="bytebase-v1-ChangedResourceTable"></a>
+
+### ChangedResourceTable
-### Value
-The data in setting value.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| string_value | [string](#string) | | Defines this value as being a string value. |
-| app_im_setting_value | [AppIMSetting](#bytebase-v1-AppIMSetting) | | |
-| workspace_profile_setting_value | [WorkspaceProfileSetting](#bytebase-v1-WorkspaceProfileSetting) | | reserved 4; // was AgentPluginSetting agent_plugin_setting_value |
-| workspace_approval_setting_value | [WorkspaceApprovalSetting](#bytebase-v1-WorkspaceApprovalSetting) | | |
-| schema_template_setting_value | [SchemaTemplateSetting](#bytebase-v1-SchemaTemplateSetting) | | |
-| data_classification_setting_value | [DataClassificationSetting](#bytebase-v1-DataClassificationSetting) | | |
-| semantic_type_setting_value | [SemanticTypeSetting](#bytebase-v1-SemanticTypeSetting) | | |
-| scim_setting | [SCIMSetting](#bytebase-v1-SCIMSetting) | | |
-| password_restriction_setting | [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting) | | |
-| ai_setting | [AISetting](#bytebase-v1-AISetting) | | |
-| environment_setting | [EnvironmentSetting](#bytebase-v1-EnvironmentSetting) | | |
+| name | [string](#string) | | |
+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
-<a name="bytebase-v1-WorkspaceApprovalSetting"></a>
+<a name="bytebase-v1-ChangedResourceView"></a>
-### WorkspaceApprovalSetting
+### ChangedResourceView
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| rules | [WorkspaceApprovalSetting.Rule](#bytebase-v1-WorkspaceApprovalSetting-Rule) | repeated | |
+| name | [string](#string) | | |
+| ranges | [Range](#bytebase-v1-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |
-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule"></a>
+<a name="bytebase-v1-ChangedResources"></a>
-### WorkspaceApprovalSetting.Rule
+### ChangedResources
| 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.
+| databases | [ChangedResourceDatabase](#bytebase-v1-ChangedResourceDatabase) | repeated | |
-All supported variables: statement.affected_rows: affected row count in the DDL/DML, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. statement.table_rows: table row count number, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. resource.environment_id: the environment resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.project_id: the project resource id, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.db_engine: the database engine type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. Check the Engine enum for values. statement.sql_type: the SQL type, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operations. resource.database_name: the database name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.schema_name: the schema name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. resource.table_name: the table name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. statement.text: the SQL statement, support &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations. request.expiration_days: the role expiration days for the request, support &#34;==&#34;, &#34;!=&#34;, &#34;&lt;&#34;, &#34;&lt;=&#34;, &#34;&gt;&#34;, &#34;&gt;=&#34; operations. request.role: the request role full name, support &#34;==&#34;, &#34;!=&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34;, &#34;contains()&#34;, &#34;matches()&#34;, &#34;startsWith()&#34;, &#34;endsWith()&#34; operations.
-When source is CHANGE_DATABASE, support: statement.*, resource.* (excluding request.*) When source is CREATE_DATABASE, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name When source is EXPORT_DATA, support: resource.environment_id, resource.project_id, resource.db_engine, resource.database_name, resource.schema_name, resource.table_name When source is REQUEST_ROLE, support: resource.project_id, request.expiration_days, request.role
-For examples: resource.environment_id == &#34;prod&#34; &amp;&amp; statement.affected_rows &gt;= 100 resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engine == &#34;MYSQL&#34; |
-| source | [WorkspaceApprovalSetting.Rule.Source](#bytebase-v1-WorkspaceApprovalSetting-Rule-Source) | | |
+<a name="bytebase-v1-Changelog"></a>
+### Changelog
-<a name="bytebase-v1-WorkspaceProfileSetting"></a>
-### WorkspaceProfileSetting
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
+| status | [Changelog.Status](#bytebase-v1-Changelog-Status) | | |
+| statement | [string](#string) | | The statement is used for preview purpose. |
+| statement_size | [int64](#int64) | | |
+| statement_sheet | [string](#string) | | The name of the sheet resource. Format: projects/{project}/sheets/{sheet} |
+| schema | [string](#string) | | |
+| schema_size | [int64](#int64) | | |
+| prev_schema | [string](#string) | | |
+| prev_schema_size | [int64](#int64) | | |
+| issue | [string](#string) | | Format: projects/{project}/issues/{issue} |
+| task_run | [string](#string) | | Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} |
+| version | [string](#string) | | Could be empty |
+| revision | [string](#string) | | Could be empty Or present but not found if deleted |
+| changed_resources | [ChangedResources](#bytebase-v1-ChangedResources) | | |
+| type | [Changelog.Type](#bytebase-v1-Changelog-Type) | | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| external_url | [string](#string) | | The external URL is used for sso authentication callback. |
-| disallow_signup | [bool](#bool) | | Disallow self-service signup, users can only be invited by the owner. |
-| require_2fa | [bool](#bool) | | Require 2FA for all users. |
-| token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for token. |
-| announcement | [Announcement](#bytebase-v1-Announcement) | | The setting of custom announcement |
-| maximum_role_expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | The max duration for role expired. |
-| domains | [string](#string) | repeated | The workspace domain, e.g., bytebase.com. |
-| enforce_identity_domain | [bool](#bool) | | Only user and group from the domains can be created and login. |
-| database_change_mode | [DatabaseChangeMode](#bytebase-v1-DatabaseChangeMode) | | The workspace database change mode. |
-| disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |
-| enable_metric_collection | [bool](#bool) | | Whether to enable metric collection for the workspace. |
-| inactive_session_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The session expiration time if not activity detected for the user. Value &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. |
+<a name="bytebase-v1-CheckConstraintMetadata"></a>
+### CheckConstraintMetadata
+CheckConstraintMetadata is the metadata for check constraints.
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name is the name of a check constraint. |
+| expression | [string](#string) | | The expression is the expression of a check constraint. |
-<a name="bytebase-v1-AISetting-Provider"></a>
-### AISetting.Provider
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| PROVIDER_UNSPECIFIED | 0 | |
-| OPEN_AI | 1 | |
-| CLAUDE | 2 | |
-| GEMINI | 3 | |
-| AZURE_OPENAI | 4 | |
+<a name="bytebase-v1-ColumnMetadata"></a>
-<a name="bytebase-v1-Algorithm-InnerOuterMask-MaskType"></a>
+### ColumnMetadata
+ColumnMetadata is the metadata for columns.
-### Algorithm.InnerOuterMask.MaskType
+| 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.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| MASK_TYPE_UNSPECIFIED | 0 | |
-| INNER | 1 | |
-| OUTER | 2 | |
+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
-<a name="bytebase-v1-Announcement-AlertLevel"></a>
+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. |
-### 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-Database"></a>
+### Database
-| 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. Format: instances/{instance}/databases/{database} {database} is the database name in the instance. |
+| state | [State](#bytebase-v1-State) | | The existence of a database. |
+| successful_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The latest synchronization time. |
+| project | [string](#string) | | The project for a database. Format: projects/{project} |
+| schema_version | [string](#string) | | The version of database schema. |
+| environment | [string](#string) | optional | The environment resource. Format: environments/prod where prod is the environment resource ID. |
+| effective_environment | [string](#string) | optional | The effective environment based on environment tag above and environment tag on the instance. Inheritance follows https://cloud.google.com/resource-manager/docs/tags/tags-overview. |
+| labels | [Database.LabelsEntry](#bytebase-v1-Database-LabelsEntry) | repeated | Labels will be used for deployment and policy control. |
+| instance_resource | [InstanceResource](#bytebase-v1-InstanceResource) | | The instance resource. |
+| backup_available | [bool](#bool) | | The database is available for DML prior backup. |
+| drifted | [bool](#bool) | | The schema is drifted from the source of truth. |
-<a name="bytebase-v1-Setting-SettingName"></a>
-### Setting.SettingName
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SETTING_NAME_UNSPECIFIED | 0 | |
-| AUTH_SECRET | 1 | |
-| BRANDING_LOGO | 2 | |
-| WORKSPACE_ID | 3 | |
-| WORKSPACE_PROFILE | 4 | |
-| WORKSPACE_APPROVAL | 5 | |
-| WORKSPACE_EXTERNAL_APPROVAL | 6 | |
-| ENTERPRISE_LICENSE | 7 | |
-| APP_IM | 8 | |
-| WATERMARK | 9 | |
-| AI | 10 | |
-| SCHEMA_TEMPLATE | 13 | |
-| DATA_CLASSIFICATION | 14 | |
-| SEMANTIC_TYPES | 15 | |
-| SCIM | 17 | |
-| PASSWORD_RESTRICTION | 18 | |
-| ENVIRONMENT | 19 | |
+<a name="bytebase-v1-Database-LabelsEntry"></a>
-<a name="bytebase-v1-WorkspaceApprovalSetting-Rule-Source"></a>
+### Database.LabelsEntry
-### WorkspaceApprovalSetting.Rule.Source
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SOURCE_UNSPECIFIED | 0 | |
-| CHANGE_DATABASE | 1 | |
-| CREATE_DATABASE | 2 | |
-| EXPORT_DATA | 3 | |
-| REQUEST_ROLE | 4 | |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| key | [string](#string) | | |
+| value | [string](#string) | | |
-
-
-<a name="bytebase-v1-SettingService"></a>
-### SettingService
-SettingService manages workspace-level settings and configurations.
+<a name="bytebase-v1-DatabaseMetadata"></a>
-| 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 |
+### DatabaseMetadata
+DatabaseMetadata is the metadata for databases.
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The database metadata name.
+Format: instances/{instance}/databases/{database}/metadata |
+| schemas | [SchemaMetadata](#bytebase-v1-SchemaMetadata) | repeated | The schemas is the list of schemas in a database. |
+| character_set | [string](#string) | | The character_set is the character set of a database. |
+| collation | [string](#string) | | The collation is the collation of a database. |
+| extensions | [ExtensionMetadata](#bytebase-v1-ExtensionMetadata) | repeated | The extensions is the list of extensions in a database. |
+| owner | [string](#string) | | The owner of the database. |
+| search_path | [string](#string) | | The search_path is the search path of a PostgreSQL database. |
-<a name="v1_user_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/user_service.proto
-<a name="bytebase-v1-BatchGetUsersRequest"></a>
-### BatchGetUsersRequest
+<a name="bytebase-v1-DatabaseSDLSchema"></a>
+### DatabaseSDLSchema
+DatabaseSDLSchema contains the schema in SDL format.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| names | [string](#string) | repeated | The user names to retrieve. Format: users/{user uid or user email} |
-
+| 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-BatchGetUsersResponse"></a>
-### BatchGetUsersResponse
+<a name="bytebase-v1-DatabaseSchema"></a>
+### DatabaseSchema
+DatabaseSchema is the metadata for databases.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| users | [User](#bytebase-v1-User) | repeated | The users from the specified request. |
-
+| schema | [string](#string) | | The schema dump from database. |
-<a name="bytebase-v1-CreateUserRequest"></a>
-### CreateUserRequest
+<a name="bytebase-v1-DependencyColumn"></a>
+### DependencyColumn
+DependencyColumn is the metadata for dependency columns.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| user | [User](#bytebase-v1-User) | | The user to create. |
+| 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-DeleteUserRequest"></a>
+<a name="bytebase-v1-DependencyTable"></a>
-### DeleteUserRequest
+### DependencyTable
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user to delete. Format: users/{user} |
+| 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-GetUserRequest"></a>
+<a name="bytebase-v1-DiffSchemaRequest"></a>
-### GetUserRequest
+### DiffSchemaRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user to retrieve. Format: users/{user uid or user email} |
+| name | [string](#string) | | The name of the database or changelog. Format: database: instances/{instance}/databases/{database} changelog: instances/{instance}/databases/{database}/changelogs/{changelog} |
+| schema | [string](#string) | | The target schema. |
+| changelog | [string](#string) | | The resource name of the changelog Format: instances/{instance}/databases/{database}/changelogs/{changelog} |
-<a name="bytebase-v1-ListUsersRequest"></a>
+<a name="bytebase-v1-DiffSchemaResponse"></a>
-### ListUsersRequest
+### DiffSchemaResponse
| 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; |
-
+| diff | [string](#string) | | |
-<a name="bytebase-v1-ListUsersResponse"></a>
-### ListUsersResponse
+<a name="bytebase-v1-DimensionConstraint"></a>
+### DimensionConstraint
+DimensionConstraint defines constraints for a spatial dimension.
| 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. |
-
+| 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-UndeleteUserRequest"></a>
-### UndeleteUserRequest
+<a name="bytebase-v1-DimensionalConfig"></a>
+### DimensionalConfig
+DimensionalConfig defines dimensional and constraint parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the deleted user. Format: users/{user} |
+| dimensions | [int32](#int32) | | Number of dimensions (2-4, default 2) |
+| data_type | [string](#string) | | Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) |
+| srid | [int32](#int32) | | Spatial reference system identifier (SRID) |
+| constraints | [DimensionConstraint](#bytebase-v1-DimensionConstraint) | repeated | Coordinate system constraints |
-<a name="bytebase-v1-UpdateUserRequest"></a>
+<a name="bytebase-v1-EnumTypeMetadata"></a>
-### UpdateUserRequest
+### EnumTypeMetadata
| 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/{user} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#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 a type. |
+| values | [string](#string) | repeated | The enum values of a type. |
+| comment | [string](#string) | | The comment describing the enum type. |
+| skip_dump | [bool](#bool) | | Whether to skip this enum type during schema dump operations. |
-<a name="bytebase-v1-User"></a>
+<a name="bytebase-v1-EventMetadata"></a>
-### User
+### EventMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the user. Format: users/{user}. {user} is a system-generated unique ID. |
-| state | [State](#bytebase-v1-State) | | The lifecycle state of the user account. |
-| email | [string](#string) | | The email address of the user, used for login and notifications. |
-| title | [string](#string) | | The display title or full name of the user. |
-| user_type | [UserType](#bytebase-v1-UserType) | | The type of user account. |
-| password | [string](#string) | | The password for authentication. Only used during user creation or password updates. |
-| service_key | [string](#string) | | The service key for service account authentication. Only used for service accounts. |
-| mfa_enabled | [bool](#bool) | | The mfa_enabled flag means if the user has enabled MFA. |
-| temp_otp_secret | [string](#string) | | Temporary OTP secret used during MFA setup and regeneration. |
-| temp_recovery_codes | [string](#string) | repeated | Temporary recovery codes used during MFA setup and regeneration. |
-| temp_otp_secret_created_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. |
-| phone | [string](#string) | | Should be a valid E.164 compliant phone number. Could be empty. |
-| profile | [User.Profile](#bytebase-v1-User-Profile) | | User profile metadata. |
-| groups | [string](#string) | repeated | The groups for the user. Format: groups/{email} |
-
+| 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-User-Profile"></a>
-### User.Profile
+<a name="bytebase-v1-ExtensionMetadata"></a>
+### ExtensionMetadata
+ExtensionMetadata is the metadata for extensions.
| 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) | | The name is the name of an extension. |
+| schema | [string](#string) | | The schema is the extension that is installed to. But the extension usage is not limited to the schema. |
+| version | [string](#string) | | The version is the version of an extension. |
+| description | [string](#string) | | The description is the description of an extension. |
-
+<a name="bytebase-v1-ExternalTableMetadata"></a>
-<a name="bytebase-v1-UserType"></a>
+### ExternalTableMetadata
-### UserType
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| USER_TYPE_UNSPECIFIED | 0 | Unspecified user type. |
-| USER | 1 | Regular human user account. |
-| SYSTEM_BOT | 2 | System-managed bot account for automated operations. |
-| SERVICE_ACCOUNT | 3 | Service account for API integrations. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name is the name of a external table. |
+| external_server_name | [string](#string) | | The external_server_name is the name of the external server. |
+| external_database_name | [string](#string) | | The external_database_name is the name of the external database. |
+| columns | [ColumnMetadata](#bytebase-v1-ColumnMetadata) | repeated | The columns is the ordered list of columns in a foreign table. |
-
-
-<a name="bytebase-v1-UserService"></a>
-### UserService
-UserService manages user accounts and authentication.
+<a name="bytebase-v1-ForeignKeyMetadata"></a>
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetUser | [GetUserRequest](#bytebase-v1-GetUserRequest) | [User](#bytebase-v1-User) | Get the user. Any authenticated user can get the user. Permissions required: bb.users.get |
-| BatchGetUsers | [BatchGetUsersRequest](#bytebase-v1-BatchGetUsersRequest) | [BatchGetUsersResponse](#bytebase-v1-BatchGetUsersResponse) | Get the users in batch. Any authenticated user can batch get users. Permissions required: bb.users.get |
-| GetCurrentUser | [.google.protobuf.Empty](#google-protobuf-Empty) | [User](#bytebase-v1-User) | Get the current authenticated user. Permissions required: None |
-| ListUsers | [ListUsersRequest](#bytebase-v1-ListUsersRequest) | [ListUsersResponse](#bytebase-v1-ListUsersResponse) | List all users. Any authenticated user can list users. Permissions required: bb.users.list |
-| CreateUser | [CreateUserRequest](#bytebase-v1-CreateUserRequest) | [User](#bytebase-v1-User) | Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up. Permissions required: bb.users.create (only when Disallow Signup is enabled) |
-| UpdateUser | [UpdateUserRequest](#bytebase-v1-UpdateUserRequest) | [User](#bytebase-v1-User) | Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user. Permissions required: bb.users.update (or self) |
-| DeleteUser | [DeleteUserRequest](#bytebase-v1-DeleteUserRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete |
-| UndeleteUser | [UndeleteUserRequest](#bytebase-v1-UndeleteUserRequest) | [User](#bytebase-v1-User) | Restores a deleted user. Permissions required: bb.users.undelete |
+### ForeignKeyMetadata
+ForeignKeyMetadata is the metadata for foreign keys.
-
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name is the name of a foreign key. |
+| columns | [string](#string) | repeated | The columns are the ordered referencing columns of a foreign key. |
+| referenced_schema | [string](#string) | | The referenced_schema is the referenced schema name of a foreign key. It is an empty string for databases without such concept such as MySQL. |
+| referenced_table | [string](#string) | | The referenced_table is the referenced table name of a foreign key. |
+| referenced_columns | [string](#string) | repeated | The referenced_columns are the ordered referenced columns of a foreign key. |
+| on_delete | [string](#string) | | The on_delete is the on delete action of a foreign key. |
+| on_update | [string](#string) | | The on_update is the on update action of a foreign key. |
+| match_type | [string](#string) | | The match_type is the match type of a foreign key. The match_type is the PostgreSQL specific field. It&#39;s empty string for other databases. |
-<a name="v1_actuator_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/actuator_service.proto
-<a name="bytebase-v1-ActuatorInfo"></a>
+<a name="bytebase-v1-FunctionMetadata"></a>
-### ActuatorInfo
-System information and configuration for the Bytebase instance.
-Actuator concept is similar to the Spring Boot Actuator.
+### FunctionMetadata
+FunctionMetadata is the metadata for functions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| version | [string](#string) | | The Bytebase server version. |
-| git_commit | [string](#string) | | The git commit hash of the build. |
-| readonly | [bool](#bool) | | Whether the Bytebase instance is running in read-only mode. |
-| saas | [bool](#bool) | | Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. |
-| demo | [bool](#bool) | | Whether the Bytebase instance is running in demo mode. |
-| host | [string](#string) | | The host address of the Bytebase instance. |
-| port | [string](#string) | | The port number of the Bytebase instance. |
-| external_url | [string](#string) | | The external URL where users or webhook callbacks access Bytebase. |
-| need_admin_setup | [bool](#bool) | | Whether the Bytebase instance requires initial admin setup. |
-| disallow_signup | [bool](#bool) | | Whether self-service user signup is disabled. |
-| last_active_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last time any API call was made, refreshed on each request. |
-| require_2fa | [bool](#bool) | | Whether two-factor authentication is required for all users. |
-| workspace_id | [string](#string) | | The unique identifier for the workspace. |
-| debug | [bool](#bool) | | Whether debug mode is enabled. |
-| unlicensed_features | [string](#string) | repeated | List of features that are not licensed. |
-| disallow_password_signin | [bool](#bool) | | Whether password-based signin is disabled (except for workspace admins). |
-| password_restriction | [PasswordRestrictionSetting](#bytebase-v1-PasswordRestrictionSetting) | | Password complexity and restriction requirements. |
-| docker | [bool](#bool) | | Whether the Bytebase instance is running in Docker. |
-| user_stats | [ActuatorInfo.StatUser](#bytebase-v1-ActuatorInfo-StatUser) | repeated | Statistics about users in the system. |
-| activated_instance_count | [int32](#int32) | | The number of activated database instances. |
-| total_instance_count | [int32](#int32) | | The total number of database instances. |
-| enable_sample | [bool](#bool) | | Whether sample data setup is enabled. |
-| external_url_from_flag | [bool](#bool) | | Whether the external URL is set via command-line flag (and thus cannot be changed via UI). |
+| name | [string](#string) | | The 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-ActuatorInfo-StatUser"></a>
+<a name="bytebase-v1-GenerationMetadata"></a>
+
+### GenerationMetadata
-### 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. |
+| type | [GenerationMetadata.Type](#bytebase-v1-GenerationMetadata-Type) | | |
+| expression | [string](#string) | | |
-<a name="bytebase-v1-DeleteCacheRequest"></a>
+<a name="bytebase-v1-GetChangelogRequest"></a>
+
+### GetChangelogRequest
-### DeleteCacheRequest
-Request message for deleting cache.
+| 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) | | |
-<a name="bytebase-v1-GetActuatorInfoRequest"></a>
-### GetActuatorInfoRequest
-Request message for getting actuator information.
+<a name="bytebase-v1-GetDatabaseMetadataRequest"></a>
+### GetDatabaseMetadataRequest
+| 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
-<a name="bytebase-v1-GetResourcePackageRequest"></a>
+Supported filter: - schema: the schema name, support &#34;==&#34; operator. - table: the table name, support &#34;==&#34; and &#34;.matches()&#34; operator.
-### GetResourcePackageRequest
-Request message for getting branding resources.
+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-ResourcePackage"></a>
+<a name="bytebase-v1-GetDatabaseRequest"></a>
+
+### GetDatabaseRequest
-### 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 database to retrieve. Format: instances/{instance}/databases/{database} |
-<a name="bytebase-v1-SetupSampleRequest"></a>
+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest"></a>
-### SetupSampleRequest
-Request message for setting up sample data.
+### GetDatabaseSDLSchemaRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database to retrieve SDL schema. Format: instances/{instance}/databases/{database}/sdlSchema |
+| format | [GetDatabaseSDLSchemaRequest.SDLFormat](#bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat) | | The format of the SDL schema output. |
-<a name="bytebase-v1-UpdateActuatorInfoRequest"></a>
-### UpdateActuatorInfoRequest
-Request message for updating actuator information.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| actuator | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | | The actuator to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. |
-| allow_missing | [bool](#bool) | | If set to true, and the actuator is not found, a new actuator will be created. In this situation, `update_mask` is ignored. |
+<a name="bytebase-v1-GetDatabaseSchemaRequest"></a>
+### GetDatabaseSchemaRequest
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database to retrieve schema. Format: instances/{instance}/databases/{database}/schema |
-
-
-
-<a name="bytebase-v1-ActuatorService"></a>
-### ActuatorService
-ActuatorService manages system health and operational information.
+<a name="bytebase-v1-GetSchemaStringRequest"></a>
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| GetActuatorInfo | [GetActuatorInfoRequest](#bytebase-v1-GetActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Gets system information and health status of the Bytebase instance. Permissions required: None |
-| UpdateActuatorInfo | [UpdateActuatorInfoRequest](#bytebase-v1-UpdateActuatorInfoRequest) | [ActuatorInfo](#bytebase-v1-ActuatorInfo) | Updates system configuration settings for the Bytebase instance. Permissions required: bb.settings.set |
-| SetupSample | [SetupSampleRequest](#bytebase-v1-SetupSampleRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Sets up sample data for demonstration and testing purposes. Permissions required: bb.projects.create |
-| DeleteCache | [DeleteCacheRequest](#bytebase-v1-DeleteCacheRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Clears the system cache to force data refresh. Permissions required: None |
-| GetResourcePackage | [GetResourcePackageRequest](#bytebase-v1-GetResourcePackageRequest) | [ResourcePackage](#bytebase-v1-ResourcePackage) | Gets custom branding resources such as logos. Permissions required: None |
+### GetSchemaStringRequest
-
+
+
+| 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. |
-<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-GetSchemaStringResponse"></a>
-<a name="bytebase-v1-AuditData"></a>
+### GetSchemaStringResponse
-### AuditData
-Additional audit data specific to certain operations.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| policy_delta | [PolicyDelta](#bytebase-v1-PolicyDelta) | | Changes to IAM policies. |
+| schema_string | [string](#string) | | |
-<a name="bytebase-v1-AuditLog"></a>
+<a name="bytebase-v1-GridLevel"></a>
-### AuditLog
-Audit log entry recording system activity or API call.
+### GridLevel
+GridLevel defines a tessellation grid level with its density.
| 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. |
+| level | [int32](#int32) | | Grid level number (1-4 for SQL Server) |
+| density | [string](#string) | | Grid density (LOW, MEDIUM, HIGH) |
-<a name="bytebase-v1-ExportAuditLogsRequest"></a>
+<a name="bytebase-v1-IndexMetadata"></a>
-### ExportAuditLogsRequest
-Request message for exporting audit logs.
+### IndexMetadata
+IndexMetadata is the metadata for indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | |
-| filter | [string](#string) | | The filter of the log. It should be a valid CEL expression. Check the filter field in the SearchAuditLogsRequest message. |
-| order_by | [string](#string) | | The order by of the log. Only support order by create_time. For example: - order_by = &#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. |
+| 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-ExportAuditLogsResponse"></a>
+<a name="bytebase-v1-ListChangelogsRequest"></a>
+
+### ListChangelogsRequest
-### 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. |
+| parent | [string](#string) | | The parent of the changelogs. Format: instances/{instance}/databases/{database} |
+| page_size | [int32](#int32) | | The maximum number of changelogs to return. The service may return fewer than this value. If unspecified, at most 10 changelogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from the previous call. Provide this to retrieve the subsequent page.
+When paginating, all other parameters provided must match the call that provided the page token. |
+| view | [ChangelogView](#bytebase-v1-ChangelogView) | | |
+| filter | [string](#string) | | The filter of the changelogs. follow the [ebnf](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) syntax. Support filter by type, source or table. For example: table = &#34;tableExists(&#39;{database}&#39;, &#39;{schema}&#39;, &#39;{table}&#39;)&#34; table = &#34;tableExists(&#39;db&#39;, &#39;public&#39;, &#39;table1&#39;) || tableExists(&#39;db&#39;, &#39;public&#39;, &#39;table2&#39;)&#34;
+The table filter follow the CEL syntax. currently, we have one function for CEL: - tableExists(database, schema, table): return true if the table exists in changed resources.
+examples: Use tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;) to filter the changelogs which have the table &#34;table1&#34; in the schema &#34;public&#34; of the database &#34;db&#34;. For MySQL, the schema is always &#34;&#34;, such as tableExists(&#34;db&#34;, &#34;&#34;, &#34;table1&#34;).
+Combine multiple functions with &#34;&amp;&amp;&#34; and &#34;||&#34;, we MUST use the Disjunctive Normal Form(DNF). In other words, the CEL expression consists of several parts connected by OR operators. For example, the following expression is valid: ( tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;) &amp;&amp; tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table2&#34;) ) || ( tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table3&#34;) ) |
-<a name="bytebase-v1-RequestMetadata"></a>
-### RequestMetadata
-Metadata about the incoming request.
+
+
+
+<a name="bytebase-v1-ListChangelogsResponse"></a>
+
+### ListChangelogsResponse
+
| 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. |
+| changelogs | [Changelog](#bytebase-v1-Changelog) | repeated | The list of changelogs. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-<a name="bytebase-v1-SearchAuditLogsRequest"></a>
+<a name="bytebase-v1-ListDatabasesRequest"></a>
+
+### ListDatabasesRequest
-### 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
+| 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 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.
+When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token. |
+| filter | [string](#string) | | Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator. - name: the database name, support &#34;.matches()&#34; operator. - project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator. - instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator. - engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator. - exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator. - drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator. - table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator. - labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example: environment == &#34;environments/{environment resource id}&#34; environment == &#34;&#34; (find databases which environment is not set) project == &#34;projects/{project resource id}&#34; instance == &#34;instances/{instance resource id}&#34; name.matches(&#34;database name&#34;) engine == &#34;MYSQL&#34; engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;] !(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]) exclude_unassigned == true drifted == true table == &#34;sample&#34; table.matches(&#34;sam&#34;) labels.environment == &#34;production&#34; labels.region == &#34;asia&#34; labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+
+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. |
-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. 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-ListDatabasesResponse"></a>
-<a name="bytebase-v1-SearchAuditLogsResponse"></a>
+### ListDatabasesResponse
-### SearchAuditLogsResponse
-Response message for searching audit logs.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| audit_logs | [AuditLog](#bytebase-v1-AuditLog) | repeated | |
-| next_page_token | [string](#string) | | A token to retrieve next page of log entities. Pass this value in the page_token field in the subsequent call to retrieve the next page of log entities. |
+| databases | [Database](#bytebase-v1-Database) | repeated | The databases from the specified request. |
+| next_page_token | [string](#string) | | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
-
+<a name="bytebase-v1-MaterializedViewMetadata"></a>
-<a name="bytebase-v1-AuditLog-Severity"></a>
+### MaterializedViewMetadata
+MaterializedViewMetadata is the metadata for materialized views.
-### AuditLog.Severity
-Severity level for audit log entries.
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| SEVERITY_UNSPECIFIED | 0 | Unspecified severity level. |
-| DEBUG | 1 | Debug-level information. |
-| INFO | 2 | Informational messages. |
-| NOTICE | 3 | Notable events. |
-| WARNING | 4 | Warning conditions. |
-| ERROR | 5 | Error conditions. |
-| CRITICAL | 6 | Critical conditions. |
-| ALERT | 7 | Action must be taken immediately. |
-| EMERGENCY | 8 | System is unusable. |
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name 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-AuditLogService"></a>
-### AuditLogService
-AuditLogService manages audit logs for system activities and API calls.
+<a name="bytebase-v1-PackageMetadata"></a>
-| 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 |
+### 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. |
-<a name="v1_auth_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/auth_service.proto
-<a name="bytebase-v1-IdentityProviderContext"></a>
+<a name="bytebase-v1-ProcedureMetadata"></a>
-### IdentityProviderContext
-Context for identity provider authentication.
+### ProcedureMetadata
+ProcedureMetadata is the metadata for procedures.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| oauth2_context | [OAuth2IdentityProviderContext](#bytebase-v1-OAuth2IdentityProviderContext) | | OAuth2 authentication context. |
-| oidc_context | [OIDCIdentityProviderContext](#bytebase-v1-OIDCIdentityProviderContext) | | OpenID Connect authentication context. |
-
+| name | [string](#string) | | The 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-LoginRequest"></a>
-### LoginRequest
+<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 |
| ----- | ---- | ----- | ----------- |
-| email | [string](#string) | | User&#39;s email address. |
-| password | [string](#string) | | User&#39;s password for authentication. |
-| web | [bool](#bool) | | If web is set, we will set access token, refresh token, and user to the cookie. |
-| idp_name | [string](#string) | | The name of the identity provider. Format: idps/{idp} |
-| idp_context | [IdentityProviderContext](#bytebase-v1-IdentityProviderContext) | | The idp_context is using to get the user information from identity provider. |
-| otp_code | [string](#string) | optional | The otp_code is used to verify the user&#39;s identity by MFA. |
-| recovery_code | [string](#string) | optional | The recovery_code is used to recovery the user&#39;s identity with MFA. |
-| mfa_temp_token | [string](#string) | optional | The mfa_temp_token is used to verify the user&#39;s identity by MFA. |
+| name | [string](#string) | | The name 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-LoginResponse"></a>
+<a name="bytebase-v1-SequenceMetadata"></a>
-### LoginResponse
+### SequenceMetadata
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| token | [string](#string) | | Access token for authenticated requests. |
-| mfa_temp_token | [string](#string) | optional | Temporary token for MFA verification. |
-| require_reset_password | [bool](#bool) | | Whether user must reset password before continuing. |
-| user | [User](#bytebase-v1-User) | | The user from the successful login. |
+| name | [string](#string) | | The name of 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-LogoutRequest"></a>
+<a name="bytebase-v1-SpatialIndexConfig"></a>
-### LogoutRequest
-Request to logout current user session.
+### 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 |
-<a name="bytebase-v1-OAuth2IdentityProviderContext"></a>
-### OAuth2IdentityProviderContext
-OAuth2 authentication context.
+
+<a name="bytebase-v1-StorageConfig"></a>
+
+### StorageConfig
+StorageConfig defines storage and performance parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorization code from OAuth2 provider. |
+| 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-OIDCIdentityProviderContext"></a>
+<a name="bytebase-v1-StreamMetadata"></a>
+
+### StreamMetadata
-### OIDCIdentityProviderContext
-OpenID Connect authentication context.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| code | [string](#string) | | Authorization code from OIDC provider. |
+| 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-SyncDatabaseRequest"></a>
-
+### SyncDatabaseRequest
-<a name="bytebase-v1-AuthService"></a>
-### AuthService
-AuthService handles user authentication operations.
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the database to sync. Format: instances/{instance}/databases/{database} |
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| Login | [LoginRequest](#bytebase-v1-LoginRequest) | [LoginResponse](#bytebase-v1-LoginResponse) | Authenticates a user and returns access tokens. Permissions required: None |
-| Logout | [LogoutRequest](#bytebase-v1-LogoutRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Logs out the current user session. Permissions required: None |
-
-<a name="v1_cel_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/cel_service.proto
+<a name="bytebase-v1-SyncDatabaseResponse"></a>
+### SyncDatabaseResponse
-<a name="bytebase-v1-BatchDeparseRequest"></a>
-### BatchDeparseRequest
-Request message for batch deparsing CEL expressions.
+
+
+
+
+<a name="bytebase-v1-TableMetadata"></a>
+
+### TableMetadata
+TableMetadata is the metadata for tables.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The CEL expression ASTs to deparse. |
+| name | [string](#string) | | The name 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-BatchDeparseResponse"></a>
+<a name="bytebase-v1-TablePartitionMetadata"></a>
-### BatchDeparseResponse
-Response message for batch deparsing CEL expressions.
+### TablePartitionMetadata
+TablePartitionMetadata is the metadata for table partitions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [string](#string) | repeated | The deparsed CEL expressions as strings. |
+| 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-BatchParseRequest"></a>
+<a name="bytebase-v1-TaskMetadata"></a>
+
+### TaskMetadata
-### BatchParseRequest
-Request message for batch parsing CEL expressions.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [string](#string) | repeated | The CEL expression strings to parse. |
+| 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-BatchParseResponse"></a>
+<a name="bytebase-v1-TessellationConfig"></a>
-### BatchParseResponse
-Response message for batch parsing CEL expressions.
+### TessellationConfig
+TessellationConfig defines tessellation parameters for spatial indexes.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| expressions | [google.api.expr.v1alpha1.Expr](#google-api-expr-v1alpha1-Expr) | repeated | The parsed CEL expressions as AST. |
-
-
+| 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-TriggerMetadata"></a>
-<a name="bytebase-v1-CelService"></a>
+### TriggerMetadata
-### 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 |
+| ----- | ---- | ----- | ----------- |
+| 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="v1_database_group_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-## v1/database_group_service.proto
+<a name="bytebase-v1-UpdateDatabaseRequest"></a>
-<a name="bytebase-v1-CreateDatabaseGroupRequest"></a>
+### UpdateDatabaseRequest
-### 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.
+| database | [Database](#bytebase-v1-Database) | | The database to update.
-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. |
+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-DatabaseGroup"></a>
+<a name="bytebase-v1-ViewMetadata"></a>
-### DatabaseGroup
-A group of databases matched by expressions.
+### ViewMetadata
+ViewMetadata is the metadata for views.
| 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
+| 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) | | |
-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-Changelog-Status"></a>
-<a name="bytebase-v1-DatabaseGroup-Database"></a>
+### Changelog.Status
-### DatabaseGroup.Database
-A database within a database group.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 | |
+| PENDING | 1 | |
+| DONE | 2 | |
+| FAILED | 3 | |
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The resource name of the database. Format: instances/{instance}/databases/{database} |
+<a name="bytebase-v1-Changelog-Type"></a>
+### Changelog.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| BASELINE | 1 | |
+| MIGRATE | 2 | |
+| SDL | 3 | |
-<a name="bytebase-v1-DeleteDatabaseGroupRequest"></a>
-### DeleteDatabaseGroupRequest
-Request message for deleting a database group.
+<a name="bytebase-v1-ChangelogView"></a>
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the database group to delete. Format: projects/{project}/databaseGroups/{databaseGroup} |
+### ChangelogView
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| CHANGELOG_VIEW_UNSPECIFIED | 0 | The default / unset value. The API will default to the BASIC view. |
+| CHANGELOG_VIEW_BASIC | 1 | |
+| CHANGELOG_VIEW_FULL | 2 | |
+
+<a name="bytebase-v1-ColumnMetadata-IdentityGeneration"></a>
+### ColumnMetadata.IdentityGeneration
-<a name="bytebase-v1-GetDatabaseGroupRequest"></a>
-### GetDatabaseGroupRequest
-Request message for getting a database group.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| IDENTITY_GENERATION_UNSPECIFIED | 0 | |
+| ALWAYS | 1 | |
+| BY_DEFAULT | 2 | |
-| 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-GenerationMetadata-Type"></a>
+### GenerationMetadata.Type
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| VIRTUAL | 1 | |
+| STORED | 2 | |
-<a name="bytebase-v1-ListDatabaseGroupsRequest"></a>
-### ListDatabaseGroupsRequest
-Request message for listing database groups.
+<a name="bytebase-v1-GetDatabaseSDLSchemaRequest-SDLFormat"></a>
+### GetDatabaseSDLSchemaRequest.SDLFormat
+SDLFormat specifies the output format for SDL schema.
-| 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 |
+| ---- | ------ | ----------- |
+| SDL_FORMAT_UNSPECIFIED | 0 | Unspecified format. Defaults to SINGLE_FILE. |
+| SINGLE_FILE | 1 | Single file format: returns the complete SDL schema as a single file. |
+| MULTI_FILE | 2 | Multi-file format: returns the SDL schema as a ZIP archive containing multiple files organized by schema objects (tables, views, functions, etc.). |
+<a name="bytebase-v1-GetSchemaStringRequest-ObjectType"></a>
+### GetSchemaStringRequest.ObjectType
-<a name="bytebase-v1-ListDatabaseGroupsResponse"></a>
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OBJECT_TYPE_UNSPECIFIED | 0 | |
+| DATABASE | 1 | |
+| SCHEMA | 2 | |
+| TABLE | 3 | |
+| VIEW | 4 | |
+| MATERIALIZED_VIEW | 5 | |
+| FUNCTION | 6 | |
+| PROCEDURE | 7 | |
+| SEQUENCE | 8 | |
-### ListDatabaseGroupsResponse
-Response message for listing database groups.
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| database_groups | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | repeated | The database groups from the specified request. |
+<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-UpdateDatabaseGroupRequest"></a>
+<a name="bytebase-v1-StreamMetadata-Type"></a>
-### UpdateDatabaseGroupRequest
-Request message for updating a database group.
+### StreamMetadata.Type
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| database_group | [DatabaseGroup](#bytebase-v1-DatabaseGroup) | | The database group to update.
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| TYPE_UNSPECIFIED | 0 | |
+| DELTA | 1 | |
-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-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-DatabaseGroupView"></a>
+<a name="bytebase-v1-TaskMetadata-State"></a>
+
+### TaskMetadata.State
-### 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. |
+| STATE_UNSPECIFIED | 0 | |
+| STARTED | 1 | |
+| SUSPENDED | 2 | |
@@ -6458,18 +6370,27 @@ View options for database group responses.
-<a name="bytebase-v1-DatabaseGroupService"></a>
+<a name="bytebase-v1-DatabaseService"></a>
-### DatabaseGroupService
-DatabaseGroupService manages database groups for organizing databases by criteria.
+### DatabaseService
+DatabaseService manages databases and their schemas.
| 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 |
+| 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 |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index b1e0042272..6fc7fa9cfd 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -253,579 +253,609 @@
<li>
- <a href="#v1%2fdatabase_catalog_service.proto">v1/database_catalog_service.proto</a>
+ <a href="#v1%2fissue_service.proto">v1/issue_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a>
+ <a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a>
</li>
<li>
- <a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a>
+ <a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a>
+ <a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a>
+ <a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a>
+ <a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a>
+ <a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a>
+ <a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a>
+ <a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a>
+ <a href="#bytebase.v1.GrantRequest"><span class="badge">M</span>GrantRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a>
+ <a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</a>
</li>
<li>
- <a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a>
+ <a href="#bytebase.v1.Issue.Approver"><span class="badge">M</span>Issue.Approver</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a>
+ <a href="#bytebase.v1.Issue.TaskStatusCountEntry"><span class="badge">M</span>Issue.TaskStatusCountEntry</a>
</li>
-
<li>
- <a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a>
+ <a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a>
+ <a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.GetInstanceRoleRequest"><span class="badge">M</span>GetInstanceRoleRequest</a>
+ <a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a>
</li>
<li>
- <a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a>
+ <a href="#bytebase.v1.IssueComment.StageEnd"><span class="badge">M</span>IssueComment.StageEnd</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a>
+ <a href="#bytebase.v1.IssueComment.TaskPriorBackup"><span class="badge">M</span>IssueComment.TaskPriorBackup</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a>
+ <a href="#bytebase.v1.IssueComment.TaskPriorBackup.Table"><span class="badge">M</span>IssueComment.TaskPriorBackup.Table</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.InstanceRoleService"><span class="badge">S</span>InstanceRoleService</a>
+ <a href="#bytebase.v1.IssueComment.TaskUpdate"><span class="badge">M</span>IssueComment.TaskUpdate</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2finstance_service.proto">v1/instance_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a>
+ <a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a>
+ <a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a>
+ <a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a>
+ <a href="#bytebase.v1.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a>
+ <a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a>
+ <a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a>
+ <a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a>
+ <a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a>
+ <a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a>
+ <a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a>
+ <a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a>
+ <a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a>
+ <a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a>
+ <a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a>
+ <a href="#bytebase.v1.IssueComment.TaskUpdate.Status"><span class="badge">E</span>IssueComment.TaskUpdate.Status</a>
</li>
<li>
- <a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a>
+ <a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a>
+ <a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fiam_policy.proto">v1/iam_policy.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a>
+ <a href="#bytebase.v1.Binding"><span class="badge">M</span>Binding</a>
</li>
<li>
- <a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a>
+ <a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a>
</li>
<li>
- <a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a>
+ <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a>
+ <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a>
+ <a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a>
</li>
<li>
- <a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a>
+ <a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a>
+ <a href="#bytebase.v1.BindingDelta.Action"><span class="badge">E</span>BindingDelta.Action</a>
</li>
+
+
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fproject_service.proto">v1/project_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a>
+ <a href="#bytebase.v1.Activity"><span class="badge">M</span>Activity</a>
</li>
<li>
- <a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a>
+ <a href="#bytebase.v1.AddWebhookRequest"><span class="badge">M</span>AddWebhookRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a>
+ <a href="#bytebase.v1.BatchDeleteProjectsRequest"><span class="badge">M</span>BatchDeleteProjectsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a>
+ <a href="#bytebase.v1.BatchGetIamPolicyRequest"><span class="badge">M</span>BatchGetIamPolicyRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a>
+ <a href="#bytebase.v1.BatchGetIamPolicyResponse"><span class="badge">M</span>BatchGetIamPolicyResponse</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a>
+ <a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult"><span class="badge">M</span>BatchGetIamPolicyResponse.PolicyResult</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a>
+ <a href="#bytebase.v1.CreateProjectRequest"><span class="badge">M</span>CreateProjectRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a>
+ <a href="#bytebase.v1.DeleteProjectRequest"><span class="badge">M</span>DeleteProjectRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a>
+ <a href="#bytebase.v1.GetProjectRequest"><span class="badge">M</span>GetProjectRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a>
+ <a href="#bytebase.v1.Label"><span class="badge">M</span>Label</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a>
+ <a href="#bytebase.v1.ListProjectsRequest"><span class="badge">M</span>ListProjectsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a>
+ <a href="#bytebase.v1.ListProjectsResponse"><span class="badge">M</span>ListProjectsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a>
+ <a href="#bytebase.v1.Project"><span class="badge">M</span>Project</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a>
+ <a href="#bytebase.v1.Project.ExecutionRetryPolicy"><span class="badge">M</span>Project.ExecutionRetryPolicy</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a>
+ <a href="#bytebase.v1.Project.LabelsEntry"><span class="badge">M</span>Project.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a>
+ <a href="#bytebase.v1.RemoveWebhookRequest"><span class="badge">M</span>RemoveWebhookRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a>
+ <a href="#bytebase.v1.SearchProjectsRequest"><span class="badge">M</span>SearchProjectsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a>
+ <a href="#bytebase.v1.SearchProjectsResponse"><span class="badge">M</span>SearchProjectsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a>
+ <a href="#bytebase.v1.TestWebhookRequest"><span class="badge">M</span>TestWebhookRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a>
+ <a href="#bytebase.v1.TestWebhookResponse"><span class="badge">M</span>TestWebhookResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a>
+ <a href="#bytebase.v1.UndeleteProjectRequest"><span class="badge">M</span>UndeleteProjectRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ChangedResourceDatabase"><span class="badge">M</span>ChangedResourceDatabase</a>
+ <a href="#bytebase.v1.UpdateProjectRequest"><span class="badge">M</span>UpdateProjectRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ChangedResourceFunction"><span class="badge">M</span>ChangedResourceFunction</a>
+ <a href="#bytebase.v1.UpdateWebhookRequest"><span class="badge">M</span>UpdateWebhookRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ChangedResourceProcedure"><span class="badge">M</span>ChangedResourceProcedure</a>
+ <a href="#bytebase.v1.Webhook"><span class="badge">M</span>Webhook</a>
</li>
+
<li>
- <a href="#bytebase.v1.ChangedResourceSchema"><span class="badge">M</span>ChangedResourceSchema</a>
+ <a href="#bytebase.v1.Activity.Type"><span class="badge">E</span>Activity.Type</a>
</li>
<li>
- <a href="#bytebase.v1.ChangedResourceTable"><span class="badge">M</span>ChangedResourceTable</a>
+ <a href="#bytebase.v1.Webhook.Type"><span class="badge">E</span>Webhook.Type</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.ChangedResourceView"><span class="badge">M</span>ChangedResourceView</a>
+ <a href="#bytebase.v1.ProjectService"><span class="badge">S</span>ProjectService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.ChangedResources"><span class="badge">M</span>ChangedResources</a>
+ <a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a>
</li>
<li>
- <a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a>
+ <a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a>
</li>
<li>
- <a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a>
+ <a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a>
</li>
<li>
- <a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a>
+ <a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a>
</li>
<li>
- <a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a>
+ <a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a>
</li>
<li>
- <a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a>
+ <a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a>
+ <a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a>
+ <a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a>
+ <a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a>
</li>
<li>
- <a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a>
+ <a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a>
</li>
<li>
- <a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a>
+ <a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a>
</li>
<li>
- <a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a>
+ <a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a>
</li>
<li>
- <a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a>
+ <a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a>
</li>
<li>
- <a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a>
+ <a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a>
</li>
<li>
- <a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a>
+ <a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a>
</li>
<li>
- <a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a>
+ <a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a>
</li>
<li>
- <a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a>
</li>
<li>
- <a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a>
</li>
<li>
- <a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a>
</li>
<li>
- <a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a>
+ <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a>
</li>
<li>
- <a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a>
+ <a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a>
</li>
<li>
- <a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a>
+ <a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a>
</li>
<li>
- <a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a>
+ <a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a>
+ <a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a>
+ <a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a>
+ <a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a>
+ <a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a>
+ <a href="#bytebase.v1.PasswordRestrictionSetting"><span class="badge">M</span>PasswordRestrictionSetting</a>
</li>
<li>
- <a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a>
+ <a href="#bytebase.v1.SCIMSetting"><span class="badge">M</span>SCIMSetting</a>
</li>
<li>
- <a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a>
+ <a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
</li>
<li>
- <a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a>
+ <a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a>
</li>
<li>
- <a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</a>
+ <a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a>
</li>
<li>
- <a href="#bytebase.v1.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a>
+ <a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a>
+ <a href="#bytebase.v1.Value"><span class="badge">M</span>Value</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a>
</li>
<li>
- <a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a>
</li>
<li>
- <a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a>
+ <a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a>
</li>
+
<li>
- <a href="#bytebase.v1.ProcedureMetadata"><span class="badge">M</span>ProcedureMetadata</a>
+ <a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaMetadata"><span class="badge">M</span>SchemaMetadata</a>
+ <a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a>
</li>
<li>
- <a href="#bytebase.v1.SequenceMetadata"><span class="badge">M</span>SequenceMetadata</a>
+ <a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a>
</li>
<li>
- <a href="#bytebase.v1.SpatialIndexConfig"><span class="badge">M</span>SpatialIndexConfig</a>
+ <a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a>
</li>
<li>
- <a href="#bytebase.v1.StorageConfig"><span class="badge">M</span>StorageConfig</a>
+ <a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a>
</li>
<li>
- <a href="#bytebase.v1.StreamMetadata"><span class="badge">M</span>StreamMetadata</a>
+ <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.SyncDatabaseRequest"><span class="badge">M</span>SyncDatabaseRequest</a>
+ <a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fuser_service.proto">v1/user_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.SyncDatabaseResponse"><span class="badge">M</span>SyncDatabaseResponse</a>
+ <a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TableMetadata"><span class="badge">M</span>TableMetadata</a>
+ <a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a>
</li>
<li>
- <a href="#bytebase.v1.TablePartitionMetadata"><span class="badge">M</span>TablePartitionMetadata</a>
+ <a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TaskMetadata"><span class="badge">M</span>TaskMetadata</a>
+ <a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TessellationConfig"><span class="badge">M</span>TessellationConfig</a>
+ <a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TriggerMetadata"><span class="badge">M</span>TriggerMetadata</a>
+ <a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseRequest"><span class="badge">M</span>UpdateDatabaseRequest</a>
+ <a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ViewMetadata"><span class="badge">M</span>ViewMetadata</a>
+ <a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a>
</li>
+ <li>
+ <a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a>
+ </li>
<li>
- <a href="#bytebase.v1.Changelog.Status"><span class="badge">E</span>Changelog.Status</a>
+ <a href="#bytebase.v1.User"><span class="badge">M</span>User</a>
</li>
<li>
- <a href="#bytebase.v1.Changelog.Type"><span class="badge">E</span>Changelog.Type</a>
+ <a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a>
</li>
+
<li>
- <a href="#bytebase.v1.ChangelogView"><span class="badge">E</span>ChangelogView</a>
+ <a href="#bytebase.v1.UserType"><span class="badge">E</span>UserType</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.ColumnMetadata.IdentityGeneration"><span class="badge">E</span>ColumnMetadata.IdentityGeneration</a>
+ <a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2factuator_service.proto">v1/actuator_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.GenerationMetadata.Type"><span class="badge">E</span>GenerationMetadata.Type</a>
+ <a href="#bytebase.v1.ActuatorInfo"><span class="badge">M</span>ActuatorInfo</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat"><span class="badge">E</span>GetDatabaseSDLSchemaRequest.SDLFormat</a>
+ <a href="#bytebase.v1.ActuatorInfo.StatUser"><span class="badge">M</span>ActuatorInfo.StatUser</a>
</li>
<li>
- <a href="#bytebase.v1.GetSchemaStringRequest.ObjectType"><span class="badge">E</span>GetSchemaStringRequest.ObjectType</a>
+ <a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a>
</li>
<li>
- <a href="#bytebase.v1.StreamMetadata.Mode"><span class="badge">E</span>StreamMetadata.Mode</a>
+ <a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a>
</li>
<li>
- <a href="#bytebase.v1.StreamMetadata.Type"><span class="badge">E</span>StreamMetadata.Type</a>
+ <a href="#bytebase.v1.GetResourcePackageRequest"><span class="badge">M</span>GetResourcePackageRequest</a>
</li>
<li>
- <a href="#bytebase.v1.TablePartitionMetadata.Type"><span class="badge">E</span>TablePartitionMetadata.Type</a>
+ <a href="#bytebase.v1.ResourcePackage"><span class="badge">M</span>ResourcePackage</a>
</li>
<li>
- <a href="#bytebase.v1.TaskMetadata.State"><span class="badge">E</span>TaskMetadata.State</a>
+ <a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateActuatorInfoRequest"><span class="badge">M</span>UpdateActuatorInfoRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.DatabaseService"><span class="badge">S</span>DatabaseService</a>
+ <a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a>
</li>
</ul>
@@ -833,154 +863,183 @@
<li>
- <a href="#v1%2fissue_service.proto">v1/issue_service.proto</a>
+ <a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.ApprovalFlow"><span class="badge">M</span>ApprovalFlow</a>
+ <a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a>
</li>
<li>
- <a href="#bytebase.v1.ApprovalTemplate"><span class="badge">M</span>ApprovalTemplate</a>
+ <a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a>
</li>
<li>
- <a href="#bytebase.v1.ApproveIssueRequest"><span class="badge">M</span>ApproveIssueRequest</a>
+ <a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateIssuesStatusRequest"><span class="badge">M</span>BatchUpdateIssuesStatusRequest</a>
+ <a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.BatchUpdateIssuesStatusResponse"><span class="badge">M</span>BatchUpdateIssuesStatusResponse</a>
+ <a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.CreateIssueCommentRequest"><span class="badge">M</span>CreateIssueCommentRequest</a>
+ <a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a>
</li>
<li>
- <a href="#bytebase.v1.CreateIssueRequest"><span class="badge">M</span>CreateIssueRequest</a>
+ <a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a>
</li>
- <li>
- <a href="#bytebase.v1.GetIssueRequest"><span class="badge">M</span>GetIssueRequest</a>
- </li>
<li>
- <a href="#bytebase.v1.GrantRequest"><span class="badge">M</span>GrantRequest</a>
+ <a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.Issue"><span class="badge">M</span>Issue</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.Issue.Approver"><span class="badge">M</span>Issue.Approver</a>
+ <a href="#bytebase.v1.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.TaskStatusCountEntry"><span class="badge">M</span>Issue.TaskStatusCountEntry</a>
+ <a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment"><span class="badge">M</span>IssueComment</a>
+ <a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.Approval"><span class="badge">M</span>IssueComment.Approval</a>
+ <a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.IssueUpdate"><span class="badge">M</span>IssueComment.IssueUpdate</a>
+ <a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.StageEnd"><span class="badge">M</span>IssueComment.StageEnd</a>
+ <a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a>
</li>
+
+
+
<li>
- <a href="#bytebase.v1.IssueComment.TaskPriorBackup"><span class="badge">M</span>IssueComment.TaskPriorBackup</a>
+ <a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fcel_service.proto">v1/cel_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.IssueComment.TaskPriorBackup.Table"><span class="badge">M</span>IssueComment.TaskPriorBackup.Table</a>
+ <a href="#bytebase.v1.BatchDeparseRequest"><span class="badge">M</span>BatchDeparseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.TaskUpdate"><span class="badge">M</span>IssueComment.TaskUpdate</a>
+ <a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssueCommentsRequest"><span class="badge">M</span>ListIssueCommentsRequest</a>
+ <a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListIssueCommentsResponse"><span class="badge">M</span>ListIssueCommentsResponse</a>
+ <a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a>
</li>
+
+
+
<li>
- <a href="#bytebase.v1.ListIssuesRequest"><span class="badge">M</span>ListIssuesRequest</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.ListIssuesResponse"><span class="badge">M</span>ListIssuesResponse</a>
+ <a href="#bytebase.v1.ColumnCatalog"><span class="badge">M</span>ColumnCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.RejectIssueRequest"><span class="badge">M</span>RejectIssueRequest</a>
+ <a href="#bytebase.v1.ColumnCatalog.LabelsEntry"><span class="badge">M</span>ColumnCatalog.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.RequestIssueRequest"><span class="badge">M</span>RequestIssueRequest</a>
+ <a href="#bytebase.v1.DatabaseCatalog"><span class="badge">M</span>DatabaseCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.SearchIssuesRequest"><span class="badge">M</span>SearchIssuesRequest</a>
+ <a href="#bytebase.v1.GetDatabaseCatalogRequest"><span class="badge">M</span>GetDatabaseCatalogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SearchIssuesResponse"><span class="badge">M</span>SearchIssuesResponse</a>
+ <a href="#bytebase.v1.ObjectSchema"><span class="badge">M</span>ObjectSchema</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIssueCommentRequest"><span class="badge">M</span>UpdateIssueCommentRequest</a>
+ <a href="#bytebase.v1.ObjectSchema.ArrayKind"><span class="badge">M</span>ObjectSchema.ArrayKind</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateIssueRequest"><span class="badge">M</span>UpdateIssueRequest</a>
+ <a href="#bytebase.v1.ObjectSchema.StructKind"><span class="badge">M</span>ObjectSchema.StructKind</a>
</li>
-
<li>
- <a href="#bytebase.v1.Issue.ApprovalStatus"><span class="badge">E</span>Issue.ApprovalStatus</a>
+ <a href="#bytebase.v1.ObjectSchema.StructKind.PropertiesEntry"><span class="badge">M</span>ObjectSchema.StructKind.PropertiesEntry</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Approver.Status"><span class="badge">E</span>Issue.Approver.Status</a>
+ <a href="#bytebase.v1.SchemaCatalog"><span class="badge">M</span>SchemaCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.Issue.Type"><span class="badge">E</span>Issue.Type</a>
+ <a href="#bytebase.v1.TableCatalog"><span class="badge">M</span>TableCatalog</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.Approval.Status"><span class="badge">E</span>IssueComment.Approval.Status</a>
+ <a href="#bytebase.v1.TableCatalog.Columns"><span class="badge">M</span>TableCatalog.Columns</a>
</li>
<li>
- <a href="#bytebase.v1.IssueComment.TaskUpdate.Status"><span class="badge">E</span>IssueComment.TaskUpdate.Status</a>
+ <a href="#bytebase.v1.UpdateDatabaseCatalogRequest"><span class="badge">M</span>UpdateDatabaseCatalogRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.IssueStatus"><span class="badge">E</span>IssueStatus</a>
+ <a href="#bytebase.v1.ObjectSchema.Type"><span class="badge">E</span>ObjectSchema.Type</a>
</li>
<li>
- <a href="#bytebase.v1.IssueService"><span class="badge">S</span>IssueService</a>
+ <a href="#bytebase.v1.DatabaseCatalogService"><span class="badge">S</span>DatabaseCatalogService</a>
</li>
</ul>
@@ -988,638 +1047,563 @@
<li>
- <a href="#v1%2fiam_policy.proto">v1/iam_policy.proto</a>
+ <a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.Binding"><span class="badge">M</span>Binding</a>
+ <a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BindingDelta"><span class="badge">M</span>BindingDelta</a>
+ <a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a>
</li>
<li>
- <a href="#bytebase.v1.GetIamPolicyRequest"><span class="badge">M</span>GetIamPolicyRequest</a>
+ <a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a>
</li>
<li>
- <a href="#bytebase.v1.IamPolicy"><span class="badge">M</span>IamPolicy</a>
+ <a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.PolicyDelta"><span class="badge">M</span>PolicyDelta</a>
+ <a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a>
</li>
<li>
- <a href="#bytebase.v1.SetIamPolicyRequest"><span class="badge">M</span>SetIamPolicyRequest</a>
+ <a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a>
</li>
+ <li>
+ <a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a>
+ </li>
<li>
- <a href="#bytebase.v1.BindingDelta.Action"><span class="badge">E</span>BindingDelta.Action</a>
+ <a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a>
</li>
+ <li>
+ <a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a>
+ </li>
+
</ul>
</li>
<li>
- <a href="#v1%2fproject_service.proto">v1/project_service.proto</a>
+ <a href="#v1%2finstance_role_service.proto">v1/instance_role_service.proto</a>
<ul>
<li>
- <a href="#bytebase.v1.Activity"><span class="badge">M</span>Activity</a>
+ <a href="#bytebase.v1.GetInstanceRoleRequest"><span class="badge">M</span>GetInstanceRoleRequest</a>
</li>
<li>
- <a href="#bytebase.v1.AddWebhookRequest"><span class="badge">M</span>AddWebhookRequest</a>
+ <a href="#bytebase.v1.InstanceRole"><span class="badge">M</span>InstanceRole</a>
</li>
<li>
- <a href="#bytebase.v1.BatchDeleteProjectsRequest"><span class="badge">M</span>BatchDeleteProjectsRequest</a>
+ <a href="#bytebase.v1.ListInstanceRolesRequest"><span class="badge">M</span>ListInstanceRolesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchGetIamPolicyRequest"><span class="badge">M</span>BatchGetIamPolicyRequest</a>
+ <a href="#bytebase.v1.ListInstanceRolesResponse"><span class="badge">M</span>ListInstanceRolesResponse</a>
</li>
+
+
+
<li>
- <a href="#bytebase.v1.BatchGetIamPolicyResponse"><span class="badge">M</span>BatchGetIamPolicyResponse</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.BatchGetIamPolicyResponse.PolicyResult"><span class="badge">M</span>BatchGetIamPolicyResponse.PolicyResult</a>
+ <a href="#bytebase.v1.AddDataSourceRequest"><span class="badge">M</span>AddDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.CreateProjectRequest"><span class="badge">M</span>CreateProjectRequest</a>
+ <a href="#bytebase.v1.BatchSyncInstancesRequest"><span class="badge">M</span>BatchSyncInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteProjectRequest"><span class="badge">M</span>DeleteProjectRequest</a>
+ <a href="#bytebase.v1.BatchSyncInstancesResponse"><span class="badge">M</span>BatchSyncInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetProjectRequest"><span class="badge">M</span>GetProjectRequest</a>
+ <a href="#bytebase.v1.BatchUpdateInstancesRequest"><span class="badge">M</span>BatchUpdateInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Label"><span class="badge">M</span>Label</a>
+ <a href="#bytebase.v1.BatchUpdateInstancesResponse"><span class="badge">M</span>BatchUpdateInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ListProjectsRequest"><span class="badge">M</span>ListProjectsRequest</a>
+ <a href="#bytebase.v1.CreateInstanceRequest"><span class="badge">M</span>CreateInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListProjectsResponse"><span class="badge">M</span>ListProjectsResponse</a>
+ <a href="#bytebase.v1.DataSource"><span class="badge">M</span>DataSource</a>
</li>
<li>
- <a href="#bytebase.v1.Project"><span class="badge">M</span>Project</a>
+ <a href="#bytebase.v1.DataSource.AWSCredential"><span class="badge">M</span>DataSource.AWSCredential</a>
</li>
<li>
- <a href="#bytebase.v1.Project.ExecutionRetryPolicy"><span class="badge">M</span>Project.ExecutionRetryPolicy</a>
+ <a href="#bytebase.v1.DataSource.Address"><span class="badge">M</span>DataSource.Address</a>
</li>
<li>
- <a href="#bytebase.v1.Project.LabelsEntry"><span class="badge">M</span>Project.LabelsEntry</a>
+ <a href="#bytebase.v1.DataSource.AzureCredential"><span class="badge">M</span>DataSource.AzureCredential</a>
</li>
<li>
- <a href="#bytebase.v1.RemoveWebhookRequest"><span class="badge">M</span>RemoveWebhookRequest</a>
+ <a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry"><span class="badge">M</span>DataSource.ExtraConnectionParametersEntry</a>
</li>
<li>
- <a href="#bytebase.v1.SearchProjectsRequest"><span class="badge">M</span>SearchProjectsRequest</a>
+ <a href="#bytebase.v1.DataSource.GCPCredential"><span class="badge">M</span>DataSource.GCPCredential</a>
</li>
<li>
- <a href="#bytebase.v1.SearchProjectsResponse"><span class="badge">M</span>SearchProjectsResponse</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret"><span class="badge">M</span>DataSourceExternalSecret</a>
</li>
<li>
- <a href="#bytebase.v1.TestWebhookRequest"><span class="badge">M</span>TestWebhookRequest</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption"><span class="badge">M</span>DataSourceExternalSecret.AppRoleAuthOption</a>
</li>
<li>
- <a href="#bytebase.v1.TestWebhookResponse"><span class="badge">M</span>TestWebhookResponse</a>
+ <a href="#bytebase.v1.DeleteInstanceRequest"><span class="badge">M</span>DeleteInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteProjectRequest"><span class="badge">M</span>UndeleteProjectRequest</a>
+ <a href="#bytebase.v1.GetInstanceRequest"><span class="badge">M</span>GetInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateProjectRequest"><span class="badge">M</span>UpdateProjectRequest</a>
+ <a href="#bytebase.v1.Instance"><span class="badge">M</span>Instance</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateWebhookRequest"><span class="badge">M</span>UpdateWebhookRequest</a>
+ <a href="#bytebase.v1.Instance.LabelsEntry"><span class="badge">M</span>Instance.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.Webhook"><span class="badge">M</span>Webhook</a>
+ <a href="#bytebase.v1.InstanceResource"><span class="badge">M</span>InstanceResource</a>
</li>
-
<li>
- <a href="#bytebase.v1.Activity.Type"><span class="badge">E</span>Activity.Type</a>
+ <a href="#bytebase.v1.KerberosConfig"><span class="badge">M</span>KerberosConfig</a>
</li>
<li>
- <a href="#bytebase.v1.Webhook.Type"><span class="badge">E</span>Webhook.Type</a>
+ <a href="#bytebase.v1.ListInstanceDatabaseRequest"><span class="badge">M</span>ListInstanceDatabaseRequest</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.ProjectService"><span class="badge">S</span>ProjectService</a>
+ <a href="#bytebase.v1.ListInstanceDatabaseResponse"><span class="badge">M</span>ListInstanceDatabaseResponse</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fsetting_service.proto">v1/setting_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.AISetting"><span class="badge">M</span>AISetting</a>
+ <a href="#bytebase.v1.ListInstancesRequest"><span class="badge">M</span>ListInstancesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm"><span class="badge">M</span>Algorithm</a>
+ <a href="#bytebase.v1.ListInstancesResponse"><span class="badge">M</span>ListInstancesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.FullMask"><span class="badge">M</span>Algorithm.FullMask</a>
+ <a href="#bytebase.v1.RemoveDataSourceRequest"><span class="badge">M</span>RemoveDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.InnerOuterMask"><span class="badge">M</span>Algorithm.InnerOuterMask</a>
+ <a href="#bytebase.v1.SASLConfig"><span class="badge">M</span>SASLConfig</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.MD5Mask"><span class="badge">M</span>Algorithm.MD5Mask</a>
+ <a href="#bytebase.v1.SyncInstanceRequest"><span class="badge">M</span>SyncInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.RangeMask"><span class="badge">M</span>Algorithm.RangeMask</a>
+ <a href="#bytebase.v1.SyncInstanceResponse"><span class="badge">M</span>SyncInstanceResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.RangeMask.Slice"><span class="badge">M</span>Algorithm.RangeMask.Slice</a>
+ <a href="#bytebase.v1.UndeleteInstanceRequest"><span class="badge">M</span>UndeleteInstanceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.Announcement"><span class="badge">M</span>Announcement</a>
+ <a href="#bytebase.v1.UpdateDataSourceRequest"><span class="badge">M</span>UpdateDataSourceRequest</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting"><span class="badge">M</span>AppIMSetting</a>
+ <a href="#bytebase.v1.UpdateInstanceRequest"><span class="badge">M</span>UpdateInstanceRequest</a>
</li>
+
<li>
- <a href="#bytebase.v1.AppIMSetting.DingTalk"><span class="badge">M</span>AppIMSetting.DingTalk</a>
+ <a href="#bytebase.v1.DataSource.AuthenticationType"><span class="badge">E</span>DataSource.AuthenticationType</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Feishu"><span class="badge">M</span>AppIMSetting.Feishu</a>
+ <a href="#bytebase.v1.DataSource.RedisType"><span class="badge">E</span>DataSource.RedisType</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.IMSetting"><span class="badge">M</span>AppIMSetting.IMSetting</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType"><span class="badge">E</span>DataSourceExternalSecret.AppRoleAuthOption.SecretType</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Lark"><span class="badge">M</span>AppIMSetting.Lark</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.AuthType"><span class="badge">E</span>DataSourceExternalSecret.AuthType</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Slack"><span class="badge">M</span>AppIMSetting.Slack</a>
+ <a href="#bytebase.v1.DataSourceExternalSecret.SecretType"><span class="badge">E</span>DataSourceExternalSecret.SecretType</a>
</li>
<li>
- <a href="#bytebase.v1.AppIMSetting.Wecom"><span class="badge">M</span>AppIMSetting.Wecom</a>
+ <a href="#bytebase.v1.DataSourceType"><span class="badge">E</span>DataSourceType</a>
</li>
+
+
<li>
- <a href="#bytebase.v1.DataClassificationSetting"><span class="badge">M</span>DataClassificationSetting</a>
+ <a href="#bytebase.v1.InstanceService"><span class="badge">S</span>InstanceService</a>
</li>
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#v1%2fdatabase_service.proto">v1/database_service.proto</a>
+ <ul>
+
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig</a>
+ <a href="#bytebase.v1.BatchGetDatabasesRequest"><span class="badge">M</span>BatchGetDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a>
+ <a href="#bytebase.v1.BatchGetDatabasesResponse"><span class="badge">M</span>BatchGetDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.DataClassification</a>
+ <a href="#bytebase.v1.BatchSyncDatabasesRequest"><span class="badge">M</span>BatchSyncDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level"><span class="badge">M</span>DataClassificationSetting.DataClassificationConfig.Level</a>
+ <a href="#bytebase.v1.BatchSyncDatabasesResponse"><span class="badge">M</span>BatchSyncDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.EnvironmentSetting"><span class="badge">M</span>EnvironmentSetting</a>
+ <a href="#bytebase.v1.BatchUpdateDatabasesRequest"><span class="badge">M</span>BatchUpdateDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.EnvironmentSetting.Environment"><span class="badge">M</span>EnvironmentSetting.Environment</a>
+ <a href="#bytebase.v1.BatchUpdateDatabasesResponse"><span class="badge">M</span>BatchUpdateDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry"><span class="badge">M</span>EnvironmentSetting.Environment.TagsEntry</a>
+ <a href="#bytebase.v1.BoundingBox"><span class="badge">M</span>BoundingBox</a>
</li>
<li>
- <a href="#bytebase.v1.GetSettingRequest"><span class="badge">M</span>GetSettingRequest</a>
+ <a href="#bytebase.v1.ChangedResourceDatabase"><span class="badge">M</span>ChangedResourceDatabase</a>
</li>
<li>
- <a href="#bytebase.v1.GetSettingResponse"><span class="badge">M</span>GetSettingResponse</a>
+ <a href="#bytebase.v1.ChangedResourceFunction"><span class="badge">M</span>ChangedResourceFunction</a>
</li>
<li>
- <a href="#bytebase.v1.ListSettingsRequest"><span class="badge">M</span>ListSettingsRequest</a>
+ <a href="#bytebase.v1.ChangedResourceProcedure"><span class="badge">M</span>ChangedResourceProcedure</a>
</li>
<li>
- <a href="#bytebase.v1.ListSettingsResponse"><span class="badge">M</span>ListSettingsResponse</a>
+ <a href="#bytebase.v1.ChangedResourceSchema"><span class="badge">M</span>ChangedResourceSchema</a>
</li>
<li>
- <a href="#bytebase.v1.PasswordRestrictionSetting"><span class="badge">M</span>PasswordRestrictionSetting</a>
+ <a href="#bytebase.v1.ChangedResourceTable"><span class="badge">M</span>ChangedResourceTable</a>
</li>
<li>
- <a href="#bytebase.v1.SCIMSetting"><span class="badge">M</span>SCIMSetting</a>
+ <a href="#bytebase.v1.ChangedResourceView"><span class="badge">M</span>ChangedResourceView</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaTemplateSetting"><span class="badge">M</span>SchemaTemplateSetting</a>
+ <a href="#bytebase.v1.ChangedResources"><span class="badge">M</span>ChangedResources</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaTemplateSetting.ColumnType"><span class="badge">M</span>SchemaTemplateSetting.ColumnType</a>
+ <a href="#bytebase.v1.Changelog"><span class="badge">M</span>Changelog</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaTemplateSetting.FieldTemplate"><span class="badge">M</span>SchemaTemplateSetting.FieldTemplate</a>
+ <a href="#bytebase.v1.CheckConstraintMetadata"><span class="badge">M</span>CheckConstraintMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.SchemaTemplateSetting.TableTemplate"><span class="badge">M</span>SchemaTemplateSetting.TableTemplate</a>
+ <a href="#bytebase.v1.ColumnMetadata"><span class="badge">M</span>ColumnMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.SemanticTypeSetting"><span class="badge">M</span>SemanticTypeSetting</a>
+ <a href="#bytebase.v1.Database"><span class="badge">M</span>Database</a>
</li>
<li>
- <a href="#bytebase.v1.SemanticTypeSetting.SemanticType"><span class="badge">M</span>SemanticTypeSetting.SemanticType</a>
+ <a href="#bytebase.v1.Database.LabelsEntry"><span class="badge">M</span>Database.LabelsEntry</a>
</li>
<li>
- <a href="#bytebase.v1.Setting"><span class="badge">M</span>Setting</a>
+ <a href="#bytebase.v1.DatabaseMetadata"><span class="badge">M</span>DatabaseMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateSettingRequest"><span class="badge">M</span>UpdateSettingRequest</a>
+ <a href="#bytebase.v1.DatabaseSDLSchema"><span class="badge">M</span>DatabaseSDLSchema</a>
</li>
<li>
- <a href="#bytebase.v1.Value"><span class="badge">M</span>Value</a>
+ <a href="#bytebase.v1.DatabaseSchema"><span class="badge">M</span>DatabaseSchema</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting"><span class="badge">M</span>WorkspaceApprovalSetting</a>
+ <a href="#bytebase.v1.DependencyColumn"><span class="badge">M</span>DependencyColumn</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule"><span class="badge">M</span>WorkspaceApprovalSetting.Rule</a>
+ <a href="#bytebase.v1.DependencyTable"><span class="badge">M</span>DependencyTable</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceProfileSetting"><span class="badge">M</span>WorkspaceProfileSetting</a>
+ <a href="#bytebase.v1.DiffSchemaRequest"><span class="badge">M</span>DiffSchemaRequest</a>
</li>
-
<li>
- <a href="#bytebase.v1.AISetting.Provider"><span class="badge">E</span>AISetting.Provider</a>
+ <a href="#bytebase.v1.DiffSchemaResponse"><span class="badge">M</span>DiffSchemaResponse</a>
</li>
<li>
- <a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType"><span class="badge">E</span>Algorithm.InnerOuterMask.MaskType</a>
+ <a href="#bytebase.v1.DimensionConstraint"><span class="badge">M</span>DimensionConstraint</a>
</li>
<li>
- <a href="#bytebase.v1.Announcement.AlertLevel"><span class="badge">E</span>Announcement.AlertLevel</a>
+ <a href="#bytebase.v1.DimensionalConfig"><span class="badge">M</span>DimensionalConfig</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseChangeMode"><span class="badge">E</span>DatabaseChangeMode</a>
+ <a href="#bytebase.v1.EnumTypeMetadata"><span class="badge">M</span>EnumTypeMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.Setting.SettingName"><span class="badge">E</span>Setting.SettingName</a>
+ <a href="#bytebase.v1.EventMetadata"><span class="badge">M</span>EventMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source"><span class="badge">E</span>WorkspaceApprovalSetting.Rule.Source</a>
+ <a href="#bytebase.v1.ExtensionMetadata"><span class="badge">M</span>ExtensionMetadata</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.SettingService"><span class="badge">S</span>SettingService</a>
+ <a href="#bytebase.v1.ExternalTableMetadata"><span class="badge">M</span>ExternalTableMetadata</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fuser_service.proto">v1/user_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.BatchGetUsersRequest"><span class="badge">M</span>BatchGetUsersRequest</a>
+ <a href="#bytebase.v1.ForeignKeyMetadata"><span class="badge">M</span>ForeignKeyMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.BatchGetUsersResponse"><span class="badge">M</span>BatchGetUsersResponse</a>
+ <a href="#bytebase.v1.FunctionMetadata"><span class="badge">M</span>FunctionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.CreateUserRequest"><span class="badge">M</span>CreateUserRequest</a>
+ <a href="#bytebase.v1.GenerationMetadata"><span class="badge">M</span>GenerationMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteUserRequest"><span class="badge">M</span>DeleteUserRequest</a>
+ <a href="#bytebase.v1.GetChangelogRequest"><span class="badge">M</span>GetChangelogRequest</a>
</li>
<li>
- <a href="#bytebase.v1.GetUserRequest"><span class="badge">M</span>GetUserRequest</a>
+ <a href="#bytebase.v1.GetDatabaseMetadataRequest"><span class="badge">M</span>GetDatabaseMetadataRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListUsersRequest"><span class="badge">M</span>ListUsersRequest</a>
+ <a href="#bytebase.v1.GetDatabaseRequest"><span class="badge">M</span>GetDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ListUsersResponse"><span class="badge">M</span>ListUsersResponse</a>
+ <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest"><span class="badge">M</span>GetDatabaseSDLSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UndeleteUserRequest"><span class="badge">M</span>UndeleteUserRequest</a>
+ <a href="#bytebase.v1.GetDatabaseSchemaRequest"><span class="badge">M</span>GetDatabaseSchemaRequest</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateUserRequest"><span class="badge">M</span>UpdateUserRequest</a>
+ <a href="#bytebase.v1.GetSchemaStringRequest"><span class="badge">M</span>GetSchemaStringRequest</a>
</li>
<li>
- <a href="#bytebase.v1.User"><span class="badge">M</span>User</a>
+ <a href="#bytebase.v1.GetSchemaStringResponse"><span class="badge">M</span>GetSchemaStringResponse</a>
</li>
<li>
- <a href="#bytebase.v1.User.Profile"><span class="badge">M</span>User.Profile</a>
+ <a href="#bytebase.v1.GridLevel"><span class="badge">M</span>GridLevel</a>
</li>
-
<li>
- <a href="#bytebase.v1.UserType"><span class="badge">E</span>UserType</a>
+ <a href="#bytebase.v1.IndexMetadata"><span class="badge">M</span>IndexMetadata</a>
</li>
-
-
<li>
- <a href="#bytebase.v1.UserService"><span class="badge">S</span>UserService</a>
+ <a href="#bytebase.v1.ListChangelogsRequest"><span class="badge">M</span>ListChangelogsRequest</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.ListChangelogsResponse"><span class="badge">M</span>ListChangelogsResponse</a>
</li>
<li>
- <a href="#bytebase.v1.ActuatorInfo.StatUser"><span class="badge">M</span>ActuatorInfo.StatUser</a>
+ <a href="#bytebase.v1.ListDatabasesRequest"><span class="badge">M</span>ListDatabasesRequest</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteCacheRequest"><span class="badge">M</span>DeleteCacheRequest</a>
+ <a href="#bytebase.v1.ListDatabasesResponse"><span class="badge">M</span>ListDatabasesResponse</a>
</li>
<li>
- <a href="#bytebase.v1.GetActuatorInfoRequest"><span class="badge">M</span>GetActuatorInfoRequest</a>
+ <a href="#bytebase.v1.MaterializedViewMetadata"><span class="badge">M</span>MaterializedViewMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.GetResourcePackageRequest"><span class="badge">M</span>GetResourcePackageRequest</a>
+ <a href="#bytebase.v1.PackageMetadata"><span class="badge">M</span>PackageMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ResourcePackage"><span class="badge">M</span>ResourcePackage</a>
+ <a href="#bytebase.v1.ProcedureMetadata"><span class="badge">M</span>ProcedureMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.SetupSampleRequest"><span class="badge">M</span>SetupSampleRequest</a>
+ <a href="#bytebase.v1.SchemaMetadata"><span class="badge">M</span>SchemaMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateActuatorInfoRequest"><span class="badge">M</span>UpdateActuatorInfoRequest</a>
+ <a href="#bytebase.v1.SequenceMetadata"><span class="badge">M</span>SequenceMetadata</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.ActuatorService"><span class="badge">S</span>ActuatorService</a>
+ <a href="#bytebase.v1.SpatialIndexConfig"><span class="badge">M</span>SpatialIndexConfig</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2faudit_log_service.proto">v1/audit_log_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.AuditData"><span class="badge">M</span>AuditData</a>
+ <a href="#bytebase.v1.StorageConfig"><span class="badge">M</span>StorageConfig</a>
</li>
<li>
- <a href="#bytebase.v1.AuditLog"><span class="badge">M</span>AuditLog</a>
+ <a href="#bytebase.v1.StreamMetadata"><span class="badge">M</span>StreamMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.ExportAuditLogsRequest"><span class="badge">M</span>ExportAuditLogsRequest</a>
+ <a href="#bytebase.v1.SyncDatabaseRequest"><span class="badge">M</span>SyncDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.ExportAuditLogsResponse"><span class="badge">M</span>ExportAuditLogsResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.RequestMetadata"><span class="badge">M</span>RequestMetadata</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.SearchAuditLogsRequest"><span class="badge">M</span>SearchAuditLogsRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.SearchAuditLogsResponse"><span class="badge">M</span>SearchAuditLogsResponse</a>
- </li>
-
-
- <li>
- <a href="#bytebase.v1.AuditLog.Severity"><span class="badge">E</span>AuditLog.Severity</a>
- </li>
-
-
-
- <li>
- <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.IdentityProviderContext"><span class="badge">M</span>IdentityProviderContext</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.LoginRequest"><span class="badge">M</span>LoginRequest</a>
+ <a href="#bytebase.v1.SyncDatabaseResponse"><span class="badge">M</span>SyncDatabaseResponse</a>
</li>
<li>
- <a href="#bytebase.v1.LoginResponse"><span class="badge">M</span>LoginResponse</a>
+ <a href="#bytebase.v1.TableMetadata"><span class="badge">M</span>TableMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.LogoutRequest"><span class="badge">M</span>LogoutRequest</a>
+ <a href="#bytebase.v1.TablePartitionMetadata"><span class="badge">M</span>TablePartitionMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.OAuth2IdentityProviderContext"><span class="badge">M</span>OAuth2IdentityProviderContext</a>
+ <a href="#bytebase.v1.TaskMetadata"><span class="badge">M</span>TaskMetadata</a>
</li>
<li>
- <a href="#bytebase.v1.OIDCIdentityProviderContext"><span class="badge">M</span>OIDCIdentityProviderContext</a>
+ <a href="#bytebase.v1.TessellationConfig"><span class="badge">M</span>TessellationConfig</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.AuthService"><span class="badge">S</span>AuthService</a>
+ <a href="#bytebase.v1.TriggerMetadata"><span class="badge">M</span>TriggerMetadata</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.UpdateDatabaseRequest"><span class="badge">M</span>UpdateDatabaseRequest</a>
</li>
<li>
- <a href="#bytebase.v1.BatchDeparseResponse"><span class="badge">M</span>BatchDeparseResponse</a>
+ <a href="#bytebase.v1.ViewMetadata"><span class="badge">M</span>ViewMetadata</a>
</li>
- <li>
- <a href="#bytebase.v1.BatchParseRequest"><span class="badge">M</span>BatchParseRequest</a>
- </li>
<li>
- <a href="#bytebase.v1.BatchParseResponse"><span class="badge">M</span>BatchParseResponse</a>
+ <a href="#bytebase.v1.Changelog.Status"><span class="badge">E</span>Changelog.Status</a>
</li>
-
-
-
<li>
- <a href="#bytebase.v1.CelService"><span class="badge">S</span>CelService</a>
+ <a href="#bytebase.v1.Changelog.Type"><span class="badge">E</span>Changelog.Type</a>
</li>
- </ul>
- </li>
-
-
- <li>
- <a href="#v1%2fdatabase_group_service.proto">v1/database_group_service.proto</a>
- <ul>
-
<li>
- <a href="#bytebase.v1.CreateDatabaseGroupRequest"><span class="badge">M</span>CreateDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.ChangelogView"><span class="badge">E</span>ChangelogView</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroup"><span class="badge">M</span>DatabaseGroup</a>
+ <a href="#bytebase.v1.ColumnMetadata.IdentityGeneration"><span class="badge">E</span>ColumnMetadata.IdentityGeneration</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroup.Database"><span class="badge">M</span>DatabaseGroup.Database</a>
+ <a href="#bytebase.v1.GenerationMetadata.Type"><span class="badge">E</span>GenerationMetadata.Type</a>
</li>
<li>
- <a href="#bytebase.v1.DeleteDatabaseGroupRequest"><span class="badge">M</span>DeleteDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat"><span class="badge">E</span>GetDatabaseSDLSchemaRequest.SDLFormat</a>
</li>
<li>
- <a href="#bytebase.v1.GetDatabaseGroupRequest"><span class="badge">M</span>GetDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.GetSchemaStringRequest.ObjectType"><span class="badge">E</span>GetSchemaStringRequest.ObjectType</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabaseGroupsRequest"><span class="badge">M</span>ListDatabaseGroupsRequest</a>
+ <a href="#bytebase.v1.StreamMetadata.Mode"><span class="badge">E</span>StreamMetadata.Mode</a>
</li>
<li>
- <a href="#bytebase.v1.ListDatabaseGroupsResponse"><span class="badge">M</span>ListDatabaseGroupsResponse</a>
+ <a href="#bytebase.v1.StreamMetadata.Type"><span class="badge">E</span>StreamMetadata.Type</a>
</li>
<li>
- <a href="#bytebase.v1.UpdateDatabaseGroupRequest"><span class="badge">M</span>UpdateDatabaseGroupRequest</a>
+ <a href="#bytebase.v1.TablePartitionMetadata.Type"><span class="badge">E</span>TablePartitionMetadata.Type</a>
</li>
-
<li>
- <a href="#bytebase.v1.DatabaseGroupView"><span class="badge">E</span>DatabaseGroupView</a>
+ <a href="#bytebase.v1.TaskMetadata.State"><span class="badge">E</span>TaskMetadata.State</a>
</li>
<li>
- <a href="#bytebase.v1.DatabaseGroupService"><span class="badge">S</span>DatabaseGroupService</a>
+ <a href="#bytebase.v1.DatabaseService"><span class="badge">S</span>DatabaseService</a>
</li>
</ul>
@@ -3330,13 +3314,13 @@ Examples:
<div class="file-heading">
- <h2 id="v1/database_catalog_service.proto">v1/database_catalog_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.ColumnCatalog">ColumnCatalog</h3>
- <p>Column metadata within a table.</p>
+ <h3 id="bytebase.v1.ApprovalFlow">ApprovalFlow</h3>
+ <p></p>
<table class="field-table">
@@ -3346,38 +3330,10 @@ Examples:
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The column name. </p></td>
- </tr>
-
- <tr>
- <td>semantic_type</td>
+ <td>roles</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The semantic type describing the data purpose. </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>
- </tr>
-
- <tr>
- <td>classification</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The data classification level for this column. </p></td>
- </tr>
-
- <tr>
- <td>object_schema</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
- <td>optional</td>
- <td><p>Object schema for complex column types like JSON. </p></td>
+ <td><p>The roles required for approval in order. </p></td>
</tr>
</tbody>
@@ -3387,7 +3343,7 @@ Examples:
- <h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3>
+ <h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3>
<p></p>
@@ -3398,17 +3354,24 @@ Examples:
<tbody>
<tr>
- <td>key</td>
+ <td>flow</td>
+ <td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td>
+ <td></td>
+ <td><p>The approval flow definition. </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The title of the approval template. </p></td>
</tr>
<tr>
- <td>value</td>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The description of the approval template. </p></td>
</tr>
</tbody>
@@ -3418,8 +3381,8 @@ Examples:
- <h3 id="bytebase.v1.DatabaseCatalog">DatabaseCatalog</h3>
- <p>Catalog metadata for a database including schemas, tables, and columns.</p>
+ <h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -3432,15 +3395,15 @@ Examples:
<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>
+ <td><p>The name of the issue to add an approver.
+Format: projects/{project}/issues/{issue} </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>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment explaining the approval decision. </p></td>
</tr>
</tbody>
@@ -3450,8 +3413,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.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</h3>
+ <p></p>
<table class="field-table">
@@ -3461,11 +3424,35 @@ Format: instances/{instance}/databases/{database}/catalog </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 catalog to retrieve.
-Format: instances/{instance}/databases/{database}/catalog </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>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><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The reason for the status change. </p></td>
</tr>
</tbody>
@@ -3475,8 +3462,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.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3>
+ <p></p>
<table class="field-table">
@@ -3486,31 +3480,18 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</a></td>
- <td></td>
- <td><p>The data type of this object. </p></td>
- </tr>
-
- <tr>
- <td>struct_kind</td>
- <td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td>
- <td></td>
- <td><p>Struct schema. </p></td>
- </tr>
-
- <tr>
- <td>array_kind</td>
- <td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Array schema. </p></td>
+ <td><p>The issue name
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>semantic_type</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>The semantic type of this object. </p></td>
+ <td><p>The comment to create. </p></td>
</tr>
</tbody>
@@ -3520,8 +3501,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>
- <p>Array type with element schema.</p>
+ <h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -3531,10 +3512,18 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>kind</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema of array elements. </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>
@@ -3544,8 +3533,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.GetIssueRequest">GetIssueRequest</h3>
+ <p></p>
<table class="field-table">
@@ -3555,10 +3544,18 @@ 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>repeated</td>
- <td><p>Properties of the struct. </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the issue to retrieve.
+Format: projects/{project}/issues/{issue} </p></td>
+ </tr>
+
+ <tr>
+ <td>force</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>
</tr>
</tbody>
@@ -3568,7 +3565,7 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3>
+ <h3 id="bytebase.v1.GrantRequest">GrantRequest</h3>
<p></p>
@@ -3579,17 +3576,33 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>key</td>
+ <td>role</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The requested role.
+Format: roles/EXPORTER. </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>user</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The user to be granted.
+Format: users/{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 for the role. Same as the condition in IAM Binding message. </p></td>
+ </tr>
+
+ <tr>
+ <td>expiration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The duration for which the grant is valid. </p></td>
</tr>
</tbody>
@@ -3599,8 +3612,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.Issue">Issue</h3>
+ <p></p>
<table class="field-table">
@@ -3613,59 +3626,152 @@ 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 name of the issue.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The title of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The description of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
+ <td></td>
+ <td><p>The status of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>approvers</td>
+ <td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td>
<td>repeated</td>
- <td><p>The tables in the schema. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>
- <p>Table metadata within a schema.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>approval_template</td>
+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
+ <td></td>
+ <td><p>The approval template for the issue. </p></td>
+ </tr>
<tr>
- <td>name</td>
+ <td>creator</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The table name. </p></td>
+ <td><p>Format: users/[email protected] </p></td>
</tr>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</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>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>Object schema for JSON/XML columns. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>classification</td>
+ <td>plan</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The data classification level for this table. </p></td>
+ <td><p>The plan associated with the issue.
+Can be empty.
+Format: projects/{project}/plans/{plan} </p></td>
+ </tr>
+
+ <tr>
+ <td>rollout</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The rollout associated with the issue.
+Can be empty.
+Format: projects/{project}/rollouts/{rollout} </p></td>
+ </tr>
+
+ <tr>
+ <td>grant_request</td>
+ <td><a href="#bytebase.v1.GrantRequest">GrantRequest</a></td>
+ <td></td>
+ <td><p>Used if the issue type is GRANT_REQUEST. </p></td>
+ </tr>
+
+ <tr>
+ <td>releasers</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The releasers of the pending stage of the issue rollout, judging
+from the rollout policy.
+Format:
+- roles/workspaceOwner
+- roles/workspaceDBA
+- roles/projectOwner
+- roles/projectReleaser </p></td>
+ </tr>
+
+ <tr>
+ <td>risk_level</td>
+ <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
+ <td></td>
+ <td><p>The risk level of the issue. </p></td>
+ </tr>
+
+ <tr>
+ <td>task_status_count</td>
+ <td><a href="#bytebase.v1.Issue.TaskStatusCountEntry">Issue.TaskStatusCountEntry</a></td>
+ <td>repeated</td>
+ <td><p>The status count of the issue.
+Keys are the following:
+- NOT_STARTED
+- SKIPPED
+- PENDING
+- RUNNING
+- DONE
+- FAILED
+- CANCELED </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>
+ </tr>
+
+ <tr>
+ <td>approval_status</td>
+ <td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>approval_status_error</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Only populated when approval_status == ERROR </p></td>
</tr>
</tbody>
@@ -3675,8 +3781,8 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
- <h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>
- <p>Column list for regular tables.</p>
+ <h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>
+ <p>Approvers and their approval status for the issue.</p>
<table class="field-table">
@@ -3686,10 +3792,17 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>columns</td>
- <td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td>
- <td>repeated</td>
- <td><p>The columns in the table. </p></td>
+ <td>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>
@@ -3699,8 +3812,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.Issue.TaskStatusCountEntry">Issue.TaskStatusCountEntry</h3>
+ <p></p>
<table class="field-table">
@@ -3710,21 +3823,17 @@ Format: instances/{instance}/databases/{database}/catalog </p></td>
<tbody>
<tr>
- <td>catalog</td>
- <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The database catalog to update.
-
-The catalog&#39;s `name` field is used to identify the database catalog to update.
-Format: instances/{instance}/databases/{database}/catalog </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>value</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>If set to true, and the database catalog is not found, a new database catalog will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -3734,135 +3843,102 @@ 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.IssueComment">IssueComment</h3>
+ <p>A comment on an issue.</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>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td>
+ </tr>
- <tr>
- <td>GetDatabaseCatalog</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/catalog}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The text content of the comment. </p></td>
+ </tr>
-
+ <tr>
+ <td>payload</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>TODO: use struct message instead. </p></td>
+ </tr>
+ <tr>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>UpdateDatabaseCatalog</td>
- <td>PATCH</td>
- <td>/v1/{catalog.name=instances/*/databases/*/catalog}</td>
- <td>catalog</td>
- </tr>
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>creator</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: users/{email} </p></td>
+ </tr>
+
+ <tr>
+ <td>approval</td>
+ <td><a href="#bytebase.v1.IssueComment.Approval">IssueComment.Approval</a></td>
+ <td></td>
+ <td><p>Approval event. </p></td>
+ </tr>
+
+ <tr>
+ <td>issue_update</td>
+ <td><a href="#bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</a></td>
+ <td></td>
+ <td><p>Issue update event. </p></td>
+ </tr>
+
+ <tr>
+ <td>stage_end</td>
+ <td><a href="#bytebase.v1.IssueComment.StageEnd">IssueComment.StageEnd</a></td>
+ <td></td>
+ <td><p>Stage end event. </p></td>
+ </tr>
+
+ <tr>
+ <td>task_update</td>
+ <td><a href="#bytebase.v1.IssueComment.TaskUpdate">IssueComment.TaskUpdate</a></td>
+ <td></td>
+ <td><p>Task update event. </p></td>
+ </tr>
+
+ <tr>
+ <td>task_prior_backup</td>
+ <td><a href="#bytebase.v1.IssueComment.TaskPriorBackup">IssueComment.TaskPriorBackup</a></td>
+ <td></td>
+ <td><p>Task prior backup event. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.GetInstanceRoleRequest">GetInstanceRoleRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>
+ <p>Approval event information.</p>
<table class="field-table">
@@ -3872,12 +3948,10 @@ Permissions required: bb.databaseCatalogs.update</p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td>
<td></td>
- <td><p>The name of the role to retrieve.
-Format: instances/{instance}/roles/{role name}
-The role name is the unique name for the role. </p></td>
+ <td><p>The approval status. </p></td>
</tr>
</tbody>
@@ -3887,8 +3961,8 @@ The role name is the unique name for the role. </p></td>
- <h3 id="bytebase.v1.InstanceRole">InstanceRole</h3>
- <p>InstanceRole is the API message for instance role.</p>
+ <h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>
+ <p>Issue update event information.</p>
<table class="field-table">
@@ -3898,49 +3972,59 @@ The role name is the unique name for the role. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>from_title</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the role.
-Format: instances/{instance}/roles/{role}
-The role name is the unique name for the role. </p></td>
+ <td>optional</td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>role_name</td>
+ <td>to_title</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The role name. It&#39;s unique within the instance. </p></td>
+ <td>optional</td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>from_description</td>
<td><a href="#string">string</a></td>
<td>optional</td>
- <td><p>The role password. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>connection_limit</td>
- <td><a href="#int32">int32</a></td>
+ <td>to_description</td>
+ <td><a href="#string">string</a></td>
<td>optional</td>
- <td><p>The connection count limit for this role. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>valid_until</td>
- <td><a href="#string">string</a></td>
+ <td>from_status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
<td>optional</td>
- <td><p>The expiration for the role&#39;s password. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>attribute</td>
- <td><a href="#string">string</a></td>
+ <td>to_status</td>
+ <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
<td>optional</td>
- <td><p>The role attribute.
-For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html
-For MySQL, it&#39;s the global privileges as GRANT statements, which means it only contains &#34;GRANT ... ON *.* TO ...&#34;. Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>from_labels</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>to_labels</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -3950,8 +4034,8 @@ For MySQL, it&#39;s the global privileges as GRANT statements, which means it on
- <h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IssueComment.StageEnd">IssueComment.StageEnd</h3>
+ <p>Stage end event information.</p>
<table class="field-table">
@@ -3961,41 +4045,62 @@ For MySQL, it&#39;s the global privileges as GRANT statements, which means it on
<tbody>
<tr>
- <td>parent</td>
+ <td>stage</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>
+ <td><p>The stage that ended. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.IssueComment.TaskPriorBackup">IssueComment.TaskPriorBackup</h3>
+ <p>Task prior backup 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>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>task</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Not used.
-The maximum number of roles to return. The service may return fewer than
-this value.
-If unspecified, at most 10 roles will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The task for which backup was performed. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>tables</td>
+ <td><a href="#bytebase.v1.IssueComment.TaskPriorBackup.Table">IssueComment.TaskPriorBackup.Table</a></td>
+ <td>repeated</td>
+ <td><p>The tables that were backed up. </p></td>
+ </tr>
+
+ <tr>
+ <td>original_line</td>
+ <td><a href="#int32">int32</a></td>
+ <td>optional</td>
+ <td><p>The original line number in the statement. </p></td>
+ </tr>
+
+ <tr>
+ <td>database</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Not used.
-A page token, received from a previous `ListInstanceRoles` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListInstanceRoles` must match
-the call that provided the page token. </p></td>
+ <td><p>The database that was backed up. </p></td>
</tr>
<tr>
- <td>refresh</td>
- <td><a href="#bool">bool</a></td>
+ <td>error</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Refresh will refresh and return the latest data. </p></td>
+ <td><p>Error message if backup failed. </p></td>
</tr>
</tbody>
@@ -4005,8 +4110,8 @@ the call that provided the page token. </p></td>
- <h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.IssueComment.TaskPriorBackup.Table">IssueComment.TaskPriorBackup.Table</h3>
+ <p>Table identification.</p>
<table class="field-table">
@@ -4016,18 +4121,17 @@ 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>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema name. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>table</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 table name. </p></td>
</tr>
</tbody>
@@ -4037,87 +4141,52 @@ 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>GetInstanceRole</td>
- <td><a href="#bytebase.v1.GetInstanceRoleRequest">GetInstanceRoleRequest</a></td>
- <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
- <td><p>Gets a database role from an instance.
-Permissions required: bb.instanceRoles.get</p></td>
- </tr>
-
- <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.IssueComment.TaskUpdate">IssueComment.TaskUpdate</h3>
+ <p>Task update event information.</p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
- <tr>
- <td>GetInstanceRole</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/roles/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>tasks</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The tasks that were updated. </p></td>
+ </tr>
-
+ <tr>
+ <td>from_sheet</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>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>Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
- <tr>
- <td>ListInstanceRoles</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/roles</td>
- <td></td>
- </tr>
+ <tr>
+ <td>to_status</td>
+ <td><a href="#bytebase.v1.IssueComment.TaskUpdate.Status">IssueComment.TaskUpdate.Status</a></td>
+ <td>optional</td>
+ <td><p> </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3>
+ <h3 id="bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</h3>
<p></p>
@@ -4128,26 +4197,31 @@ Permissions required: bb.instanceRoles.list</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 instance to add a data source to.
-Format: instances/{instance} </p></td>
+ <td><p>Format: projects/{projects}/issues/{issue} </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Identified by data source ID.
-Only READ_ONLY data source can be added. </p></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>validate_only</td>
- <td><a href="#bool">bool</a></td>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Validate only also tests the data source connection. </p></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>
@@ -4157,7 +4231,7 @@ Only READ_ONLY data source can be added. </p></td>
- <h3 id="bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</h3>
+ <h3 id="bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</h3>
<p></p>
@@ -4168,42 +4242,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>issue_comments</td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</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 issue comments from the specified request. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>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>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>
@@ -4213,7 +4263,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.ListIssuesRequest">ListIssuesRequest</h3>
<p></p>
@@ -4224,20 +4274,77 @@ 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>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>
- </tbody>
+ <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.
+- task_type: support &#34;==&#34; operator, the value can be &#34;DDL&#34;, &#34;DML&#34; or &#34;DATA_EXPORT&#34;
+- instance: the instance full name in the &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
+- database: the database full name in the &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator.
+- environment: the database full name in the &#34;environments/{name}&#34; format, support &#34;==&#34; operator.
+- 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;
+instance == &#34;instances/sample&#34; &amp;&amp; labels in [&#34;label1&#34;, &#34;label2&#34;]
+create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
+environment == &#34;environments/test&#34; </p></td>
+ </tr>
+
+ <tr>
+ <td>query</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Query is the query statement. </p></td>
+ </tr>
+
+ </tbody>
</table>
- <h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3>
+ <h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3>
<p></p>
@@ -4248,28 +4355,18 @@ 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></td>
- <td><p>The instance to create. </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>instance_id</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The ID to use for the instance, which will become the final component of
-the instance&#39;s resource name.
-
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
- </tr>
-
- <tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <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>
@@ -4279,7 +4376,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DataSource">DataSource</h3>
+ <h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3>
<p></p>
@@ -4290,287 +4387,191 @@ 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 issue to add a rejection.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of data source (ADMIN or READ_ONLY). </p></td>
+ <td><p>The 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>username</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The username for database authentication. </p></td>
+ <td><p>The name of the issue to request a issue.
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>password</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The password for database authentication. </p></td>
+ <td><p>The comment explaining the request. </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>
+ </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>ssl_ca</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SSL certificate authority certificate. </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>ssl_cert</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The SSL client certificate. </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>ssl_key</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The SSL client private key. </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>verify_tls_certificate</td>
- <td><a href="#bool">bool</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>verify_tls_certificate enables TLS certificate verification for SSL connections.
-Default is false (no verification) for backward compatibility.
-Set to true for secure connections (recommended for production).
-Only set to false for development or when certificates cannot be properly
-validated (e.g., self-signed certs, VPN environments). </p></td>
+ <td><p>Filter is used to filter issues returned in the list.
+Check the filter field in the ListIssuesRequest message. </p></td>
</tr>
<tr>
- <td>host</td>
+ <td>query</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The hostname or IP address of the database server. </p></td>
+ <td><p>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>port</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The port number of the database server. </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>database</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to connect to. </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>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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>authentication_database</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td>
+ <td><p>The issue name
+Format: projects/{project}/issues/{issue} </p></td>
</tr>
<tr>
- <td>replica_set</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>replica_set is used for MongoDB replica set. </p></td>
+ <td><p>The comment to update. </p></td>
</tr>
<tr>
- <td>sid</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>sid and service_name are used for Oracle. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>service_name</td>
- <td><a href="#string">string</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</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>
- </tr>
-
- <tr>
- <td>ssh_port</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>
- </tr>
-
- <tr>
- <td>ssh_user</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The user to login the server.
-Required. </p></td>
- </tr>
-
- <tr>
- <td>ssh_password</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The password to login the server. If it&#39;s empty string, no password is required. </p></td>
- </tr>
-
- <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>authentication_private_key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required.
-Used for authentication when connecting to the data source. </p></td>
- </tr>
-
- <tr>
- <td>external_secret</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>authentication_type</td>
- <td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>azure_credential</td>
- <td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>aws_credential</td>
- <td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>gcp_credential</td>
- <td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sasl_config</td>
- <td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>additional_addresses</td>
- <td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td>
- <td>repeated</td>
- <td><p>additional_addresses is used for MongoDB replica set. </p></td>
- </tr>
-
- <tr>
- <td>direct_connection</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td>
- </tr>
-
- <tr>
- <td>region</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>region is the location of where the DB is, works for AWS RDS. For example, us-east-1. </p></td>
- </tr>
-
- <tr>
- <td>warehouse_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>warehouse_id is used by Databricks. </p></td>
- </tr>
-
- <tr>
- <td>master_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>master_name is the master name used by connecting redis-master via redis sentinel. </p></td>
- </tr>
-
- <tr>
- <td>master_username</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>master_username and master_password are master credentials used by redis sentinel mode. </p></td>
- </tr>
-
- <tr>
- <td>master_password</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>redis_type</td>
- <td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>cluster</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </p></td>
- </tr>
-
- <tr>
- <td>extra_connection_parameters</td>
- <td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>
- <td>repeated</td>
- <td><p>Extra connection parameters for the database connection.
-For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p></td>
+ <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>
@@ -4580,7 +4581,7 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><
- <h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3>
+ <h3 id="bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</h3>
<p></p>
@@ -4591,40 +4592,28 @@ For PostgreSQL HA, this can be used to set target_session_attrs=read-write </p><
<tbody>
<tr>
- <td>access_key_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>secret_access_key</td>
- <td><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>issue</td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
<td></td>
- <td><p> </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>role_arn</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>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>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>external_id</td>
- <td><a href="#string">string</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</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>
+ <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>
@@ -4634,575 +4623,514 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e
- <h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>host</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>port</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>tenant_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>client_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>client_secret</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.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>
+
+ <tr>
+ <td>ERROR</td>
+ <td>6</td>
+ <td><p>Error occurred during approval evaluation.</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></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.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.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><a href="#string">string</a></td>
- <td></td>
- <td><p> </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.IssueComment.TaskUpdate.Status">IssueComment.TaskUpdate.Status</h3>
+ <p>Task 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>Task is pending.</p></td>
+ </tr>
+
+ <tr>
+ <td>RUNNING</td>
+ <td>2</td>
+ <td><p>Task is running.</p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>3</td>
+ <td><p>Task is done.</p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>4</td>
+ <td><p>Task failed.</p></td>
+ </tr>
+
+ <tr>
+ <td>SKIPPED</td>
+ <td>5</td>
+ <td><p>Task was skipped.</p></td>
+ </tr>
+
+ <tr>
+ <td>CANCELED</td>
+ <td>6</td>
+ <td><p>Task was canceled.</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.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></td>
- <td><p>The type of external secret store. </p></td>
- </tr>
-
- <tr>
- <td>url</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The URL of the external secret store. </p></td>
- </tr>
-
- <tr>
- <td>auth_type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td>
- <td></td>
- <td><p>The authentication method for accessing the secret store. </p></td>
- </tr>
-
- <tr>
- <td>app_role</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td>
- <td></td>
- <td><p>AppRole authentication configuration. </p></td>
- </tr>
-
- <tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Token for direct authentication. </p></td>
- </tr>
-
- <tr>
- <td>engine_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>engine name is the name for secret engine. </p></td>
- </tr>
-
- <tr>
- <td>secret_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the secret name in the engine to store the password. </p></td>
- </tr>
-
- <tr>
- <td>password_key_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the key name for the password. </p></td>
- </tr>
-
- <tr>
- <td>skip_vault_tls_verification</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>TLS configuration for connecting to Vault server.
-These fields are separate from the database TLS configuration in DataSource.
-skip_vault_tls_verification disables TLS certificate verification for Vault connections.
-Default is false (verification enabled) for security.
-Only set to true for development or when certificates cannot be properly validated. </p></td>
- </tr>
-
- <tr>
- <td>vault_ssl_ca</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>CA certificate for Vault server verification. </p></td>
- </tr>
-
- <tr>
- <td>vault_ssl_cert</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Client certificate for mutual TLS authentication with Vault. </p></td>
- </tr>
-
- <tr>
- <td>vault_ssl_key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Client private key for mutual TLS authentication with Vault. </p></td>
- </tr>
-
- </tbody>
- </table>
-
+
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3>
- <p></p>
+ <h3 id="bytebase.v1.IssueService">IssueService</h3>
+ <p>IssueService manages issues for tracking database changes and tasks.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetIssue</td>
+ <td><a href="#bytebase.v1.GetIssueRequest">GetIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Retrieves an issue by name.
+Permissions required: bb.issues.get</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIssue</td>
+ <td><a href="#bytebase.v1.CreateIssueRequest">CreateIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Creates a new issue for database changes or tasks.
+Permissions required: bb.issues.create</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIssues</td>
+ <td><a href="#bytebase.v1.ListIssuesRequest">ListIssuesRequest</a></td>
+ <td><a href="#bytebase.v1.ListIssuesResponse">ListIssuesResponse</a></td>
+ <td><p>Lists issues in a project.
+Permissions required: bb.issues.list</p></td>
+ </tr>
+
+ <tr>
+ <td>SearchIssues</td>
+ <td><a href="#bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</a></td>
+ <td><a href="#bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</a></td>
+ <td><p>Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter &amp; query.
+Permissions required: bb.issues.get</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIssue</td>
+ <td><a href="#bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Updates an issue&#39;s properties such as title, description, or labels.
+Permissions required: bb.issues.update</p></td>
+ </tr>
+
+ <tr>
+ <td>ListIssueComments</td>
+ <td><a href="#bytebase.v1.ListIssueCommentsRequest">ListIssueCommentsRequest</a></td>
+ <td><a href="#bytebase.v1.ListIssueCommentsResponse">ListIssueCommentsResponse</a></td>
+ <td><p>Lists comments on an issue.
+Permissions required: bb.issueComments.list</p></td>
+ </tr>
+
+ <tr>
+ <td>CreateIssueComment</td>
+ <td><a href="#bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</a></td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td><p>Adds a comment to an issue.
+Permissions required: bb.issueComments.create</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateIssueComment</td>
+ <td><a href="#bytebase.v1.UpdateIssueCommentRequest">UpdateIssueCommentRequest</a></td>
+ <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
+ <td><p>Updates an existing issue comment.
+Permissions required: bb.issueComments.update</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchUpdateIssuesStatus</td>
+ <td><a href="#bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</a></td>
+ <td><p>Updates the status of multiple issues in a single operation.
+Permissions required: bb.issues.update</p></td>
+ </tr>
+
+ <tr>
+ <td>ApproveIssue</td>
+ <td><a href="#bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ <tr>
+ <td>RejectIssue</td>
+ <td><a href="#bytebase.v1.RejectIssueRequest">RejectIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ <tr>
+ <td>RequestIssue</td>
+ <td><a href="#bytebase.v1.RequestIssueRequest">RequestIssueRequest</a></td>
+ <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td><p>Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
+Permissions required: None (determined by approval flow)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>role_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The role ID for Vault AppRole authentication. </p></td>
- </tr>
-
- <tr>
- <td>secret_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>the secret id for the role without ttl. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td>
- <td></td>
- <td><p>The type of secret for AppRole authentication. </p></td>
- </tr>
-
- <tr>
- <td>mount_path</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The path where the approle auth method is mounted. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</h3>
- <p></p>
-
-
- <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 instance to delete.
-Format: instances/{instance} </p></td>
- </tr>
- <tr>
- <td>force</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>
- </tr>
+ <tr>
+ <td>GetIssue</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/issues/*}</td>
+ <td></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 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>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3>
- <p></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 retrieve.
-Format: instances/{instance} </p></td>
- </tr>
+ <tr>
+ <td>CreateIssue</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues</td>
+ <td>issue</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Instance">Instance</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>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>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The lifecycle state of the instance. </p></td>
- </tr>
+ <tr>
+ <td>ListIssues</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/issues</td>
+ <td></td>
+ </tr>
- <tr>
- <td>title</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>
- </tr>
- <tr>
- <td>engine_version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version of the database engine. </p></td>
- </tr>
+ <tr>
+ <td>SearchIssues</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues:search</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>external_link</td>
- <td><a href="#string">string</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>UpdateIssue</td>
+ <td>PATCH</td>
+ <td>/v1/{issue.name=projects/*/issues/*}</td>
+ <td>issue</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>ListIssueComments</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*/issues/*}/issueComments</td>
+ <td></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>maximum_connections</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of connections.
-The default is 10 if the value is unset or zero. </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>CreateIssueComment</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*/issues/*}:comment</td>
+ <td>issue_comment</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>
- </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>UpdateIssueComment</td>
+ <td>PATCH</td>
+ <td>/v1/{parent=projects/*/issues/*}:comment</td>
+ <td>issue_comment</td>
+ </tr>
- <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.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>BatchUpdateIssuesStatus</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>title</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>
- </tr>
- <tr>
- <td>engine_version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version of the database engine. </p></td>
- </tr>
+ <tr>
+ <td>ApproveIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:approve</td>
+ <td>*</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>
- </tr>
- <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>
- </tr>
+ <tr>
+ <td>RejectIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:reject</td>
+ <td>*</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>RequestIssue</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*/issues/*}:request</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.KerberosConfig">KerberosConfig</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">
@@ -5212,52 +5140,48 @@ 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>role</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>
+ <td><p>The role that is assigned to the members.
+Format: roles/{role} </p></td>
</tr>
<tr>
- <td>kdc_host</td>
+ <td>members</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The hostname of the Key Distribution Center (KDC). </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>kdc_port</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 port of the Key Distribution Center (KDC). </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>kdc_transport_protocol</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>The transport protocol for KDC communication (tcp or udp). </p></td>
+ <td><p>The parsed expression of the condition. </p></td>
</tr>
</tbody>
@@ -5267,8 +5191,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.BindingDelta">BindingDelta</h3>
+ <p>A single change to a binding.</p>
<table class="field-table">
@@ -5278,18 +5202,32 @@ Format: environments/prod where prod is the environment resource ID. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <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>The name of the instance.
-Format: instances/{instance} </p></td>
+ <td><p>Role that is assigned to `members`.
+For example, `roles/projectOwner`. </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>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>
@@ -5299,8 +5237,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</h3>
+ <p>Request message for getting an IAM policy.</p>
<table class="field-table">
@@ -5310,10 +5248,12 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>databases</td>
+ <td>resource</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>All database name list in the instance. </p></td>
+ <td></td>
+ <td><p>The name of the resource to get the IAM policy.
+Format: projects/{project}
+Format: workspaces/{workspace} </p></td>
</tr>
</tbody>
@@ -5323,8 +5263,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.ListInstancesRequest">ListInstancesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IamPolicy">IamPolicy</h3>
+ <p>IAM policy that binds members to roles.</p>
<table class="field-table">
@@ -5334,72 +5274,20 @@ 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><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>
- </tr>
-
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted instances if specified. </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>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>
+ <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>
@@ -5409,8 +5297,8 @@ host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; </p></td>
- <h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.PolicyDelta">PolicyDelta</h3>
+ <p>Describes changes between two IAM policies.</p>
<table class="field-table">
@@ -5420,18 +5308,10 @@ host == &#34;127.0.0.1&#34; &amp;&amp; port == &#34;54321&#34; </p></td>
<tbody>
<tr>
- <td>instances</td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>binding_deltas</td>
+ <td><a href="#bytebase.v1.BindingDelta">BindingDelta</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></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 delta for Bindings between two policies. </p></td>
</tr>
</tbody>
@@ -5441,8 +5321,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.SetIamPolicyRequest">SetIamPolicyRequest</h3>
+ <p>Request message for setting an IAM policy.</p>
<table class="field-table">
@@ -5452,19 +5332,26 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>resource</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 resource to set the IAM policy.
+Format: projects/{project}
+Format: workspaces/{workspace} </p></td>
</tr>
<tr>
- <td>data_source</td>
- <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>policy</td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
<td></td>
- <td><p>Identified by data source ID.
-Only READ_ONLY data source can be removed. </p></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>
@@ -5474,7 +5361,57 @@ Only READ_ONLY data source can be removed. </p></td>
- <h3 id="bytebase.v1.SASLConfig">SASLConfig</h3>
+
+
+ <h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3>
+ <p>Type of action performed on a binding.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ACTION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified action.</p></td>
+ </tr>
+
+ <tr>
+ <td>ADD</td>
+ <td>1</td>
+ <td><p>Add a binding.</p></td>
+ </tr>
+
+ <tr>
+ <td>REMOVE</td>
+ <td>2</td>
+ <td><p>Remove a binding.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/project_service.proto">v1/project_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.Activity">Activity</h3>
+ <p>Activity types for webhook notifications.</p>
+
+
+
+
+
+ <h3 id="bytebase.v1.AddWebhookRequest">AddWebhookRequest</h3>
<p></p>
@@ -5485,10 +5422,18 @@ Only READ_ONLY data source can be removed. </p></td>
<tbody>
<tr>
- <td>krb_config</td>
- <td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td>
+ <td>project</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Kerberos authentication configuration. </p></td>
+ <td><p>The name of the project to add the webhook to.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td></td>
+ <td><p>The webhook to add. </p></td>
</tr>
</tbody>
@@ -5498,7 +5443,7 @@ Only READ_ONLY data source can be removed. </p></td>
- <h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3>
+ <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>
<p></p>
@@ -5509,19 +5454,21 @@ Only READ_ONLY data source can be removed. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of instance.
-Format: instances/{instance} </p></td>
+ <td>repeated</td>
+ <td><p>The names of the projects to delete.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>enable_full_sync</td>
+ <td>force</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only
-the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td>
+ <td><p>If set to true, any databases from this project will be moved to default project.
+Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
+Open issues will remain open but associated with the deleted project.
+If set to false, the operation will fail if the project has databases or open issues. </p></td>
</tr>
</tbody>
@@ -5531,7 +5478,7 @@ the instance metadata (such as the database list) and any newly discovered datab
- <h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3>
+ <h3 id="bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</h3>
<p></p>
@@ -5542,10 +5489,17 @@ the instance metadata (such as the database list) and any newly discovered datab
<tbody>
<tr>
- <td>databases</td>
+ <td>scope</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The scope of the batch get. Typically it&#39;s &#34;projects/-&#34;. </p></td>
+ </tr>
+
+ <tr>
+ <td>names</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>All database name list in the instance. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -5555,7 +5509,7 @@ the instance metadata (such as the database list) and any newly discovered datab
- <h3 id="bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</h3>
+ <h3 id="bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</h3>
<p></p>
@@ -5566,11 +5520,10 @@ the instance metadata (such as the database list) and any newly discovered datab
<tbody>
<tr>
- <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>
+ <td>policy_results</td>
+ <td><a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</a></td>
+ <td>repeated</td>
+ <td><p>The policy results for each requested project. </p></td>
</tr>
</tbody>
@@ -5580,8 +5533,8 @@ Format: instances/{instance} </p></td>
- <h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</h3>
+ <p>Result for a single project's IAM policy.</p>
<table class="field-table">
@@ -5591,40 +5544,17 @@ Format: instances/{instance} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>project</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>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>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to update. </p></td>
- </tr>
-
- <tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Validate only also tests the data source connection. </p></td>
+ <td><p>The project resource name. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>policy</td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</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 IAM policy for the project. </p></td>
</tr>
</tbody>
@@ -5634,7 +5564,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</h3>
+ <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3>
<p></p>
@@ -5645,514 +5575,404 @@ In this situation, `update_mask` is ignored. </p></td>
<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>project</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The project to create. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>project_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the instance is not found, a new instance will be created.
-In this situation, `update_mask` is ignored. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>AUTHENTICATION_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PASSWORD</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GOOGLE_CLOUD_SQL_IAM</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AWS_RDS_IAM</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AZURE_IAM</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSource.RedisType">DataSource.RedisType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>REDIS_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STANDALONE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SENTINEL</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CLUSTER</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SECRET_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified secret type.</p></td>
- </tr>
-
- <tr>
- <td>PLAIN</td>
- <td>1</td>
- <td><p>Plain text secret.</p></td>
- </tr>
-
- <tr>
- <td>ENVIRONMENT</td>
- <td>2</td>
- <td><p>Secret from environment variable.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</h3>
- <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>
-
- </tbody>
- </table>
+ <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.DataSourceType">DataSourceType</h3>
+ <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATA_SOURCE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified data source type.</p></td>
- </tr>
-
- <tr>
- <td>ADMIN</td>
- <td>1</td>
- <td><p>Admin data source with write permissions.</p></td>
- </tr>
-
- <tr>
- <td>READ_ONLY</td>
- <td>2</td>
- <td><p>Read-only data source for query operations.</p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+ <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>force</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, any databases from this project will be moved to default project.
+Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
+Open issues will remain open but associated with the deleted project.
+If set to false, the operation will fail if the project has databases or open issues. </p></td>
+ </tr>
+
+ <tr>
+ <td>purge</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, permanently purge the soft-deleted project and all related resources.
+This operation is irreversible. Following AIP-165, this should only be used for
+administrative cleanup of old soft-deleted projects.
+The project must already be soft-deleted for this to work. </p></td>
+ </tr>
+
+ </tbody>
+ </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.InstanceService">InstanceService</h3>
- <p>InstanceService manages database instances and their connections.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetInstance</td>
- <td><a href="#bytebase.v1.GetInstanceRequest">GetInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Gets a database instance by name.
-Permissions required: bb.instances.get</p></td>
- </tr>
-
- <tr>
- <td>ListInstances</td>
- <td><a href="#bytebase.v1.ListInstancesRequest">ListInstancesRequest</a></td>
- <td><a href="#bytebase.v1.ListInstancesResponse">ListInstancesResponse</a></td>
- <td><p>Lists all database instances.
-Permissions required: bb.instances.list</p></td>
- </tr>
-
- <tr>
- <td>CreateInstance</td>
- <td><a href="#bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Creates a new database instance.
-Permissions required: bb.instances.create</p></td>
- </tr>
-
- <tr>
- <td>UpdateInstance</td>
- <td><a href="#bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Updates a database instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>DeleteInstance</td>
- <td><a href="#bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes or soft-deletes a database instance.
-Permissions required: bb.instances.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteInstance</td>
- <td><a href="#bytebase.v1.UndeleteInstanceRequest">UndeleteInstanceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Restores a soft-deleted database instance.
-Permissions required: bb.instances.undelete</p></td>
- </tr>
-
- <tr>
- <td>SyncInstance</td>
- <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
- <td><a href="#bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</a></td>
- <td><p>Syncs database schemas and metadata from an instance.
-Permissions required: bb.instances.sync</p></td>
- </tr>
-
- <tr>
- <td>ListInstanceDatabase</td>
- <td><a href="#bytebase.v1.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</a></td>
- <td><a href="#bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</a></td>
- <td><p>Lists all databases within an instance without creating them.
-Permissions required: bb.instances.get</p></td>
- </tr>
-
- <tr>
- <td>BatchSyncInstances</td>
- <td><a href="#bytebase.v1.BatchSyncInstancesRequest">BatchSyncInstancesRequest</a></td>
- <td><a href="#bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</a></td>
- <td><p>Syncs multiple instances in a single request.
-Permissions required: bb.instances.sync</p></td>
- </tr>
-
- <tr>
- <td>BatchUpdateInstances</td>
- <td><a href="#bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</a></td>
- <td><p>Updates multiple instances in a single request.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>AddDataSource</td>
- <td><a href="#bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Adds a read-only data source to an instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>RemoveDataSource</td>
- <td><a href="#bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Removes a read-only data source from an instance.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- <tr>
- <td>UpdateDataSource</td>
- <td><a href="#bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</a></td>
- <td><a href="#bytebase.v1.Instance">Instance</a></td>
- <td><p>Updates a data source configuration.
-Permissions required: bb.instances.update</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.ListProjectsRequest">ListProjectsRequest</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>GetInstance</td>
- <td>GET</td>
- <td>/v1/{name=instances/*}</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>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>DeleteInstance</td>
- <td>DELETE</td>
- <td>/v1/{name=instances/*}</td>
- <td></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>
+ </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>UndeleteInstance</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:undelete</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>repeated</td>
+ <td><p>The projects from the specified request. </p></td>
+ </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.Project">Project</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>SyncInstance</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:sync</td>
- <td>*</td>
- </tr>
+ <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>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>ListInstanceDatabase</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:databases</td>
- <td>*</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>BatchSyncInstances</td>
- <td>POST</td>
- <td>/v1/instances:batchSync</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>force_issue_labels</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Force issue labels to be used when creating an issue. </p></td>
+ </tr>
-
+ <tr>
+ <td>allow_modify_statement</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Allow modifying SQL statements after issue is created. </p></td>
+ </tr>
+ <tr>
+ <td>auto_resolve_issue</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Enable automatic issue resolution when tasks complete. </p></td>
+ </tr>
- <tr>
- <td>BatchUpdateInstances</td>
- <td>POST</td>
- <td>/v1/instances:batchUpdate</td>
- <td>*</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>AddDataSource</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:addDataSource</td>
- <td>*</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>RemoveDataSource</td>
- <td>POST</td>
- <td>/v1/{name=instances/*}:removeDataSource</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>ci_sampling_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of database rows to sample during CI data validation.
+Without specification, sampling is disabled, resulting in full validation. </p></td>
+ </tr>
-
+ <tr>
+ <td>parallel_tasks_per_rollout</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td>
+ </tr>
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels are key-value pairs that can be attached to the project.
+For example, { &#34;environment&#34;: &#34;production&#34;, &#34;team&#34;: &#34;backend&#34; } </p></td>
+ </tr>
- <tr>
- <td>UpdateDataSource</td>
- <td>PATCH</td>
- <td>/v1/{name=instances/*}:updateDataSource</td>
- <td>data_source</td>
- </tr>
+ <tr>
+ <td>enforce_sql_review</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enforce SQL review checks to pass before issue creation.
+If enabled, issues cannot be created when SQL review finds errors. </p></td>
+ </tr>
-
</tbody>
</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.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>
+ <p>Execution retry policy configuration.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>maximum_retries</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of retries for lock timeout errors. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
- <h3 id="bytebase.v1.BatchGetDatabasesRequest">BatchGetDatabasesRequest</h3>
+ <h3 id="bytebase.v1.Project.LabelsEntry">Project.LabelsEntry</h3>
<p></p>
@@ -6163,20 +5983,17 @@ Permissions required: bb.instances.update</p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>key</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> </p></td>
</tr>
<tr>
- <td>names</td>
+ <td>value</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> </p></td>
</tr>
</tbody>
@@ -6186,7 +6003,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.RemoveWebhookRequest">RemoveWebhookRequest</h3>
<p></p>
@@ -6197,10 +6014,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>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>
@@ -6210,7 +6027,7 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </p></td>
- <h3 id="bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3>
+ <h3 id="bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</h3>
<p></p>
@@ -6221,19 +6038,93 @@ Use &#34;-&#34; as wildcard to batch get databases across parent. </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 databases being updated.
-Format: instances/{instance}
-If the operation spans parents, a dash (-) may be accepted as a wildcard. </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>names</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>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>projects</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
<td>repeated</td>
- <td><p>The list of database names to sync. </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>
@@ -6243,14 +6134,39 @@ If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></
- <h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3>
+ <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>
<p></p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>project</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the project which owns the webhook to test.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td></td>
+ <td><p>The webhook to test. Identified by its url. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
- <h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3>
+ <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>
<p></p>
@@ -6261,21 +6177,35 @@ If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></
<tbody>
<tr>
- <td>parent</td>
+ <td>error</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource shared by all databases being updated.
-Format: instances/{instance}
-If the operation spans parents, a dash (-) may be accepted as a wildcard.
-We only support updating the project of databases for now. </p></td>
+ <td><p>The result of the test, empty if the test is successful. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the deleted project.
+Format: projects/{project} </p></td>
</tr>
</tbody>
@@ -6285,7 +6215,7 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
- <h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3>
+ <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>
<p></p>
@@ -6296,10 +6226,28 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
<tbody>
<tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>Databases updated. </p></td>
+ <td>project</td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td></td>
+ <td><p>The project to update.
+
+The project&#39;s `name` field is used to identify the project to update.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>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 project is not found, a new project will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -6309,8 +6257,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.UpdateWebhookRequest">UpdateWebhookRequest</h3>
+ <p></p>
<table class="field-table">
@@ -6320,31 +6268,25 @@ 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></td>
- <td><p>Minimum X coordinate </p></td>
- </tr>
-
- <tr>
- <td>ymin</td>
- <td><a href="#double">double</a></td>
+ <td>webhook</td>
+ <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
<td></td>
- <td><p>Minimum Y coordinate </p></td>
+ <td><p>The webhook to modify. </p></td>
</tr>
<tr>
- <td>xmax</td>
- <td><a href="#double">double</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>Maximum X coordinate </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>ymax</td>
- <td><a href="#double">double</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Maximum Y coordinate </p></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>
@@ -6354,7 +6296,7 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
- <h3 id="bytebase.v1.ChangedResourceDatabase">ChangedResourceDatabase</h3>
+ <h3 id="bytebase.v1.Webhook">Webhook</h3>
<p></p>
@@ -6368,387 +6310,516 @@ A maximum of 1000 databases can be modified in a batch. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </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>schemas</td>
- <td><a href="#bytebase.v1.ChangedResourceSchema">ChangedResourceSchema</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Webhook.Type">Webhook.Type</a></td>
+ <td></td>
+ <td><p>type is the type of the webhook. </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>title is the title of the webhook. </p></td>
+ </tr>
+
+ <tr>
+ <td>url</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>url is the url of the webhook, should be unique within the project. </p></td>
+ </tr>
+
+ <tr>
+ <td>direct_message</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>if direct_message is set, the notification is sent directly
+to the persons and url will be ignored.
+IM integration setting should be set for this function to work. </p></td>
+ </tr>
+
+ <tr>
+ <td>notification_types</td>
+ <td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>notification_types is the list of activities types that the webhook is interested in.
+Bytebase will only send notifications to the webhook if the activity type is in the list.
+It should not be empty, and should be a subset of the following:
+- ISSUE_CREATE
+- ISSUE_COMMENT_CREATE
+- ISSUE_FIELD_UPDATE
+- ISSUE_STATUS_UPDATE
+- ISSUE_APPROVAL_NOTIFY
+- ISSUE_PIPELINE_STAGE_STATUS_UPDATE
+- ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE
+- NOTIFY_ISSUE_APPROVED
+- NOTIFY_PIPELINE_ROLLOUT </p></td>
</tr>
</tbody>
</table>
-
+
+
+
+
+
+
+ <h3 id="bytebase.v1.Activity.Type">Activity.Type</h3>
+ <p>Activity type enumeration.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>NOTIFY_ISSUE_APPROVED</td>
+ <td>23</td>
+ <td><p>Notifications via webhooks.
+
+NOTIFY_ISSUE_APPROVED represents the issue approved notification.</p></td>
+ </tr>
+
+ <tr>
+ <td>NOTIFY_PIPELINE_ROLLOUT</td>
+ <td>24</td>
+ <td><p>NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_CREATE</td>
+ <td>1</td>
+ <td><p>Issue related activity types.
+
+ISSUE_CREATE represents creating an issue.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_COMMENT_CREATE</td>
+ <td>2</td>
+ <td><p>ISSUE_COMMENT_CREATE represents commenting on an issue.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_FIELD_UPDATE</td>
+ <td>3</td>
+ <td><p>ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_STATUS_UPDATE</td>
+ <td>4</td>
+ <td><p>ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_APPROVAL_NOTIFY</td>
+ <td>21</td>
+ <td><p>ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_PIPELINE_STAGE_STATUS_UPDATE</td>
+ <td>5</td>
+ <td><p>ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now.</p></td>
+ </tr>
+
+ <tr>
+ <td>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE</td>
+ <td>22</td>
+ <td><p>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Webhook.Type">Webhook.Type</h3>
+ <p>Webhook integration 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>SLACK</td>
+ <td>1</td>
+ <td><p>Slack integration.</p></td>
+ </tr>
+
+ <tr>
+ <td>DISCORD</td>
+ <td>2</td>
+ <td><p>Discord integration.</p></td>
+ </tr>
+
+ <tr>
+ <td>TEAMS</td>
+ <td>3</td>
+ <td><p>Microsoft Teams integration.</p></td>
+ </tr>
+
+ <tr>
+ <td>DINGTALK</td>
+ <td>4</td>
+ <td><p>DingTalk integration.</p></td>
+ </tr>
+
+ <tr>
+ <td>FEISHU</td>
+ <td>5</td>
+ <td><p>Feishu integration.</p></td>
+ </tr>
+
+ <tr>
+ <td>WECOM</td>
+ <td>6</td>
+ <td><p>WeCom (WeChat Work) integration.</p></td>
+ </tr>
+
+ <tr>
+ <td>LARK</td>
+ <td>8</td>
+ <td><p>Lark integration.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
-
- <h3 id="bytebase.v1.ChangedResourceFunction">ChangedResourceFunction</h3>
- <p></p>
+ <h3 id="bytebase.v1.ProjectService">ProjectService</h3>
+ <p>ProjectService manages projects that group databases and changes.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetProject</td>
+ <td><a href="#bytebase.v1.GetProjectRequest">GetProjectRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>GetProject retrieves a project by name.
+Users with &#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>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>BatchGetIamPolicy</td>
+ <td><a href="#bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</a></td>
+ <td><a href="#bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</a></td>
+ <td><p>Deprecated. No permission check implemented.
+Permissions required: None</p></td>
+ </tr>
+
+ <tr>
+ <td>SetIamPolicy</td>
+ <td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td>
+ <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
+ <td><p>Sets the IAM policy for a project.
+Permissions required: bb.projects.setIamPolicy</p></td>
+ </tr>
+
+ <tr>
+ <td>AddWebhook</td>
+ <td><a href="#bytebase.v1.AddWebhookRequest">AddWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Adds a webhook to a project for notifications.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateWebhook</td>
+ <td><a href="#bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Updates an existing webhook configuration.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ <tr>
+ <td>RemoveWebhook</td>
+ <td><a href="#bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td><p>Removes a webhook from a project.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ <tr>
+ <td>TestWebhook</td>
+ <td><a href="#bytebase.v1.TestWebhookRequest">TestWebhookRequest</a></td>
+ <td><a href="#bytebase.v1.TestWebhookResponse">TestWebhookResponse</a></td>
+ <td><p>Tests a webhook by sending a test notification.
+Permissions required: bb.projects.update</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <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> </p></td>
- </tr>
- <tr>
- <td>ranges</td>
- <td><a href="#bytebase.v1.Range">Range</a></td>
- <td>repeated</td>
- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
- </tr>
+ <tr>
+ <td>GetProject</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*}</td>
+ <td></td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ChangedResourceProcedure">ChangedResourceProcedure</h3>
- <p></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>
- </tr>
- <tr>
- <td>ranges</td>
- <td><a href="#bytebase.v1.Range">Range</a></td>
- <td>repeated</td>
- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
- </tr>
+ <tr>
+ <td>ListProjects</td>
+ <td>GET</td>
+ <td>/v1/projects</td>
+ <td></td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ChangedResourceSchema">ChangedResourceSchema</h3>
- <p></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>
- </tr>
- <tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.ChangedResourceTable">ChangedResourceTable</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>SearchProjects</td>
+ <td>POST</td>
+ <td>/v1/projects:search</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>views</td>
- <td><a href="#bytebase.v1.ChangedResourceView">ChangedResourceView</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>functions</td>
- <td><a href="#bytebase.v1.ChangedResourceFunction">ChangedResourceFunction</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>procedures</td>
- <td><a href="#bytebase.v1.ChangedResourceProcedure">ChangedResourceProcedure</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>CreateProject</td>
+ <td>POST</td>
+ <td>/v1/projects</td>
+ <td>project</td>
+ </tr>
+
+
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ChangedResourceTable">ChangedResourceTable</h3>
- <p></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>
- </tr>
+ <tr>
+ <td>UpdateProject</td>
+ <td>PATCH</td>
+ <td>/v1/{project.name=projects/*}</td>
+ <td>project</td>
+ </tr>
- <tr>
- <td>ranges</td>
- <td><a href="#bytebase.v1.Range">Range</a></td>
- <td>repeated</td>
- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
- </tr>
+
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ChangedResourceView">ChangedResourceView</h3>
- <p></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>
- </tr>
+ <tr>
+ <td>DeleteProject</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>ranges</td>
- <td><a href="#bytebase.v1.Range">Range</a></td>
- <td>repeated</td>
- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
- </tr>
+
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ChangedResources">ChangedResources</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
- <tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.ChangedResourceDatabase">ChangedResourceDatabase</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>UndeleteProject</td>
+ <td>POST</td>
+ <td>/v1/{name=projects/*}:undelete</td>
+ <td>*</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Changelog">Changelog</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: instances/{instance}/databases/{database}/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>
- </tr>
+ <tr>
+ <td>BatchDeleteProjects</td>
+ <td>POST</td>
+ <td>/v1/projects:batchDelete</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>statement</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The statement is used for preview purpose. </p></td>
- </tr>
- <tr>
- <td>statement_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>GetIamPolicy</td>
+ <td>GET</td>
+ <td>/v1/{resource=projects/*}:getIamPolicy</td>
+ <td></td>
+ </tr>
- <tr>
- <td>statement_sheet</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the sheet resource.
-Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
+
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>schema_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>BatchGetIamPolicy</td>
+ <td>GET</td>
+ <td>/v1/{scope=*/*}/iamPolicies:batchGet</td>
+ <td></td>
+ </tr>
- <tr>
- <td>prev_schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>prev_schema_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>issue</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{project}/issues/{issue} </p></td>
- </tr>
+ <tr>
+ <td>SetIamPolicy</td>
+ <td>POST</td>
+ <td>/v1/{resource=projects/*}:setIamPolicy</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>task_run</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
- </tr>
+
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Could be empty </p></td>
- </tr>
- <tr>
- <td>revision</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Could be empty
-Or present but not found if deleted </p></td>
- </tr>
+ <tr>
+ <td>AddWebhook</td>
+ <td>POST</td>
+ <td>/v1/{project=projects/*}:addWebhook</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>changed_resources</td>
- <td><a href="#bytebase.v1.ChangedResources">ChangedResources</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
+
+
+ <tr>
+ <td>UpdateWebhook</td>
+ <td>PATCH</td>
+ <td>/v1/{webhook.name=projects/*/webhooks/*}:updateWebhook</td>
+ <td>webhook</td>
+ </tr>
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Changelog.Type">Changelog.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</h3>
- <p>CheckConstraintMetadata is the metadata for check constraints.</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 check constraint. </p></td>
- </tr>
+ <tr>
+ <td>RemoveWebhook</td>
+ <td>POST</td>
+ <td>/v1/{webhook.name=projects/*/webhooks/*}:removeWebhook</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>expression</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The expression is the expression of a check constraint. </p></td>
- </tr>
+
+
+
+ <tr>
+ <td>TestWebhook</td>
+ <td>POST</td>
+ <td>/v1/{project=projects/*}:testWebhook</td>
+ <td>*</td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.ColumnMetadata">ColumnMetadata</h3>
- <p>ColumnMetadata is the metadata for columns.</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">
@@ -6758,144 +6829,45 @@ Or present but not found if deleted </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 column. </p></td>
- </tr>
-
- <tr>
- <td>position</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The position is the position in columns. </p></td>
- </tr>
-
- <tr>
- <td>has_default</td>
+ <td>enabled</td>
<td><a href="#bool">bool</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>default</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The 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>provider</td>
+ <td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td>
<td></td>
- <td><p>The type is the type of a column. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>character_set</td>
+ <td>endpoint</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The character_set is the character_set of a column. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>collation</td>
+ <td>api_key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The collation is the collation of a column. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>model</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>version</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>
@@ -6905,7 +6877,7 @@ from SQL files), the system cannot automatically drop the constraint. </p></td>
- <h3 id="bytebase.v1.Database">Database</h3>
+ <h3 id="bytebase.v1.Algorithm">Algorithm</h3>
<p></p>
@@ -6916,86 +6888,31 @@ from SQL files), the system cannot automatically drop the constraint. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database.
-Format: instances/{instance}/databases/{database}
-{database} is the database name in the instance. </p></td>
- </tr>
-
- <tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
- <td></td>
- <td><p>The existence of a database. </p></td>
- </tr>
-
- <tr>
- <td>successful_sync_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The latest synchronization time. </p></td>
- </tr>
-
- <tr>
- <td>project</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The project for a database.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>schema_version</td>
- <td><a href="#string">string</a></td>
+ <td>full_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>
<td></td>
- <td><p>The version of database schema. </p></td>
- </tr>
-
- <tr>
- <td>environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The environment resource.
-Format: environments/prod where prod is the environment resource ID. </p></td>
- </tr>
-
- <tr>
- <td>effective_environment</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>The effective environment based on environment tag above and environment
-tag on the instance. Inheritance follows
-https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
- </tr>
-
- <tr>
- <td>labels</td>
- <td><a href="#bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</a></td>
- <td>repeated</td>
- <td><p>Labels will be used for deployment and policy control. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>instance_resource</td>
- <td><a href="#bytebase.v1.InstanceResource">InstanceResource</a></td>
+ <td>range_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td>
<td></td>
- <td><p>The instance resource. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>backup_available</td>
- <td><a href="#bool">bool</a></td>
+ <td>md5_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</a></td>
<td></td>
- <td><p>The database is available for DML prior backup. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>drifted</td>
- <td><a href="#bool">bool</a></td>
+ <td>inner_outer_mask</td>
+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</a></td>
<td></td>
- <td><p>The schema is drifted from the source of truth. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7005,7 +6922,7 @@ https://cloud.google.com/resource-manager/docs/tags/tags-overview. </p></td>
- <h3 id="bytebase.v1.Database.LabelsEntry">Database.LabelsEntry</h3>
+ <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>
<p></p>
@@ -7016,17 +6933,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>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </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>
@@ -7036,8 +6947,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.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>
+ <p></p>
<table class="field-table">
@@ -7047,54 +6958,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>prefix_len</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The character_set is the character set of a database. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>collation</td>
- <td><a href="#string">string</a></td>
+ <td>suffix_len</td>
+ <td><a href="#int32">int32</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> </p></td>
</tr>
<tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>
<td></td>
- <td><p>The owner of the database. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>search_path</td>
+ <td>substitution</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> </p></td>
</tr>
</tbody>
@@ -7104,8 +6992,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.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>
+ <p></p>
<table class="field-table">
@@ -7115,23 +7003,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>salt</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The MIME type of the schema content.
-Indicates how the client should interpret the schema field.
-Examples:
-- &#34;text/plain; charset=utf-8&#34; for SINGLE_FILE format
-- &#34;application/zip&#34; for MULTI_FILE format </p></td>
+ <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td>
</tr>
</tbody>
@@ -7141,8 +7016,8 @@ Examples:
- <h3 id="bytebase.v1.DatabaseSchema">DatabaseSchema</h3>
- <p>DatabaseSchema is the metadata for databases.</p>
+ <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</h3>
+ <p></p>
<table class="field-table">
@@ -7152,10 +7027,11 @@ 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>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>
@@ -7165,8 +7041,8 @@ Examples:
- <h3 id="bytebase.v1.DependencyColumn">DependencyColumn</h3>
- <p>DependencyColumn is the metadata for dependency columns.</p>
+ <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3>
+ <p></p>
<table class="field-table">
@@ -7176,24 +7052,24 @@ Examples:
<tbody>
<tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
+ <td>start</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The schema is the schema of a reference column. </p></td>
+ <td><p>start is the start index of the original value, start from 0 and should be less than stop. </p></td>
</tr>
<tr>
- <td>table</td>
- <td><a href="#string">string</a></td>
+ <td>end</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The table is the table of a reference column. </p></td>
+ <td><p>stop is the stop index of the original value, should be less than the length of the original value. </p></td>
</tr>
<tr>
- <td>column</td>
+ <td>substitution</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The column is the name of a reference column. </p></td>
+ <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>
</tr>
</tbody>
@@ -7203,7 +7079,7 @@ Examples:
- <h3 id="bytebase.v1.DependencyTable">DependencyTable</h3>
+ <h3 id="bytebase.v1.Announcement">Announcement</h3>
<p></p>
@@ -7214,17 +7090,24 @@ Examples:
<tbody>
<tr>
- <td>schema</td>
+ <td>level</td>
+ <td><a href="#bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</a></td>
+ <td></td>
+ <td><p>The alert level of announcement </p></td>
+ </tr>
+
+ <tr>
+ <td>text</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The schema is the schema of a reference table. </p></td>
+ <td><p>The text of announcement </p></td>
</tr>
<tr>
- <td>table</td>
+ <td>link</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The table is the name of a reference table. </p></td>
+ <td><p>The optional link, user can follow the link to check extra details </p></td>
</tr>
</tbody>
@@ -7234,7 +7117,7 @@ Examples:
- <h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3>
+ <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>
<p></p>
@@ -7245,29 +7128,10 @@ Examples:
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database or changelog.
-Format:
-database: instances/{instance}/databases/{database}
-changelog: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The target schema. </p></td>
- </tr>
-
- <tr>
- <td>changelog</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the changelog
-Format:
-instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
+ <td>settings</td>
+ <td><a href="#bytebase.v1.AppIMSetting.IMSetting">AppIMSetting.IMSetting</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7277,7 +7141,7 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3>
+ <h3 id="bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</h3>
<p></p>
@@ -7288,7 +7152,21 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>diff</td>
+ <td>client_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>robot_code</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
@@ -7301,8 +7179,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.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>
+ <p></p>
<table class="field-table">
@@ -7312,31 +7190,17 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>dimension</td>
+ <td>app_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td>
- </tr>
-
- <tr>
- <td>min_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Minimum value for this dimension </p></td>
- </tr>
-
- <tr>
- <td>max_value</td>
- <td><a href="#double">double</a></td>
- <td></td>
- <td><p>Maximum value for this dimension </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>tolerance</td>
- <td><a href="#double">double</a></td>
+ <td>app_secret</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Tolerance for this dimension </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7346,8 +7210,8 @@ 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.AppIMSetting.IMSetting">AppIMSetting.IMSetting</h3>
+ <p></p>
<table class="field-table">
@@ -7357,31 +7221,45 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>dimensions</td>
- <td><a href="#int32">int32</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Webhook.Type">Webhook.Type</a></td>
<td></td>
- <td><p>Number of dimensions (2-4, default 2) </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>data_type</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>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>srid</td>
- <td><a href="#int32">int32</a></td>
+ <td>feishu</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>
<td></td>
- <td><p>Spatial reference system identifier (SRID) </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>wecom</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>lark</td>
+ <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>
+ <td></td>
+ <td><p> </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>
+ <td>dingtalk</td>
+ <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7391,7 +7269,7 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</h3>
+ <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3>
<p></p>
@@ -7402,31 +7280,17 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>app_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of a type. </p></td>
- </tr>
-
- <tr>
- <td>values</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The enum values of a type. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>app_secret</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>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7436,7 +7300,7 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- <h3 id="bytebase.v1.EventMetadata">EventMetadata</h3>
+ <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3>
<p></p>
@@ -7447,52 +7311,48 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the event. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schedule of the event. </p></td>
- </tr>
-
- <tr>
- <td>time_zone</td>
+ <td>token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The time zone of the event. </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The SQL mode setting for the event. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>
+ <p></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_client</td>
+ <td>corp_id</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> </p></td>
</tr>
<tr>
- <td>collation_connection</td>
+ <td>agent_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The collation used for the connection when creating the event. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>secret</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment is the comment of an event. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7502,8 +7362,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.DataClassificationSetting">DataClassificationSetting</h3>
+ <p></p>
<table class="field-table">
@@ -7513,32 +7373,10 @@ instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of an extension. </p></td>
- </tr>
-
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema is the extension that is installed to. But the extension usage
-is not limited to the schema. </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The version is the version of an extension. </p></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The description is the description of an extension. </p></td>
+ <td>configs</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7548,7 +7386,7 @@ is not limited to the schema. </p></td>
- <h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3>
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3>
<p></p>
@@ -7559,31 +7397,33 @@ is not limited to the schema. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a external table. </p></td>
+ <td><p>id is the uuid for classification. Each project can chose one classification config. </p></td>
</tr>
<tr>
- <td>external_server_name</td>
+ <td>title</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>
+ <td><p> </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>
+ <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>columns</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>classification</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</a></td>
<td>repeated</td>
- <td><p>The columns is the ordered list of columns in a foreign table. </p></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>
@@ -7593,8 +7433,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.DataClassificationSetting.DataClassificationConfig.ClassificationEntry">DataClassificationSetting.DataClassificationConfig.ClassificationEntry</h3>
+ <p></p>
<table class="field-table">
@@ -7604,62 +7444,62 @@ is not limited to the schema. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>key</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>
+ <td><p> </p></td>
</tr>
<tr>
- <td>referenced_schema</td>
- <td><a href="#string">string</a></td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>
<td></td>
- <td><p>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>
+ <td><p> </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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>referenced_columns</td>
+ <td>id</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>
+ <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>on_delete</td>
+ <td>title</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>
+ <td><p> </p></td>
</tr>
<tr>
- <td>on_update</td>
+ <td>description</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> </p></td>
</tr>
<tr>
- <td>match_type</td>
+ <td>level_id</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>
+ <td>optional</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7669,8 +7509,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.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3>
+ <p></p>
<table class="field-table">
@@ -7680,73 +7520,102 @@ It&#39;s empty string for other databases. </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name is the name of a function. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition is the definition of a function. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>signature</td>
+ <td>description</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>
+ <td><p> </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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
- <td></td>
+ <td>environments</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.EnvironmentSetting.Environment">EnvironmentSetting.Environment</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>database_collation</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The resource name of the environment.
+Format: environments/{environment}.
+Output only. </p></td>
</tr>
<tr>
- <td>sql_mode</td>
+ <td>id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </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>comment</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The display name of the environment. </p></td>
</tr>
<tr>
- <td>dependency_tables</td>
- <td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>
+ <td>tags</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</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> </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>color</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -7758,7 +7627,7 @@ For PostgreSQL, it&#39;s the list of tables that the function depends on the ret
- <h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3>
+ <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>
<p></p>
@@ -7769,14 +7638,14 @@ 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>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>expression</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
@@ -7789,8 +7658,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.GetSettingRequest">GetSettingRequest</h3>
+ <p>The request message for getting a setting.</p>
<table class="field-table">
@@ -7803,15 +7672,7 @@ For PostgreSQL, it&#39;s the list of tables that the function depends on the ret
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the changelog to retrieve.
-Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
- </tr>
-
- <tr>
- <td>view</td>
- <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The resource name of the setting. </p></td>
</tr>
</tbody>
@@ -7821,8 +7682,8 @@ Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></t
- <h3 id="bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>
+ <p>The response message for getting a setting.</p>
<table class="field-table">
@@ -7832,41 +7693,10 @@ Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></t
<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>setting</td>
+ <td><a href="#bytebase.v1.Setting">Setting</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>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7876,7 +7706,14 @@ Default 0, means no limit. </p></td>
- <h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3>
+ <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3>
<p></p>
@@ -7887,11 +7724,10 @@ Default 0, means no limit. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database to retrieve.
-Format: instances/{instance}/databases/{database} </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>
@@ -7901,7 +7737,7 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</h3>
+ <h3 id="bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</h3>
<p></p>
@@ -7912,18 +7748,52 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>min_length</td>
+ <td><a href="#int32">int32</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>min_length is the minimum length for password, should no less than 8. </p></td>
</tr>
<tr>
- <td>format</td>
- <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td>
+ <td>require_number</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The format of the SDL schema output. </p></td>
+ <td><p>require_number requires the password must contains at least one number. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_letter</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td>
+ </tr>
+
+ <tr>
+ <td>require_uppercase_letter</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>require_uppercase_letter requires the password must contains at least one upper case letter. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_special_character</td>
+ <td><a href="#bool">bool</a></td>
+ <td></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>
@@ -7933,7 +7803,7 @@ Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
- <h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</h3>
+ <h3 id="bytebase.v1.SCIMSetting">SCIMSetting</h3>
<p></p>
@@ -7944,11 +7814,10 @@ Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the database to retrieve schema.
-Format: instances/{instance}/databases/{database}/schema </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -7958,7 +7827,7 @@ Format: instances/{instance}/databases/{database}/schema </p></td>
- <h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3>
+ <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>
<p></p>
@@ -7969,42 +7838,12 @@ Format: instances/{instance}/databases/{database}/schema </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database.
-Format: instances/{instance}/databases/{database} </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</a></td>
- <td></td>
+ <td>types</td>
+ <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
- <tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>It&#39;s empty for DATABASE. </p></td>
- </tr>
-
- <tr>
- <td>object</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>It&#39;s empty for DATABASE and SCHEMA. </p></td>
- </tr>
-
- <tr>
- <td>metadata</td>
- <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
- <td></td>
- <td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.
-Also the schema and object are empty. </p></td>
- </tr>
-
</tbody>
</table>
@@ -8012,7 +7851,7 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3>
+ <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>
<p></p>
@@ -8023,12 +7862,40 @@ Also the schema and object are empty. </p></td>
<tbody>
<tr>
- <td>schema_string</td>
+ <td>id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>id is the uuid for semantic type. </p></td>
+ </tr>
+
+ <tr>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>the title of the semantic type, it should not be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
<td><a href="#string">string</a></td>
<td></td>
+ <td><p>the description of the semantic type, it can be empty. </p></td>
+ </tr>
+
+ <tr>
+ <td>algorithm</td>
+ <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>icon</td>
+ <td><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>
@@ -8036,8 +7903,8 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.GridLevel">GridLevel</h3>
- <p>GridLevel defines a tessellation grid level with its density.</p>
+ <h3 id="bytebase.v1.Setting">Setting</h3>
+ <p>The schema of setting.</p>
<table class="field-table">
@@ -8047,17 +7914,20 @@ Also the schema and object are empty. </p></td>
<tbody>
<tr>
- <td>level</td>
- <td><a href="#int32">int32</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Grid level number (1-4 for SQL Server) </p></td>
+ <td><p>The resource name of the setting. Must be one of the following forms:
+
+- `setting/{setting}`
+For example, &#34;settings/bb.branding.logo&#34; </p></td>
</tr>
<tr>
- <td>density</td>
- <td><a href="#string">string</a></td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.Value">Value</a></td>
<td></td>
- <td><p>Grid density (LOW, MEDIUM, HIGH) </p></td>
+ <td><p>The configuration value of the setting. </p></td>
</tr>
</tbody>
@@ -8067,8 +7937,8 @@ Also the schema and object are empty. </p></td>
- <h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3>
- <p>IndexMetadata is the metadata for indexes.</p>
+ <h3 id="bytebase.v1.UpdateSettingRequest">UpdateSettingRequest</h3>
+ <p>The request message for updating or creating a setting.</p>
<table class="field-table">
@@ -8078,126 +7948,143 @@ Also the schema and object are empty. </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 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>
+ <td><p>The setting to update. </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>
+ <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>descending</td>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
- <td>repeated</td>
- <td><p>The descending is the ordered descending of an index. </p></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>type</td>
- <td><a href="#string">string</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The type is the type of an index. </p></td>
+ <td><p> </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Value">Value</h3>
+ <p>The data in setting value.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>unique</td>
- <td><a href="#bool">bool</a></td>
+ <td>string_value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique is whether the index is unique. </p></td>
+ <td><p>Defines this value as being a string value. </p></td>
</tr>
<tr>
- <td>primary</td>
- <td><a href="#bool">bool</a></td>
+ <td>app_im_setting_value</td>
+ <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td>
<td></td>
- <td><p>The primary is whether the index is a primary key index. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>visible</td>
- <td><a href="#bool">bool</a></td>
+ <td>workspace_profile_setting_value</td>
+ <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>
<td></td>
- <td><p>The visible is whether the index is visible. </p></td>
+ <td><p>reserved 4; // was AgentPluginSetting agent_plugin_setting_value </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>workspace_approval_setting_value</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td>
<td></td>
- <td><p>The comment is the comment of an index. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
+ <td>data_classification_setting_value</td>
+ <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td>
<td></td>
- <td><p>The definition of an index. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>parent_index_schema</td>
- <td><a href="#string">string</a></td>
+ <td>semantic_type_setting_value</td>
+ <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>
<td></td>
- <td><p>The schema name of the parent index. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>parent_index_name</td>
- <td><a href="#string">string</a></td>
+ <td>scim_setting</td>
+ <td><a href="#bytebase.v1.SCIMSetting">SCIMSetting</a></td>
<td></td>
- <td><p>The index name of the parent index. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>granularity</td>
- <td><a href="#int64">int64</a></td>
+ <td>password_restriction_setting</td>
+ <td><a href="#bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</a></td>
<td></td>
- <td><p>The number of granules in the block. It&#39;s a ClickHouse specific field. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>is_constraint</td>
- <td><a href="#bool">bool</a></td>
+ <td>ai_setting</td>
+ <td><a href="#bytebase.v1.AISetting">AISetting</a></td>
<td></td>
- <td><p>It&#39;s a PostgreSQL specific field.
-The unique constraint and unique index are not the same thing in PostgreSQL. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>spatial_config</td>
- <td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</a></td>
+ <td>environment_setting</td>
+ <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>
<td></td>
- <td><p>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td>
+ <td><p> </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.WorkspaceApprovalSetting">WorkspaceApprovalSetting</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>opclass_defaults</td>
- <td><a href="#bool">bool</a></td>
+ <td>rules</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</a></td>
<td>repeated</td>
- <td><p>True if the operator class is the default. (PostgreSQL specific). </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -8207,7 +8094,7 @@ Name of the operator class for each column. (PostgreSQL specific). </p></td>
- <h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</h3>
+ <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule">WorkspaceApprovalSetting.Rule</h3>
<p></p>
@@ -8218,76 +8105,52 @@ 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>template</td>
+ <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</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>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_token</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>A page token, received from the previous call.
-Provide this to retrieve the subsequent page.
+ <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
-When paginating, all other parameters provided must match
-the call that provided the page token. </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>view</td>
- <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
+ <td>source</td>
+ <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>
<td></td>
<td><p> </p></td>
</tr>
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The filter of the changelogs.
-follow the
-[ebnf](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
-syntax. Support filter by type, source or table. For example: table =
-&#34;tableExists(&#39;{database}&#39;, &#39;{schema}&#39;, &#39;{table}&#39;)&#34; table =
-&#34;tableExists(&#39;db&#39;, &#39;public&#39;, &#39;table1&#39;) || tableExists(&#39;db&#39;, &#39;public&#39;,
-&#39;table2&#39;)&#34;
-
-The table filter follow the CEL syntax.
-currently, we have one function for CEL:
-- tableExists(database, schema, table): return true if the table exists in
-changed resources.
-
-examples:
-Use
- tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;)
-to filter the changelogs which have the table &#34;table1&#34; in the schema
-&#34;public&#34; of the database &#34;db&#34;. For MySQL, the schema is always &#34;&#34;, such as
-tableExists(&#34;db&#34;, &#34;&#34;, &#34;table1&#34;).
-
-Combine multiple functions with &#34;&amp;&amp;&#34; and &#34;||&#34;, we MUST use the Disjunctive
-Normal Form(DNF). In other words, the CEL expression consists of several
-parts connected by OR operators. For example, the following expression is
-valid:
-(
- tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;) &amp;&amp;
- tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table2&#34;)
-) || (
- tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table3&#34;)
-) </p></td>
- </tr>
-
</tbody>
</table>
@@ -8295,7 +8158,7 @@ valid:
- <h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3>
+ <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3>
<p></p>
@@ -8306,111 +8169,95 @@ valid:
<tbody>
<tr>
- <td>changelogs</td>
- <td><a href="#bytebase.v1.Changelog">Changelog</a></td>
- <td>repeated</td>
- <td><p>The list of changelogs. </p></td>
+ <td>external_url</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The external URL is used for sso authentication callback. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>disallow_signup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>Disallow self-service signup, users can only be invited by the owner. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>require_2fa</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Require 2FA for all users. </p></td>
+ </tr>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>token_duration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
<td></td>
- <td><p>- projects/{project}: list databases in a project, require &#34;bb.projects.get&#34; permission.
-- workspaces/-: list databases in the workspace, require &#34;bb.databases.list&#34; permission.
-- instances/{instances}: list databases in a instance, require &#34;bb.instances.get&#34; permission </p></td>
+ <td><p>The duration for token. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>announcement</td>
+ <td><a href="#bytebase.v1.Announcement">Announcement</a></td>
<td></td>
- <td><p>The maximum number of databases to return. The service may return fewer
-than this value.
-If unspecified, at most 10 databases will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The setting of custom announcement </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>maximum_role_expiration</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</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 max duration for role expired. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>domains</td>
<td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The workspace domain, e.g., bytebase.com. </p></td>
+ </tr>
+
+ <tr>
+ <td>enforce_identity_domain</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Filter is used to filter databases returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
-- name: the database name, support &#34;.matches()&#34; operator.
-- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
-- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
-- engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
-- exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator.
-- drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator.
-- table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator.
-- labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
-
-For example:
-environment == &#34;environments/{environment resource id}&#34;
-environment == &#34;&#34; (find databases which environment is not set)
-project == &#34;projects/{project resource id}&#34;
-instance == &#34;instances/{instance resource id}&#34;
-name.matches(&#34;database name&#34;)
-engine == &#34;MYSQL&#34;
-engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
-!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
-exclude_unassigned == true
-drifted == true
-table == &#34;sample&#34;
-table.matches(&#34;sam&#34;)
-labels.environment == &#34;production&#34;
-labels.region == &#34;asia&#34;
-labels.region in [&#34;asia&#34;, &#34;europe&#34;]
-
-You can combine filter conditions like:
-environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) </p></td>
+ <td><p>Only user and group from the domains can be created and login. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
+ <td>database_change_mode</td>
+ <td><a href="#bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</a></td>
+ <td></td>
+ <td><p>The workspace database change mode. </p></td>
+ </tr>
+
+ <tr>
+ <td>disallow_password_signin</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Show deleted database if specified. </p></td>
+ <td><p>Whether to disallow password signin. (Except workspace admins) </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_metric_collection</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enable metric collection for the workspace. </p></td>
+ </tr>
+
+ <tr>
+ <td>inactive_session_timeout</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_audit_log_stdout</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to enable audit logging to stdout in structured JSON format.
+Requires TEAM or ENTERPRISE license. </p></td>
</tr>
</tbody>
@@ -8420,350 +8267,382 @@ environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee
- <h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3>
+
+
+ <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>OPEN_AI</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>CLAUDE</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>GEMINI</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>AZURE_OPENAI</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>MASK_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INNER</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>OUTER</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3>
+ <p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>ALERT_LEVEL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INFO</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>WARNING</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>CRITICAL</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>DATABASE_CHANGE_MODE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>PIPELINE</td>
+ <td>1</td>
+ <td><p>A more advanced database change process, including custom approval workflows and other advanced features.
+Default to this mode.</p></td>
+ </tr>
+
+ <tr>
+ <td>EDITOR</td>
+ <td>2</td>
+ <td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.Setting.SettingName">Setting.SettingName</h3>
<p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>databases</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
- <td>repeated</td>
- <td><p>The databases from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>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>
-
-
-
-
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>SETTING_NAME_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>AUTH_SECRET</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>BRANDING_LOGO</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>WORKSPACE_ID</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>WORKSPACE_PROFILE</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>WORKSPACE_APPROVAL</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ENTERPRISE_LICENSE</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>APP_IM</td>
+ <td>8</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>WATERMARK</td>
+ <td>9</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>AI</td>
+ <td>10</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DATA_CLASSIFICATION</td>
+ <td>14</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SEMANTIC_TYPES</td>
+ <td>15</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SCIM</td>
+ <td>17</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>PASSWORD_RESTRICTION</td>
+ <td>18</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ENVIRONMENT</td>
+ <td>19</td>
+ <td><p></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><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a materialized view. </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 materialized view. </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 materialized view. </p></td>
- </tr>
-
- <tr>
- <td>dependency_columns</td>
- <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
- <td>repeated</td>
- <td><p>The dependency_columns is the list of dependency columns of a materialized
-view. </p></td>
- </tr>
-
- <tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
- <td>repeated</td>
- <td><p>The columns is the ordered list of columns in a table. </p></td>
- </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>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></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.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><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a package. </p></td>
- </tr>
-
- <tr>
- <td>definition</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The definition is the definition of a package. </p></td>
- </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><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a procedure. </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 procedure. </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
-procedure takes. </p></td>
- </tr>
-
- <tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>MySQL specific metadata. </p></td>
- </tr>
-
- <tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>database_collation</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>sql_mode</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of a procedure. </p></td>
- </tr>
-
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </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>
+ <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 is the schema name.
-It is an empty string for databases without such concept such as MySQL. </p></td>
- </tr>
-
- <tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td>
- <td>repeated</td>
- <td><p>The tables is the list of tables in a schema. </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>
- </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>ListSettings</td>
+ <td>GET</td>
+ <td>/v1/settings</td>
+ <td></td>
+ </tr>
- <tr>
- <td>owner</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner of the schema. </p></td>
- </tr>
+
- <tr>
- <td>sequences</td>
- <td><a href="#bytebase.v1.SequenceMetadata">SequenceMetadata</a></td>
- <td>repeated</td>
- <td><p>The sequences is the list of sequences in a schema, sorted by name. </p></td>
- </tr>
- <tr>
- <td>events</td>
- <td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td>
- <td>repeated</td>
- <td><p>The events is the list of scheduled events in a schema. </p></td>
- </tr>
+ <tr>
+ <td>GetSetting</td>
+ <td>GET</td>
+ <td>/v1/{name=settings/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>enum_types</td>
- <td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td>
- <td>repeated</td>
- <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td>
- </tr>
+
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this schema during schema dump operations. </p></td>
- </tr>
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment is the comment of a schema. </p></td>
- </tr>
+ <tr>
+ <td>UpdateSetting</td>
+ <td>PATCH</td>
+ <td>/v1/{setting.name=settings/*}</td>
+ <td>setting</td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</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>
@@ -8774,94 +8653,11 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>data_type</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The data type of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>start</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The start value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>min_value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The minimum value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>max_value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The maximum value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>increment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Increment value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>cycle</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>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>Cache size of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>last_value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Last value of a sequence. </p></td>
- </tr>
-
- <tr>
- <td>owner_table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner table of the sequence. </p></td>
- </tr>
-
- <tr>
- <td>owner_column</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The owner column of the sequence. </p></td>
- </tr>
-
- <tr>
- <td>comment</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment describing the sequence. </p></td>
- </tr>
-
- <tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether to skip this sequence during schema dump operations. </p></td>
+ <td>repeated</td>
+ <td><p>The user names to retrieve.
+Format: users/{user uid or user email} </p></td>
</tr>
</tbody>
@@ -8871,8 +8667,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.BatchGetUsersResponse">BatchGetUsersResponse</h3>
+ <p></p>
<table class="field-table">
@@ -8882,31 +8678,10 @@ Snowflake. </p></td>
<tbody>
<tr>
- <td>method</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) </p></td>
- </tr>
-
- <tr>
- <td>tessellation</td>
- <td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td>
- <td></td>
- <td><p>Tessellation configuration for grid-based spatial indexes </p></td>
- </tr>
-
- <tr>
- <td>storage</td>
- <td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td>
- <td></td>
- <td><p>Storage and performance configuration </p></td>
- </tr>
-
- <tr>
- <td>dimensional</td>
- <td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td>
- <td></td>
- <td><p>Dimensional configuration </p></td>
+ <td>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>
@@ -8916,112 +8691,46 @@ 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.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>fillfactor</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Fill factor percentage (1-100) </p></td>
- </tr>
-
- <tr>
- <td>buffering</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>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>
+ </thead>
+ <tbody>
<tr>
- <td>maxdop</td>
- <td><a href="#int32">int32</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The user to create. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>data_compression</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>NONE, ROW, PAGE </p></td>
+ <td><p>The name of the user to delete.
+Format: users/{user} </p></td>
</tr>
</tbody>
@@ -9031,7 +8740,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.StreamMetadata">StreamMetadata</h3>
+ <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3>
<p></p>
@@ -9045,56 +8754,114 @@ Snowflake. </p></td>
<td>name</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 name of the user to retrieve.
+Format: users/{user uid or user email} </p></td>
</tr>
- <tr>
- <td>table_name</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>
- </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>owner</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The owner of the stream. </p></td>
+ <td><p>The maximum number of users to return. The service may return fewer than
+this value.
+If unspecified, at most 10 users will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The comment of the stream. </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>type</td>
- <td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The type of the stream. </p></td>
+ <td><p>Show deleted users if specified. </p></td>
</tr>
<tr>
- <td>stale</td>
- <td><a href="#bool">bool</a></td>
+ <td>filter</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>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>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>mode</td>
- <td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td>
- <td></td>
- <td><p>The mode of the stream. </p></td>
+ <td>users</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td>repeated</td>
+ <td><p>The users from the specified request. </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition of the stream. </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>
@@ -9104,7 +8871,7 @@ Snowflake. </p></td>
- <h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3>
+ <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>
<p></p>
@@ -9118,8 +8885,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 deleted user.
+Format: users/{user} </p></td>
</tr>
</tbody>
@@ -9129,17 +8896,10 @@ Format: instances/{instance}/databases/{database} </p></td>
- <h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3>
+ <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</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>
@@ -9147,152 +8907,206 @@ Format: instances/{instance}/databases/{database} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
<td></td>
- <td><p>The name is the name of a table. </p></td>
+ <td><p>The user to update.
+
+The user&#39;s `name` field is used to identify the user to update.
+Format: users/{user} </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>
+ <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>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>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>engine</td>
- <td><a href="#string">string</a></td>
+ <td>regenerate_temp_mfa_secret</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The engine is the engine of a table. </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>collation</td>
- <td><a href="#string">string</a></td>
+ <td>regenerate_recovery_codes</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The collation is the collation of a table. </p></td>
+ <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>
</tr>
<tr>
- <td>charset</td>
+ <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>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.User">User</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The character set of table. </p></td>
+ <td><p>The name of the user.
+Format: users/{user}. {user} is a system-generated unique ID. </p></td>
</tr>
<tr>
- <td>row_count</td>
- <td><a href="#int64">int64</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>The row_count is the estimated number of rows of a table. </p></td>
+ <td><p>The lifecycle state of the user account. </p></td>
</tr>
<tr>
- <td>data_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>email</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 email address of the user, used for login and notifications. </p></td>
</tr>
<tr>
- <td>index_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>title</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>The display title or full name of the user. </p></td>
</tr>
<tr>
- <td>data_free</td>
- <td><a href="#int64">int64</a></td>
+ <td>user_type</td>
+ <td><a href="#bytebase.v1.UserType">UserType</a></td>
<td></td>
- <td><p>The data_free is the estimated free data size of a table. </p></td>
+ <td><p>The type of user account. </p></td>
</tr>
<tr>
- <td>create_options</td>
+ <td>password</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><p>The password for authentication. Only used during user creation or password updates. </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>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>mfa_enabled</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment is the comment of a table. </p></td>
+ <td><p>The mfa_enabled flag means if the user has enabled MFA. </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>
+ <td>temp_otp_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Temporary OTP secret used during MFA setup and regeneration. </p></td>
</tr>
<tr>
- <td>partitions</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
+ <td>temp_recovery_codes</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The partitions is the list of partitions in a table. </p></td>
+ <td><p>Temporary recovery codes used during MFA setup and regeneration. </p></td>
</tr>
<tr>
- <td>check_constraints</td>
- <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
- <td>repeated</td>
- <td><p>The check_constraints is the list of check constraints in a table. </p></td>
+ <td>temp_otp_secret_created_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </p></td>
</tr>
<tr>
- <td>owner</td>
+ <td>phone</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The owner of the table. </p></td>
+ <td><p>Should be a valid E.164 compliant phone number.
+Could be empty. </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>profile</td>
+ <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td>
+ <td></td>
+ <td><p>User profile metadata. </p></td>
</tr>
<tr>
- <td>triggers</td>
- <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>groups</td>
+ <td><a href="#string">string</a></td>
<td>repeated</td>
- <td><p>The triggers is the list of triggers associated with the table. </p></td>
+ <td><p>The groups for the user.
+Format: groups/{email} </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>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>last_login_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>Whether to skip this table during schema dump operations. </p></td>
+ <td><p>The last time the user successfully logged in. </p></td>
</tr>
<tr>
- <td>sharding_info</td>
- <td><a href="#string">string</a></td>
+ <td>last_change_password_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td>
+ <td><p>The last time the user changed their password. </p></td>
</tr>
<tr>
- <td>primary_key_type</td>
+ <td>source</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>source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td>
</tr>
</tbody>
@@ -9302,100 +9116,234 @@ 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.UserType">UserType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>USER_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified user type.</p></td>
+ </tr>
+
+ <tr>
+ <td>USER</td>
+ <td>1</td>
+ <td><p>Regular human user account.</p></td>
+ </tr>
+
+ <tr>
+ <td>SYSTEM_BOT</td>
+ <td>2</td>
+ <td><p>System-managed bot account for automated operations.</p></td>
+ </tr>
+
+ <tr>
+ <td>SERVICE_ACCOUNT</td>
+ <td>3</td>
+ <td><p>Service account for API integrations.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.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.
+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>
+
+ </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>GetUser</td>
+ <td>GET</td>
+ <td>/v1/{name=users/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchGetUsers</td>
+ <td>GET</td>
+ <td>/v1/users:batchGet</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>GetCurrentUser</td>
+ <td>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>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name is the name of a table partition. </p></td>
- </tr>
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td>
- <td></td>
- <td><p>The type of a table partition. </p></td>
- </tr>
+ <tr>
+ <td>CreateUser</td>
+ <td>POST</td>
+ <td>/v1/users</td>
+ <td>user</td>
+ </tr>
- <tr>
- <td>expression</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>
- </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>UpdateUser</td>
+ <td>PATCH</td>
+ <td>/v1/{user.name=users/*}</td>
+ <td>user</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>
+ <tr>
+ <td>DeleteUser</td>
+ <td>DELETE</td>
+ <td>/v1/{name=users/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UndeleteUser</td>
+ <td>POST</td>
+ <td>/v1/{name=users/*}:undelete</td>
+ <td>*</td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.TaskMetadata">TaskMetadata</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">
@@ -9405,242 +9353,164 @@ in syntax [SUB]PARTITION {number}. </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 task. </p></td>
- </tr>
-
- <tr>
- <td>id</td>
+ <td>version</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 Bytebase server version. </p></td>
</tr>
<tr>
- <td>owner</td>
+ <td>git_commit</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The owner of the task. </p></td>
+ <td><p>The git commit hash of the build. </p></td>
</tr>
<tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
+ <td>readonly</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment of the task. </p></td>
+ <td><p>Whether the Bytebase instance is running in read-only mode. </p></td>
</tr>
<tr>
- <td>warehouse</td>
- <td><a href="#string">string</a></td>
+ <td>saas</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The warehouse of the task. </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>schedule</td>
- <td><a href="#string">string</a></td>
+ <td>demo</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The schedule interval of the task. </p></td>
+ <td><p>Whether the Bytebase instance is running in demo mode. </p></td>
</tr>
<tr>
- <td>predecessors</td>
+ <td>host</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 host address of the Bytebase instance. </p></td>
</tr>
<tr>
- <td>condition</td>
+ <td>port</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The condition of the task. </p></td>
+ <td><p>The port number of the Bytebase instance. </p></td>
</tr>
<tr>
- <td>definition</td>
+ <td>external_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The definition of the task. </p></td>
+ <td><p>The external URL where users or webhook callbacks access Bytebase. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TessellationConfig">TessellationConfig</h3>
- <p>TessellationConfig defines tessellation 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>scheme</td>
- <td><a href="#string">string</a></td>
+ <td>need_admin_setup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) </p></td>
- </tr>
-
- <tr>
- <td>grid_levels</td>
- <td><a href="#bytebase.v1.GridLevel">GridLevel</a></td>
- <td>repeated</td>
- <td><p>Grid levels and densities for multi-level tessellation </p></td>
+ <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>
</tr>
<tr>
- <td>cells_per_object</td>
- <td><a href="#int32">int32</a></td>
+ <td>disallow_signup</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Number of cells per object (1-8192 for SQL Server) </p></td>
+ <td><p>Whether self-service user signup is disabled. </p></td>
</tr>
<tr>
- <td>bounding_box</td>
- <td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td>
+ <td>last_active_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td>
+ <td><p>The last time any API call was made, refreshed on each request. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3>
- <p></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>require_2fa</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name is the name of the trigger. </p></td>
+ <td><p>Whether two-factor authentication is required for all users. </p></td>
</tr>
<tr>
- <td>event</td>
+ <td>workspace_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The event is the event of the trigger, such as INSERT, UPDATE, DELETE,
-TRUNCATE. </p></td>
+ <td><p>The unique identifier for the workspace. </p></td>
</tr>
<tr>
- <td>timing</td>
- <td><a href="#string">string</a></td>
+ <td>debug</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>Whether debug mode is enabled. </p></td>
</tr>
<tr>
- <td>body</td>
+ <td>unlicensed_features</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p>The body is the body of the trigger. </p></td>
+ <td>repeated</td>
+ <td><p>List of features that are not licensed. </p></td>
</tr>
<tr>
- <td>sql_mode</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 SQL mode setting for the trigger. </p></td>
+ <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td>
</tr>
<tr>
- <td>character_set_client</td>
- <td><a href="#string">string</a></td>
+ <td>password_restriction</td>
+ <td><a href="#bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</a></td>
<td></td>
- <td><p>The character set used by the client creating the trigger. </p></td>
+ <td><p>Password complexity and restriction requirements. </p></td>
</tr>
<tr>
- <td>collation_connection</td>
- <td><a href="#string">string</a></td>
+ <td>docker</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The collation used for the connection when creating the trigger. </p></td>
+ <td><p>Whether the Bytebase instance is running in Docker. </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>
+ <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>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>activated_instance_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Whether to skip this trigger during schema dump operations. </p></td>
+ <td><p>The number of activated database instances. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3>
- <p></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</td>
- <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>total_instance_count</td>
+ <td><a href="#int32">int32</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 total number of database instances. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>enable_sample</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>Whether sample data setup is enabled. </p></td>
</tr>
<tr>
- <td>allow_missing</td>
+ <td>external_url_from_flag</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>
+ <td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </p></td>
</tr>
</tbody>
@@ -9650,8 +9520,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.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>
+ <p>User statistics by type and state.</p>
<table class="field-table">
@@ -9661,52 +9531,24 @@ In this situation, `update_mask` is ignored. </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 view. </p></td>
- </tr>
-
- <tr>
- <td>definition</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 definition is the definition of a view. </p></td>
+ <td><p>The type of user. </p></td>
</tr>
<tr>
- <td>comment</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 comment is the comment of a view. </p></td>
- </tr>
-
- <tr>
- <td>dependency_columns</td>
- <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
- <td>repeated</td>
- <td><p>The dependency_columns is the list of dependency columns of a view. </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>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><p>The state of the user. </p></td>
</tr>
<tr>
- <td>skip_dump</td>
- <td><a href="#bool">bool</a></td>
+ <td>count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The count of users matching this type and state. </p></td>
</tr>
</tbody>
@@ -9716,689 +9558,727 @@ In this situation, `update_mask` is ignored. </p></td>
+ <h3 id="bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</h3>
+ <p>Request message for deleting cache.</p>
+
+
+
- <h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PENDING</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DONE</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FAILED</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Changelog.Type">Changelog.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>BASELINE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>MIGRATE</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SDL</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</h3>
+ <p>Request message for getting actuator information.</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>
- </thead>
- <tbody>
-
- <tr>
- <td>CHANGELOG_VIEW_UNSPECIFIED</td>
- <td>0</td>
- <td><p>The default / unset value.
-The API will default to the BASIC view.</p></td>
- </tr>
-
- <tr>
- <td>CHANGELOG_VIEW_BASIC</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CHANGELOG_VIEW_FULL</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</h3>
+ <p>Request message for getting branding resources.</p>
+
+
+
+
- <h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>IDENTITY_GENERATION_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>ALWAYS</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>BY_DEFAULT</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.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>logo</td>
+ <td><a href="#bytes">bytes</a></td>
+ <td></td>
+ <td><p>The branding logo. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>VIRTUAL</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>STORED</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>
+ <p>Request message for setting up sample data.</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>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SDL_FORMAT_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified format. Defaults to SINGLE_FILE.</p></td>
- </tr>
-
- <tr>
- <td>SINGLE_FILE</td>
- <td>1</td>
- <td><p>Single file format: returns the complete SDL schema as a single file.</p></td>
- </tr>
-
- <tr>
- <td>MULTI_FILE</td>
- <td>2</td>
- <td><p>Multi-file format: returns the SDL schema as a ZIP archive containing
-multiple files organized by schema objects (tables, views, functions, etc.).</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</h3>
+ <p>Request message for updating actuator information.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>actuator</td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td></td>
+ <td><p>The actuator to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If set to true, and the actuator is not found, a new actuator will be created.
+In this situation, `update_mask` is ignored. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.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>OBJECT_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DATABASE</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SCHEMA</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>TABLE</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>VIEW</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>MATERIALIZED_VIEW</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FUNCTION</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PROCEDURE</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SEQUENCE</td>
- <td>8</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
- <h3 id="bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>MODE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DEFAULT</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>APPEND_ONLY</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>INSERT_ONLY</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
- <h3 id="bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DELTA</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
- <h3 id="bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</h3>
- <p>Type is the type of a table partition, some database engines may not</p><p>support all types. Only avilable for the following database engines now:</p><p>MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,</p><p>LINEAR_KEY</p><p>(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:</p><p>RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,</p><p>LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)</p>
+ <h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>
+ <p>ActuatorService manages system health and operational information.</p>
<table class="enum-table">
<thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
+ <tbody>
<tr>
- <td>RANGE</td>
- <td>1</td>
- <td><p></p></td>
+ <td>GetActuatorInfo</td>
+ <td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td><p>Gets system information and health status of the Bytebase instance.
+Permissions required: None</p></td>
</tr>
<tr>
- <td>RANGE_COLUMNS</td>
- <td>2</td>
- <td><p></p></td>
+ <td>UpdateActuatorInfo</td>
+ <td><a href="#bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</a></td>
+ <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <td><p>Updates system configuration settings for the Bytebase instance.
+Permissions required: bb.settings.set</p></td>
</tr>
<tr>
- <td>LIST</td>
- <td>3</td>
- <td><p></p></td>
+ <td>SetupSample</td>
+ <td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Sets up sample data for demonstration and testing purposes.
+Permissions required: bb.projects.create</p></td>
</tr>
<tr>
- <td>LIST_COLUMNS</td>
- <td>4</td>
- <td><p></p></td>
+ <td>DeleteCache</td>
+ <td><a href="#bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Clears the system cache to force data refresh.
+Permissions required: None</p></td>
</tr>
<tr>
- <td>HASH</td>
- <td>5</td>
- <td><p></p></td>
+ <td>GetResourcePackage</td>
+ <td><a href="#bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</a></td>
+ <td><a href="#bytebase.v1.ResourcePackage">ResourcePackage</a></td>
+ <td><p>Gets custom branding resources such as logos.
+Permissions required: None</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>LINEAR_HASH</td>
- <td>6</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>KEY</td>
- <td>7</td>
- <td><p></p></td>
+ <td>GetActuatorInfo</td>
+ <td>GET</td>
+ <td>/v1/actuator/info</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>LINEAR_KEY</td>
- <td>8</td>
- <td><p></p></td>
+ <td>UpdateActuatorInfo</td>
+ <td>PATCH</td>
+ <td>/v1/actuator/info</td>
+ <td>actuator</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>
+ <td>SetupSample</td>
+ <td>POST</td>
+ <td>/v1/actuator:setupSample</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>STARTED</td>
- <td>1</td>
- <td><p></p></td>
+ <td>DeleteCache</td>
+ <td>DELETE</td>
+ <td>/v1/actuator/cache</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>SUSPENDED</td>
- <td>2</td>
- <td><p></p></td>
+ <td>GetResourcePackage</td>
+ <td>GET</td>
+ <td>/v1/actuator/resources</td>
+ <td></td>
</tr>
+
- </tbody>
- </table>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/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>
+
+
+ <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 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>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>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>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>
+ </table>
+
+
+
+
+ <h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>
+ <p>Request message for exporting 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>parent</td>
+ <td><a href="#string">string</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.
+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.
+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.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>
+ <p>Response message for exporting 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>content</td>
+ <td><a href="#bytes">bytes</a></td>
+ <td></td>
+ <td><p>The exported audit log content in the requested format. </p></td>
+ </tr>
+
+ <tr>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token to retrieve next page of log entities.
+Pass this value in the page_token field in the subsequent call
+to retrieve the next page of log entities. </p></td>
+ </tr>
+
+ </tbody>
+ </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>
+ <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>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><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>
+ </tr>
+
+ </tbody>
+ </table>
+
+
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+
+ <h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>
+ <p>Request message for searching audit logs.</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>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>GetDatabase</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*}</td>
- <td></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></td>
+ <td><p>The order by of the log.
+Only support order by create_time.
+For example:
+ - order_by = &#34;create_time asc&#34;
+ - order_by = &#34;create_time desc&#34; </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 `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>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>
+ <p>Severity level for audit log entries.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>BatchGetDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/databases:batchGet</td>
- <td></td>
+ <td>SEVERITY_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified severity level.</p></td>
</tr>
-
+
<tr>
- <td>BatchGetDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/databases:batchGet</td>
- <td></td>
+ <td>DEBUG</td>
+ <td>1</td>
+ <td><p>Debug-level information.</p></td>
</tr>
-
-
-
<tr>
- <td>ListDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/databases</td>
- <td></td>
+ <td>INFO</td>
+ <td>2</td>
+ <td><p>Informational messages.</p></td>
</tr>
-
+
<tr>
- <td>ListDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=instances/*}/databases</td>
- <td></td>
+ <td>NOTICE</td>
+ <td>3</td>
+ <td><p>Notable events.</p></td>
</tr>
-
+
<tr>
- <td>ListDatabases</td>
- <td>GET</td>
- <td>/v1/{parent=workspaces/*}/databases</td>
- <td></td>
+ <td>WARNING</td>
+ <td>4</td>
+ <td><p>Warning conditions.</p></td>
</tr>
-
-
-
<tr>
- <td>UpdateDatabase</td>
- <td>PATCH</td>
- <td>/v1/{database.name=instances/*/databases/*}</td>
- <td>database</td>
+ <td>ERROR</td>
+ <td>5</td>
+ <td><p>Error conditions.</p></td>
</tr>
-
-
-
<tr>
- <td>BatchUpdateDatabases</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*}/databases:batchUpdate</td>
- <td>*</td>
+ <td>CRITICAL</td>
+ <td>6</td>
+ <td><p>Critical conditions.</p></td>
</tr>
-
-
-
<tr>
- <td>SyncDatabase</td>
- <td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:sync</td>
- <td>*</td>
+ <td>ALERT</td>
+ <td>7</td>
+ <td><p>Action must be taken immediately.</p></td>
</tr>
-
-
-
<tr>
- <td>BatchSyncDatabases</td>
- <td>POST</td>
- <td>/v1/{parent=instances/*}/databases:batchSync</td>
- <td>*</td>
+ <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>GetDatabaseMetadata</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/metadata}</td>
- <td></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>GetDatabaseSchema</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/schema}</td>
- <td></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>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>GetDatabaseSDLSchema</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/sdlSchema}</td>
- <td></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
-
+ </thead>
+ <tbody>
<tr>
- <td>DiffSchema</td>
+ <td>SearchAuditLogs</td>
<td>POST</td>
- <td>/v1/{name=instances/*/databases/*}:diffSchema</td>
+ <td>/v1/{parent=projects/*}/auditLogs:search</td>
<td>*</td>
</tr>
<tr>
- <td>DiffSchema</td>
+ <td>SearchAuditLogs</td>
<td>POST</td>
- <td>/v1/{name=instances/*/databases/*/changelogs/*}:diffSchema</td>
+ <td>/v1/auditLogs:search</td>
<td>*</td>
</tr>
@@ -10406,30 +10286,17 @@ Permissions required: bb.databases.getSchema</p></td>
<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>
+ <td>ExportAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/auditLogs:export</td>
+ <td>*</td>
</tr>
-
-
-
<tr>
- <td>GetSchemaString</td>
- <td>GET</td>
- <td>/v1/{name=instances/*/databases/*/schemaString}</td>
- <td></td>
+ <td>ExportAuditLogs</td>
+ <td>POST</td>
+ <td>/v1/auditLogs:export</td>
+ <td>*</td>
</tr>
@@ -10440,13 +10307,13 @@ Permissions required: bb.databases.getSchema</p></td>
<div class="file-heading">
- <h2 id="v1/issue_service.proto">v1/issue_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.ApprovalFlow">ApprovalFlow</h3>
- <p></p>
+ <h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>
+ <p>Context for identity provider authentication.</p>
<table class="field-table">
@@ -10456,10 +10323,17 @@ Permissions required: bb.databases.getSchema</p></td>
<tbody>
<tr>
- <td>roles</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The roles required for approval in order. </p></td>
+ <td>oauth2_context</td>
+ <td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td>
+ <td></td>
+ <td><p>OAuth2 authentication context. </p></td>
+ </tr>
+
+ <tr>
+ <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>
@@ -10469,7 +10343,7 @@ Permissions required: bb.databases.getSchema</p></td>
- <h3 id="bytebase.v1.ApprovalTemplate">ApprovalTemplate</h3>
+ <h3 id="bytebase.v1.LoginRequest">LoginRequest</h3>
<p></p>
@@ -10480,24 +10354,60 @@ Permissions required: bb.databases.getSchema</p></td>
<tbody>
<tr>
- <td>flow</td>
- <td><a href="#bytebase.v1.ApprovalFlow">ApprovalFlow</a></td>
+ <td>email</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The approval flow definition. </p></td>
+ <td><p>User&#39;s email address. </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>password</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the approval template. </p></td>
+ <td><p>User&#39;s password for authentication. </p></td>
</tr>
<tr>
- <td>description</td>
+ <td>web</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>If web is set, we will set access token, refresh token, and user to the cookie. </p></td>
+ </tr>
+
+ <tr>
+ <td>idp_name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The description of the approval template. </p></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 using 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>
@@ -10507,7 +10417,7 @@ Permissions required: bb.databases.getSchema</p></td>
- <h3 id="bytebase.v1.ApproveIssueRequest">ApproveIssueRequest</h3>
+ <h3 id="bytebase.v1.LoginResponse">LoginResponse</h3>
<p></p>
@@ -10518,18 +10428,31 @@ Permissions required: bb.databases.getSchema</p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>token</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>Access token for authenticated requests. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>mfa_temp_token</td>
<td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>Temporary token for MFA verification. </p></td>
+ </tr>
+
+ <tr>
+ <td>require_reset_password</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The comment explaining the approval decision. </p></td>
+ <td><p>Whether user must reset password before continuing. </p></td>
+ </tr>
+
+ <tr>
+ <td>user</td>
+ <td><a href="#bytebase.v1.User">User</a></td>
+ <td></td>
+ <td><p>The user from the successful login. </p></td>
</tr>
</tbody>
@@ -10539,8 +10462,15 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.BatchUpdateIssuesStatusRequest">BatchUpdateIssuesStatusRequest</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">
@@ -10550,53 +10480,125 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>code</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>
+ <td><p>Authorization code from OAuth2 provider. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</h3>
+ <p>OpenID Connect authentication context.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>issues</td>
+ <td>code</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>
+ <td></td>
+ <td><p>Authorization code from OIDC provider. </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>
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+ <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>
+
+ </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>Login</td>
+ <td>POST</td>
+ <td>/v1/auth/login</td>
+ <td>*</td>
+ </tr>
+
+
- <tr>
- <td>reason</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The reason for the status change. </p></td>
- </tr>
+ <tr>
+ <td>Logout</td>
+ <td>POST</td>
+ <td>/v1/auth/logout</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.BatchUpdateIssuesStatusResponse">BatchUpdateIssuesStatusResponse</h3>
- <p></p>
-
-
+ <div class="file-heading">
+ <h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
-
- <h3 id="bytebase.v1.CreateIssueCommentRequest">CreateIssueCommentRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>
+ <p>Request message for batch deparsing CEL expressions.</p>
<table class="field-table">
@@ -10606,18 +10608,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 issue name
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>issue_comment</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td></td>
- <td><p>The comment to create. </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>
@@ -10627,8 +10621,8 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.CreateIssueRequest">CreateIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>
+ <p>Response message for batch deparsing CEL expressions.</p>
<table class="field-table">
@@ -10638,18 +10632,10 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>expressions</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>issue</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td></td>
- <td><p>The issue to create. </p></td>
+ <td>repeated</td>
+ <td><p>The deparsed CEL expressions as strings. </p></td>
</tr>
</tbody>
@@ -10659,8 +10645,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.GetIssueRequest">GetIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>
+ <p>Request message for batch parsing CEL expressions.</p>
<table class="field-table">
@@ -10670,18 +10656,10 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>expressions</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>
- </tr>
-
- <tr>
- <td>force</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 CEL expression strings to parse. </p></td>
</tr>
</tbody>
@@ -10691,8 +10669,8 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.GrantRequest">GrantRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>
+ <p>Response message for batch parsing CEL expressions.</p>
<table class="field-table">
@@ -10702,33 +10680,10 @@ Format: projects/{project}/issues/{issue} </p></td>
<tbody>
<tr>
- <td>role</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The requested role.
-Format: roles/EXPORTER. </p></td>
- </tr>
-
- <tr>
- <td>user</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The user to be granted.
-Format: users/{email}. </p></td>
- </tr>
-
- <tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td>
- </tr>
-
- <tr>
- <td>expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
- <td></td>
- <td><p>The duration for which the grant is valid. </p></td>
+ <td>expressions</td>
+ <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>repeated</td>
+ <td><p>The parsed CEL expressions as AST. </p></td>
</tr>
</tbody>
@@ -10738,166 +10693,129 @@ Format: users/{email}. </p></td>
- <h3 id="bytebase.v1.Issue">Issue</h3>
- <p></p>
+
+
+
+
+
+
+ <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>
- <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 issue.
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The title of the issue. </p></td>
- </tr>
-
- <tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The description of the issue. </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Issue.Type">Issue.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td></td>
- <td><p>The status of the issue. </p></td>
- </tr>
-
- <tr>
- <td>approvers</td>
- <td><a href="#bytebase.v1.Issue.Approver">Issue.Approver</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>approval_template</td>
- <td><a href="#bytebase.v1.ApprovalTemplate">ApprovalTemplate</a></td>
- <td></td>
- <td><p>The approval template for the issue. </p></td>
- </tr>
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Format: users/[email protected] </p></td>
- </tr>
+ <tr>
+ <td>BatchParse</td>
+ <td>POST</td>
+ <td>/v1/cel/batchParse</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>plan</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The plan associated with the issue.
-Can be empty.
-Format: projects/{project}/plans/{plan} </p></td>
- </tr>
+ <tr>
+ <td>BatchDeparse</td>
+ <td>POST</td>
+ <td>/v1/cel/batchDeparse</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>rollout</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The rollout associated with the issue.
-Can be empty.
-Format: projects/{project}/rollouts/{rollout} </p></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>grant_request</td>
- <td><a href="#bytebase.v1.GrantRequest">GrantRequest</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Used if the issue type is GRANT_REQUEST. </p></td>
+ <td><p>The column name. </p></td>
</tr>
<tr>
- <td>releasers</td>
+ <td>semantic_type</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The releasers of the pending stage of the issue rollout, judging
-from the rollout policy.
-Format:
-- roles/workspaceOwner
-- roles/workspaceDBA
-- roles/projectOwner
-- roles/projectReleaser </p></td>
- </tr>
-
- <tr>
- <td>risk_level</td>
- <td><a href="#bytebase.v1.RiskLevel">RiskLevel</a></td>
<td></td>
- <td><p>The risk level of the issue. </p></td>
- </tr>
-
- <tr>
- <td>task_status_count</td>
- <td><a href="#bytebase.v1.Issue.TaskStatusCountEntry">Issue.TaskStatusCountEntry</a></td>
- <td>repeated</td>
- <td><p>The status count of the issue.
-Keys are the following:
-- NOT_STARTED
-- SKIPPED
-- PENDING
-- RUNNING
-- DONE
-- FAILED
-- CANCELED </p></td>
+ <td><p>The semantic type describing the data purpose. </p></td>
</tr>
<tr>
<td>labels</td>
- <td><a href="#string">string</a></td>
+ <td><a href="#bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</a></td>
<td>repeated</td>
- <td><p>Labels attached to the issue for categorization and filtering. </p></td>
+ <td><p>User-defined labels for this column. </p></td>
</tr>
<tr>
- <td>approval_status</td>
- <td><a href="#bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</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>approval_status_error</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Only populated when approval_status == ERROR </p></td>
+ <td>object_schema</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td>optional</td>
+ <td><p>Object schema for complex column types like JSON. </p></td>
</tr>
</tbody>
@@ -10907,8 +10825,8 @@ Keys are the following:
- <h3 id="bytebase.v1.Issue.Approver">Issue.Approver</h3>
- <p>Approvers and their approval status for the issue.</p>
+ <h3 id="bytebase.v1.ColumnCatalog.LabelsEntry">ColumnCatalog.LabelsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -10918,17 +10836,17 @@ Keys are the following:
<tbody>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The new status. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>principal</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: users/[email protected] </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -10938,8 +10856,8 @@ Keys are the following:
- <h3 id="bytebase.v1.Issue.TaskStatusCountEntry">Issue.TaskStatusCountEntry</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">
@@ -10949,17 +10867,18 @@ Keys are the following:
<tbody>
<tr>
- <td>key</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the database catalog.
+Format: instances/{instance}/databases/{database}/catalog </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>schemas</td>
+ <td><a href="#bytebase.v1.SchemaCatalog">SchemaCatalog</a></td>
+ <td>repeated</td>
+ <td><p>The schemas in the database. </p></td>
</tr>
</tbody>
@@ -10969,8 +10888,8 @@ Keys are the following:
- <h3 id="bytebase.v1.IssueComment">IssueComment</h3>
- <p>A comment on an issue.</p>
+ <h3 id="bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</h3>
+ <p>Request message for getting a database catalog.</p>
<table class="field-table">
@@ -10983,77 +10902,53 @@ Keys are the following:
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{project}/issues/{issue}/issueComments/{issueComment-uid} </p></td>
+ <td><p>The name of the database catalog to retrieve.
+Format: instances/{instance}/databases/{database}/catalog </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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ObjectSchema">ObjectSchema</h3>
+ <p>Schema definition for object-type columns.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>payload</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>TODO: use struct message instead. </p></td>
+ <td><p>The data type of this object. </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>struct_kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Struct schema. </p></td>
</tr>
<tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>array_kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Array schema. </p></td>
</tr>
<tr>
- <td>creator</td>
+ <td>semantic_type</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>stage_end</td>
- <td><a href="#bytebase.v1.IssueComment.StageEnd">IssueComment.StageEnd</a></td>
- <td></td>
- <td><p>Stage end event. </p></td>
- </tr>
-
- <tr>
- <td>task_update</td>
- <td><a href="#bytebase.v1.IssueComment.TaskUpdate">IssueComment.TaskUpdate</a></td>
- <td></td>
- <td><p>Task update event. </p></td>
- </tr>
-
- <tr>
- <td>task_prior_backup</td>
- <td><a href="#bytebase.v1.IssueComment.TaskPriorBackup">IssueComment.TaskPriorBackup</a></td>
- <td></td>
- <td><p>Task prior backup event. </p></td>
+ <td><p>The semantic type of this object. </p></td>
</tr>
</tbody>
@@ -11063,8 +10958,8 @@ Keys are the following:
- <h3 id="bytebase.v1.IssueComment.Approval">IssueComment.Approval</h3>
- <p>Approval event information.</p>
+ <h3 id="bytebase.v1.ObjectSchema.ArrayKind">ObjectSchema.ArrayKind</h3>
+ <p>Array type with element schema.</p>
<table class="field-table">
@@ -11074,10 +10969,10 @@ Keys are the following:
<tbody>
<tr>
- <td>status</td>
- <td><a href="#bytebase.v1.IssueComment.Approval.Status">IssueComment.Approval.Status</a></td>
+ <td>kind</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>The approval status. </p></td>
+ <td><p>The schema of array elements. </p></td>
</tr>
</tbody>
@@ -11086,70 +10981,52 @@ Keys are the following:
-
- <h3 id="bytebase.v1.IssueComment.IssueUpdate">IssueComment.IssueUpdate</h3>
- <p>Issue update event information.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>from_title</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>to_title</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>from_description</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>to_description</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
+
+ <h3 id="bytebase.v1.ObjectSchema.StructKind">ObjectSchema.StructKind</h3>
+ <p>Structure type with named properties.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>from_status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td>optional</td>
- <td><p> </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>
- <tr>
- <td>to_status</td>
- <td><a href="#bytebase.v1.IssueStatus">IssueStatus</a></td>
- <td>optional</td>
- <td><p> </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ObjectSchema.StructKind.PropertiesEntry">ObjectSchema.StructKind.PropertiesEntry</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>from_labels</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
+ <td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>to_labels</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
+ <td>value</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
@@ -11160,8 +11037,8 @@ Keys are the following:
- <h3 id="bytebase.v1.IssueComment.StageEnd">IssueComment.StageEnd</h3>
- <p>Stage end event information.</p>
+ <h3 id="bytebase.v1.SchemaCatalog">SchemaCatalog</h3>
+ <p>Schema metadata within a database.</p>
<table class="field-table">
@@ -11171,10 +11048,17 @@ Keys are the following:
<tbody>
<tr>
- <td>stage</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The stage that ended. </p></td>
+ <td><p>The schema name. </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>
</tr>
</tbody>
@@ -11184,8 +11068,8 @@ Keys are the following:
- <h3 id="bytebase.v1.IssueComment.TaskPriorBackup">IssueComment.TaskPriorBackup</h3>
- <p>Task prior backup event information.</p>
+ <h3 id="bytebase.v1.TableCatalog">TableCatalog</h3>
+ <p>Table metadata within a schema.</p>
<table class="field-table">
@@ -11195,38 +11079,31 @@ Keys are the following:
<tbody>
<tr>
- <td>task</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The task for which backup was performed. </p></td>
- </tr>
-
- <tr>
- <td>tables</td>
- <td><a href="#bytebase.v1.IssueComment.TaskPriorBackup.Table">IssueComment.TaskPriorBackup.Table</a></td>
- <td>repeated</td>
- <td><p>The tables that were backed up. </p></td>
+ <td><p>The table name. </p></td>
</tr>
<tr>
- <td>original_line</td>
- <td><a href="#int32">int32</a></td>
- <td>optional</td>
- <td><p>The original line number in the statement. </p></td>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</a></td>
+ <td></td>
+ <td><p>Regular table columns. </p></td>
</tr>
<tr>
- <td>database</td>
- <td><a href="#string">string</a></td>
+ <td>object_schema</td>
+ <td><a href="#bytebase.v1.ObjectSchema">ObjectSchema</a></td>
<td></td>
- <td><p>The database that was backed up. </p></td>
+ <td><p>Object schema for JSON/XML columns. </p></td>
</tr>
<tr>
- <td>error</td>
+ <td>classification</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Error message if backup failed. </p></td>
+ <td><p>The data classification level for this table. </p></td>
</tr>
</tbody>
@@ -11236,8 +11113,8 @@ Keys are the following:
- <h3 id="bytebase.v1.IssueComment.TaskPriorBackup.Table">IssueComment.TaskPriorBackup.Table</h3>
- <p>Table identification.</p>
+ <h3 id="bytebase.v1.TableCatalog.Columns">TableCatalog.Columns</h3>
+ <p>Column list for regular tables.</p>
<table class="field-table">
@@ -11247,17 +11124,10 @@ Keys are the following:
<tbody>
<tr>
- <td>schema</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The schema name. </p></td>
- </tr>
-
- <tr>
- <td>table</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The table name. </p></td>
+ <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>
@@ -11267,8 +11137,8 @@ Keys are the following:
- <h3 id="bytebase.v1.IssueComment.TaskUpdate">IssueComment.TaskUpdate</h3>
- <p>Task update event information.</p>
+ <h3 id="bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</h3>
+ <p>Request message for updating a database catalog.</p>
<table class="field-table">
@@ -11278,42 +11148,159 @@ Keys are the following:
<tbody>
<tr>
- <td>tasks</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The tasks that were updated. </p></td>
+ <td>catalog</td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</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>
</tr>
<tr>
- <td>from_sheet</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
+ <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>
</tr>
- <tr>
- <td>to_sheet</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Format: projects/{project}/sheets/{sheet} </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+ <h3 id="bytebase.v1.ObjectSchema.Type">ObjectSchema.Type</h3>
+ <p>Object schema data types.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified type.</p></td>
+ </tr>
+
+ <tr>
+ <td>STRING</td>
+ <td>1</td>
+ <td><p>String type.</p></td>
+ </tr>
+
+ <tr>
+ <td>NUMBER</td>
+ <td>2</td>
+ <td><p>Number type.</p></td>
+ </tr>
+
+ <tr>
+ <td>BOOLEAN</td>
+ <td>3</td>
+ <td><p>Boolean type.</p></td>
+ </tr>
+
+ <tr>
+ <td>OBJECT</td>
+ <td>4</td>
+ <td><p>Object/struct type.</p></td>
+ </tr>
+
+ <tr>
+ <td>ARRAY</td>
+ <td>5</td>
+ <td><p>Array type.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DatabaseCatalogService">DatabaseCatalogService</h3>
+ <p>DatabaseCatalogService manages database schema metadata and classification.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>GetDatabaseCatalog</td>
+ <td><a href="#bytebase.v1.GetDatabaseCatalogRequest">GetDatabaseCatalogRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td><p>Gets the catalog metadata for a database.
+Permissions required: bb.databaseCatalogs.get</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateDatabaseCatalog</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseCatalogRequest">UpdateDatabaseCatalogRequest</a></td>
+ <td><a href="#bytebase.v1.DatabaseCatalog">DatabaseCatalog</a></td>
+ <td><p>Updates catalog metadata such as classifications and labels.
+Permissions required: bb.databaseCatalogs.update</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
+
+
+ <tr>
+ <td>GetDatabaseCatalog</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*/databases/*/catalog}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>to_status</td>
- <td><a href="#bytebase.v1.IssueComment.TaskUpdate.Status">IssueComment.TaskUpdate.Status</a></td>
- <td>optional</td>
- <td><p> </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.ListIssueCommentsRequest">ListIssueCommentsRequest</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">
@@ -11326,60 +11313,33 @@ Keys are the following:
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Format: projects/{projects}/issues/{issue} </p></td>
+ <td><p>The parent resource where this database group will be created.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>database_group</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</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 database group to create. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>database_group_id</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>
+ <td><p>The ID to use for the database group, which will become the final component of
+the database group&#39;s resource name.
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <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>
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>If set, validate the create request and preview the full database group response, but do not actually create it. </p></td>
</tr>
</tbody>
@@ -11389,8 +11349,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.ListIssuesRequest">ListIssuesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>
+ <p>A group of databases matched by expressions.</p>
<table class="field-table">
@@ -11400,99 +11360,44 @@ 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 issues.
-Format: projects/{project} </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of issues to return. The service may return fewer than
-this value.
-If unspecified, at most 10 issues will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>The name of the database group.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>title</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>The short name used in actual databases specified by users. </p></td>
</tr>
<tr>
- <td>filter</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>Filter is used to filter issues returned in the list.
+ <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
-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.
-- task_type: support &#34;==&#34; operator, the value can be &#34;DDL&#34;, &#34;DML&#34; or &#34;DATA_EXPORT&#34;
-- instance: the instance full name in the &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
-- database: the database full name in the &#34;instances/{id}/databases/{name}&#34; format, support &#34;==&#34; operator.
-- environment: the database full name in the &#34;environments/{name}&#34; format, support &#34;==&#34; operator.
-- 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.
+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:
-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;
-instance == &#34;instances/sample&#34; &amp;&amp; labels in [&#34;label1&#34;, &#34;label2&#34;]
-create_time &gt;= &#34;2025-01-02T15:04:05Z07:00&#34;
-environment == &#34;environments/test&#34; </p></td>
- </tr>
-
- <tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Query is the query statement. </p></td>
+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>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListIssuesResponse">ListIssuesResponse</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>issues</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>matched_databases</td>
+ <td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td>
<td>repeated</td>
- <td><p>The issues from the specified request. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>The list of databases that match the database group condition. </p></td>
</tr>
</tbody>
@@ -11502,8 +11407,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.RejectIssueRequest">RejectIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</h3>
+ <p>A database within a database group.</p>
<table class="field-table">
@@ -11516,15 +11421,8 @@ 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 issue to add a rejection.
-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 rejection decision. </p></td>
+ <td><p>The resource name of the database.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
</tbody>
@@ -11534,8 +11432,8 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.RequestIssueRequest">RequestIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</h3>
+ <p>Request message for deleting a database group.</p>
<table class="field-table">
@@ -11548,15 +11446,8 @@ 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>
- </tr>
-
- <tr>
- <td>comment</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The comment explaining the request. </p></td>
+ <td><p>The name of the database group to delete.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
</tbody>
@@ -11566,8 +11457,8 @@ Format: projects/{project}/issues/{issue} </p></td>
- <h3 id="bytebase.v1.SearchIssuesRequest">SearchIssuesRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetDatabaseGroupRequest">GetDatabaseGroupRequest</h3>
+ <p>Request message for getting a database group.</p>
<table class="field-table">
@@ -11577,48 +11468,18 @@ 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, 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>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 `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>filter</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter issues returned in the list.
-Check the filter field in the ListIssuesRequest message. </p></td>
+ <td><p>The name of the database group to retrieve.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
- <td>query</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
<td></td>
- <td><p>Query is the query statement. </p></td>
+ <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
</tr>
</tbody>
@@ -11628,8 +11489,8 @@ Check the filter field in the ListIssuesRequest message. </p></td>
- <h3 id="bytebase.v1.SearchIssuesResponse">SearchIssuesResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListDatabaseGroupsRequest">ListDatabaseGroupsRequest</h3>
+ <p>Request message for listing database groups.</p>
<table class="field-table">
@@ -11639,18 +11500,18 @@ Check the filter field in the ListIssuesRequest message. </p></td>
<tbody>
<tr>
- <td>issues</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
- <td>repeated</td>
- <td><p>The issues from the specified request. </p></td>
+ <td>parent</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>
</tr>
<tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</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 view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
</tr>
</tbody>
@@ -11660,8 +11521,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.ListDatabaseGroupsResponse">ListDatabaseGroupsResponse</h3>
+ <p>Response message for listing database groups.</p>
<table class="field-table">
@@ -11671,33 +11532,10 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The issue name
-Format: projects/{project}/issues/{issue} </p></td>
- </tr>
-
- <tr>
- <td>issue_comment</td>
- <td><a href="#bytebase.v1.IssueComment">IssueComment</a></td>
- <td></td>
- <td><p>The comment 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 issue comment is not found, a new issue comment will be created.
-In this situation, `update_mask` is ignored. </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>
@@ -11707,8 +11545,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateIssueRequest">UpdateIssueRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>
+ <p>Request message for updating a database group.</p>
<table class="field-table">
@@ -11718,13 +11556,13 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>issue</td>
- <td><a href="#bytebase.v1.Issue">Issue</a></td>
+ <td>database_group</td>
+ <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
<td></td>
- <td><p>The issue to update.
+ <td><p>The database group to update.
-The issue&#39;s `name` field is used to identify the issue to update.
-Format: projects/{project}/issues/{issue} </p></td>
+The database group&#39;s `name` field is used to identify the database group to update.
+Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
</tr>
<tr>
@@ -11738,7 +11576,7 @@ Format: projects/{project}/issues/{issue} </p></td>
<td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the issue is not found, a new issue will be created.
+ <td><p>If set to true, and the database group is not found, a new database group will be created.
In this situation, `update_mask` is ignored. </p></td>
</tr>
@@ -11751,61 +11589,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.Issue.ApprovalStatus">Issue.ApprovalStatus</h3>
- <p>The overall approval status for the issue.</p>
- <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>
-
- <tr>
- <td>ERROR</td>
- <td>6</td>
- <td><p>Error occurred during approval evaluation.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Issue.Approver.Status">Issue.Approver.Status</h3>
- <p>The approval status of an approver.</p>
+ <h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3>
+ <p>View options for database group responses.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -11813,196 +11598,344 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>STATUS_UNSPECIFIED</td>
+ <td>DATABASE_GROUP_VIEW_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified status.</p></td>
+ <td><p>The default / unset value.
+The API will default to the BASIC view.</p></td>
</tr>
<tr>
- <td>PENDING</td>
+ <td>DATABASE_GROUP_VIEW_BASIC</td>
<td>1</td>
- <td><p>Awaiting approval.</p></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>APPROVED</td>
+ <td>DATABASE_GROUP_VIEW_FULL</td>
<td>2</td>
- <td><p>Approved.</p></td>
- </tr>
-
- <tr>
- <td>REJECTED</td>
- <td>3</td>
- <td><p>Rejected.</p></td>
+ <td><p>Include everything.</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.IssueComment.TaskUpdate.Status">IssueComment.TaskUpdate.Status</h3>
- <p>Task status values.</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>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>STATUS_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified status.</p></td>
+ <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>PENDING</td>
- <td>1</td>
- <td><p>Task is pending.</p></td>
+ <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>RUNNING</td>
- <td>2</td>
- <td><p>Task is running.</p></td>
+ <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>DONE</td>
- <td>3</td>
- <td><p>Task is done.</p></td>
+ <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>FAILED</td>
- <td>4</td>
- <td><p>Task failed.</p></td>
+ <td>DeleteDatabaseGroup</td>
+ <td><a href="#bytebase.v1.DeleteDatabaseGroupRequest">DeleteDatabaseGroupRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a database group.
+Permissions required: bb.databaseGroups.delete</p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>SKIPPED</td>
- <td>5</td>
- <td><p>Task was skipped.</p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>CANCELED</td>
- <td>6</td>
- <td><p>Task was canceled.</p></td>
+ <td>ListDatabaseGroups</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td></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>
+ <td>GetDatabaseGroup</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <td></td>
</tr>
+
+
+
<tr>
- <td>OPEN</td>
- <td>1</td>
- <td><p>Issue is open and active.</p></td>
+ <td>CreateDatabaseGroup</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td>database_group</td>
</tr>
+
+
+
<tr>
- <td>DONE</td>
- <td>2</td>
- <td><p>Issue is completed.</p></td>
+ <td>UpdateDatabaseGroup</td>
+ <td>PATCH</td>
+ <td>/v1/{database_group.name=projects/*/databaseGroups/*}</td>
+ <td>database_group</td>
</tr>
+
+
+
<tr>
- <td>CANCELED</td>
- <td>3</td>
- <td><p>Issue is canceled.</p></td>
+ <td>DeleteDatabaseGroup</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <td></td>
</tr>
+
- </tbody>
- </table>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/instance_role_service.proto">v1/instance_role_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.GetInstanceRoleRequest">GetInstanceRoleRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the role to retrieve.
+Format: instances/{instance}/roles/{role name}
+The role name is the unique name for the role. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.InstanceRole">InstanceRole</h3>
+ <p>InstanceRole is the API message for instance role.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>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>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>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>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstanceRolesRequest">ListInstanceRolesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>parent</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>
+ </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.
+
+When paginating, all other parameters provided to `ListInstanceRoles` must match
+the call that provided the page token. </p></td>
+ </tr>
+
+ <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>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListInstanceRolesResponse">ListInstanceRolesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>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>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.IssueService">IssueService</h3>
- <p>IssueService manages issues for tracking database changes and tasks.</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>
@@ -12010,99 +11943,19 @@ In this situation, `update_mask` is ignored. </p></td>
<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>
+ <td>GetInstanceRole</td>
+ <td><a href="#bytebase.v1.GetInstanceRoleRequest">GetInstanceRoleRequest</a></td>
+ <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
+ <td><p>Gets a database role from an instance.
+Permissions required: bb.instanceRoles.get</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>
+ <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>
@@ -12126,9 +11979,9 @@ Permissions required: None (determined by approval flow)</p></td>
<tr>
- <td>GetIssue</td>
+ <td>GetInstanceRole</td>
<td>GET</td>
- <td>/v1/{name=projects/*/issues/*}</td>
+ <td>/v1/{name=instances/*/roles/*}</td>
<td></td>
</tr>
@@ -12136,308 +11989,479 @@ Permissions required: None (determined by approval flow)</p></td>
<tr>
- <td>CreateIssue</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues</td>
- <td>issue</td>
+ <td>ListInstanceRoles</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/roles</td>
+ <td></td>
</tr>
-
+
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/instance_service.proto">v1/instance_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.AddDataSourceRequest">AddDataSourceRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>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>
+ </tr>
+
+ <tr>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td></td>
+ <td><p>Identified by data source ID.
+Only READ_ONLY data source can be added. </p></td>
+ </tr>
+
+ <tr>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
+ </tr>
+
+ </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>requests</td>
+ <td><a href="#bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</a></td>
+ <td>repeated</td>
+ <td><p>The request message specifying the instances to sync.
+A maximum of 1000 instances can be synced in a batch. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchSyncInstancesResponse">BatchSyncInstancesResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateInstancesRequest">BatchUpdateInstancesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>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>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateInstancesResponse">BatchUpdateInstancesResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>instances</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateInstanceRequest">CreateInstanceRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>ListIssues</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/issues</td>
- <td></td>
- </tr>
+ <tr>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
+ <td></td>
+ <td><p>The instance to create. </p></td>
+ </tr>
-
+ <tr>
+ <td>instance_id</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The ID to use for the instance, which will become the final component of
+the instance&#39;s resource name.
+
+This value should be 4-63 characters, and valid characters
+are /[a-z][0-9]-/. </p></td>
+ </tr>
+ <tr>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
+ </tr>
- <tr>
- <td>SearchIssues</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues:search</td>
- <td>*</td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DataSource">DataSource</h3>
+ <p></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>The unique identifier for this data source. </p></td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.DataSourceType">DataSourceType</a></td>
+ <td></td>
+ <td><p>The type of data source (ADMIN or READ_ONLY). </p></td>
+ </tr>
- <tr>
- <td>UpdateIssue</td>
- <td>PATCH</td>
- <td>/v1/{issue.name=projects/*/issues/*}</td>
- <td>issue</td>
- </tr>
+ <tr>
+ <td>username</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The username for database authentication. </p></td>
+ </tr>
-
+ <tr>
+ <td>password</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The password for database authentication. </p></td>
+ </tr>
+ <tr>
+ <td>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>ListIssueComments</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*/issues/*}/issueComments</td>
- <td></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>CreateIssueComment</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*/issues/*}:comment</td>
- <td>issue_comment</td>
- </tr>
+ <tr>
+ <td>verify_tls_certificate</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>verify_tls_certificate enables TLS certificate verification for SSL connections.
+Default is false (no verification) for backward compatibility.
+Set to true for secure connections (recommended for production).
+Only set to false for development or when certificates cannot be properly
+validated (e.g., self-signed certs, VPN environments). </p></td>
+ </tr>
-
+ <tr>
+ <td>host</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The hostname or IP address of the database server. </p></td>
+ </tr>
+ <tr>
+ <td>port</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The port number of the database server. </p></td>
+ </tr>
- <tr>
- <td>UpdateIssueComment</td>
- <td>PATCH</td>
- <td>/v1/{parent=projects/*/issues/*}:comment</td>
- <td>issue_comment</td>
- </tr>
+ <tr>
+ <td>database</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the database to connect to. </p></td>
+ </tr>
-
+ <tr>
+ <td>srv</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>srv, authentication_database and replica_set are used for MongoDB.
+srv is a boolean flag that indicates whether the host is a DNS SRV record. </p></td>
+ </tr>
+ <tr>
+ <td>authentication_database</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>authentication_database is the database name to authenticate against, which stores the user credentials. </p></td>
+ </tr>
- <tr>
- <td>BatchUpdateIssuesStatus</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/issues:batchUpdateStatus</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>replica_set</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>replica_set is used for MongoDB replica set. </p></td>
+ </tr>
-
+ <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>ApproveIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:approve</td>
- <td>*</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>
+ </tr>
-
+ <tr>
+ <td>ssh_port</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>
+ </tr>
+ <tr>
+ <td>ssh_user</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The user to login the server.
+Required. </p></td>
+ </tr>
- <tr>
- <td>RejectIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:reject</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>ssh_password</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The password to login the server. If it&#39;s empty string, no password is required. </p></td>
+ </tr>
-
+ <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>authentication_private_key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>PKCS#8 private key in PEM format. If it&#39;s empty string, no private key is required.
+Used for authentication when connecting to the data source. </p></td>
+ </tr>
- <tr>
- <td>RequestIssue</td>
- <td>POST</td>
- <td>/v1/{name=projects/*/issues/*}:request</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>external_secret</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</a></td>
+ <td></td>
+ <td><p> </p></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>authentication_type</td>
+ <td><a href="#bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>role</td>
- <td><a href="#string">string</a></td>
+ <td>azure_credential</td>
+ <td><a href="#bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</a></td>
<td></td>
- <td><p>The role that is assigned to the members.
-Format: roles/{role} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>members</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Specifies the principals requesting access for a Bytebase resource.
-For users, the member should be: user:{email}
-For groups, the member should be: group:{email} </p></td>
+ <td>aws_credential</td>
+ <td><a href="#bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</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>gcp_credential</td>
+ <td><a href="#bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</a></td>
<td></td>
- <td><p>The condition that is associated with this binding, only used in the project IAM policy.
-If the condition evaluates to true, then this binding applies to the current request.
-If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.database: the database full name in &#34;instances/{instance}/databases/{database}&#34; format, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-resource.schema_name: the schema name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-resource.table_name: the table name, used by the &#34;roles/sqlEditorUser&#34; role, support &#34;==&#34; operator.
-request.time: the expiration. Only support &#34;&lt;&#34; operation in `request.time &lt; timestamp(&#34;{ISO datetime string format}&#34;)`.
-
-For example:
-resource.database == &#34;instances/local-pg/databases/postgres&#34; &amp;&amp; resource.schema_name in [&#34;public&#34;,&#34;another_schema&#34;]
-resource.database == &#34;instances/local-pg/databases/bytebase&#34; &amp;&amp; resource.schema_name == &#34;public&#34; &amp;&amp; resource.table_name in [&#34;audit_log&#34;]
-request.time &lt; timestamp(&#34;2025-04-26T11:24:48.655Z&#34;) </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>parsed_expr</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
+ <td>sasl_config</td>
+ <td><a href="#bytebase.v1.SASLConfig">SASLConfig</a></td>
<td></td>
- <td><p>The parsed expression of the condition. </p></td>
+ <td><p> </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>additional_addresses</td>
+ <td><a href="#bytebase.v1.DataSource.Address">DataSource.Address</a></td>
+ <td>repeated</td>
+ <td><p>additional_addresses is used for MongoDB replica set. </p></td>
+ </tr>
<tr>
- <td>action</td>
- <td><a href="#bytebase.v1.BindingDelta.Action">BindingDelta.Action</a></td>
+ <td>direct_connection</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The action that was performed on a Binding. </p></td>
+ <td><p>direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string. </p></td>
</tr>
<tr>
- <td>role</td>
+ <td>region</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Role that is assigned to `members`.
-For example, `roles/projectOwner`. </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>member</td>
+ <td>warehouse_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Follows the same format of Binding.members. </p></td>
+ <td><p>warehouse_id is used by Databricks. </p></td>
</tr>
<tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>master_name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The condition that is associated with this binding. </p></td>
+ <td><p>master_name is the master name used by connecting redis-master via redis sentinel. </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>master_username</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the resource to get the IAM policy.
-Format: projects/{project}
-Format: workspaces/{workspace} </p></td>
+ <td><p>master_username and master_password are master credentials used by redis sentinel mode. </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>master_password</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>bindings</td>
- <td><a href="#bytebase.v1.Binding">Binding</a></td>
- <td>repeated</td>
- <td><p>Collection of binding.
-A binding binds one or more project members to a single project role. </p></td>
+ <td>redis_type</td>
+ <td><a href="#bytebase.v1.DataSource.RedisType">DataSource.RedisType</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>etag</td>
+ <td>cluster</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The current etag of the policy.
-If an etag is provided and does not match the current etag of the policy,
-the call will be blocked and an ABORTED error will be returned. </p></td>
+ <td><p>Cluster is the cluster name for the data source. Used by CockroachDB. </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>extra_connection_parameters</td>
+ <td><a href="#bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</a></td>
<td>repeated</td>
- <td><p>The delta for Bindings between two policies. </p></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>
@@ -12447,8 +12471,8 @@ the call will be blocked and an ABORTED error will be returned. </p></td>
- <h3 id="bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</h3>
- <p>Request message for setting an IAM policy.</p>
+ <h3 id="bytebase.v1.DataSource.AWSCredential">DataSource.AWSCredential</h3>
+ <p></p>
<table class="field-table">
@@ -12458,26 +12482,40 @@ the call will be blocked and an ABORTED error will be returned. </p></td>
<tbody>
<tr>
- <td>resource</td>
+ <td>access_key_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the resource to set the IAM policy.
-Format: projects/{project}
-Format: workspaces/{workspace} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
+ <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>etag</td>
+ <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>The current etag of the policy. </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>
</tbody>
@@ -12487,57 +12525,7 @@ Format: workspaces/{workspace} </p></td>
-
-
- <h3 id="bytebase.v1.BindingDelta.Action">BindingDelta.Action</h3>
- <p>Type of action performed on a binding.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ACTION_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified action.</p></td>
- </tr>
-
- <tr>
- <td>ADD</td>
- <td>1</td>
- <td><p>Add a binding.</p></td>
- </tr>
-
- <tr>
- <td>REMOVE</td>
- <td>2</td>
- <td><p>Remove a binding.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/project_service.proto">v1/project_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.Activity">Activity</h3>
- <p>Activity types for webhook notifications.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.AddWebhookRequest">AddWebhookRequest</h3>
+ <h3 id="bytebase.v1.DataSource.Address">DataSource.Address</h3>
<p></p>
@@ -12548,18 +12536,17 @@ Format: workspaces/{workspace} </p></td>
<tbody>
<tr>
- <td>project</td>
+ <td>host</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to add the webhook to.
-Format: projects/{project} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>port</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The webhook to add. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -12569,7 +12556,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</h3>
+ <h3 id="bytebase.v1.DataSource.AzureCredential">DataSource.AzureCredential</h3>
<p></p>
@@ -12580,21 +12567,24 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>names</td>
+ <td>tenant_id</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The names of the projects to delete.
-Format: projects/{project} </p></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>force</td>
- <td><a href="#bool">bool</a></td>
+ <td>client_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, any databases from this project will be moved to default project.
-Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
-Open issues will remain open but associated with the deleted project.
-If set to false, the operation will fail if the project has databases or open issues. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>client_secret</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -12604,7 +12594,7 @@ If set to false, the operation will fail if the project has databases or open is
- <h3 id="bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</h3>
+ <h3 id="bytebase.v1.DataSource.ExtraConnectionParametersEntry">DataSource.ExtraConnectionParametersEntry</h3>
<p></p>
@@ -12615,16 +12605,16 @@ If set to false, the operation will fail if the project has databases or open is
<tbody>
<tr>
- <td>scope</td>
+ <td>key</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The scope of the batch get. Typically it&#39;s &#34;projects/-&#34;. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>names</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
+ <td></td>
<td><p> </p></td>
</tr>
@@ -12635,7 +12625,7 @@ If set to false, the operation will fail if the project has databases or open is
- <h3 id="bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</h3>
+ <h3 id="bytebase.v1.DataSource.GCPCredential">DataSource.GCPCredential</h3>
<p></p>
@@ -12646,10 +12636,10 @@ If set to false, the operation will fail if the project has databases or open is
<tbody>
<tr>
- <td>policy_results</td>
- <td><a href="#bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</a></td>
- <td>repeated</td>
- <td><p>The policy results for each requested project. </p></td>
+ <td>content</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -12659,8 +12649,8 @@ If set to false, the operation will fail if the project has databases or open is
- <h3 id="bytebase.v1.BatchGetIamPolicyResponse.PolicyResult">BatchGetIamPolicyResponse.PolicyResult</h3>
- <p>Result for a single project's IAM policy.</p>
+ <h3 id="bytebase.v1.DataSourceExternalSecret">DataSourceExternalSecret</h3>
+ <p></p>
<table class="field-table">
@@ -12670,17 +12660,91 @@ If set to false, the operation will fail if the project has databases or open is
<tbody>
<tr>
- <td>project</td>
+ <td>secret_type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.SecretType">DataSourceExternalSecret.SecretType</a></td>
+ <td></td>
+ <td><p>The type of external secret store. </p></td>
+ </tr>
+
+ <tr>
+ <td>url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The project resource name. </p></td>
+ <td><p>The URL of the external secret store. </p></td>
</tr>
<tr>
- <td>policy</td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
+ <td>auth_type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AuthType">DataSourceExternalSecret.AuthType</a></td>
<td></td>
- <td><p>The IAM policy for the project. </p></td>
+ <td><p>The authentication method for accessing the secret store. </p></td>
+ </tr>
+
+ <tr>
+ <td>app_role</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</a></td>
+ <td></td>
+ <td><p>AppRole authentication configuration. </p></td>
+ </tr>
+
+ <tr>
+ <td>token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Token for direct authentication. </p></td>
+ </tr>
+
+ <tr>
+ <td>engine_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>engine name is the name for secret engine. </p></td>
+ </tr>
+
+ <tr>
+ <td>secret_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>the secret name in the engine to store the password. </p></td>
+ </tr>
+
+ <tr>
+ <td>password_key_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>the key name for the password. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_vault_tls_verification</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>TLS configuration for connecting to Vault server.
+These fields are separate from the database TLS configuration in DataSource.
+skip_vault_tls_verification disables TLS certificate verification for Vault connections.
+Default is false (verification enabled) for security.
+Only set to true for development or when certificates cannot be properly validated. </p></td>
+ </tr>
+
+ <tr>
+ <td>vault_ssl_ca</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>CA certificate for Vault server verification. </p></td>
+ </tr>
+
+ <tr>
+ <td>vault_ssl_cert</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Client certificate for mutual TLS authentication with Vault. </p></td>
+ </tr>
+
+ <tr>
+ <td>vault_ssl_key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Client private key for mutual TLS authentication with Vault. </p></td>
</tr>
</tbody>
@@ -12690,7 +12754,7 @@ If set to false, the operation will fail if the project has databases or open is
- <h3 id="bytebase.v1.CreateProjectRequest">CreateProjectRequest</h3>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption">DataSourceExternalSecret.AppRoleAuthOption</h3>
<p></p>
@@ -12701,21 +12765,31 @@ If set to false, the operation will fail if the project has databases or open is
<tbody>
<tr>
- <td>project</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>role_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The project to create. </p></td>
+ <td><p>The role ID for Vault AppRole authentication. </p></td>
</tr>
<tr>
- <td>project_id</td>
+ <td>secret_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>
+ <td><p>the secret id for the role without ttl. </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</a></td>
+ <td></td>
+ <td><p>The type of secret for AppRole authentication. </p></td>
+ </tr>
+
+ <tr>
+ <td>mount_path</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The path where the approle auth method is mounted. </p></td>
</tr>
</tbody>
@@ -12725,7 +12799,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</h3>
+ <h3 id="bytebase.v1.DeleteInstanceRequest">DeleteInstanceRequest</h3>
<p></p>
@@ -12739,28 +12813,25 @@ are /[a-z][0-9]-/. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to delete.
-Format: projects/{project} </p></td>
+ <td><p>The name of the instance to delete.
+Format: instances/{instance} </p></td>
</tr>
<tr>
<td>force</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, any databases from this project will be moved to default project.
-Sheets are not moved since BYTEBASE_ARTIFACT sheets belong to the issue and issue project.
-Open issues will remain open but associated with the deleted project.
-If set to false, the operation will fail if the project has databases or open issues. </p></td>
+ <td><p>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>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.
+ <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 projects.
-The project must already be soft-deleted for this to work. </p></td>
+administrative cleanup of old soft-deleted instances.
+The instance must already be soft-deleted for this to work. </p></td>
</tr>
</tbody>
@@ -12770,7 +12841,7 @@ The project must already be soft-deleted for this to work. </p></td>
- <h3 id="bytebase.v1.GetProjectRequest">GetProjectRequest</h3>
+ <h3 id="bytebase.v1.GetInstanceRequest">GetInstanceRequest</h3>
<p></p>
@@ -12784,8 +12855,8 @@ The project must already be soft-deleted for this to work. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the project to retrieve.
-Format: projects/{project} </p></td>
+ <td><p>The name of the instance to retrieve.
+Format: instances/{instance} </p></td>
</tr>
</tbody>
@@ -12795,8 +12866,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.Instance">Instance</h3>
+ <p></p>
<table class="field-table">
@@ -12806,78 +12877,113 @@ 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 of the instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>color</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 color code for the label (e.g., hex color). </p></td>
+ <td><p>The lifecycle state of the instance. </p></td>
</tr>
<tr>
- <td>group</td>
+ <td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The group this label belongs to. </p></td>
+ <td><p>The display title of the instance. </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>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td></td>
+ <td><p>The database engine type. </p></td>
+ </tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>engine_version</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>The version of the database engine. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>external_link</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>
+ <td><p>External URL to the database instance console. </p></td>
</tr>
<tr>
- <td>show_deleted</td>
+ <td>data_sources</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
+ <td>repeated</td>
+ <td><p>Data source configurations for connecting to the instance. </p></td>
+ </tr>
+
+ <tr>
+ <td>environment</td>
+ <td><a href="#string">string</a></td>
+ <td>optional</td>
+ <td><p>The environment resource.
+Format: environments/prod where prod is the environment resource ID. </p></td>
+ </tr>
+
+ <tr>
+ <td>activation</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Show deleted projects if specified. </p></td>
+ <td><p>Whether the instance is activated for use. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>roles</td>
+ <td><a href="#bytebase.v1.InstanceRole">InstanceRole</a></td>
+ <td>repeated</td>
+ <td><p>Database roles available in this instance. </p></td>
+ </tr>
+
+ <tr>
+ <td>sync_interval</td>
+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td></td>
+ <td><p>How often the instance is synced. </p></td>
+ </tr>
+
+ <tr>
+ <td>maximum_connections</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of connections.
+The default is 10 if the value is unset or zero. </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>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>
+ <td><p>The last time the instance was synced. </p></td>
+ </tr>
+
+ <tr>
+ <td>labels</td>
+ <td><a href="#bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</a></td>
+ <td>repeated</td>
+ <td><p>Labels are key-value pairs that can be attached to the instance.
+For example, { &#34;org_group&#34;: &#34;infrastructure&#34;, &#34;environment&#34;: &#34;production&#34; } </p></td>
</tr>
</tbody>
@@ -12887,7 +12993,7 @@ Supports filtering by name, resource_id, state, and labels (e.g., labels.environ
- <h3 id="bytebase.v1.ListProjectsResponse">ListProjectsResponse</h3>
+ <h3 id="bytebase.v1.Instance.LabelsEntry">Instance.LabelsEntry</h3>
<p></p>
@@ -12898,18 +13004,17 @@ Supports filtering by name, resource_id, state, and labels (e.g., labels.environ
<tbody>
<tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>value</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -12919,7 +13024,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.Project">Project</h3>
+ <h3 id="bytebase.v1.InstanceResource">InstanceResource</h3>
<p></p>
@@ -12929,166 +13034,121 @@ If this field is omitted, there are no subsequent pages. </p></td>
</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>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>
+ <td><p>The display title of the instance. </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>engine</td>
+ <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td></td>
+ <td><p>The database engine type. </p></td>
</tr>
<tr>
- <td>data_classification_config_id</td>
+ <td>engine_version</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 version of the database engine. </p></td>
</tr>
<tr>
- <td>issue_labels</td>
- <td><a href="#bytebase.v1.Label">Label</a></td>
+ <td>data_sources</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
<td>repeated</td>
- <td><p>Labels available for tagging issues in this project. </p></td>
- </tr>
-
- <tr>
- <td>force_issue_labels</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Force issue labels to be used when creating an issue. </p></td>
- </tr>
-
- <tr>
- <td>allow_modify_statement</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Allow modifying SQL statements after issue is created. </p></td>
- </tr>
-
- <tr>
- <td>auto_resolve_issue</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Enable automatic issue resolution when tasks complete. </p></td>
+ <td><p>Data source configurations for the instance. </p></td>
</tr>
<tr>
- <td>enforce_issue_title</td>
+ <td>activation</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>
+ <td><p>Whether the instance is activated. </p></td>
</tr>
<tr>
- <td>auto_enable_backup</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to automatically enable backup for database changes. </p></td>
+ <td><p>The name of the instance.
+Format: instances/{instance} </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>
+ <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>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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.KerberosConfig">KerberosConfig</h3>
+ <p></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>primary</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 primary component of the Kerberos principal. </p></td>
</tr>
<tr>
- <td>execution_retry_policy</td>
- <td><a href="#bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td>
+ <td>instance</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Execution retry policy for task runs. </p></td>
+ <td><p>The instance component of the Kerberos principal. </p></td>
</tr>
<tr>
- <td>ci_sampling_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>realm</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 Kerberos realm. </p></td>
</tr>
<tr>
- <td>parallel_tasks_per_rollout</td>
- <td><a href="#int32">int32</a></td>
+ <td>keytab</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p>The maximum number of parallel tasks allowed during rollout execution. </p></td>
+ <td><p>The keytab file contents for authentication. </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>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>enforce_sql_review</td>
- <td><a href="#bool">bool</a></td>
+ <td>kdc_port</td>
+ <td><a href="#string">string</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 port of the Key Distribution Center (KDC). </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>
- <p>Execution retry policy configuration.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>maximum_retries</td>
- <td><a href="#int32">int32</a></td>
+ <td>kdc_transport_protocol</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of retries for lock timeout errors. </p></td>
+ <td><p>The transport protocol for KDC communication (tcp or udp). </p></td>
</tr>
</tbody>
@@ -13098,7 +13158,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.ListInstanceDatabaseRequest">ListInstanceDatabaseRequest</h3>
<p></p>
@@ -13109,17 +13169,18 @@ If enabled, issues cannot be created when SQL review finds errors. </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>The name of the instance.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </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>
@@ -13129,7 +13190,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
- <h3 id="bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</h3>
+ <h3 id="bytebase.v1.ListInstanceDatabaseResponse">ListInstanceDatabaseResponse</h3>
<p></p>
@@ -13140,10 +13201,10 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td>
<tbody>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
- <td></td>
- <td><p>The webhook to remove. Identified by its url. </p></td>
+ <td>databases</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>All database name list in the instance. </p></td>
</tr>
</tbody>
@@ -13153,7 +13214,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.ListInstancesRequest">ListInstancesRequest</h3>
<p></p>
@@ -13164,61 +13225,72 @@ 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>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Show deleted projects if specified. </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>filter</td>
+ <td>page_token</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.
+ <td><p>A page token, received from a previous `ListInstances` call.
+Provide this to retrieve the subsequent page.
-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>
+When paginating, all other parameters provided to `ListInstances` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</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>Show deleted instances if specified. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>filter</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.
+ <td><p>Filter the instance.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-When paginating, all other parameters provided to `SearchProjects` must match
-the call that provided the page token. </p></td>
+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>
</tbody>
@@ -13228,7 +13300,7 @@ the call that provided the page token. </p></td>
- <h3 id="bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</h3>
+ <h3 id="bytebase.v1.ListInstancesResponse">ListInstancesResponse</h3>
<p></p>
@@ -13239,10 +13311,10 @@ the call that provided the page token. </p></td>
<tbody>
<tr>
- <td>projects</td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
+ <td>instances</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
<td>repeated</td>
- <td><p>The projects from the specified request. </p></td>
+ <td><p>The instances from the specified request. </p></td>
</tr>
<tr>
@@ -13260,7 +13332,7 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.TestWebhookRequest">TestWebhookRequest</h3>
+ <h3 id="bytebase.v1.RemoveDataSourceRequest">RemoveDataSourceRequest</h3>
<p></p>
@@ -13271,18 +13343,19 @@ 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 of the instance to remove a data source from.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
<td></td>
- <td><p>The webhook to test. Identified by its url. </p></td>
+ <td><p>Identified by data source ID.
+Only READ_ONLY data source can be removed. </p></td>
</tr>
</tbody>
@@ -13292,7 +13365,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.TestWebhookResponse">TestWebhookResponse</h3>
+ <h3 id="bytebase.v1.SASLConfig">SASLConfig</h3>
<p></p>
@@ -13303,10 +13376,10 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>error</td>
- <td><a href="#string">string</a></td>
+ <td>krb_config</td>
+ <td><a href="#bytebase.v1.KerberosConfig">KerberosConfig</a></td>
<td></td>
- <td><p>The result of the test, empty if the test is successful. </p></td>
+ <td><p>Kerberos authentication configuration. </p></td>
</tr>
</tbody>
@@ -13316,7 +13389,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</h3>
+ <h3 id="bytebase.v1.SyncInstanceRequest">SyncInstanceRequest</h3>
<p></p>
@@ -13330,8 +13403,16 @@ Format: projects/{project} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the deleted project.
-Format: projects/{project} </p></td>
+ <td><p>The name of instance.
+Format: instances/{instance} </p></td>
+ </tr>
+
+ <tr>
+ <td>enable_full_sync</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>When full sync is enabled, all databases in the instance will be synchronized. Otherwise, only
+the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td>
</tr>
</tbody>
@@ -13341,7 +13422,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.UpdateProjectRequest">UpdateProjectRequest</h3>
+ <h3 id="bytebase.v1.SyncInstanceResponse">SyncInstanceResponse</h3>
<p></p>
@@ -13352,28 +13433,35 @@ 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>databases</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>All database name list in the 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>
+ </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>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the project is not found, a new project will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The name of the deleted instance.
+Format: instances/{instance} </p></td>
</tr>
</tbody>
@@ -13383,7 +13471,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</h3>
+ <h3 id="bytebase.v1.UpdateDataSourceRequest">UpdateDataSourceRequest</h3>
<p></p>
@@ -13394,10 +13482,18 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>webhook</td>
- <td><a href="#bytebase.v1.Webhook">Webhook</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the instance to update a data source.
+Format: instances/{instance} </p></td>
+ </tr>
+
+ <tr>
+ <td>data_source</td>
+ <td><a href="#bytebase.v1.DataSource">DataSource</a></td>
<td></td>
- <td><p>The webhook to modify. </p></td>
+ <td><p>Identified by data source ID. </p></td>
</tr>
<tr>
@@ -13407,11 +13503,18 @@ In this situation, `update_mask` is ignored. </p></td>
<td><p>The list of fields to update. </p></td>
</tr>
+ <tr>
+ <td>validate_only</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Validate only also tests the data source connection. </p></td>
+ </tr>
+
<tr>
<td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>If set to true, and the webhook is not found, a new webhook will be created.
+ <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>
@@ -13422,7 +13525,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.Webhook">Webhook</h3>
+ <h3 id="bytebase.v1.UpdateInstanceRequest">UpdateInstanceRequest</h3>
<p></p>
@@ -13433,59 +13536,28 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>name is the name of the webhook, generated by the server.
-format: projects/{project}/webhooks/{webhook} </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Webhook.Type">Webhook.Type</a></td>
- <td></td>
- <td><p>type is the type of the webhook. </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>instance</td>
+ <td><a href="#bytebase.v1.Instance">Instance</a></td>
<td></td>
- <td><p>title is the title of the webhook. </p></td>
+ <td><p>The instance to update.
+
+The instance&#39;s `name` field is used to identify the instance to update.
+Format: instances/{instance} </p></td>
</tr>
<tr>
- <td>url</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>url is the url of the webhook, should be unique within the project. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>direct_message</td>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>if direct_message is set, the notification is sent directly
-to the persons and url will be ignored.
-IM integration setting should be set for this function to work. </p></td>
- </tr>
-
- <tr>
- <td>notification_types</td>
- <td><a href="#bytebase.v1.Activity.Type">Activity.Type</a></td>
- <td>repeated</td>
- <td><p>notification_types is the list of activities types that the webhook is interested in.
-Bytebase will only send notifications to the webhook if the activity type is in the list.
-It should not be empty, and should be a subset of the following:
-- ISSUE_CREATE
-- ISSUE_COMMENT_CREATE
-- ISSUE_FIELD_UPDATE
-- ISSUE_STATUS_UPDATE
-- ISSUE_APPROVAL_NOTIFY
-- ISSUE_PIPELINE_STAGE_STATUS_UPDATE
-- ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE
-- NOTIFY_ISSUE_APPROVED
-- NOTIFY_PIPELINE_ROLLOUT </p></td>
+ <td><p>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>
@@ -13497,8 +13569,8 @@ It should not be empty, and should be a subset of the following:
- <h3 id="bytebase.v1.Activity.Type">Activity.Type</h3>
- <p>Activity type enumeration.</p>
+ <h3 id="bytebase.v1.DataSource.AuthenticationType">DataSource.AuthenticationType</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -13506,74 +13578,40 @@ It should not be empty, and should be a subset of the following:
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>AUTHENTICATION_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified type.</p></td>
- </tr>
-
- <tr>
- <td>NOTIFY_ISSUE_APPROVED</td>
- <td>23</td>
- <td><p>Notifications via webhooks.
-
-NOTIFY_ISSUE_APPROVED represents the issue approved notification.</p></td>
- </tr>
-
- <tr>
- <td>NOTIFY_PIPELINE_ROLLOUT</td>
- <td>24</td>
- <td><p>NOTIFY_PIPELINE_ROLLOUT represents the pipeline rollout notification.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ISSUE_CREATE</td>
+ <td>PASSWORD</td>
<td>1</td>
- <td><p>Issue related activity types.
-
-ISSUE_CREATE represents creating an issue.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ISSUE_COMMENT_CREATE</td>
+ <td>GOOGLE_CLOUD_SQL_IAM</td>
<td>2</td>
- <td><p>ISSUE_COMMENT_CREATE represents commenting on an issue.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ISSUE_FIELD_UPDATE</td>
+ <td>AWS_RDS_IAM</td>
<td>3</td>
- <td><p>ISSUE_FIELD_UPDATE represents updating the issue field, likes title, description, etc.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>ISSUE_STATUS_UPDATE</td>
+ <td>AZURE_IAM</td>
<td>4</td>
- <td><p>ISSUE_STATUS_UPDATE represents the issue status change, including OPEN, CLOSE, CANCEL fow now.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_APPROVAL_NOTIFY</td>
- <td>21</td>
- <td><p>ISSUE_APPROVAL_NOTIFY is the type for notifying issue approval.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_PIPELINE_STAGE_STATUS_UPDATE</td>
- <td>5</td>
- <td><p>ISSUE_PIPELINE_STAGE_STATUS_UPDATE represents the pipeline stage status change, including BEGIN, END for now.</p></td>
- </tr>
-
- <tr>
- <td>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE</td>
- <td>22</td>
- <td><p>ISSUE_PIPELINE_TASK_RUN_STATUS_UPDATE represents the pipeline task run status change, including PENDING, RUNNING, DONE, FAILED, CANCELED.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
- <h3 id="bytebase.v1.Webhook.Type">Webhook.Type</h3>
- <p>Webhook integration type.</p>
+ <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>
@@ -13581,821 +13619,431 @@ ISSUE_CREATE represents creating an issue.</p></td>
<tbody>
<tr>
- <td>TYPE_UNSPECIFIED</td>
+ <td>REDIS_TYPE_UNSPECIFIED</td>
<td>0</td>
- <td><p>Unspecified type.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>SLACK</td>
+ <td>STANDALONE</td>
<td>1</td>
- <td><p>Slack integration.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>DISCORD</td>
+ <td>SENTINEL</td>
<td>2</td>
- <td><p>Discord integration.</p></td>
+ <td><p></p></td>
</tr>
<tr>
- <td>TEAMS</td>
+ <td>CLUSTER</td>
<td>3</td>
- <td><p>Microsoft Teams integration.</p></td>
- </tr>
-
- <tr>
- <td>DINGTALK</td>
- <td>4</td>
- <td><p>DingTalk integration.</p></td>
- </tr>
-
- <tr>
- <td>FEISHU</td>
- <td>5</td>
- <td><p>Feishu integration.</p></td>
- </tr>
-
- <tr>
- <td>WECOM</td>
- <td>6</td>
- <td><p>WeCom (WeChat Work) integration.</p></td>
- </tr>
-
- <tr>
- <td>LARK</td>
- <td>8</td>
- <td><p>Lark integration.</p></td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h3 id="bytebase.v1.ProjectService">ProjectService</h3>
- <p>ProjectService manages projects that group databases and changes.</p>
+ <h3 id="bytebase.v1.DataSourceExternalSecret.AppRoleAuthOption.SecretType">DataSourceExternalSecret.AppRoleAuthOption.SecretType</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>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>ListProjects</td>
- <td><a href="#bytebase.v1.ListProjectsRequest">ListProjectsRequest</a></td>
- <td><a href="#bytebase.v1.ListProjectsResponse">ListProjectsResponse</a></td>
- <td><p>Lists all projects in the workspace with optional filtering.
-Permissions required: bb.projects.list</p></td>
+ <td>SECRET_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified secret type.</p></td>
</tr>
<tr>
- <td>SearchProjects</td>
- <td><a href="#bytebase.v1.SearchProjectsRequest">SearchProjectsRequest</a></td>
- <td><a href="#bytebase.v1.SearchProjectsResponse">SearchProjectsResponse</a></td>
- <td><p>Searches for projects with advanced filtering capabilities.
-Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)</p></td>
+ <td>PLAIN</td>
+ <td>1</td>
+ <td><p>Plain text secret.</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>
+ <td>ENVIRONMENT</td>
+ <td>2</td>
+ <td><p>Secret from environment variable.</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>
+ </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>DeleteProject</td>
- <td><a href="#bytebase.v1.DeleteProjectRequest">DeleteProjectRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes (soft-delete or purge) a project.
-Permissions required: bb.projects.delete</p></td>
+ <td>AUTH_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified authentication type.</p></td>
</tr>
<tr>
- <td>UndeleteProject</td>
- <td><a href="#bytebase.v1.UndeleteProjectRequest">UndeleteProjectRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Restores a soft-deleted project.
-Permissions required: bb.projects.undelete</p></td>
+ <td>TOKEN</td>
+ <td>1</td>
+ <td><p>ref: https://developer.hashicorp.com/vault/docs/auth/token</p></td>
</tr>
<tr>
- <td>BatchDeleteProjects</td>
- <td><a href="#bytebase.v1.BatchDeleteProjectsRequest">BatchDeleteProjectsRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes multiple projects in a single operation.
-Permissions required: bb.projects.delete</p></td>
+ <td>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>GetIamPolicy</td>
- <td><a href="#bytebase.v1.GetIamPolicyRequest">GetIamPolicyRequest</a></td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
- <td><p>Retrieves the IAM policy for a project.
-Permissions required: bb.projects.getIamPolicy</p></td>
+ <td>SECRET_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified secret type.</p></td>
</tr>
<tr>
- <td>BatchGetIamPolicy</td>
- <td><a href="#bytebase.v1.BatchGetIamPolicyRequest">BatchGetIamPolicyRequest</a></td>
- <td><a href="#bytebase.v1.BatchGetIamPolicyResponse">BatchGetIamPolicyResponse</a></td>
- <td><p>Deprecated. No permission check implemented.
-Permissions required: None</p></td>
+ <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>SetIamPolicy</td>
- <td><a href="#bytebase.v1.SetIamPolicyRequest">SetIamPolicyRequest</a></td>
- <td><a href="#bytebase.v1.IamPolicy">IamPolicy</a></td>
- <td><p>Sets the IAM policy for a project.
-Permissions required: bb.projects.setIamPolicy</p></td>
+ <td>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>AddWebhook</td>
- <td><a href="#bytebase.v1.AddWebhookRequest">AddWebhookRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Adds a webhook to a project for notifications.
-Permissions required: bb.projects.update</p></td>
+ <td>GCP_SECRET_MANAGER</td>
+ <td>3</td>
+ <td><p>ref: https://cloud.google.com/secret-manager/docs</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>UpdateWebhook</td>
- <td><a href="#bytebase.v1.UpdateWebhookRequest">UpdateWebhookRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Updates an existing webhook configuration.
-Permissions required: bb.projects.update</p></td>
+ <td>DATA_SOURCE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified data source type.</p></td>
</tr>
<tr>
- <td>RemoveWebhook</td>
- <td><a href="#bytebase.v1.RemoveWebhookRequest">RemoveWebhookRequest</a></td>
- <td><a href="#bytebase.v1.Project">Project</a></td>
- <td><p>Removes a webhook from a project.
-Permissions required: bb.projects.update</p></td>
+ <td>ADMIN</td>
+ <td>1</td>
+ <td><p>Admin data source with write permissions.</p></td>
</tr>
<tr>
- <td>TestWebhook</td>
- <td><a href="#bytebase.v1.TestWebhookRequest">TestWebhookRequest</a></td>
- <td><a href="#bytebase.v1.TestWebhookResponse">TestWebhookResponse</a></td>
- <td><p>Tests a webhook by sending a test notification.
-Permissions required: bb.projects.update</p></td>
+ <td>READ_ONLY</td>
+ <td>2</td>
+ <td><p>Read-only data source for query operations.</p></td>
</tr>
</tbody>
</table>
+
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
+
+
+
+ <h3 id="bytebase.v1.InstanceService">InstanceService</h3>
+ <p>InstanceService manages database instances and their connections.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</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>
- </thead>
- <tbody>
-
-
<tr>
- <td>GetProject</td>
- <td>GET</td>
- <td>/v1/{name=projects/*}</td>
- <td></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>ListProjects</td>
- <td>GET</td>
- <td>/v1/projects</td>
- <td></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>SearchProjects</td>
- <td>POST</td>
- <td>/v1/projects:search</td>
- <td>*</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>
-
-
-
<tr>
- <td>CreateProject</td>
- <td>POST</td>
- <td>/v1/projects</td>
- <td>project</td>
+ <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>UpdateProject</td>
- <td>PATCH</td>
- <td>/v1/{project.name=projects/*}</td>
- <td>project</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>DeleteProject</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*}</td>
- <td></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>
-
-
-
<tr>
- <td>UndeleteProject</td>
- <td>POST</td>
- <td>/v1/{name=projects/*}:undelete</td>
- <td>*</td>
+ <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>BatchDeleteProjects</td>
- <td>POST</td>
- <td>/v1/projects:batchDelete</td>
- <td>*</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>GetIamPolicy</td>
- <td>GET</td>
- <td>/v1/{resource=projects/*}:getIamPolicy</td>
- <td></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>BatchGetIamPolicy</td>
- <td>GET</td>
- <td>/v1/{scope=*/*}/iamPolicies:batchGet</td>
- <td></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>SetIamPolicy</td>
- <td>POST</td>
- <td>/v1/{resource=projects/*}:setIamPolicy</td>
- <td>*</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>AddWebhook</td>
- <td>POST</td>
- <td>/v1/{project=projects/*}:addWebhook</td>
- <td>*</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>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
-
+ </thead>
+ <tbody>
<tr>
- <td>UpdateWebhook</td>
- <td>PATCH</td>
- <td>/v1/{webhook.name=projects/*/webhooks/*}:updateWebhook</td>
- <td>webhook</td>
+ <td>GetInstance</td>
+ <td>GET</td>
+ <td>/v1/{name=instances/*}</td>
+ <td></td>
</tr>
<tr>
- <td>RemoveWebhook</td>
- <td>POST</td>
- <td>/v1/{webhook.name=projects/*/webhooks/*}:removeWebhook</td>
- <td>*</td>
+ <td>ListInstances</td>
+ <td>GET</td>
+ <td>/v1/instances</td>
+ <td></td>
</tr>
<tr>
- <td>TestWebhook</td>
+ <td>CreateInstance</td>
<td>POST</td>
- <td>/v1/{project=projects/*}:testWebhook</td>
- <td>*</td>
+ <td>/v1/instances</td>
+ <td>instance</td>
</tr>
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/setting_service.proto">v1/setting_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.AISetting">AISetting</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>enabled</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>provider</td>
- <td><a href="#bytebase.v1.AISetting.Provider">AISetting.Provider</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>endpoint</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>api_key</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>model</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>version</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm">Algorithm</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>full_mask</td>
- <td><a href="#bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>range_mask</td>
- <td><a href="#bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <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>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm.FullMask">Algorithm.FullMask</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>substitution</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>substitution is the string used to replace the original value, the
-max length of the string is 16 bytes. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm.InnerOuterMask">Algorithm.InnerOuterMask</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>prefix_len</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>suffix_len</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>type</td>
- <td><a href="#bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>substitution</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm.MD5Mask">Algorithm.MD5Mask</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
- <tr>
- <td>salt</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>salt is the salt value to generate a different hash that with the word alone. </p></td>
- </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm.RangeMask">Algorithm.RangeMask</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>UpdateInstance</td>
+ <td>PATCH</td>
+ <td>/v1/{instance.name=instances/*}</td>
+ <td>instance</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>
-
-
-
-
-
- <h3 id="bytebase.v1.Algorithm.RangeMask.Slice">Algorithm.RangeMask.Slice</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
- <tr>
- <td>start</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>start is the start index of the original value, start from 0 and should be less than stop. </p></td>
- </tr>
+ <tr>
+ <td>DeleteInstance</td>
+ <td>DELETE</td>
+ <td>/v1/{name=instances/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>end</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>stop is the stop index of the original value, should be less than the length of the original value. </p></td>
- </tr>
+
- <tr>
- <td>substitution</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>substitution is the string used to replace the OriginalValue[start:end). </p></td>
- </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Announcement">Announcement</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>UndeleteInstance</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:undelete</td>
+ <td>*</td>
+ </tr>
- <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><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>
+ <tr>
+ <td>SyncInstance</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:sync</td>
+ <td>*</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AppIMSetting">AppIMSetting</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <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>ListInstanceDatabase</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:databases</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>client_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>client_secret</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>robot_code</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>BatchSyncInstances</td>
+ <td>POST</td>
+ <td>/v1/instances:batchSync</td>
+ <td>*</td>
+ </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+
- <tr>
- <td>app_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>app_secret</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>BatchUpdateInstances</td>
+ <td>POST</td>
+ <td>/v1/instances:batchUpdate</td>
+ <td>*</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>type</td>
- <td><a href="#bytebase.v1.Webhook.Type">Webhook.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>slack</td>
- <td><a href="#bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>AddDataSource</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:addDataSource</td>
+ <td>*</td>
+ </tr>
- <tr>
- <td>feishu</td>
- <td><a href="#bytebase.v1.AppIMSetting.Feishu">AppIMSetting.Feishu</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>wecom</td>
- <td><a href="#bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>lark</td>
- <td><a href="#bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>RemoveDataSource</td>
+ <td>POST</td>
+ <td>/v1/{name=instances/*}:removeDataSource</td>
+ <td>*</td>
+ </tr>
+
+
- <tr>
- <td>dingtalk</td>
- <td><a href="#bytebase.v1.AppIMSetting.DingTalk">AppIMSetting.DingTalk</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>UpdateDataSource</td>
+ <td>PATCH</td>
+ <td>/v1/{name=instances/*}:updateDataSource</td>
+ <td>data_source</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.AppIMSetting.Lark">AppIMSetting.Lark</h3>
+ <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>
@@ -14406,17 +14054,20 @@ But frontend can be started with a single rule easily. </p></td>
<tbody>
<tr>
- <td>app_id</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent resource shared by all databases being 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>app_secret</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>repeated</td>
+ <td><p>The list of database names to retrieve. </p></td>
</tr>
</tbody>
@@ -14426,7 +14077,7 @@ But frontend can be started with a single rule easily. </p></td>
- <h3 id="bytebase.v1.AppIMSetting.Slack">AppIMSetting.Slack</h3>
+ <h3 id="bytebase.v1.BatchGetDatabasesResponse">BatchGetDatabasesResponse</h3>
<p></p>
@@ -14437,10 +14088,10 @@ But frontend can be started with a single rule easily. </p></td>
<tbody>
<tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
+ <td>repeated</td>
+ <td><p>The databases from the specified request. </p></td>
</tr>
</tbody>
@@ -14450,7 +14101,7 @@ But frontend can be started with a single rule easily. </p></td>
- <h3 id="bytebase.v1.AppIMSetting.Wecom">AppIMSetting.Wecom</h3>
+ <h3 id="bytebase.v1.BatchSyncDatabasesRequest">BatchSyncDatabasesRequest</h3>
<p></p>
@@ -14461,24 +14112,19 @@ But frontend can be started with a single rule easily. </p></td>
<tbody>
<tr>
- <td>corp_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>agent_id</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent resource shared by all databases being updated.
+Format: instances/{instance}
+If the operation spans parents, a dash (-) may be accepted as a wildcard. </p></td>
</tr>
<tr>
- <td>secret</td>
+ <td>names</td>
<td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>repeated</td>
+ <td><p>The list of database names to sync. </p></td>
</tr>
</tbody>
@@ -14488,7 +14134,14 @@ But frontend can be started with a single rule easily. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting">DataClassificationSetting</h3>
+ <h3 id="bytebase.v1.BatchSyncDatabasesResponse">BatchSyncDatabasesResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.BatchUpdateDatabasesRequest">BatchUpdateDatabasesRequest</h3>
<p></p>
@@ -14499,10 +14152,21 @@ But frontend can be started with a single rule easily. </p></td>
<tbody>
<tr>
- <td>configs</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</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.
+We only support updating the project of databases for now. </p></td>
+ </tr>
+
+ <tr>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</a></td>
<td>repeated</td>
- <td><p> </p></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>
@@ -14512,7 +14176,7 @@ But frontend can be started with a single rule easily. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig">DataClassificationSetting.DataClassificationConfig</h3>
+ <h3 id="bytebase.v1.BatchUpdateDatabasesResponse">BatchUpdateDatabasesResponse</h3>
<p></p>
@@ -14523,33 +14187,10 @@ But frontend can be started with a single rule easily. </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></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>databases</td>
+ <td><a href="#bytebase.v1.Database">Database</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>Databases updated. </p></td>
</tr>
</tbody>
@@ -14559,8 +14200,8 @@ 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>
- <p></p>
+ <h3 id="bytebase.v1.BoundingBox">BoundingBox</h3>
+ <p>BoundingBox defines the spatial bounds for GEOMETRY spatial indexes.</p>
<table class="field-table">
@@ -14570,17 +14211,31 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<tbody>
<tr>
- <td>key</td>
- <td><a href="#string">string</a></td>
+ <td>xmin</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>Minimum X coordinate </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.DataClassificationSetting.DataClassificationConfig.DataClassification">DataClassificationSetting.DataClassificationConfig.DataClassification</a></td>
+ <td>ymin</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p> </p></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>
@@ -14590,7 +14245,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.ChangedResourceDatabase">ChangedResourceDatabase</h3>
<p></p>
@@ -14601,30 +14256,16 @@ 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></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>name</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>schemas</td>
+ <td><a href="#bytebase.v1.ChangedResourceSchema">ChangedResourceSchema</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
@@ -14635,7 +14276,7 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.DataClassificationSetting.DataClassificationConfig.Level">DataClassificationSetting.DataClassificationConfig.Level</h3>
+ <h3 id="bytebase.v1.ChangedResourceFunction">ChangedResourceFunction</h3>
<p></p>
@@ -14646,24 +14287,17 @@ 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></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>title</td>
+ <td>name</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>
+ <td>ranges</td>
+ <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td>repeated</td>
+ <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
</tr>
</tbody>
@@ -14673,7 +14307,7 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting">EnvironmentSetting</h3>
+ <h3 id="bytebase.v1.ChangedResourceProcedure">ChangedResourceProcedure</h3>
<p></p>
@@ -14684,12 +14318,19 @@ 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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
+ <tr>
+ <td>ranges</td>
+ <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td>repeated</td>
+ <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -14697,7 +14338,7 @@ 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>
+ <h3 id="bytebase.v1.ChangedResourceSchema">ChangedResourceSchema</h3>
<p></p>
@@ -14711,38 +14352,34 @@ The id should in [0-9]&#43;-[0-9]&#43;-[0-9]&#43; format. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the environment.
-Format: environments/{environment}.
-Output only. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource id of the environment.
-This value should be 4-63 characters, and valid characters
-are /[a-z][0-9]-/. </p></td>
+ <td>tables</td>
+ <td><a href="#bytebase.v1.ChangedResourceTable">ChangedResourceTable</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The display name of the environment. </p></td>
+ <td>views</td>
+ <td><a href="#bytebase.v1.ChangedResourceView">ChangedResourceView</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>tags</td>
- <td><a href="#bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</a></td>
+ <td>functions</td>
+ <td><a href="#bytebase.v1.ChangedResourceFunction">ChangedResourceFunction</a></td>
<td>repeated</td>
<td><p> </p></td>
</tr>
- <tr>
- <td>color</td>
- <td><a href="#string">string</a></td>
- <td></td>
+ <tr>
+ <td>procedures</td>
+ <td><a href="#bytebase.v1.ChangedResourceProcedure">ChangedResourceProcedure</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
@@ -14753,7 +14390,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.EnvironmentSetting.Environment.TagsEntry">EnvironmentSetting.Environment.TagsEntry</h3>
+ <h3 id="bytebase.v1.ChangedResourceTable">ChangedResourceTable</h3>
<p></p>
@@ -14764,17 +14401,17 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>key</td>
+ <td>name</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>ranges</td>
+ <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td>repeated</td>
+ <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
</tr>
</tbody>
@@ -14784,8 +14421,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.ChangedResourceView">ChangedResourceView</h3>
+ <p></p>
<table class="field-table">
@@ -14798,31 +14435,14 @@ are /[a-z][0-9]-/. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The resource name of the setting. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.GetSettingResponse">GetSettingResponse</h3>
- <p>The response message for getting a setting.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
<tr>
- <td>setting</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td></td>
- <td><p> </p></td>
+ <td>ranges</td>
+ <td><a href="#bytebase.v1.Range">Range</a></td>
+ <td>repeated</td>
+ <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>
</tr>
</tbody>
@@ -14832,14 +14452,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.ListSettingsRequest">ListSettingsRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListSettingsResponse">ListSettingsResponse</h3>
+ <h3 id="bytebase.v1.ChangedResources">ChangedResources</h3>
<p></p>
@@ -14850,10 +14463,10 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>settings</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
+ <td>databases</td>
+ <td><a href="#bytebase.v1.ChangedResourceDatabase">ChangedResourceDatabase</a></td>
<td>repeated</td>
- <td><p>The settings from the specified request. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -14863,7 +14476,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</h3>
+ <h3 id="bytebase.v1.Changelog">Changelog</h3>
<p></p>
@@ -14874,75 +14487,116 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>min_length</td>
- <td><a href="#int32">int32</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>min_length is the minimum length for password, should no less than 8. </p></td>
+ <td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
</tr>
<tr>
- <td>require_number</td>
- <td><a href="#bool">bool</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>require_number requires the password must contains at least one number. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>require_letter</td>
- <td><a href="#bool">bool</a></td>
+ <td>status</td>
+ <td><a href="#bytebase.v1.Changelog.Status">Changelog.Status</a></td>
<td></td>
- <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>require_uppercase_letter</td>
- <td><a href="#bool">bool</a></td>
+ <td>statement</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>require_uppercase_letter requires the password must contains at least one upper case letter. </p></td>
+ <td><p>The statement is used for preview purpose. </p></td>
</tr>
<tr>
- <td>require_special_character</td>
- <td><a href="#bool">bool</a></td>
+ <td>statement_size</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>require_special_character requires the password must contains at least one special character. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>require_reset_password_for_first_login</td>
- <td><a href="#bool">bool</a></td>
+ <td>statement_sheet</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>require_reset_password_for_first_login requires users to reset their password after the 1st login. </p></td>
+ <td><p>The name of the sheet resource.
+Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>password_rotation</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>password_rotation requires users to reset their password after the duration. </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SCIMSetting">SCIMSetting</h3>
- <p></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_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>token</td>
+ <td>prev_schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>prev_schema_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>issue</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{project}/issues/{issue} </p></td>
+ </tr>
+
+ <tr>
+ <td>task_run</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun} </p></td>
+ </tr>
+
+ <tr>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Could be empty </p></td>
+ </tr>
+
+ <tr>
+ <td>revision</td>
<td><a href="#string">string</a></td>
<td></td>
+ <td><p>Could be empty
+Or present but not found if deleted </p></td>
+ </tr>
+
+ <tr>
+ <td>changed_resources</td>
+ <td><a href="#bytebase.v1.ChangedResources">ChangedResources</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.Changelog.Type">Changelog.Type</a></td>
+ <td></td>
<td><p> </p></td>
</tr>
@@ -14953,8 +14607,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SchemaTemplateSetting">SchemaTemplateSetting</h3>
- <p></p>
+ <h3 id="bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</h3>
+ <p>CheckConstraintMetadata is the metadata for check constraints.</p>
<table class="field-table">
@@ -14964,24 +14618,17 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>field_templates</td>
- <td><a href="#bytebase.v1.SchemaTemplateSetting.FieldTemplate">SchemaTemplateSetting.FieldTemplate</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>column_types</td>
- <td><a href="#bytebase.v1.SchemaTemplateSetting.ColumnType">SchemaTemplateSetting.ColumnType</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a check constraint. </p></td>
</tr>
<tr>
- <td>table_templates</td>
- <td><a href="#bytebase.v1.SchemaTemplateSetting.TableTemplate">SchemaTemplateSetting.TableTemplate</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>expression</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The expression is the expression of a check constraint. </p></td>
</tr>
</tbody>
@@ -14991,8 +14638,8 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SchemaTemplateSetting.ColumnType">SchemaTemplateSetting.ColumnType</h3>
- <p></p>
+ <h3 id="bytebase.v1.ColumnMetadata">ColumnMetadata</h3>
+ <p>ColumnMetadata is the metadata for columns.</p>
<table class="field-table">
@@ -15002,152 +14649,144 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name is the name of a column. </p></td>
</tr>
<tr>
- <td>enabled</td>
+ <td>position</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The position is the position in columns. </p></td>
+ </tr>
+
+ <tr>
+ <td>has_default</td>
<td><a href="#bool">bool</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>types</td>
+ <td>default</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>The default value of column. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SchemaTemplateSetting.FieldTemplate">SchemaTemplateSetting.FieldTemplate</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</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>id</td>
- <td><a href="#string">string</a></td>
+ <td>nullable</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The nullable is the nullable of a column. </p></td>
</tr>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The type is the type of a column. </p></td>
</tr>
<tr>
- <td>category</td>
+ <td>character_set</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The character_set is the character_set of a column. </p></td>
</tr>
<tr>
- <td>column</td>
- <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The collation is the collation of a column. </p></td>
</tr>
<tr>
- <td>catalog</td>
- <td><a href="#bytebase.v1.ColumnCatalog">ColumnCatalog</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The comment is the comment of a column. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SchemaTemplateSetting.TableTemplate">SchemaTemplateSetting.TableTemplate</h3>
- <p></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>generation</td>
+ <td><a href="#bytebase.v1.GenerationMetadata">GenerationMetadata</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The generation is the generation of a column. </p></td>
</tr>
<tr>
- <td>engine</td>
- <td><a href="#bytebase.v1.Engine">Engine</a></td>
+ <td>is_identity</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>category</td>
- <td><a href="#string">string</a></td>
+ <td>identity_generation</td>
+ <td><a href="#bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The identity_generation is for identity columns, PG only. </p></td>
</tr>
<tr>
- <td>table</td>
- <td><a href="#bytebase.v1.TableMetadata">TableMetadata</a></td>
+ <td>identity_seed</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The identity_seed is for identity columns, MSSQL only. </p></td>
</tr>
<tr>
- <td>catalog</td>
- <td><a href="#bytebase.v1.TableCatalog">TableCatalog</a></td>
+ <td>identity_increment</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The identity_increment is for identity columns, MSSQL only. </p></td>
</tr>
- </tbody>
- </table>
+ <tr>
+ <td>default_constraint_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The default_constraint_name is the name of the default constraint, MSSQL only.
+In MSSQL, default values are implemented as named constraints. When modifying or
+dropping a column&#39;s default value, you must reference the constraint by name.
+This field stores the actual constraint name from the database.
-
+Example: A column definition like:
+ CREATE TABLE employees (
+ status NVARCHAR(20) DEFAULT &#39;active&#39;
+ )
-
-
- <h3 id="bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</h3>
- <p></p>
+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
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>types</td>
- <td><a href="#bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+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>
@@ -15157,7 +14796,7 @@ are /[a-z][0-9]-/. </p></td>
- <h3 id="bytebase.v1.SemanticTypeSetting.SemanticType">SemanticTypeSetting.SemanticType</h3>
+ <h3 id="bytebase.v1.Database">Database</h3>
<p></p>
@@ -15168,72 +14807,86 @@ are /[a-z][0-9]-/. </p></td>
<tbody>
<tr>
- <td>id</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>id is the uuid for semantic type. </p></td>
+ <td><p>The name of the database.
+Format: instances/{instance}/databases/{database}
+{database} is the database name in the instance. </p></td>
</tr>
<tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>the title of the semantic type, it should not be empty. </p></td>
+ <td><p>The existence of a database. </p></td>
</tr>
<tr>
- <td>description</td>
- <td><a href="#string">string</a></td>
+ <td>successful_sync_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>the description of the semantic type, it can be empty. </p></td>
+ <td><p>The latest synchronization time. </p></td>
</tr>
<tr>
- <td>algorithm</td>
- <td><a href="#bytebase.v1.Algorithm">Algorithm</a></td>
+ <td>project</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The project for a database.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>icon</td>
+ <td>schema_version</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>icon is the icon for semantic type, it can be emoji or base64 encoded image. </p></td>
+ <td><p>The version of database schema. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.Setting">Setting</h3>
- <p>The schema of setting.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <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>name</td>
+ <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 resource name of the setting. Must be one of the following forms:
-
-- `setting/{setting}`
-For example, &#34;settings/bb.branding.logo&#34; </p></td>
+ <td><p>The instance resource. </p></td>
</tr>
<tr>
- <td>value</td>
- <td><a href="#bytebase.v1.Value">Value</a></td>
+ <td>backup_available</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The configuration value of the setting. </p></td>
+ <td><p>The database is available for DML prior backup. </p></td>
+ </tr>
+
+ <tr>
+ <td>drifted</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>The schema is drifted from the source of truth. </p></td>
</tr>
</tbody>
@@ -15243,8 +14896,8 @@ For example, &#34;settings/bb.branding.logo&#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.Database.LabelsEntry">Database.LabelsEntry</h3>
+ <p></p>
<table class="field-table">
@@ -15254,30 +14907,15 @@ For example, &#34;settings/bb.branding.logo&#34; </p></td>
<tbody>
<tr>
- <td>setting</td>
- <td><a href="#bytebase.v1.Setting">Setting</a></td>
- <td></td>
- <td><p>The setting to update. </p></td>
- </tr>
-
- <tr>
- <td>validate_only</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>validate_only is a flag to indicate whether to validate the setting value,
-server would not persist the setting value if it is true. </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>key</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -15289,8 +14927,8 @@ server would not persist the setting value if it is true. </p></td>
- <h3 id="bytebase.v1.Value">Value</h3>
- <p>The data in setting value.</p>
+ <h3 id="bytebase.v1.DatabaseMetadata">DatabaseMetadata</h3>
+ <p>DatabaseMetadata is the metadata for databases.</p>
<table class="field-table">
@@ -15300,80 +14938,91 @@ server would not persist the setting value if it is true. </p></td>
<tbody>
<tr>
- <td>string_value</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Defines this value as being a string value. </p></td>
- </tr>
-
- <tr>
- <td>app_im_setting_value</td>
- <td><a href="#bytebase.v1.AppIMSetting">AppIMSetting</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>workspace_profile_setting_value</td>
- <td><a href="#bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</a></td>
- <td></td>
- <td><p>reserved 4; // was AgentPluginSetting agent_plugin_setting_value </p></td>
+ <td><p>The database metadata name.
+
+Format: instances/{instance}/databases/{database}/metadata </p></td>
</tr>
<tr>
- <td>workspace_approval_setting_value</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting">WorkspaceApprovalSetting</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>schema_template_setting_value</td>
- <td><a href="#bytebase.v1.SchemaTemplateSetting">SchemaTemplateSetting</a></td>
+ <td>character_set</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The character_set is the character set of a database. </p></td>
</tr>
<tr>
- <td>data_classification_setting_value</td>
- <td><a href="#bytebase.v1.DataClassificationSetting">DataClassificationSetting</a></td>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The collation is the collation of a database. </p></td>
</tr>
<tr>
- <td>semantic_type_setting_value</td>
- <td><a href="#bytebase.v1.SemanticTypeSetting">SemanticTypeSetting</a></td>
- <td></td>
- <td><p> </p></td>
+ <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>scim_setting</td>
- <td><a href="#bytebase.v1.SCIMSetting">SCIMSetting</a></td>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The owner of the database. </p></td>
</tr>
<tr>
- <td>password_restriction_setting</td>
- <td><a href="#bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</a></td>
+ <td>search_path</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The search_path is the search path of a PostgreSQL database. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DatabaseSDLSchema">DatabaseSDLSchema</h3>
+ <p>DatabaseSDLSchema contains the schema in SDL format.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>ai_setting</td>
- <td><a href="#bytebase.v1.AISetting">AISetting</a></td>
+ <td>schema</td>
+ <td><a href="#bytes">bytes</a></td>
<td></td>
- <td><p> </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>environment_setting</td>
- <td><a href="#bytebase.v1.EnvironmentSetting">EnvironmentSetting</a></td>
+ <td>content_type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </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>
@@ -15383,8 +15032,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.DatabaseSchema">DatabaseSchema</h3>
+ <p>DatabaseSchema is the metadata for databases.</p>
<table class="field-table">
@@ -15394,10 +15043,10 @@ 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>schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema dump from database. </p></td>
</tr>
</tbody>
@@ -15407,8 +15056,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.DependencyColumn">DependencyColumn</h3>
+ <p>DependencyColumn is the metadata for dependency columns.</p>
<table class="field-table">
@@ -15418,50 +15067,24 @@ 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>schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The schema is the schema of a reference column. </p></td>
</tr>
<tr>
- <td>condition</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
+ <td>table</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The condition that is associated with the rule.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-The `source` field filters which rules apply. The `condition` field then evaluates with full context.
-
-All supported variables:
-statement.affected_rows: affected row count in the DDL/DML, support &#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 table is the table of a reference column. </p></td>
</tr>
<tr>
- <td>source</td>
- <td><a href="#bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</a></td>
+ <td>column</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The column is the name of a reference column. </p></td>
</tr>
</tbody>
@@ -15471,7 +15094,7 @@ resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engin
- <h3 id="bytebase.v1.WorkspaceProfileSetting">WorkspaceProfileSetting</h3>
+ <h3 id="bytebase.v1.DependencyTable">DependencyTable</h3>
<p></p>
@@ -15482,492 +15105,582 @@ resource.table_name.matches(&#34;sensitive_.*&#34;) &amp;&amp; resource.db_engin
<tbody>
<tr>
- <td>external_url</td>
+ <td>schema</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The external URL is used for sso authentication callback. </p></td>
+ <td><p>The schema is the schema of a reference table. </p></td>
</tr>
<tr>
- <td>disallow_signup</td>
- <td><a href="#bool">bool</a></td>
+ <td>table</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Disallow self-service signup, users can only be invited by the owner. </p></td>
+ <td><p>The table is the name of a reference table. </p></td>
</tr>
- <tr>
- <td>require_2fa</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Require 2FA for all users. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DiffSchemaRequest">DiffSchemaRequest</h3>
+ <p></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_duration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The duration for token. </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>announcement</td>
- <td><a href="#bytebase.v1.Announcement">Announcement</a></td>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The setting of custom announcement </p></td>
+ <td><p>The target schema. </p></td>
</tr>
<tr>
- <td>maximum_role_expiration</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>changelog</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The max duration for role expired. </p></td>
+ <td><p>The resource name of the changelog
+Format:
+instances/{instance}/databases/{database}/changelogs/{changelog} </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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DiffSchemaResponse">DiffSchemaResponse</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>enforce_identity_domain</td>
- <td><a href="#bool">bool</a></td>
+ <td>diff</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Only user and group from the domains can be created and login. </p></td>
+ <td><p> </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>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DimensionConstraint">DimensionConstraint</h3>
+ <p>DimensionConstraint defines constraints for a spatial dimension.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>disallow_password_signin</td>
- <td><a href="#bool">bool</a></td>
+ <td>dimension</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether to disallow password signin. (Except workspace admins) </p></td>
+ <td><p>Dimension name/type (X, Y, Z, M, etc.) </p></td>
</tr>
<tr>
- <td>enable_metric_collection</td>
- <td><a href="#bool">bool</a></td>
+ <td>min_value</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>Whether to enable metric collection for the workspace. </p></td>
+ <td><p>Minimum value for this dimension </p></td>
</tr>
<tr>
- <td>inactive_session_timeout</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>max_value</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>The session expiration time if not activity detected for the user. Value &lt;= 0 means no limit. </p></td>
+ <td><p>Maximum value for this dimension </p></td>
</tr>
- <tr>
- <td>enable_audit_log_stdout</td>
- <td><a href="#bool">bool</a></td>
+ <tr>
+ <td>tolerance</td>
+ <td><a href="#double">double</a></td>
<td></td>
- <td><p>Whether to enable audit logging to stdout in structured JSON format.
-Requires TEAM or ENTERPRISE license. </p></td>
+ <td><p>Tolerance for this dimension </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>OPEN_AI</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CLAUDE</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>GEMINI</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AZURE_OPENAI</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Algorithm.InnerOuterMask.MaskType">Algorithm.InnerOuterMask.MaskType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>MASK_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>INNER</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>OUTER</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Announcement.AlertLevel">Announcement.AlertLevel</h3>
- <p>We support three levels of AlertLevel: INFO, WARNING, and ERROR.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>ALERT_LEVEL_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>INFO</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WARNING</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>CRITICAL</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.DatabaseChangeMode">DatabaseChangeMode</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>DATABASE_CHANGE_MODE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PIPELINE</td>
- <td>1</td>
- <td><p>A more advanced database change process, including custom approval workflows and other advanced features.
-Default to this mode.</p></td>
- </tr>
-
- <tr>
- <td>EDITOR</td>
- <td>2</td>
- <td><p>A simple database change process in SQL editor. Users can execute SQL directly.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.Setting.SettingName">Setting.SettingName</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SETTING_NAME_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AUTH_SECRET</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>BRANDING_LOGO</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE_ID</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE_PROFILE</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE_APPROVAL</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WORKSPACE_EXTERNAL_APPROVAL</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>ENTERPRISE_LICENSE</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>APP_IM</td>
- <td>8</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>WATERMARK</td>
- <td>9</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>AI</td>
- <td>10</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SCHEMA_TEMPLATE</td>
- <td>13</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>DATA_CLASSIFICATION</td>
- <td>14</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SEMANTIC_TYPES</td>
- <td>15</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>SCIM</td>
- <td>17</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PASSWORD_RESTRICTION</td>
- <td>18</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>ENVIRONMENT</td>
- <td>19</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
+
- <h3 id="bytebase.v1.WorkspaceApprovalSetting.Rule.Source">WorkspaceApprovalSetting.Rule.Source</h3>
+ <h3 id="bytebase.v1.DimensionalConfig">DimensionalConfig</h3>
+ <p>DimensionalConfig defines dimensional and constraint parameters for spatial indexes.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>dimensions</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Number of dimensions (2-4, default 2) </p></td>
+ </tr>
+
+ <tr>
+ <td>data_type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Spatial data type (GEOMETRY, GEOGRAPHY, POINT, POLYGON, etc.) </p></td>
+ </tr>
+
+ <tr>
+ <td>srid</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>Spatial reference system identifier (SRID) </p></td>
+ </tr>
+
+ <tr>
+ <td>constraints</td>
+ <td><a href="#bytebase.v1.DimensionConstraint">DimensionConstraint</a></td>
+ <td>repeated</td>
+ <td><p>Coordinate system constraints </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</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>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of a type. </p></td>
+ </tr>
+
+ <tr>
+ <td>values</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The enum values of a type. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment describing the enum type. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this enum type during schema dump operations. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.EventMetadata">EventMetadata</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schedule of the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>time_zone</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The time zone of the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_mode</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The SQL mode setting for the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>character_set_client</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character set used by the client creating the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>collation_connection</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation used for the connection when creating the event. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment is the comment of an event. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ExtensionMetadata">ExtensionMetadata</h3>
+ <p>ExtensionMetadata is the metadata for extensions.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of an extension. </p></td>
+ </tr>
+
+ <tr>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The schema is the extension that is installed to. But the extension usage
+is not limited to the schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>version</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The version is the version of an extension. </p></td>
+ </tr>
+
+ <tr>
+ <td>description</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The description is the description of an extension. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h3 id="bytebase.v1.ExternalTableMetadata">ExternalTableMetadata</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a external table. </p></td>
+ </tr>
+
+ <tr>
+ <td>external_server_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The external_server_name is the name of the external server. </p></td>
+ </tr>
+
+ <tr>
+ <td>external_database_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The external_database_name is the name of the external database. </p></td>
+ </tr>
+
+ <tr>
+ <td>columns</td>
+ <td><a href="#bytebase.v1.ColumnMetadata">ColumnMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a foreign table. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
+
+
- <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>
+ <h3 id="bytebase.v1.ForeignKeyMetadata">ForeignKeyMetadata</h3>
+ <p>ForeignKeyMetadata is the metadata for foreign keys.</p>
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>columns</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The columns are the ordered referencing columns of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>referenced_schema</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The referenced_schema is the referenced schema name of a foreign key.
+It is an empty string for databases without such concept such as MySQL. </p></td>
+ </tr>
+
+ <tr>
+ <td>referenced_table</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The referenced_table is the referenced table name of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>referenced_columns</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The referenced_columns are the ordered referenced columns of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>on_delete</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The on_delete is the on delete action of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>on_update</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The on_update is the on update action of a foreign key. </p></td>
+ </tr>
+
+ <tr>
+ <td>match_type</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The match_type is the match type of a foreign key.
+The match_type is the PostgreSQL specific field.
+It&#39;s empty string for other databases. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+
+
+
+ <h3 id="bytebase.v1.FunctionMetadata">FunctionMetadata</h3>
+ <p>FunctionMetadata is the metadata for functions.</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 is the name of a function. </p></td>
+ </tr>
- <tr>
- <td>ListSettings</td>
- <td>GET</td>
- <td>/v1/settings</td>
- <td></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>GetSetting</td>
- <td>GET</td>
- <td>/v1/{name=settings/*}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>collation_connection</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
+ <tr>
+ <td>database_collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>sql_mode</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>UpdateSetting</td>
- <td>PATCH</td>
- <td>/v1/{setting.name=settings/*}</td>
- <td>setting</td>
- </tr>
+ <tr>
+ <td>dependency_tables</td>
+ <td><a href="#bytebase.v1.DependencyTable">DependencyTable</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_tables is the list of dependency tables of a function.
+For PostgreSQL, it&#39;s the list of tables that the function depends on the return type definition. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.GenerationMetadata">GenerationMetadata</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>expression</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <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>
+ <h3 id="bytebase.v1.GetChangelogRequest">GetChangelogRequest</h3>
<p></p>
@@ -15978,11 +15691,18 @@ Permissions required: bb.settings.set</p></td>
<tbody>
<tr>
- <td>names</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The user names to retrieve.
-Format: users/{user uid or user email} </p></td>
+ <td></td>
+ <td><p>The name of the changelog to retrieve.
+Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>
+ </tr>
+
+ <tr>
+ <td>view</td>
+ <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -15992,7 +15712,7 @@ Format: users/{user uid or user email} </p></td>
- <h3 id="bytebase.v1.BatchGetUsersResponse">BatchGetUsersResponse</h3>
+ <h3 id="bytebase.v1.GetDatabaseMetadataRequest">GetDatabaseMetadataRequest</h3>
<p></p>
@@ -16003,10 +15723,41 @@ Format: users/{user uid or user 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>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>
@@ -16016,7 +15767,7 @@ Format: users/{user uid or user email} </p></td>
- <h3 id="bytebase.v1.CreateUserRequest">CreateUserRequest</h3>
+ <h3 id="bytebase.v1.GetDatabaseRequest">GetDatabaseRequest</h3>
<p></p>
@@ -16027,10 +15778,11 @@ Format: users/{user uid or user email} </p></td>
<tbody>
<tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The user to create. </p></td>
+ <td><p>The name of the database to retrieve.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
</tbody>
@@ -16040,7 +15792,7 @@ Format: users/{user uid or user email} </p></td>
- <h3 id="bytebase.v1.DeleteUserRequest">DeleteUserRequest</h3>
+ <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest">GetDatabaseSDLSchemaRequest</h3>
<p></p>
@@ -16054,8 +15806,15 @@ Format: users/{user uid or user 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/{user} </p></td>
+ <td><p>The name of the database to retrieve SDL schema.
+Format: instances/{instance}/databases/{database}/sdlSchema </p></td>
+ </tr>
+
+ <tr>
+ <td>format</td>
+ <td><a href="#bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</a></td>
+ <td></td>
+ <td><p>The format of the SDL schema output. </p></td>
</tr>
</tbody>
@@ -16065,7 +15824,7 @@ Format: users/{user} </p></td>
- <h3 id="bytebase.v1.GetUserRequest">GetUserRequest</h3>
+ <h3 id="bytebase.v1.GetDatabaseSchemaRequest">GetDatabaseSchemaRequest</h3>
<p></p>
@@ -16079,8 +15838,8 @@ Format: users/{user} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the user to retrieve.
-Format: users/{user uid or user email} </p></td>
+ <td><p>The name of the database to retrieve schema.
+Format: instances/{instance}/databases/{database}/schema </p></td>
</tr>
</tbody>
@@ -16090,7 +15849,7 @@ Format: users/{user uid or user email} </p></td>
- <h3 id="bytebase.v1.ListUsersRequest">ListUsersRequest</h3>
+ <h3 id="bytebase.v1.GetSchemaStringRequest">GetSchemaStringRequest</h3>
<p></p>
@@ -16101,60 +15860,64 @@ Format: users/{user uid or user email} </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 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 name of the database.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>page_token</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>A page token, received from a previous `ListUsers` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListUsers` must match
-the call that provided the page token. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
+ <td>schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Show deleted users if specified. </p></td>
+ <td><p>It&#39;s empty for DATABASE. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>object</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
+ <td><p>It&#39;s empty for DATABASE and SCHEMA. </p></td>
+ </tr>
+
+ <tr>
+ <td>metadata</td>
+ <td><a href="#bytebase.v1.DatabaseMetadata">DatabaseMetadata</a></td>
+ <td></td>
+ <td><p>If use the metadata to generate the schema string, the type is OBJECT_TYPE_UNSPECIFIED.
+Also the schema and object are empty. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
-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>
+
+
+ <h3 id="bytebase.v1.GetSchemaStringResponse">GetSchemaStringResponse</h3>
+ <p></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_string</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -16164,8 +15927,8 @@ name.matches(&#34;ed&#34;) &amp;&amp; project == &#34;projects/sample-project&#3
- <h3 id="bytebase.v1.ListUsersResponse">ListUsersResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.GridLevel">GridLevel</h3>
+ <p>GridLevel defines a tessellation grid level with its density.</p>
<table class="field-table">
@@ -16175,18 +15938,17 @@ 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>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>next_page_token</td>
+ <td>density</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>Grid density (LOW, MEDIUM, HIGH) </p></td>
</tr>
</tbody>
@@ -16196,8 +15958,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.UndeleteUserRequest">UndeleteUserRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.IndexMetadata">IndexMetadata</h3>
+ <p>IndexMetadata is the metadata for indexes.</p>
<table class="field-table">
@@ -16207,75 +15969,126 @@ 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>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 name of the deleted user.
-Format: users/{user} </p></td>
+ <td><p>The visible is whether the index is visible. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateUserRequest">UpdateUserRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
+ <td>definition</td>
+ <td><a href="#string">string</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/{user} </p></td>
+ <td><p>The definition of an index. </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>parent_index_schema</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The list of fields to update. </p></td>
+ <td><p>The schema name of the parent index. </p></td>
</tr>
<tr>
- <td>otp_code</td>
+ <td>parent_index_name</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></td>
+ <td><p>The index name of the parent index. </p></td>
</tr>
<tr>
- <td>regenerate_temp_mfa_secret</td>
- <td><a href="#bool">bool</a></td>
+ <td>granularity</td>
+ <td><a href="#int64">int64</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 number of granules in the block. It&#39;s a ClickHouse specific field. </p></td>
</tr>
<tr>
- <td>regenerate_recovery_codes</td>
+ <td>is_constraint</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The regenerate_recovery_codes flag means to regenerate recovery codes for user. </p></td>
+ <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>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>spatial_config</td>
+ <td><a href="#bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</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>Spatial index configuration for spatial databases like SQL Server, PostgreSQL with PostGIS, etc. </p></td>
+ </tr>
+
+ <tr>
+ <td>opclass_names</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>https://www.postgresql.org/docs/current/catalog-pg-opclass.html
+Name of the operator class for each column. (PostgreSQL specific). </p></td>
+ </tr>
+
+ <tr>
+ <td>opclass_defaults</td>
+ <td><a href="#bool">bool</a></td>
+ <td>repeated</td>
+ <td><p>True if the operator class is the default. (PostgreSQL specific). </p></td>
</tr>
</tbody>
@@ -16285,7 +16098,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.User">User</h3>
+ <h3 id="bytebase.v1.ListChangelogsRequest">ListChangelogsRequest</h3>
<p></p>
@@ -16296,104 +16109,199 @@ In this situation, `update_mask` is ignored. </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.
-Format: users/{user}. {user} is a system-generated unique ID. </p></td>
+ <td><p>The parent of the changelogs.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The lifecycle state of the user account. </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>email</td>
+ <td>page_token</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>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>title</td>
- <td><a href="#string">string</a></td>
+ <td>view</td>
+ <td><a href="#bytebase.v1.ChangelogView">ChangelogView</a></td>
<td></td>
- <td><p>The display title or full name of the user. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>user_type</td>
- <td><a href="#bytebase.v1.UserType">UserType</a></td>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The type of user account. </p></td>
+ <td><p>The filter of the changelogs.
+follow the
+[ebnf](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form)
+syntax. Support filter by type, source or table. For example: table =
+&#34;tableExists(&#39;{database}&#39;, &#39;{schema}&#39;, &#39;{table}&#39;)&#34; table =
+&#34;tableExists(&#39;db&#39;, &#39;public&#39;, &#39;table1&#39;) || tableExists(&#39;db&#39;, &#39;public&#39;,
+&#39;table2&#39;)&#34;
+
+The table filter follow the CEL syntax.
+currently, we have one function for CEL:
+- tableExists(database, schema, table): return true if the table exists in
+changed resources.
+
+examples:
+Use
+ tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;)
+to filter the changelogs which have the table &#34;table1&#34; in the schema
+&#34;public&#34; of the database &#34;db&#34;. For MySQL, the schema is always &#34;&#34;, such as
+tableExists(&#34;db&#34;, &#34;&#34;, &#34;table1&#34;).
+
+Combine multiple functions with &#34;&amp;&amp;&#34; and &#34;||&#34;, we MUST use the Disjunctive
+Normal Form(DNF). In other words, the CEL expression consists of several
+parts connected by OR operators. For example, the following expression is
+valid:
+(
+ tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table1&#34;) &amp;&amp;
+ tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table2&#34;)
+) || (
+ tableExists(&#34;db&#34;, &#34;public&#34;, &#34;table3&#34;)
+) </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListChangelogsResponse">ListChangelogsResponse</h3>
+ <p></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></td>
- <td><p>The password for authentication. Only used during user creation or password updates. </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>service_key</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The service key for service account authentication. Only used for service accounts. </p></td>
+ <td><p>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>mfa_enabled</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>The mfa_enabled flag means if the user has enabled MFA. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListDatabasesRequest">ListDatabasesRequest</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>temp_otp_secret</td>
+ <td>parent</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>- 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>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>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>temp_otp_secret_created_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>Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer. </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>phone</td>
+ <td>filter</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>Filter is used to filter databases returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- environment: the environment full name in &#34;environments/{id}&#34; format, support &#34;==&#34; operator.
+- name: the database name, support &#34;.matches()&#34; operator.
+- project: the project full name in &#34;projects/{id}&#34; format, support &#34;==&#34; operator.
+- instance: the instance full name in &#34;instances/{id}&#34; format, support &#34;==&#34; operator.
+- engine: the database engine, check Engine enum for values. Support &#34;==&#34;, &#34;in [xx]&#34;, &#34;!(in [xx])&#34; operator.
+- exclude_unassigned: should be &#34;true&#34; or &#34;false&#34;, will not show unassigned databases if it&#39;s true, support &#34;==&#34; operator.
+- drifted: should be &#34;true&#34; or &#34;false&#34;, show drifted databases if it&#39;s true, support &#34;==&#34; operator.
+- table: filter by the database table, support &#34;==&#34; and &#34;.matches()&#34; operator.
+- labels.{key}: the database label, support &#34;==&#34; and &#34;in&#34; operators.
+
+For example:
+environment == &#34;environments/{environment resource id}&#34;
+environment == &#34;&#34; (find databases which environment is not set)
+project == &#34;projects/{project resource id}&#34;
+instance == &#34;instances/{instance resource id}&#34;
+name.matches(&#34;database name&#34;)
+engine == &#34;MYSQL&#34;
+engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;]
+!(engine in [&#34;MYSQL&#34;, &#34;POSTGRES&#34;])
+exclude_unassigned == true
+drifted == true
+table == &#34;sample&#34;
+table.matches(&#34;sam&#34;)
+labels.environment == &#34;production&#34;
+labels.region == &#34;asia&#34;
+labels.region in [&#34;asia&#34;, &#34;europe&#34;]
+
+You can combine filter conditions like:
+environment == &#34;environments/prod&#34; &amp;&amp; name.matches(&#34;employee&#34;) </p></td>
</tr>
<tr>
- <td>profile</td>
- <td><a href="#bytebase.v1.User.Profile">User.Profile</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>User profile metadata. </p></td>
- </tr>
-
- <tr>
- <td>groups</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The groups for the user.
-Format: groups/{email} </p></td>
+ <td><p>Show deleted database if specified. </p></td>
</tr>
</tbody>
@@ -16403,7 +16311,7 @@ Format: groups/{email} </p></td>
- <h3 id="bytebase.v1.User.Profile">User.Profile</h3>
+ <h3 id="bytebase.v1.ListDatabasesResponse">ListDatabasesResponse</h3>
<p></p>
@@ -16414,24 +16322,18 @@ Format: groups/{email} </p></td>
<tbody>
<tr>
- <td>last_login_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last time the user successfully logged in. </p></td>
- </tr>
-
- <tr>
- <td>last_change_password_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last time the user changed their password. </p></td>
+ <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>source</td>
+ <td>next_page_token</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>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>
@@ -16441,234 +16343,187 @@ Format: groups/{email} </p></td>
-
-
- <h3 id="bytebase.v1.UserType">UserType</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>USER_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified user type.</p></td>
- </tr>
-
- <tr>
- <td>USER</td>
- <td>1</td>
- <td><p>Regular human user account.</p></td>
- </tr>
-
- <tr>
- <td>SYSTEM_BOT</td>
- <td>2</td>
- <td><p>System-managed bot account for automated operations.</p></td>
- </tr>
-
- <tr>
- <td>SERVICE_ACCOUNT</td>
- <td>3</td>
- <td><p>Service account for API integrations.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.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.
-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>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.MaterializedViewMetadata">MaterializedViewMetadata</h3>
+ <p>MaterializedViewMetadata is the metadata for materialized views.</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>GetUser</td>
- <td>GET</td>
- <td>/v1/{name=users/*}</td>
- <td></td>
- </tr>
-
-
+ <tr>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a materialized view. </p></td>
+ </tr>
- <tr>
- <td>BatchGetUsers</td>
- <td>GET</td>
- <td>/v1/users:batchGet</td>
- <td></td>
- </tr>
-
-
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a materialized view. </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 materialized view. </p></td>
+ </tr>
- <tr>
- <td>GetCurrentUser</td>
- <td>GET</td>
- <td>/v1/users/me</td>
- <td></td>
- </tr>
+ <tr>
+ <td>dependency_columns</td>
+ <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_columns is the list of dependency columns of a materialized
+view. </p></td>
+ </tr>
-
+ <tr>
+ <td>triggers</td>
+ <td><a href="#bytebase.v1.TriggerMetadata">TriggerMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The columns is the ordered list of columns in a table. </p></td>
+ </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>ListUsers</td>
- <td>GET</td>
- <td>/v1/users</td>
- <td></td>
- </tr>
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.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><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a package. </p></td>
+ </tr>
- <tr>
- <td>CreateUser</td>
- <td>POST</td>
- <td>/v1/users</td>
- <td>user</td>
- </tr>
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a package. </p></td>
+ </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><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name is the name of a procedure. </p></td>
+ </tr>
- <tr>
- <td>UpdateUser</td>
- <td>PATCH</td>
- <td>/v1/{user.name=users/*}</td>
- <td>user</td>
- </tr>
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a procedure. </p></td>
+ </tr>
-
+ <tr>
+ <td>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
+procedure 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>DeleteUser</td>
- <td>DELETE</td>
- <td>/v1/{name=users/*}</td>
- <td></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>UndeleteUser</td>
- <td>POST</td>
- <td>/v1/{name=users/*}:undelete</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 procedure. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </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.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">
@@ -16678,164 +16533,271 @@ Permissions required: bb.users.undelete</p></td>
<tbody>
<tr>
- <td>version</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The Bytebase server version. </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>
<tr>
- <td>git_commit</td>
+ <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>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 git commit hash of the build. </p></td>
+ <td><p>The owner of the schema. </p></td>
</tr>
<tr>
- <td>readonly</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether the Bytebase instance is running in read-only mode. </p></td>
+ <td>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>saas</td>
+ <td>events</td>
+ <td><a href="#bytebase.v1.EventMetadata">EventMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The events is the list of scheduled events in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>enum_types</td>
+ <td><a href="#bytebase.v1.EnumTypeMetadata">EnumTypeMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The enum_types is the list of user-defined enum types in a schema. </p></td>
+ </tr>
+
+ <tr>
+ <td>skip_dump</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in SaaS mode where some features cannot be edited by users. </p></td>
+ <td><p>Whether to skip this schema during schema dump operations. </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 is the comment of a schema. </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SequenceMetadata">SequenceMetadata</h3>
+ <p></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 a sequence. </p></td>
</tr>
<tr>
- <td>port</td>
+ <td>data_type</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The port number of the Bytebase instance. </p></td>
+ <td><p>The data type of a sequence. </p></td>
</tr>
<tr>
- <td>external_url</td>
+ <td>start</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 start value of a sequence. </p></td>
</tr>
<tr>
- <td>need_admin_setup</td>
- <td><a href="#bool">bool</a></td>
+ <td>min_value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether the Bytebase instance requires initial admin setup. </p></td>
+ <td><p>The minimum value of a sequence. </p></td>
</tr>
<tr>
- <td>disallow_signup</td>
- <td><a href="#bool">bool</a></td>
+ <td>max_value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether self-service user signup is disabled. </p></td>
+ <td><p>The maximum value of a sequence. </p></td>
</tr>
<tr>
- <td>last_active_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>increment</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>Increment value of a sequence. </p></td>
</tr>
<tr>
- <td>require_2fa</td>
+ <td>cycle</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether two-factor authentication is required for all users. </p></td>
+ <td><p>Cycle is whether the sequence cycles. </p></td>
</tr>
<tr>
- <td>workspace_id</td>
+ <td>cache_size</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The unique identifier for the workspace. </p></td>
+ <td><p>Cache size of a sequence. </p></td>
</tr>
<tr>
- <td>debug</td>
- <td><a href="#bool">bool</a></td>
+ <td>last_value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether debug mode is enabled. </p></td>
+ <td><p>Last value of a sequence. </p></td>
</tr>
<tr>
- <td>unlicensed_features</td>
+ <td>owner_table</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>List of features that are not licensed. </p></td>
+ <td></td>
+ <td><p>The owner table of the sequence. </p></td>
</tr>
<tr>
- <td>disallow_password_signin</td>
- <td><a href="#bool">bool</a></td>
+ <td>owner_column</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Whether password-based signin is disabled (except for workspace admins). </p></td>
+ <td><p>The owner column of the sequence. </p></td>
</tr>
<tr>
- <td>password_restriction</td>
- <td><a href="#bytebase.v1.PasswordRestrictionSetting">PasswordRestrictionSetting</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Password complexity and restriction requirements. </p></td>
+ <td><p>The comment describing the sequence. </p></td>
</tr>
<tr>
- <td>docker</td>
+ <td>skip_dump</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether the Bytebase instance is running in Docker. </p></td>
+ <td><p>Whether to skip this sequence during schema dump operations. </p></td>
</tr>
- <tr>
- <td>user_stats</td>
- <td><a href="#bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</a></td>
- <td>repeated</td>
- <td><p>Statistics about users in the system. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SpatialIndexConfig">SpatialIndexConfig</h3>
+ <p>SpatialIndexConfig defines the spatial index configuration for spatial databases.</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
<tr>
- <td>activated_instance_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>method</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The number of activated database instances. </p></td>
+ <td><p>Spatial indexing method (e.g., &#34;SPATIAL&#34;, &#34;R-TREE&#34;, &#34;GIST&#34;) </p></td>
</tr>
<tr>
- <td>total_instance_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>tessellation</td>
+ <td><a href="#bytebase.v1.TessellationConfig">TessellationConfig</a></td>
<td></td>
- <td><p>The total number of database instances. </p></td>
+ <td><p>Tessellation configuration for grid-based spatial indexes </p></td>
</tr>
<tr>
- <td>enable_sample</td>
- <td><a href="#bool">bool</a></td>
+ <td>storage</td>
+ <td><a href="#bytebase.v1.StorageConfig">StorageConfig</a></td>
<td></td>
- <td><p>Whether sample data setup is enabled. </p></td>
+ <td><p>Storage and performance configuration </p></td>
</tr>
<tr>
- <td>external_url_from_flag</td>
- <td><a href="#bool">bool</a></td>
+ <td>dimensional</td>
+ <td><a href="#bytebase.v1.DimensionalConfig">DimensionalConfig</a></td>
<td></td>
- <td><p>Whether the external URL is set via command-line flag (and thus cannot be changed via UI). </p></td>
+ <td><p>Dimensional configuration </p></td>
</tr>
</tbody>
@@ -16845,8 +16807,8 @@ Permissions required: bb.users.undelete</p></td>
- <h3 id="bytebase.v1.ActuatorInfo.StatUser">ActuatorInfo.StatUser</h3>
- <p>User statistics by type and state.</p>
+ <h3 id="bytebase.v1.StorageConfig">StorageConfig</h3>
+ <p>StorageConfig defines storage and performance parameters for spatial indexes.</p>
<table class="field-table">
@@ -16856,115 +16818,101 @@ Permissions required: bb.users.undelete</p></td>
<tbody>
<tr>
- <td>user_type</td>
- <td><a href="#bytebase.v1.UserType">UserType</a></td>
+ <td>fillfactor</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The type of user. </p></td>
+ <td><p>Fill factor percentage (1-100) </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>buffering</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The state of the user. </p></td>
+ <td><p>Buffering mode for PostgreSQL (auto, on, off) </p></td>
</tr>
<tr>
- <td>count</td>
+ <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>The count of users matching this type and state. </p></td>
+ <td><p> </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>commit_interval</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>logo</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>pad_index</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The branding logo. </p></td>
+ <td><p>SQL Server specific parameters </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SetupSampleRequest">SetupSampleRequest</h3>
- <p>Request message for setting up sample data.</p>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</h3>
- <p>Request message for updating actuator information.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>sort_in_tempdb</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>ON, OFF </p></td>
+ </tr>
<tr>
- <td>actuator</td>
- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
+ <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>The actuator to update. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>maxdop</td>
+ <td><a href="#int32">int32</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>data_compression</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the actuator is not found, a new actuator will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>NONE, ROW, PAGE </p></td>
</tr>
</tbody>
@@ -16974,142 +16922,81 @@ In this situation, `update_mask` is ignored. </p></td>
-
-
-
-
-
-
- <h3 id="bytebase.v1.ActuatorService">ActuatorService</h3>
- <p>ActuatorService manages system health and operational information.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetActuatorInfo</td>
- <td><a href="#bytebase.v1.GetActuatorInfoRequest">GetActuatorInfoRequest</a></td>
- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
- <td><p>Gets system information and health status of the Bytebase instance.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>UpdateActuatorInfo</td>
- <td><a href="#bytebase.v1.UpdateActuatorInfoRequest">UpdateActuatorInfoRequest</a></td>
- <td><a href="#bytebase.v1.ActuatorInfo">ActuatorInfo</a></td>
- <td><p>Updates system configuration settings for the Bytebase instance.
-Permissions required: bb.settings.set</p></td>
- </tr>
-
- <tr>
- <td>SetupSample</td>
- <td><a href="#bytebase.v1.SetupSampleRequest">SetupSampleRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Sets up sample data for demonstration and testing purposes.
-Permissions required: bb.projects.create</p></td>
- </tr>
-
- <tr>
- <td>DeleteCache</td>
- <td><a href="#bytebase.v1.DeleteCacheRequest">DeleteCacheRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Clears the system cache to force data refresh.
-Permissions required: None</p></td>
- </tr>
-
- <tr>
- <td>GetResourcePackage</td>
- <td><a href="#bytebase.v1.GetResourcePackageRequest">GetResourcePackageRequest</a></td>
- <td><a href="#bytebase.v1.ResourcePackage">ResourcePackage</a></td>
- <td><p>Gets custom branding resources such as logos.
-Permissions required: None</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.StreamMetadata">StreamMetadata</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>GetActuatorInfo</td>
- <td>GET</td>
- <td>/v1/actuator/info</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateActuatorInfo</td>
- <td>PATCH</td>
- <td>/v1/actuator/info</td>
- <td>actuator</td>
- </tr>
-
-
+ <tr>
+ <td>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>SetupSample</td>
- <td>POST</td>
- <td>/v1/actuator:setupSample</td>
- <td></td>
- </tr>
+ <tr>
+ <td>table_name</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>
+ </tr>
-
+ <tr>
+ <td>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the stream. </p></td>
+ </tr>
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The comment of the stream. </p></td>
+ </tr>
- <tr>
- <td>DeleteCache</td>
- <td>DELETE</td>
- <td>/v1/actuator/cache</td>
- <td></td>
- </tr>
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</a></td>
+ <td></td>
+ <td><p>The type of the stream. </p></td>
+ </tr>
-
+ <tr>
+ <td>stale</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Indicates whether the stream was last read before the `stale_after` time. </p></td>
+ </tr>
+ <tr>
+ <td>mode</td>
+ <td><a href="#bytebase.v1.StreamMetadata.Mode">StreamMetadata.Mode</a></td>
+ <td></td>
+ <td><p>The mode of the stream. </p></td>
+ </tr>
- <tr>
- <td>GetResourcePackage</td>
- <td>GET</td>
- <td>/v1/actuator/resources</td>
- <td></td>
- </tr>
+ <tr>
+ <td>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition of the stream. </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/audit_log_service.proto">v1/audit_log_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.AuditData">AuditData</h3>
- <p>Additional audit data specific to certain operations.</p>
+ <h3 id="bytebase.v1.SyncDatabaseRequest">SyncDatabaseRequest</h3>
+ <p></p>
<table class="field-table">
@@ -17119,10 +17006,11 @@ Permissions required: None</p></td>
<tbody>
<tr>
- <td>policy_delta</td>
- <td><a href="#bytebase.v1.PolicyDelta">PolicyDelta</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Changes to IAM policies. </p></td>
+ <td><p>The name of the database to sync.
+Format: instances/{instance}/databases/{database} </p></td>
</tr>
</tbody>
@@ -17132,8 +17020,15 @@ Permissions required: None</p></td>
- <h3 id="bytebase.v1.AuditLog">AuditLog</h3>
- <p>Audit log entry recording system activity or API call.</p>
+ <h3 id="bytebase.v1.SyncDatabaseResponse">SyncDatabaseResponse</h3>
+ <p></p>
+
+
+
+
+
+ <h3 id="bytebase.v1.TableMetadata">TableMetadata</h3>
+ <p>TableMetadata is the metadata for tables.</p>
<table class="field-table">
@@ -17143,93 +17038,152 @@ Permissions required: None</p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></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>
+ </tr>
+
+ <tr>
+ <td>collation</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The collation is the collation of a table. </p></td>
+ </tr>
+
+ <tr>
+ <td>charset</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The character set of table. </p></td>
+ </tr>
+
+ <tr>
+ <td>row_count</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>The row_count is the estimated number of rows of a table. </p></td>
+ </tr>
+
+ <tr>
+ <td>data_size</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The name of the log.
-Formats:
-- projects/{project}/auditLogs/{uid}
-- workspaces/{workspace}/auditLogs/{uid} </p></td>
+ <td><p>The data_size is the estimated data size of a table. </p></td>
</tr>
<tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td>index_size</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The timestamp when the audit log was created. </p></td>
+ <td><p>The index_size is the estimated index size of a table. </p></td>
</tr>
<tr>
- <td>user</td>
- <td><a href="#string">string</a></td>
+ <td>data_free</td>
+ <td><a href="#int64">int64</a></td>
<td></td>
- <td><p>The user who performed the action.
-Format: users/{email} </p></td>
+ <td><p>The data_free is the estimated free data size of a table. </p></td>
</tr>
<tr>
- <td>method</td>
+ <td>create_options</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The method or action being audited.
-For example: /bytebase.v1.SQLService/Query or bb.project.repository.push </p></td>
+ <td><p>The create_options is the create option of a table. </p></td>
</tr>
<tr>
- <td>severity</td>
- <td><a href="#bytebase.v1.AuditLog.Severity">AuditLog.Severity</a></td>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The severity level of this audit log entry. </p></td>
+ <td><p>The comment is the comment of a table. </p></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>
+ <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>request</td>
+ <td>partitions</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The partitions is the list of partitions in a table. </p></td>
+ </tr>
+
+ <tr>
+ <td>check_constraints</td>
+ <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>repeated</td>
+ <td><p>The check_constraints is the list of check constraints in a table. </p></td>
+ </tr>
+
+ <tr>
+ <td>owner</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The request payload in JSON format. </p></td>
+ <td><p>The owner of the table. </p></td>
</tr>
<tr>
- <td>response</td>
+ <td>sorting_keys</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>
+ <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>status</td>
- <td><a href="#google.rpc.Status">google.rpc.Status</a></td>
- <td></td>
- <td><p>The status of the operation. </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 associated with the table. </p></td>
</tr>
<tr>
- <td>latency</td>
- <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
+ <td>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The duration of the operation. </p></td>
+ <td><p>Whether to skip this table during schema dump operations. </p></td>
</tr>
<tr>
- <td>service_data</td>
- <td><a href="#google.protobuf.Any">google.protobuf.Any</a></td>
+ <td>sharding_info</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Service-specific metadata about the request, response, and activities. </p></td>
+ <td><p>https://docs.pingcap.com/tidb/stable/information-schema-tables/ </p></td>
</tr>
<tr>
- <td>request_metadata</td>
- <td><a href="#bytebase.v1.RequestMetadata">RequestMetadata</a></td>
+ <td>primary_key_type</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>Metadata about the request context. </p></td>
+ <td><p>https://docs.pingcap.com/tidb/stable/clustered-indexes/#clustered-indexes
+CLUSTERED or NONCLUSTERED. </p></td>
</tr>
</tbody>
@@ -17239,8 +17193,8 @@ Some fields may be omitted if they are too large or contain sensitive informatio
- <h3 id="bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</h3>
- <p>Request message for exporting audit logs.</p>
+ <h3 id="bytebase.v1.TablePartitionMetadata">TablePartitionMetadata</h3>
+ <p>TablePartitionMetadata is the metadata for table partitions.</p>
<table class="field-table">
@@ -17250,87 +17204,78 @@ Some fields may be omitted if they are too large or contain sensitive informatio
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name is the name of a table partition. </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</a></td>
<td></td>
- <td><p>The filter of the log. It should be a valid CEL expression.
-Check the filter field in the SearchAuditLogsRequest message. </p></td>
+ <td><p>The type of a table partition. </p></td>
</tr>
<tr>
- <td>order_by</td>
+ <td>expression</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The order by of the log.
-Only support order by create_time.
-For example:
- - order_by = &#34;create_time asc&#34;
- - order_by = &#34;create_time desc&#34; </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>format</td>
- <td><a href="#bytebase.v1.ExportFormat">ExportFormat</a></td>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The export format. </p></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>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>use_default</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of logs to return.
-The service may return fewer than this value.
-If unspecified, at most 10 log entries will be returned.
-The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ <td><p>The 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>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>
+ <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>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</h3>
- <p>Response message for exporting 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>content</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The exported audit log content in the requested format. </p></td>
+ <td>indexes</td>
+ <td><a href="#bytebase.v1.IndexMetadata">IndexMetadata</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>
+ <td>check_constraints</td>
+ <td><a href="#bytebase.v1.CheckConstraintMetadata">CheckConstraintMetadata</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -17340,8 +17285,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.TaskMetadata">TaskMetadata</h3>
+ <p></p>
<table class="field-table">
@@ -17351,91 +17296,74 @@ to retrieve the next page of log entities. </p></td>
<tbody>
<tr>
- <td>caller_ip</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The IP address of the request originator. </p></td>
+ <td><p>The name is the name of a task. </p></td>
</tr>
<tr>
- <td>caller_supplied_user_agent</td>
+ <td>id</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>The id is the snowflake-generated id of a task.
+Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</h3>
- <p>Request 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>owner</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The owner of the task. </p></td>
+ </tr>
<tr>
- <td>parent</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The comment of the task. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>warehouse</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>
+ <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>order_by</td>
+ <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 order by of the log.
-Only support order by create_time.
-For example:
- - order_by = &#34;create_time asc&#34;
- - order_by = &#34;create_time desc&#34; </p></td>
+ <td><p>The state of the task. </p></td>
</tr>
<tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
+ <td>condition</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The maximum number of logs to return.
-The service may return fewer than this value.
-If unspecified, at most 10 log entries will be returned.
-The maximum value is 5000; values above 5000 will be coerced to 5000. </p></td>
+ <td><p>The condition of the task. </p></td>
</tr>
<tr>
- <td>page_token</td>
+ <td>definition</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `SearchLogs` call.
-Provide this to retrieve the subsequent page. </p></td>
+ <td><p>The definition of the task. </p></td>
</tr>
</tbody>
@@ -17445,8 +17373,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.TessellationConfig">TessellationConfig</h3>
+ <p>TessellationConfig defines tessellation parameters for spatial indexes.</p>
<table class="field-table">
@@ -17456,209 +17384,31 @@ 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>scheme</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>Tessellation scheme (e.g., &#34;GEOMETRY_GRID&#34;, &#34;GEOGRAPHY_GRID&#34;, &#34;GEOMETRY_AUTO_GRID&#34;) </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
-
-
- <h3 id="bytebase.v1.AuditLog.Severity">AuditLog.Severity</h3>
- <p>Severity level for audit log entries.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SEVERITY_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified severity level.</p></td>
- </tr>
-
- <tr>
- <td>DEBUG</td>
- <td>1</td>
- <td><p>Debug-level information.</p></td>
- </tr>
-
- <tr>
- <td>INFO</td>
- <td>2</td>
- <td><p>Informational messages.</p></td>
- </tr>
-
- <tr>
- <td>NOTICE</td>
- <td>3</td>
- <td><p>Notable events.</p></td>
- </tr>
-
- <tr>
- <td>WARNING</td>
- <td>4</td>
- <td><p>Warning conditions.</p></td>
- </tr>
-
- <tr>
- <td>ERROR</td>
- <td>5</td>
- <td><p>Error conditions.</p></td>
- </tr>
-
- <tr>
- <td>CRITICAL</td>
- <td>6</td>
- <td><p>Critical conditions.</p></td>
- </tr>
-
- <tr>
- <td>ALERT</td>
- <td>7</td>
- <td><p>Action must be taken immediately.</p></td>
- </tr>
-
- <tr>
- <td>EMERGENCY</td>
- <td>8</td>
- <td><p>System is unusable.</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.AuditLogService">AuditLogService</h3>
- <p>AuditLogService manages audit logs for system activities and API calls.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>SearchAuditLogs</td>
- <td><a href="#bytebase.v1.SearchAuditLogsRequest">SearchAuditLogsRequest</a></td>
- <td><a href="#bytebase.v1.SearchAuditLogsResponse">SearchAuditLogsResponse</a></td>
- <td><p>Searches audit logs with optional filtering and pagination.
-Permissions required: bb.auditLogs.search</p></td>
- </tr>
-
- <tr>
- <td>ExportAuditLogs</td>
- <td><a href="#bytebase.v1.ExportAuditLogsRequest">ExportAuditLogsRequest</a></td>
- <td><a href="#bytebase.v1.ExportAuditLogsResponse">ExportAuditLogsResponse</a></td>
- <td><p>Exports audit logs in a specified format for external analysis.
-Permissions required: bb.auditLogs.export</p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>SearchAuditLogs</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/auditLogs:search</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>SearchAuditLogs</td>
- <td>POST</td>
- <td>/v1/auditLogs:search</td>
- <td>*</td>
- </tr>
-
-
-
-
- <tr>
- <td>ExportAuditLogs</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/auditLogs:export</td>
- <td>*</td>
- </tr>
-
- <tr>
- <td>ExportAuditLogs</td>
- <td>POST</td>
- <td>/v1/auditLogs:export</td>
- <td>*</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/auth_service.proto">v1/auth_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.IdentityProviderContext">IdentityProviderContext</h3>
- <p>Context for identity provider authentication.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <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>oauth2_context</td>
- <td><a href="#bytebase.v1.OAuth2IdentityProviderContext">OAuth2IdentityProviderContext</a></td>
+ <td>cells_per_object</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>OAuth2 authentication context. </p></td>
+ <td><p>Number of cells per object (1-8192 for SQL Server) </p></td>
</tr>
<tr>
- <td>oidc_context</td>
- <td><a href="#bytebase.v1.OIDCIdentityProviderContext">OIDCIdentityProviderContext</a></td>
+ <td>bounding_box</td>
+ <td><a href="#bytebase.v1.BoundingBox">BoundingBox</a></td>
<td></td>
- <td><p>OpenID Connect authentication context. </p></td>
+ <td><p>Bounding box for GEOMETRY tessellation (not used for GEOGRAPHY) </p></td>
</tr>
</tbody>
@@ -17668,7 +17418,7 @@ Permissions required: bb.auditLogs.export</p></td>
- <h3 id="bytebase.v1.LoginRequest">LoginRequest</h3>
+ <h3 id="bytebase.v1.TriggerMetadata">TriggerMetadata</h3>
<p></p>
@@ -17679,60 +17429,67 @@ Permissions required: bb.auditLogs.export</p></td>
<tbody>
<tr>
- <td>email</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>User&#39;s email address. </p></td>
+ <td><p>The name is the name of the trigger. </p></td>
+ </tr>
+
+ <tr>
+ <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>password</td>
+ <td>timing</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>User&#39;s password for authentication. </p></td>
+ <td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td>
</tr>
<tr>
- <td>web</td>
- <td><a href="#bool">bool</a></td>
+ <td>body</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If web is set, we will set access token, refresh token, and user to the cookie. </p></td>
+ <td><p>The body is the body of the trigger. </p></td>
</tr>
<tr>
- <td>idp_name</td>
+ <td>sql_mode</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 SQL mode setting for the trigger. </p></td>
</tr>
<tr>
- <td>idp_context</td>
- <td><a href="#bytebase.v1.IdentityProviderContext">IdentityProviderContext</a></td>
+ <td>character_set_client</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The idp_context is using to get the user information from identity provider. </p></td>
+ <td><p>The character set used by the client creating the trigger. </p></td>
</tr>
<tr>
- <td>otp_code</td>
+ <td>collation_connection</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></td>
+ <td><p>The collation used for the connection when creating the trigger. </p></td>
</tr>
<tr>
- <td>recovery_code</td>
+ <td>comment</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></td>
+ <td><p>The comment describing the trigger. </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>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether to skip this trigger during schema dump operations. </p></td>
</tr>
</tbody>
@@ -17742,7 +17499,7 @@ Format: idps/{idp} </p></td>
- <h3 id="bytebase.v1.LoginResponse">LoginResponse</h3>
+ <h3 id="bytebase.v1.UpdateDatabaseRequest">UpdateDatabaseRequest</h3>
<p></p>
@@ -17753,31 +17510,28 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>token</td>
- <td><a href="#string">string</a></td>
+ <td>database</td>
+ <td><a href="#bytebase.v1.Database">Database</a></td>
<td></td>
- <td><p>Access token for authenticated requests. </p></td>
- </tr>
-
- <tr>
- <td>mfa_temp_token</td>
- <td><a href="#string">string</a></td>
- <td>optional</td>
- <td><p>Temporary token for MFA verification. </p></td>
+ <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>require_reset_password</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>Whether user must reset password before continuing. </p></td>
+ <td><p>The list of fields to update. </p></td>
</tr>
<tr>
- <td>user</td>
- <td><a href="#bytebase.v1.User">User</a></td>
+ <td>allow_missing</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The user from the successful login. </p></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>
@@ -17787,15 +17541,8 @@ Format: idps/{idp} </p></td>
- <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>
+ <h3 id="bytebase.v1.ViewMetadata">ViewMetadata</h3>
+ <p>ViewMetadata is the metadata for views.</p>
<table class="field-table">
@@ -17805,34 +17552,52 @@ Format: idps/{idp} </p></td>
<tbody>
<tr>
- <td>code</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Authorization code from OAuth2 provider. </p></td>
+ <td><p>The name is the name of a view. </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>definition</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The definition is the definition of a view. </p></td>
+ </tr>
<tr>
- <td>code</td>
+ <td>comment</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Authorization code from OIDC provider. </p></td>
+ <td><p>The comment is the comment of a view. </p></td>
+ </tr>
+
+ <tr>
+ <td>dependency_columns</td>
+ <td><a href="#bytebase.v1.DependencyColumn">DependencyColumn</a></td>
+ <td>repeated</td>
+ <td><p>The dependency_columns is the list of dependency columns of a view. </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>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>skip_dump</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -17844,631 +17609,533 @@ Format: idps/{idp} </p></td>
-
+ <h3 id="bytebase.v1.Changelog.Status">Changelog.Status</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATUS_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>PENDING</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DONE</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FAILED</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
-
+ <h3 id="bytebase.v1.Changelog.Type">Changelog.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>BASELINE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MIGRATE</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SDL</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.ChangelogView">ChangelogView</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>CHANGELOG_VIEW_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>The default / unset value.
+The API will default to the BASIC view.</p></td>
+ </tr>
+
+ <tr>
+ <td>CHANGELOG_VIEW_BASIC</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>CHANGELOG_VIEW_FULL</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.ColumnMetadata.IdentityGeneration">ColumnMetadata.IdentityGeneration</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>IDENTITY_GENERATION_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>ALWAYS</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>BY_DEFAULT</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.AuthService">AuthService</h3>
- <p>AuthService handles user authentication operations.</p>
+ <h3 id="bytebase.v1.GenerationMetadata.Type">GenerationMetadata.Type</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>Login</td>
- <td><a href="#bytebase.v1.LoginRequest">LoginRequest</a></td>
- <td><a href="#bytebase.v1.LoginResponse">LoginResponse</a></td>
- <td><p>Authenticates a user and returns access tokens.
-Permissions required: None</p></td>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>Logout</td>
- <td><a href="#bytebase.v1.LogoutRequest">LogoutRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Logs out the current user session.
-Permissions required: None</p></td>
+ <td>VIRTUAL</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STORED</td>
+ <td>2</td>
+ <td><p></p></td>
</tr>
</tbody>
</table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
+
+ <h3 id="bytebase.v1.GetDatabaseSDLSchemaRequest.SDLFormat">GetDatabaseSDLSchemaRequest.SDLFormat</h3>
+ <p>SDLFormat specifies the output format for SDL schema.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>SDL_FORMAT_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified format. Defaults to SINGLE_FILE.</p></td>
</tr>
- </thead>
- <tbody>
-
-
<tr>
- <td>Login</td>
- <td>POST</td>
- <td>/v1/auth/login</td>
- <td>*</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>Logout</td>
- <td>POST</td>
- <td>/v1/auth/logout</td>
- <td>*</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>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/cel_service.proto">v1/cel_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</h3>
- <p>Request message for batch deparsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
- <td>repeated</td>
- <td><p>The CEL expression ASTs to deparse. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</h3>
- <p>Response message for batch deparsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The deparsed CEL expressions as strings. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchParseRequest">BatchParseRequest</h3>
- <p>Request message for batch parsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The CEL expression strings to parse. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchParseResponse">BatchParseResponse</h3>
- <p>Response message for batch parsing CEL expressions.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>expressions</td>
- <td><a href="#google.api.expr.v1alpha1.Expr">google.api.expr.v1alpha1.Expr</a></td>
- <td>repeated</td>
- <td><p>The parsed CEL expressions as AST. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-
-
-
-
-
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.CelService">CelService</h3>
- <p>CelService manages CEL (Common Expression Language) parsing and formatting operations.</p>
+ <h3 id="bytebase.v1.GetSchemaStringRequest.ObjectType">GetSchemaStringRequest.ObjectType</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>BatchParse</td>
- <td><a href="#bytebase.v1.BatchParseRequest">BatchParseRequest</a></td>
- <td><a href="#bytebase.v1.BatchParseResponse">BatchParseResponse</a></td>
- <td><p>Parses multiple CEL expression strings into AST representations.
-Permissions required: None</p></td>
+ <td>OBJECT_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DATABASE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SCHEMA</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>TABLE</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>VIEW</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MATERIALIZED_VIEW</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FUNCTION</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>PROCEDURE</td>
+ <td>7</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>BatchDeparse</td>
- <td><a href="#bytebase.v1.BatchDeparseRequest">BatchDeparseRequest</a></td>
- <td><a href="#bytebase.v1.BatchDeparseResponse">BatchDeparseResponse</a></td>
- <td><p>Converts multiple CEL AST representations back into expression strings.
-Permissions required: None</p></td>
+ <td>SEQUENCE</td>
+ <td>8</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>
- </tr>
- </thead>
- <tbody>
+
+ <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>BatchParse</td>
- <td>POST</td>
- <td>/v1/cel/batchParse</td>
- <td>*</td>
+ <td>MODE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
-
-
-
<tr>
- <td>BatchDeparse</td>
- <td>POST</td>
- <td>/v1/cel/batchDeparse</td>
- <td>*</td>
+ <td>DEFAULT</td>
+ <td>1</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>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource where this 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></td>
- <td><p>The database group to create. </p></td>
- </tr>
-
- <tr>
- <td>database_group_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The ID to use for the database group, which will become the final component of
-the database group&#39;s resource name.
-
-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, validate the create request and preview the full database group response, but do not actually create it. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseGroup">DatabaseGroup</h3>
- <p>A group of databases matched by 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>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database group.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- </tr>
-
- <tr>
- <td>title</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The short name used in actual databases specified by users. </p></td>
- </tr>
-
- <tr>
- <td>database_expr</td>
- <td><a href="#google.type.Expr">google.type.Expr</a></td>
- <td></td>
- <td><p>The condition that is associated with this database group.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Support variables:
-resource.environment_id: the environment resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34; operations.
-resource.instance_id: the instance resource id. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
-resource.database_name: the database name. Support &#34;==&#34;, &#34;!=&#34;, &#34;in [XX]&#34;, &#34;!(in [xx])&#34;, &#34;contains&#34;, &#34;matches&#34;, &#34;startsWith&#34;, &#34;endsWith&#34; operations.
-resource.database_labels: the database labels. Support map access operations.
-All variables should join with &#34;&amp;&amp;&#34; condition.
-
-For example:
-resource.environment_id == &#34;test&#34; &amp;&amp; resource.database_name.startsWith(&#34;sample_&#34;)
-resource.database_labels[&#34;tenant&#34;] == &#34;tenant1&#34; </p></td>
- </tr>
-
- <tr>
- <td>matched_databases</td>
- <td><a href="#bytebase.v1.DatabaseGroup.Database">DatabaseGroup.Database</a></td>
- <td>repeated</td>
- <td><p>The list of databases that match the database group condition. </p></td>
- </tr>
-
- </tbody>
- </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>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The resource name of the database.
-Format: instances/{instance}/databases/{database} </p></td>
- </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>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database group to delete.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- </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>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the database group to retrieve.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- </tr>
-
- <tr>
- <td>view</td>
- <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
- <td></td>
- <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <tr>
+ <td>APPEND_ONLY</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>INSERT_ONLY</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.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>parent</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>
- </tr>
-
- <tr>
- <td>view</td>
- <td><a href="#bytebase.v1.DatabaseGroupView">DatabaseGroupView</a></td>
- <td></td>
- <td><p>The view to return. Defaults to DATABASE_GROUP_VIEW_BASIC. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.StreamMetadata.Type">StreamMetadata.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>DELTA</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.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>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>
- </table>
-
-
-
-
+ <h3 id="bytebase.v1.TablePartitionMetadata.Type">TablePartitionMetadata.Type</h3>
+ <p>Type is the type of a table partition, some database engines may not</p><p>support all types. Only avilable for the following database engines now:</p><p>MySQL: RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, LINEAR HASH, KEY,</p><p>LINEAR_KEY</p><p>(https://dev.mysql.com/doc/refman/8.0/en/partitioning-types.html) TiDB:</p><p>RANGE, RANGE COLUMNS, LIST, LIST COLUMNS, HASH, KEY PostgreSQL: RANGE,</p><p>LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>RANGE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>RANGE_COLUMNS</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LIST</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LIST_COLUMNS</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>HASH</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LINEAR_HASH</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>KEY</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>LINEAR_KEY</td>
+ <td>8</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.TaskMetadata.State">TaskMetadata.State</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>STATE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>STARTED</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SUSPENDED</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.UpdateDatabaseGroupRequest">UpdateDatabaseGroupRequest</h3>
- <p>Request message for updating 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_group</td>
- <td><a href="#bytebase.v1.DatabaseGroup">DatabaseGroup</a></td>
- <td></td>
- <td><p>The database group to update.
-
-The database group&#39;s `name` field is used to identify the database group to update.
-Format: projects/{project}/databaseGroups/{databaseGroup} </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></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>
- </table>
-
-
-
- <h3 id="bytebase.v1.DatabaseGroupView">DatabaseGroupView</h3>
- <p>View options for database group responses.</p>
+ <h3 id="bytebase.v1.DatabaseService">DatabaseService</h3>
+ <p>DatabaseService manages databases and their schemas.</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>DATABASE_GROUP_VIEW_UNSPECIFIED</td>
- <td>0</td>
- <td><p>The default / unset value.
-The API will default to the BASIC view.</p></td>
+ <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>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>
+ <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>DATABASE_GROUP_VIEW_FULL</td>
- <td>2</td>
- <td><p>Include everything.</p></td>
+ <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>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DatabaseGroupService">DatabaseGroupService</h3>
- <p>DatabaseGroupService manages database groups for organizing databases by criteria.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>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>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>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>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>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>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>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>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>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>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>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>
@@ -18492,9 +18159,9 @@ Permissions required: bb.databaseGroups.delete</p></td>
<tr>
- <td>ListDatabaseGroups</td>
+ <td>GetDatabase</td>
<td>GET</td>
- <td>/v1/{parent=projects/*}/databaseGroups</td>
+ <td>/v1/{name=instances/*/databases/*}</td>
<td></td>
</tr>
@@ -18502,9 +18169,16 @@ Permissions required: bb.databaseGroups.delete</p></td>
<tr>
- <td>GetDatabaseGroup</td>
+ <td>BatchGetDatabases</td>
<td>GET</td>
- <td>/v1/{name=projects/*/databaseGroups/*}</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>
@@ -18512,29 +18186,140 @@ Permissions required: bb.databaseGroups.delete</p></td>
<tr>
- <td>CreateDatabaseGroup</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/databaseGroups</td>
- <td>database_group</td>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/databases</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=instances/*}/databases</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListDatabases</td>
+ <td>GET</td>
+ <td>/v1/{parent=workspaces/*}/databases</td>
+ <td></td>
</tr>
<tr>
- <td>UpdateDatabaseGroup</td>
+ <td>UpdateDatabase</td>
<td>PATCH</td>
- <td>/v1/{database_group.name=projects/*/databaseGroups/*}</td>
- <td>database_group</td>
+ <td>/v1/{database.name=instances/*/databases/*}</td>
+ <td>database</td>
</tr>
<tr>
- <td>DeleteDatabaseGroup</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/databaseGroups/*}</td>
+ <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>
diff --git a/proto/store/store/setting.proto b/proto/store/store/setting.proto
index 33b4504aac..39e2775221 100644
--- a/proto/store/store/setting.proto
+++ b/proto/store/store/setting.proto
@@ -5,14 +5,14 @@ package bytebase.store;
import "google/protobuf/duration.proto";
import "google/type/expr.proto";
import "store/approval.proto";
-import "store/common.proto";
-import "store/database.proto";
import "store/project_webhook.proto";
option go_package = "generated-go/store";
enum SettingName {
reserved 16;
+ reserved 6; // was WORKSPACE_EXTERNAL_APPROVAL
+ reserved 13; // was SCHEMA_TEMPLATE
SETTING_NAME_UNSPECIFIED = 0;
AUTH_SECRET = 1;
@@ -20,12 +20,10 @@ enum SettingName {
WORKSPACE_ID = 3;
WORKSPACE_PROFILE = 4;
WORKSPACE_APPROVAL = 5;
- WORKSPACE_EXTERNAL_APPROVAL = 6;
ENTERPRISE_LICENSE = 7;
APP_IM = 8;
WATERMARK = 9;
AI = 10;
- SCHEMA_TEMPLATE = 13;
DATA_CLASSIFICATION = 14;
SEMANTIC_TYPES = 15;
SCIM = 17;
@@ -110,46 +108,6 @@ message WorkspaceApprovalSetting {
repeated Rule rules = 1;
}
-message SchemaTemplateSetting {
- message FieldTemplate {
- string id = 1;
-
- Engine engine = 2;
-
- string category = 3;
-
- ColumnMetadata column = 4;
-
- ColumnCatalog catalog = 5;
- }
-
- repeated FieldTemplate field_templates = 1;
-
- message ColumnType {
- Engine engine = 1;
-
- bool enabled = 2;
-
- repeated string types = 3;
- }
-
- repeated ColumnType column_types = 2;
-
- message TableTemplate {
- string id = 1;
-
- Engine engine = 2;
-
- string category = 3;
-
- TableMetadata table = 4;
-
- TableCatalog catalog = 5;
- }
-
- repeated TableTemplate table_templates = 3;
-}
-
message DataClassificationSetting {
message DataClassificationConfig {
// id is the uuid for classification. Each project can chose one
diff --git a/proto/v1/v1/setting_service.proto b/proto/v1/v1/setting_service.proto
index 259edca12e..0951641d9c 100644
--- a/proto/v1/v1/setting_service.proto
+++ b/proto/v1/v1/setting_service.proto
@@ -10,9 +10,6 @@ import "google/protobuf/duration.proto";
import "google/protobuf/field_mask.proto";
import "google/type/expr.proto";
import "v1/annotation.proto";
-import "v1/common.proto";
-import "v1/database_catalog_service.proto";
-import "v1/database_service.proto";
import "v1/issue_service.proto";
import "v1/project_service.proto";
@@ -102,12 +99,12 @@ message Setting {
WORKSPACE_ID = 3;
WORKSPACE_PROFILE = 4;
WORKSPACE_APPROVAL = 5;
- WORKSPACE_EXTERNAL_APPROVAL = 6;
+ reserved 6; // was WORKSPACE_EXTERNAL_APPROVAL
ENTERPRISE_LICENSE = 7;
APP_IM = 8;
WATERMARK = 9;
AI = 10;
- SCHEMA_TEMPLATE = 13;
+ reserved 13; // was SCHEMA_TEMPLATE
DATA_CLASSIFICATION = 14;
SEMANTIC_TYPES = 15;
SCIM = 17;
@@ -128,6 +125,7 @@ message Setting {
// The data in setting value.
message Value {
reserved 18;
+ reserved 9; // was SchemaTemplateSetting schema_template_setting_value
// Value is a oneof field for setting value.
oneof value {
@@ -137,7 +135,6 @@ message Value {
// reserved 4; // was AgentPluginSetting agent_plugin_setting_value
WorkspaceProfileSetting workspace_profile_setting_value = 5;
WorkspaceApprovalSetting workspace_approval_setting_value = 6;
- SchemaTemplateSetting schema_template_setting_value = 9;
DataClassificationSetting data_classification_setting_value = 10;
SemanticTypeSetting semantic_type_setting_value = 11;
SCIMSetting scim_setting = 14;
@@ -288,46 +285,6 @@ message WorkspaceApprovalSetting {
repeated Rule rules = 1;
}
-message SchemaTemplateSetting {
- message FieldTemplate {
- string id = 1;
-
- Engine engine = 2;
-
- string category = 3;
-
- ColumnMetadata column = 4;
-
- ColumnCatalog catalog = 5;
- }
-
- repeated FieldTemplate field_templates = 1;
-
- message ColumnType {
- Engine engine = 1;
-
- bool enabled = 2;
-
- repeated string types = 3;
- }
-
- repeated ColumnType column_types = 2;
-
- message TableTemplate {
- string id = 1;
-
- Engine engine = 2;
-
- string category = 3;
-
- TableMetadata table = 4;
-
- TableCatalog catalog = 5;
- }
-
- repeated TableTemplate table_templates = 3;
-}
-
message DataClassificationSetting {
message DataClassificationConfig {
// id is the uuid for classification. Each project can chose one classification config.