Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix: correct comments and documentation in proto files (#17695)
Danny Xu7a17ffccb449
diff --git a/backend/generated-go/store/advice.pb.go b/backend/generated-go/store/advice.pb.goindex 68e174ecee..4fb6e800c3 100644--- a/backend/generated-go/store/advice.pb.go+++ b/backend/generated-go/store/advice.pb.go@@ -24,7 +24,7 @@ const (type Advice_Status int32const (- // Unspecified.+ // Unspecified status.Advice_STATUS_UNSPECIFIED Advice_Status = 0Advice_SUCCESS Advice_Status = 1Advice_WARNING Advice_Status = 2diff --git a/backend/generated-go/store/approval.pb.go b/backend/generated-go/store/approval.pb.goindex b0fa79756a..1743aff521 100644--- a/backend/generated-go/store/approval.pb.go+++ b/backend/generated-go/store/approval.pb.go@@ -21,13 +21,17 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Status represents the approver's decision state.type IssuePayloadApproval_Approver_Status int32const (IssuePayloadApproval_Approver_STATUS_UNSPECIFIED IssuePayloadApproval_Approver_Status = 0- IssuePayloadApproval_Approver_PENDING IssuePayloadApproval_Approver_Status = 1- IssuePayloadApproval_Approver_APPROVED IssuePayloadApproval_Approver_Status = 2- IssuePayloadApproval_Approver_REJECTED IssuePayloadApproval_Approver_Status = 3+ // Approval is pending from this approver.+ IssuePayloadApproval_Approver_PENDING IssuePayloadApproval_Approver_Status = 1+ // Approver has approved the issue.+ IssuePayloadApproval_Approver_APPROVED IssuePayloadApproval_Approver_Status = 2+ // Approver has rejected the issue.+ IssuePayloadApproval_Approver_REJECTED IssuePayloadApproval_Approver_Status = 3)// Enum value maps for IssuePayloadApproval_Approver_Status.@@ -73,19 +77,22 @@ func (IssuePayloadApproval_Approver_Status) EnumDescriptor() ([]byte, []int) {return file_store_approval_proto_rawDescGZIP(), []int{0, 0, 0}}-// IssuePayloadApproval is a part of the payload of an issue.-// IssuePayloadApproval records the approval template used and the approval history.+// IssuePayloadApproval records the approval template used and approval history for an issue.type IssuePayloadApproval struct {- state protoimpl.MessageState `protogen:"open.v1"`- ApprovalTemplate *ApprovalTemplate `protobuf:"bytes,1,opt,name=approval_template,json=approvalTemplate,proto3" json:"approval_template,omitempty"`- Approvers []*IssuePayloadApproval_Approver `protobuf:"bytes,2,rep,name=approvers,proto3" json:"approvers,omitempty"`- // If the value is `false`, it means that the backend is still finding matching approval templates.- // If `true`, other fields are available.- ApprovalFindingDone bool `protobuf:"varint,3,opt,name=approval_finding_done,json=approvalFindingDone,proto3" json:"approval_finding_done,omitempty"`- ApprovalFindingError string `protobuf:"bytes,4,opt,name=approval_finding_error,json=approvalFindingError,proto3" json:"approval_finding_error,omitempty"`- RiskLevel RiskLevel `protobuf:"varint,5,opt,name=risk_level,json=riskLevel,proto3,enum=bytebase.store.RiskLevel" json:"risk_level,omitempty"`- unknownFields protoimpl.UnknownFields- sizeCache protoimpl.SizeCache+ state protoimpl.MessageState `protogen:"open.v1"`+ // The approval template being used for this issue.+ ApprovalTemplate *ApprovalTemplate `protobuf:"bytes,1,opt,name=approval_template,json=approvalTemplate,proto3" json:"approval_template,omitempty"`+ // List of approvers and their current status.+ Approvers []*IssuePayloadApproval_Approver `protobuf:"bytes,2,rep,name=approvers,proto3" json:"approvers,omitempty"`+ // Whether the system has finished finding a matching approval template.+ // False means the backend is still searching for matching templates.+ ApprovalFindingDone bool `protobuf:"varint,3,opt,name=approval_finding_done,json=approvalFindingDone,proto3" json:"approval_finding_done,omitempty"`+ // Error message if approval template finding failed.+ ApprovalFindingError string `protobuf:"bytes,4,opt,name=approval_finding_error,json=approvalFindingError,proto3" json:"approval_finding_error,omitempty"`+ // The assessed risk level for this issue.+ RiskLevel RiskLevel `protobuf:"varint,5,opt,name=risk_level,json=riskLevel,proto3,enum=bytebase.store.RiskLevel" json:"risk_level,omitempty"`+ unknownFields protoimpl.UnknownFields+ sizeCache protoimpl.SizeCache}func (x *IssuePayloadApproval) Reset() {@@ -153,15 +160,19 @@ func (x *IssuePayloadApproval) GetRiskLevel() RiskLevel {return RiskLevel_RISK_LEVEL_UNSPECIFIED}+// ApprovalTemplate defines the approval workflow and requirements for an issue.type ApprovalTemplate struct {state protoimpl.MessageState `protogen:"open.v1"`// The unique identifier for the approval template.- // For built-in templates, use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").- // For custom templates, use a UUID or other unique identifier.- Id string `protobuf:"bytes,4,opt,name=id,proto3" json:"id,omitempty"`- Flow *ApprovalFlow `protobuf:"bytes,1,opt,name=flow,proto3" json:"flow,omitempty"`- Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`- Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`+ // Built-in templates use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").+ // Custom templates use a UUID or other unique identifier.+ Id string `protobuf:"bytes,4,opt,name=id,proto3" json:"id,omitempty"`+ // The approval workflow specification.+ Flow *ApprovalFlow `protobuf:"bytes,1,opt,name=flow,proto3" json:"flow,omitempty"`+ // Human-readable title of the approval template.+ Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`+ // Detailed description of when this template applies.+ Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -224,9 +235,11 @@ func (x *ApprovalTemplate) GetDescription() string {return ""}+// ApprovalFlow defines the sequence of approvals required.type ApprovalFlow struct {- state protoimpl.MessageState `protogen:"open.v1"`- Roles []string `protobuf:"bytes,1,rep,name=roles,proto3" json:"roles,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // List of role names that must approve, in order.+ Roles []string `protobuf:"bytes,1,rep,name=roles,proto3" json:"roles,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -268,11 +281,12 @@ func (x *ApprovalFlow) GetRoles() []string {return nil}+// Approver represents a user who can approve or reject an issue.type IssuePayloadApproval_Approver struct {state protoimpl.MessageState `protogen:"open.v1"`- // The new status.+ // The current approval status.Status IssuePayloadApproval_Approver_Status `protobuf:"varint,1,opt,name=status,proto3,enum=bytebase.store.IssuePayloadApproval_Approver_Status" json:"status,omitempty"`- // The principal id of the approver.+ // The ID of the principal who is the approver.PrincipalId int32 `protobuf:"varint,2,opt,name=principal_id,json=principalId,proto3" json:"principal_id,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/audit_log.pb.go b/backend/generated-go/store/audit_log.pb.goindex 36ce6f6d95..274cdaf2d8 100644--- a/backend/generated-go/store/audit_log.pb.go+++ b/backend/generated-go/store/audit_log.pb.go@@ -98,10 +98,10 @@ type AuditLog struct {// - projects/{project}// - workspaces/{workspace}Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`- // e.g. /bytebase.v1.SQLService/Query+ // Example: /bytebase.v1.SQLService/QueryMethod string `protobuf:"bytes,2,opt,name=method,proto3" json:"method,omitempty"`- // resource name- // projects/{project}+ // The resource name.+ // Example: projects/{project}Resource string `protobuf:"bytes,3,opt,name=resource,proto3" json:"resource,omitempty"`// Format: users/{userUID}.User string `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"`@@ -114,7 +114,7 @@ type AuditLog struct {Status *status.Status `protobuf:"bytes,8,opt,name=status,proto3" json:"status,omitempty"`// The latency of the RPC.Latency *durationpb.Duration `protobuf:"bytes,9,opt,name=latency,proto3" json:"latency,omitempty"`- // service-specific data about the request, response, and other activities.+ // The service-specific data about the request, response, and other activities.ServiceData *anypb.Any `protobuf:"bytes,10,opt,name=service_data,json=serviceData,proto3" json:"service_data,omitempty"`// Metadata about the operation.RequestMetadata *RequestMetadata `protobuf:"bytes,11,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`diff --git a/backend/generated-go/store/changelist.pb.go b/backend/generated-go/store/changelist.pb.goindex bd23f5f95a..6d0fc43b5b 100644--- a/backend/generated-go/store/changelist.pb.go+++ b/backend/generated-go/store/changelist.pb.go@@ -21,10 +21,13 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Changelist represents a collection of database changes that can be applied together.type Changelist struct {- state protoimpl.MessageState `protogen:"open.v1"`- Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`- Changes []*Changelist_Change `protobuf:"bytes,2,rep,name=changes,proto3" json:"changes,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Human-readable description of this changelist.+ Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`+ // The list of changes in this changelist.+ Changes []*Changelist_Change `protobuf:"bytes,2,rep,name=changes,proto3" json:"changes,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -73,13 +76,14 @@ func (x *Changelist) GetChanges() []*Changelist_Change {return nil}+// Change represents a single database modification within the changelist.type Changelist_Change struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of a sheet.+ // Resource name of the sheet containing the SQL statements.Sheet string `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`- // The source of origin.- // 1) changes: instances/{instance}/databases/{database}/changelogs/{changelog}.- // 2) raw SQL if empty.+ // The source where this change originated from.+ // Format: instances/{instance}/databases/{database}/changelogs/{changelog} for changes from changelog.+ // Empty for raw SQL changes.Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/changelog.pb.go b/backend/generated-go/store/changelog.pb.goindex 614a95d379..b9f3eb62b8 100644--- a/backend/generated-go/store/changelog.pb.go+++ b/backend/generated-go/store/changelog.pb.go@@ -418,9 +418,9 @@ func (x *ChangedResourceSchema) GetProcedures() []*ChangedResourceProcedure {type ChangedResourceTable struct {state protoimpl.MessageState `protogen:"open.v1"`Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // estimated row count of the table+ // The estimated row count of the table.TableRows int64 `protobuf:"varint,2,opt,name=table_rows,json=tableRows,proto3" json:"table_rows,omitempty"`- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.Ranges []*Range `protobuf:"bytes,3,rep,name=ranges,proto3" json:"ranges,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -480,7 +480,7 @@ func (x *ChangedResourceTable) GetRanges() []*Range {type ChangedResourceView struct {state protoimpl.MessageState `protogen:"open.v1"`Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.Ranges []*Range `protobuf:"bytes,2,rep,name=ranges,proto3" json:"ranges,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -533,7 +533,7 @@ func (x *ChangedResourceView) GetRanges() []*Range {type ChangedResourceFunction struct {state protoimpl.MessageState `protogen:"open.v1"`Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.Ranges []*Range `protobuf:"bytes,2,rep,name=ranges,proto3" json:"ranges,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -586,7 +586,7 @@ func (x *ChangedResourceFunction) GetRanges() []*Range {type ChangedResourceProcedure struct {state protoimpl.MessageState `protogen:"open.v1"`Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.Ranges []*Range `protobuf:"bytes,2,rep,name=ranges,proto3" json:"ranges,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/common.pb.go b/backend/generated-go/store/common.pb.goindex a9748fa5ab..0393213a68 100644--- a/backend/generated-go/store/common.pb.go+++ b/backend/generated-go/store/common.pb.go@@ -21,6 +21,7 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Engine represents the type of database system.type Engine int32const (@@ -139,6 +140,7 @@ func (Engine) EnumDescriptor() ([]byte, []int) {return file_store_common_proto_rawDescGZIP(), []int{0}}+// VCSType represents the type of version control system.type VCSType int32const (@@ -194,13 +196,17 @@ func (VCSType) EnumDescriptor() ([]byte, []int) {return file_store_common_proto_rawDescGZIP(), []int{1}}+// MaskingLevel represents the level of data masking applied to sensitive information.type MaskingLevel int32const (MaskingLevel_MASKING_LEVEL_UNSPECIFIED MaskingLevel = 0- MaskingLevel_NONE MaskingLevel = 1- MaskingLevel_PARTIAL MaskingLevel = 2- MaskingLevel_FULL MaskingLevel = 3+ // No masking applied.+ MaskingLevel_NONE MaskingLevel = 1+ // Partial masking (e.g., showing first/last characters).+ MaskingLevel_PARTIAL MaskingLevel = 2+ // Full masking (all characters masked).+ MaskingLevel_FULL MaskingLevel = 3)// Enum value maps for MaskingLevel.@@ -246,6 +252,7 @@ func (MaskingLevel) EnumDescriptor() ([]byte, []int) {return file_store_common_proto_rawDescGZIP(), []int{2}}+// ExportFormat represents the file format for exported data.type ExportFormat int32const (@@ -301,6 +308,7 @@ func (ExportFormat) EnumDescriptor() ([]byte, []int) {return file_store_common_proto_rawDescGZIP(), []int{3}}+// RiskLevel represents the assessed risk level of a database operation.type RiskLevel int32const (@@ -353,11 +361,13 @@ func (RiskLevel) EnumDescriptor() ([]byte, []int) {return file_store_common_proto_rawDescGZIP(), []int{4}}-// Used internally for obfuscating the page token.+// PageToken is used internally for obfuscating pagination tokens.type PageToken struct {- state protoimpl.MessageState `protogen:"open.v1"`- Limit int32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`- Offset int32 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Maximum number of items to return.+ Limit int32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`+ // Number of items to skip before starting to return results.+ Offset int32 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -406,8 +416,7 @@ func (x *PageToken) GetOffset() int32 {return 0}-// Position in a text expressed as zero-based line and zero-based column byte-// offset.+// Position in a text expressed as zero-based line and column byte offset.type Position struct {state protoimpl.MessageState `protogen:"open.v1"`// Line position in a text (zero-based).@@ -462,10 +471,13 @@ func (x *Position) GetColumn() int32 {return 0}+// Range represents a span within a text or sequence.type Range struct {- state protoimpl.MessageState `protogen:"open.v1"`- Start int32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`- End int32 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Start index (inclusive).+ Start int32 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`+ // End index (exclusive).+ End int32 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}diff --git a/backend/generated-go/store/data_source.pb.go b/backend/generated-go/store/data_source.pb.godeleted file mode 100644index 7f30dcad03..0000000000--- a/backend/generated-go/store/data_source.pb.go+++ /dev/null@@ -1,59 +0,0 @@-// Code generated by protoc-gen-go. DO NOT EDIT.-// versions:-// protoc-gen-go v1.36.10-// protoc (unknown)-// source: store/data_source.proto--package store--import (- protoreflect "google.golang.org/protobuf/reflect/protoreflect"- protoimpl "google.golang.org/protobuf/runtime/protoimpl"- reflect "reflect"- unsafe "unsafe"-)--const (- // Verify that this generated code is sufficiently up-to-date.- _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)- // Verify that runtime/protoimpl is sufficiently up-to-date.- _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)-)--var File_store_data_source_proto protoreflect.FileDescriptor--const file_store_data_source_proto_rawDesc = "" +- "\n" +- "\x17store/data_source.proto\x12\x0ebytebase.storeB\x14Z\x12generated-go/storeb\x06proto3"--var file_store_data_source_proto_goTypes = []any{}-var file_store_data_source_proto_depIdxs = []int32{- 0, // [0:0] is the sub-list for method output_type- 0, // [0:0] is the sub-list for method input_type- 0, // [0:0] is the sub-list for extension type_name- 0, // [0:0] is the sub-list for extension extendee- 0, // [0:0] is the sub-list for field type_name-}--func init() { file_store_data_source_proto_init() }-func file_store_data_source_proto_init() {- if File_store_data_source_proto != nil {- return- }- type x struct{}- out := protoimpl.TypeBuilder{- File: protoimpl.DescBuilder{- GoPackagePath: reflect.TypeOf(x{}).PkgPath(),- RawDescriptor: unsafe.Slice(unsafe.StringData(file_store_data_source_proto_rawDesc), len(file_store_data_source_proto_rawDesc)),- NumEnums: 0,- NumMessages: 0,- NumExtensions: 0,- NumServices: 0,- },- GoTypes: file_store_data_source_proto_goTypes,- DependencyIndexes: file_store_data_source_proto_depIdxs,- }.Build()- File_store_data_source_proto = out.File- file_store_data_source_proto_goTypes = nil- file_store_data_source_proto_depIdxs = nil-}diff --git a/backend/generated-go/store/data_source_equal.pb.go b/backend/generated-go/store/data_source_equal.pb.godeleted file mode 100644index aaee95d6aa..0000000000--- a/backend/generated-go/store/data_source_equal.pb.go+++ /dev/null@@ -1,4 +0,0 @@-// Code generated by protoc-gen-equal-go. DO NOT EDIT.-// source: store/data_source.proto--package storediff --git a/backend/generated-go/store/database.pb.go b/backend/generated-go/store/database.pb.goindex c5b73fc7dc..2ca236e221 100644--- a/backend/generated-go/store/database.pb.go+++ b/backend/generated-go/store/database.pb.go@@ -169,8 +169,8 @@ func (StreamMetadata_Mode) EnumDescriptor() ([]byte, []int) {return file_store_database_proto_rawDescGZIP(), []int{10, 1}}-// Type is the type of a table partition, some database engines may not-// support all types. Only avilable for the following database engines now:+// The type is the type of a table partition. Some database engines may not+// support all types. Only available 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:@@ -406,7 +406,7 @@ type DatabaseMetadata struct {LastSyncTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_sync_time,json=lastSyncTime,proto3" json:"last_sync_time,omitempty"`BackupAvailable bool `protobuf:"varint,3,opt,name=backup_available,json=backupAvailable,proto3" json:"backup_available,omitempty"`Datashare bool `protobuf:"varint,4,opt,name=datashare,proto3" json:"datashare,omitempty"`- // The schema is drifted from the source of truth.+ // The schema has drifted from the source of truth.Drifted bool `protobuf:"varint,6,opt,name=drifted,proto3" json:"drifted,omitempty"`// The version of database schema.Version string `protobuf:"bytes,7,opt,name=version,proto3" json:"version,omitempty"`@@ -490,17 +490,17 @@ func (x *DatabaseMetadata) GetVersion() string {type DatabaseSchemaMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The schemas is the list of schemas in a database.+ // The list of schemas in a database.Schemas []*SchemaMetadata `protobuf:"bytes,2,rep,name=schemas,proto3" json:"schemas,omitempty"`- // The character_set is the character set of a database.+ // The character set of the database.CharacterSet string `protobuf:"bytes,3,opt,name=character_set,json=characterSet,proto3" json:"character_set,omitempty"`- // The collation is the collation of a database.+ // The collation of the database.Collation string `protobuf:"bytes,4,opt,name=collation,proto3" json:"collation,omitempty"`- // The extensions is the list of extensions in a database.+ // The list of extensions in a database.Extensions []*ExtensionMetadata `protobuf:"bytes,5,rep,name=extensions,proto3" json:"extensions,omitempty"`// The database belongs to a datashare.Datashare bool `protobuf:"varint,6,opt,name=datashare,proto3" json:"datashare,omitempty"`- // The service name of the database. It's the Oracle specific concept.+ // The service name of the database. It's an Oracle-specific concept.ServiceName string `protobuf:"bytes,7,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`LinkedDatabases []*LinkedDatabaseMetadata `protobuf:"bytes,8,rep,name=linked_databases,json=linkedDatabases,proto3" json:"linked_databases,omitempty"`Owner string `protobuf:"bytes,9,opt,name=owner,proto3" json:"owner,omitempty"`@@ -674,30 +674,28 @@ func (x *LinkedDatabaseMetadata) GetHost() string {// This is the concept of schema in Postgres, but it's a no-op for MySQL.type SchemaMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the schema name.+ // The schema name.// It is an empty string for databases without such concept such as MySQL.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The tables is the list of tables in a schema.+ // The list of tables in a schema.Tables []*TableMetadata `protobuf:"bytes,2,rep,name=tables,proto3" json:"tables,omitempty"`- // The external_tables is the list of external tables in a schema.+ // The list of external tables in a schema.ExternalTables []*ExternalTableMetadata `protobuf:"bytes,3,rep,name=external_tables,json=externalTables,proto3" json:"external_tables,omitempty"`- // The views is the list of views in a schema.+ // The list of views in a schema.Views []*ViewMetadata `protobuf:"bytes,4,rep,name=views,proto3" json:"views,omitempty"`- // The functions is the list of functions in a schema.+ // The list of functions in a schema.Functions []*FunctionMetadata `protobuf:"bytes,5,rep,name=functions,proto3" json:"functions,omitempty"`- // The procedures is the list of procedures in a schema.+ // The list of procedures in a schema.Procedures []*ProcedureMetadata `protobuf:"bytes,6,rep,name=procedures,proto3" json:"procedures,omitempty"`- // The streams is the list of streams in a schema, currently, only used for- // Snowflake.+ // The list of streams in a schema, currently only used for Snowflake.Streams []*StreamMetadata `protobuf:"bytes,7,rep,name=streams,proto3" json:"streams,omitempty"`- // The routines is the list of routines in a schema, currently, only used for- // Snowflake.+ // The list of tasks in a schema, currently only used for Snowflake.Tasks []*TaskMetadata `protobuf:"bytes,8,rep,name=tasks,proto3" json:"tasks,omitempty"`- // The materialized_views is the list of materialized views in a schema.+ // The list of materialized views in a schema.MaterializedViews []*MaterializedViewMetadata `protobuf:"bytes,9,rep,name=materialized_views,json=materializedViews,proto3" json:"materialized_views,omitempty"`- // The sequences is the list of sequences in a schema.+ // The list of sequences in a schema.Sequences []*SequenceMetadata `protobuf:"bytes,10,rep,name=sequences,proto3" json:"sequences,omitempty"`- // The packages is the list of packages in a schema.+ // The list of packages in a schema.Packages []*PackageMetadata `protobuf:"bytes,11,rep,name=packages,proto3" json:"packages,omitempty"`Owner string `protobuf:"bytes,12,opt,name=owner,proto3" json:"owner,omitempty"`Comment string `protobuf:"bytes,13,opt,name=comment,proto3" json:"comment,omitempty"`@@ -852,9 +850,9 @@ func (x *SchemaMetadata) GetSkipDump() bool {type EnumTypeMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of a type.+ // The name of the enum type.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The enum values of a type.+ // The enum values of the type.Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`Comment string `protobuf:"bytes,3,opt,name=comment,proto3" json:"comment,omitempty"`SkipDump bool `protobuf:"varint,4,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`@@ -1027,17 +1025,17 @@ type SequenceMetadata struct {MinValue string `protobuf:"bytes,4,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`// The maximum value of a sequence.MaxValue string `protobuf:"bytes,5,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`- // Increment value of a sequence.+ // The increment value of a sequence.Increment string `protobuf:"bytes,6,opt,name=increment,proto3" json:"increment,omitempty"`- // Cycle is whether the sequence cycles.+ // Whether the sequence cycles.Cycle bool `protobuf:"varint,7,opt,name=cycle,proto3" json:"cycle,omitempty"`// Cache size of a sequence.CacheSize string `protobuf:"bytes,8,opt,name=cache_size,json=cacheSize,proto3" json:"cache_size,omitempty"`- // Last value of a sequence.+ // The last value of a sequence.LastValue string `protobuf:"bytes,9,opt,name=last_value,json=lastValue,proto3" json:"last_value,omitempty"`- // The owner table of the sequence.+ // The table that owns the sequence.OwnerTable string `protobuf:"bytes,10,opt,name=owner_table,json=ownerTable,proto3" json:"owner_table,omitempty"`- // The owner column of the sequence.+ // The column that owns the sequence.OwnerColumn string `protobuf:"bytes,11,opt,name=owner_column,json=ownerColumn,proto3" json:"owner_column,omitempty"`Comment string `protobuf:"bytes,12,opt,name=comment,proto3" json:"comment,omitempty"`SkipDump bool `protobuf:"varint,13,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`@@ -1168,14 +1166,13 @@ func (x *SequenceMetadata) GetSkipDump() bool {type TriggerMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of the trigger.+ // The name of the trigger.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The event is the event of the trigger, such as INSERT, UPDATE, DELETE,- // TRUNCATE.+ // The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE.Event string `protobuf:"bytes,3,opt,name=event,proto3" json:"event,omitempty"`- // The timing is the timing of the trigger, such as BEFORE, AFTER.+ // The timing of when the trigger fires, such as BEFORE or AFTER.Timing string `protobuf:"bytes,4,opt,name=timing,proto3" json:"timing,omitempty"`- // The body is the body of the trigger.+ // The body of the trigger.Body string `protobuf:"bytes,5,opt,name=body,proto3" json:"body,omitempty"`SqlMode string `protobuf:"bytes,6,opt,name=sql_mode,json=sqlMode,proto3" json:"sql_mode,omitempty"`CharacterSetClient string `protobuf:"bytes,7,opt,name=character_set_client,json=characterSetClient,proto3" json:"character_set_client,omitempty"`@@ -1282,19 +1279,19 @@ func (x *TriggerMetadata) GetSkipDump() bool {// RuleMetadata is the metadata for PostgreSQL rules.type RuleMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of the rule.+ // The name of the rule.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The event is the event type of the rule: SELECT, INSERT, UPDATE, or DELETE.+ // The event type of the rule: SELECT, INSERT, UPDATE, or DELETE.Event string `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`- // The condition is the WHERE condition of the rule (optional).+ // The WHERE condition of the rule (optional).Condition string `protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`- // The action is the command(s) to execute when the rule fires.+ // The command(s) to execute when the rule fires.Action string `protobuf:"bytes,4,opt,name=action,proto3" json:"action,omitempty"`// The is_instead indicates whether this is an INSTEAD rule.IsInstead bool `protobuf:"varint,5,opt,name=is_instead,json=isInstead,proto3" json:"is_instead,omitempty"`// The is_enabled indicates whether the rule is enabled.IsEnabled bool `protobuf:"varint,6,opt,name=is_enabled,json=isEnabled,proto3" json:"is_enabled,omitempty"`- // The definition is the full CREATE RULE statement.+ // The full CREATE RULE statement.Definition string `protobuf:"bytes,7,opt,name=definition,proto3" json:"definition,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -1381,10 +1378,10 @@ func (x *RuleMetadata) GetDefinition() string {type TaskMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a task.+ // The name of the task.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The id is the snowflake-generated id of a task.- // Example: 01ad32a0-1bb6-5e93-0000-000000000001+ // The Snowflake-generated ID of the task.+ // Example: 01ad32a0-1bb6-5e93-0000-000000000001.Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`// The owner of the task.Owner string `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"`@@ -1508,7 +1505,7 @@ func (x *TaskMetadata) GetDefinition() string {type StreamMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a stream.+ // The name of the stream.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The table_name is the name of the table/view that the stream is created on.TableName string `protobuf:"bytes,2,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`@@ -1617,7 +1614,7 @@ func (x *StreamMetadata) GetDefinition() string {// TableMetadata is the metadata for tables.type TableMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a table.+ // The name of the table.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The columns is the ordered list of columns in a table.Columns []*ColumnMetadata `protobuf:"bytes,2,rep,name=columns,proto3" json:"columns,omitempty"`@@ -1627,7 +1624,7 @@ type TableMetadata struct {Engine string `protobuf:"bytes,4,opt,name=engine,proto3" json:"engine,omitempty"`// The collation is the collation of a table.Collation string `protobuf:"bytes,5,opt,name=collation,proto3" json:"collation,omitempty"`- // The character set of table.+ // The character set of the table.Charset string `protobuf:"bytes,17,opt,name=charset,proto3" json:"charset,omitempty"`// The row_count is the estimated number of rows of a table.RowCount int64 `protobuf:"varint,6,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`@@ -1860,7 +1857,7 @@ func (x *TableMetadata) GetPrimaryKeyType() string {type CheckConstraintMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a check constraint.+ // The name of the check constraint.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The expression is the expression of a check constraint.Expression string `protobuf:"bytes,2,opt,name=expression,proto3" json:"expression,omitempty"`@@ -1914,7 +1911,7 @@ func (x *CheckConstraintMetadata) GetExpression() string {type ExternalTableMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a external table.+ // The name of the external table.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The external_server_name is the name of the external server.ExternalServerName string `protobuf:"bytes,2,opt,name=external_server_name,json=externalServerName,proto3" json:"external_server_name,omitempty"`@@ -1987,7 +1984,7 @@ func (x *ExternalTableMetadata) GetColumns() []*ColumnMetadata {// TablePartitionMetadata is the metadata for table partitions.type TablePartitionMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a table partition.+ // The name of the table partition.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The type of a table partition.Type TablePartitionMetadata_Type `protobuf:"varint,2,opt,name=type,proto3,enum=bytebase.store.TablePartitionMetadata_Type" json:"type,omitempty"`@@ -2114,11 +2111,11 @@ func (x *TablePartitionMetadata) GetCheckConstraints() []*CheckConstraintMetadat// ColumnMetadata is the metadata for columns.type ColumnMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a column.+ // The name of the column.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The position is the position in columns.Position int32 `protobuf:"varint,2,opt,name=position,proto3" json:"position,omitempty"`- // The default value of column.+ // The default value of the column.Default string `protobuf:"bytes,3,opt,name=default,proto3" json:"default,omitempty"`// Deprecated.DefaultNull bool `protobuf:"varint,4,opt,name=default_null,json=defaultNull,proto3" json:"default_null,omitempty"`@@ -2399,17 +2396,17 @@ func (x *GenerationMetadata) GetExpression() string {// ViewMetadata is the metadata for views.type ViewMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a view.+ // The name of the view.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The definition is the definition of a view.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`// The comment is the comment of a view.Comment string `protobuf:"bytes,3,opt,name=comment,proto3" json:"comment,omitempty"`- // The dependency_columns is the list of dependency columns of a view.+ // The list of dependency columns of a view.DependencyColumns []*DependencyColumn `protobuf:"bytes,4,rep,name=dependency_columns,json=dependencyColumns,proto3" json:"dependency_columns,omitempty"`- // The columns is the ordered list of columns in a table.+ // The ordered list of columns in the view.Columns []*ColumnMetadata `protobuf:"bytes,5,rep,name=columns,proto3" json:"columns,omitempty"`- // The triggers is the list of triggers in a view.+ // The list of triggers in the view.Triggers []*TriggerMetadata `protobuf:"bytes,6,rep,name=triggers,proto3" json:"triggers,omitempty"`SkipDump bool `protobuf:"varint,7,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`// The rules is the list of rules in a view (PostgreSQL specific).@@ -2571,17 +2568,17 @@ func (x *DependencyColumn) GetColumn() string {// MaterializedViewMetadata is the metadata for materialized views.type MaterializedViewMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a view.+ // The name of the materialized view.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The definition is the definition of a view.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`// The comment is the comment of a view.Comment string `protobuf:"bytes,3,opt,name=comment,proto3" json:"comment,omitempty"`- // The dependency_columns is the list of dependency columns of a view.+ // The list of dependency columns of the view.DependencyColumns []*DependencyColumn `protobuf:"bytes,4,rep,name=dependency_columns,json=dependencyColumns,proto3" json:"dependency_columns,omitempty"`- // The columns is the ordered list of columns in a table.+ // The ordered list of columns in the materialized view.Triggers []*TriggerMetadata `protobuf:"bytes,5,rep,name=triggers,proto3" json:"triggers,omitempty"`- // The indexes is the list of indexes in a table.+ // The list of indexes in the materialized view.Indexes []*IndexMetadata `protobuf:"bytes,6,rep,name=indexes,proto3" json:"indexes,omitempty"`SkipDump bool `protobuf:"varint,7,opt,name=skip_dump,json=skipDump,proto3" json:"skip_dump,omitempty"`unknownFields protoimpl.UnknownFields@@ -2724,7 +2721,7 @@ func (x *DependencyTable) GetTable() string {// FunctionMetadata is the metadata for functions.type FunctionMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a function.+ // The name of the function.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The definition is the definition of a function.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`@@ -2848,7 +2845,7 @@ func (x *FunctionMetadata) GetSkipDump() bool {// ProcedureMetadata is the metadata for procedures.type ProcedureMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a procedure.+ // The name of the procedure.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The definition is the definition of a procedure.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`@@ -2962,7 +2959,7 @@ func (x *ProcedureMetadata) GetSkipDump() bool {// PackageMetadata is the metadata for packages.type PackageMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a package.+ // The name of the package.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The definition is the definition of a package.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`@@ -3017,15 +3014,15 @@ func (x *PackageMetadata) GetDefinition() string {// IndexMetadata is the metadata for indexes.type IndexMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of an index.+ // The name of the index.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The expressions are the ordered columns or expressions of an index.// This could refer to a column or an expression.Expressions []string `protobuf:"bytes,2,rep,name=expressions,proto3" json:"expressions,omitempty"`- // The key_lengths are the ordered key lengths of an index.- // If the key length is not specified, it's -1.+ // The ordered list of key lengths for the index.+ // If the key length is not specified, it is -1.KeyLength []int64 `protobuf:"varint,9,rep,packed,name=key_length,json=keyLength,proto3" json:"key_length,omitempty"`- // The descending is the ordered descending of an index.+ // The ordered list of descending flags for the index columns.Descending []bool `protobuf:"varint,10,rep,packed,name=descending,proto3" json:"descending,omitempty"`// The type is the type of an index.Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`@@ -3727,9 +3724,9 @@ func (x *DimensionalConfig) GetParallelBuild() bool {// ExtensionMetadata is the metadata for extensions.type ExtensionMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of an extension.+ // The name of the extension.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`- // The schema is the extension that is installed to. But the extension usage+ // The schema where the extension is installed. However, the extension usage// is not limited to the schema.Schema string `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`// The version is the version of an extension.@@ -3801,7 +3798,7 @@ func (x *ExtensionMetadata) GetDescription() string {// ForeignKeyMetadata is the metadata for foreign keys.type ForeignKeyMetadata struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a foreign key.+ // The name of the foreign key.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The columns are the ordered referencing columns of a foreign key.Columns []string `protobuf:"bytes,2,rep,name=columns,proto3" json:"columns,omitempty"`@@ -4021,7 +4018,7 @@ func (x *DatabaseConfig) GetSchemas() []*SchemaCatalog {type SchemaCatalog struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the schema name.+ // The schema name.// It is an empty string for databases without such concept such as MySQL.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The table_configs is the list of configs for tables in a schema.@@ -4076,7 +4073,7 @@ func (x *SchemaCatalog) GetTables() []*TableCatalog {type TableCatalog struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a table.+ // The name of the table.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The column_configs is the ordered list of configs for columns in a table.Columns []*ColumnCatalog `protobuf:"bytes,2,rep,name=columns,proto3" json:"columns,omitempty"`@@ -4146,7 +4143,7 @@ func (x *TableCatalog) GetClassification() string {type ColumnCatalog struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name is the name of a column.+ // The name of the column.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`SemanticType string `protobuf:"bytes,2,opt,name=semantic_type,json=semanticType,proto3" json:"semantic_type,omitempty"`// The user labels for a column.diff --git a/backend/generated-go/store/group.pb.go b/backend/generated-go/store/group.pb.goindex 1eeb7e14a9..2a7950d813 100644--- a/backend/generated-go/store/group.pb.go+++ b/backend/generated-go/store/group.pb.go@@ -72,7 +72,7 @@ func (GroupMember_Role) EnumDescriptor() ([]byte, []int) {type GroupMember struct {state protoimpl.MessageState `protogen:"open.v1"`- // Member is the principal who belong to this group.+ // Member is the principal who belongs to this group.//// Format: users/{userUID}.Member string `protobuf:"bytes,1,opt,name=member,proto3" json:"member,omitempty"`@@ -128,7 +128,7 @@ func (x *GroupMember) GetRole() GroupMember_Role {type GroupPayload struct {state protoimpl.MessageState `protogen:"open.v1"`Members []*GroupMember `protobuf:"bytes,1,rep,name=members,proto3" json:"members,omitempty"`- // source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ // The source indicates where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/idp.pb.go b/backend/generated-go/store/idp.pb.goindex e3779a5563..2b5792b9b2 100644--- a/backend/generated-go/store/idp.pb.go+++ b/backend/generated-go/store/idp.pb.go@@ -80,7 +80,7 @@ const (// IN_PARAMS sends the "client_id" and "client_secret" in the POST body// as application/x-www-form-urlencoded parameters.OAuth2AuthStyle_IN_PARAMS OAuth2AuthStyle = 1- // IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.+ // IN_HEADER sends the client_id and client_secret using HTTP Basic Authorization.// This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.OAuth2AuthStyle_IN_HEADER OAuth2AuthStyle = 2)diff --git a/backend/generated-go/store/instance.pb.go b/backend/generated-go/store/instance.pb.goindex 55bfcc4d80..7c9f4abe61 100644--- a/backend/generated-go/store/instance.pb.go+++ b/backend/generated-go/store/instance.pb.go@@ -182,7 +182,7 @@ func (DataSource_RedisType) EnumDescriptor() ([]byte, []int) {type DataSourceExternalSecret_SecretType int32const (- DataSourceExternalSecret_SAECRET_TYPE_UNSPECIFIED DataSourceExternalSecret_SecretType = 0+ DataSourceExternalSecret_SECRET_TYPE_UNSPECIFIED DataSourceExternalSecret_SecretType = 0// ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2DataSourceExternalSecret_VAULT_KV_V2 DataSourceExternalSecret_SecretType = 1// ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html@@ -194,16 +194,16 @@ const (// Enum value maps for DataSourceExternalSecret_SecretType.var (DataSourceExternalSecret_SecretType_name = map[int32]string{- 0: "SAECRET_TYPE_UNSPECIFIED",+ 0: "SECRET_TYPE_UNSPECIFIED",1: "VAULT_KV_V2",2: "AWS_SECRETS_MANAGER",3: "GCP_SECRET_MANAGER",}DataSourceExternalSecret_SecretType_value = map[string]int32{- "SAECRET_TYPE_UNSPECIFIED": 0,- "VAULT_KV_V2": 1,- "AWS_SECRETS_MANAGER": 2,- "GCP_SECRET_MANAGER": 3,+ "SECRET_TYPE_UNSPECIFIED": 0,+ "VAULT_KV_V2": 1,+ "AWS_SECRETS_MANAGER": 2,+ "GCP_SECRET_MANAGER": 3,})@@ -343,12 +343,12 @@ type Instance struct {Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`ExternalLink string `protobuf:"bytes,5,opt,name=external_link,json=externalLink,proto3" json:"external_link,omitempty"`DataSources []*DataSource `protobuf:"bytes,6,rep,name=data_sources,json=dataSources,proto3" json:"data_sources,omitempty"`- // How often the instance is synced.+ // The interval between automatic instance synchronizations.SyncInterval *durationpb.Duration `protobuf:"bytes,7,opt,name=sync_interval,json=syncInterval,proto3" json:"sync_interval,omitempty"`// The maximum number of connections.// The default is 10 if the value is unset or zero.MaximumConnections int32 `protobuf:"varint,8,opt,name=maximum_connections,json=maximumConnections,proto3" json:"maximum_connections,omitempty"`- // Enable sync for following databases.+ // Enable sync for the following databases.// Default empty, means sync all schemas & databases.SyncDatabases []string `protobuf:"bytes,9,rep,name=sync_databases,json=syncDatabases,proto3" json:"sync_databases,omitempty"`// The lower_case_table_names config for MySQL instances.@@ -494,8 +494,8 @@ type InstanceRole struct {// The expiration for the role's password.ValidUntil *string `protobuf:"bytes,3,opt,name=valid_until,json=validUntil,proto3,oneof" json:"valid_until,omitempty"`// The role attribute.- // For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html- // For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html+ // 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 is the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.htmlAttribute *string `protobuf:"bytes,4,opt,name=attribute,proto3,oneof" json:"attribute,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -566,7 +566,7 @@ type DataSource struct {Username string `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`Password string `protobuf:"bytes,37,opt,name=password,proto3" json:"password,omitempty"`ObfuscatedPassword string `protobuf:"bytes,4,opt,name=obfuscated_password,json=obfuscatedPassword,proto3" json:"obfuscated_password,omitempty"`- // Use SSL to connect to the data source. By default, we use system default SSL configuration.+ // Use SSL to connect to the data source. By default, we use the system's SSL configuration.UseSsl bool `protobuf:"varint,30,opt,name=use_ssl,json=useSsl,proto3" json:"use_ssl,omitempty"`SslCa string `protobuf:"bytes,38,opt,name=ssl_ca,json=sslCa,proto3" json:"ssl_ca,omitempty"`ObfuscatedSslCa string `protobuf:"bytes,5,opt,name=obfuscated_ssl_ca,json=obfuscatedSslCa,proto3" json:"obfuscated_ssl_ca,omitempty"`@@ -583,7 +583,7 @@ type DataSource struct {Host string `protobuf:"bytes,8,opt,name=host,proto3" json:"host,omitempty"`Port string `protobuf:"bytes,9,opt,name=port,proto3" json:"port,omitempty"`Database string `protobuf:"bytes,10,opt,name=database,proto3" json:"database,omitempty"`- // srv, authentication_database and replica_set are used for MongoDB.+ // 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.Srv bool `protobuf:"varint,11,opt,name=srv,proto3" json:"srv,omitempty"`// authentication_database is the database name to authenticate against, which stores the user credentials.@@ -623,7 +623,7 @@ type DataSource struct {AdditionalAddresses []*DataSource_Address `protobuf:"bytes,26,rep,name=additional_addresses,json=additionalAddresses,proto3" json:"additional_addresses,omitempty"`// direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string.DirectConnection bool `protobuf:"varint,27,opt,name=direct_connection,json=directConnection,proto3" json:"direct_connection,omitempty"`- // region is the location of where the DB is, works for AWS RDS. For example, us-east-1.+ // Region is the location of the database, used for AWS RDS. For example, us-east-1.Region string `protobuf:"bytes,28,opt,name=region,proto3" json:"region,omitempty"`// warehouse_id is used by Databricks.WarehouseId string `protobuf:"bytes,29,opt,name=warehouse_id,json=warehouseId,proto3" json:"warehouse_id,omitempty"`@@ -1249,7 +1249,7 @@ func (x *DataSourceExternalSecret) GetSecretType() DataSourceExternalSecret_Secrif x != nil {return x.SecretType}- return DataSourceExternalSecret_SAECRET_TYPE_UNSPECIFIED+ return DataSourceExternalSecret_SECRET_TYPE_UNSPECIFIED}func (x *DataSourceExternalSecret) GetUrl() string {@@ -1607,7 +1607,7 @@ func (x *DataSource_Address) GetPort() string {type DataSourceExternalSecret_AppRoleAuthOption struct {state protoimpl.MessageState `protogen:"open.v1"`RoleId string `protobuf:"bytes,1,opt,name=role_id,json=roleId,proto3" json:"role_id,omitempty"`- // the secret id for the role without ttl.+ // The secret ID for the role without TTL.SecretId string `protobuf:"bytes,2,opt,name=secret_id,json=secretId,proto3" json:"secret_id,omitempty"`Type DataSourceExternalSecret_AppRoleAuthOption_SecretType `protobuf:"varint,3,opt,name=type,proto3,enum=bytebase.store.DataSourceExternalSecret_AppRoleAuthOption_SecretType" json:"type,omitempty"`// The path where the approle auth method is mounted.@@ -1812,7 +1812,7 @@ const file_store_instance_proto_rawDesc = "" +"\x06keytab\x18\x04 \x01(\fR\x06keytab\x12\x19\n" +"\bkdc_host\x18\x05 \x01(\tR\akdcHost\x12\x19\n" +"\bkdc_port\x18\x06 \x01(\tR\akdcPort\x124\n" +- "\x16kdc_transport_protocol\x18\a \x01(\tR\x14kdcTransportProtocol\"\x81\a\n" ++ "\x16kdc_transport_protocol\x18\a \x01(\tR\x14kdcTransportProtocol\"\x80\a\n" +"\x18DataSourceExternalSecret\x12T\n" +"\vsecret_type\x18\x01 \x01(\x0e23.bytebase.store.DataSourceExternalSecret.SecretTypeR\n" +"secretType\x12\x10\n" +@@ -1835,10 +1835,10 @@ const file_store_instance_proto_rawDesc = "" +"SecretType\x12\x1b\n" +"\x17SECRET_TYPE_UNSPECIFIED\x10\x00\x12\t\n" +"\x05PLAIN\x10\x01\x12\x0f\n" +- "\vENVIRONMENT\x10\x02\"l\n" ++ "\vENVIRONMENT\x10\x02\"k\n" +"\n" +- "SecretType\x12\x1c\n" +- "\x18SAECRET_TYPE_UNSPECIFIED\x10\x00\x12\x0f\n" ++ "SecretType\x12\x1b\n" ++ "\x17SECRET_TYPE_UNSPECIFIED\x10\x00\x12\x0f\n" +"\vVAULT_KV_V2\x10\x01\x12\x17\n" +"\x13AWS_SECRETS_MANAGER\x10\x02\x12\x16\n" +"\x12GCP_SECRET_MANAGER\x10\x03\"D\n" +diff --git a/backend/generated-go/store/issue.pb.go b/backend/generated-go/store/issue.pb.goindex 4bc5b15eb1..cec233d17a 100644--- a/backend/generated-go/store/issue.pb.go+++ b/backend/generated-go/store/issue.pb.go@@ -23,13 +23,17 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Type represents the category of issue.type Issue_Type int32const (Issue_ISSUE_TYPE_UNSPECIFIED Issue_Type = 0- Issue_DATABASE_CHANGE Issue_Type = 1- Issue_GRANT_REQUEST Issue_Type = 2- Issue_DATABASE_EXPORT Issue_Type = 3+ // Issue for database schema or data changes.+ Issue_DATABASE_CHANGE Issue_Type = 1+ // Issue requesting database access permissions.+ Issue_GRANT_REQUEST Issue_Type = 2+ // Issue for exporting data from databases.+ Issue_DATABASE_EXPORT Issue_Type = 3)// Enum value maps for Issue_Type.@@ -75,13 +79,17 @@ func (Issue_Type) EnumDescriptor() ([]byte, []int) {return file_store_issue_proto_rawDescGZIP(), []int{0, 0}}+// Status represents the current state of the issue.type Issue_Status int32const (Issue_ISSUE_STATUS_UNSPECIFIED Issue_Status = 0- Issue_OPEN Issue_Status = 1- Issue_DONE Issue_Status = 2- Issue_CANCELED Issue_Status = 3+ // Issue is open and pending action.+ Issue_OPEN Issue_Status = 1+ // Issue has been completed successfully.+ Issue_DONE Issue_Status = 2+ // Issue was canceled and will not be completed.+ Issue_CANCELED Issue_Status = 3)// Enum value maps for Issue_Status.@@ -127,11 +135,15 @@ func (Issue_Status) EnumDescriptor() ([]byte, []int) {return file_store_issue_proto_rawDescGZIP(), []int{0, 1}}+// Issue is the metadata for issues that track database operations and access requests.type Issue struct {- state protoimpl.MessageState `protogen:"open.v1"`- Approval *IssuePayloadApproval `protobuf:"bytes,1,opt,name=approval,proto3" json:"approval,omitempty"`- GrantRequest *GrantRequest `protobuf:"bytes,2,opt,name=grant_request,json=grantRequest,proto3" json:"grant_request,omitempty"`- Labels []string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Approval information for the issue workflow.+ Approval *IssuePayloadApproval `protobuf:"bytes,1,opt,name=approval,proto3" json:"approval,omitempty"`+ // Access grant request details if this is a grant request issue.+ GrantRequest *GrantRequest `protobuf:"bytes,2,opt,name=grant_request,json=grantRequest,proto3" json:"grant_request,omitempty"`+ // Labels attached to categorize and filter the issue.+ Labels []string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -187,15 +199,18 @@ func (x *Issue) GetLabels() []string {return nil}+// GrantRequest contains details for requesting database access permissions.type GrantRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // The requested role.+ // The role being requested for the user.// Format: roles/EXPORTER.Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`- // The user to be granted.+ // The user who will receive the role.// Format: users/{userUID}.- User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`- Condition *expr.Expr `protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`+ User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`+ // Optional conditional expression that limits when the grant applies.+ Condition *expr.Expr `protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`+ // Duration after which the grant automatically expires.Expiration *durationpb.Duration `protobuf:"bytes,4,opt,name=expiration,proto3" json:"expiration,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/plan.pb.go b/backend/generated-go/store/plan.pb.goindex 810adf813c..02c30c752b 100644--- a/backend/generated-go/store/plan.pb.go+++ b/backend/generated-go/store/plan.pb.go@@ -512,8 +512,8 @@ type PlanConfig_ExportDataConfig struct {Sheet string `protobuf:"bytes,2,opt,name=sheet,proto3" json:"sheet,omitempty"`// The format of the exported file.Format ExportFormat `protobuf:"varint,3,opt,name=format,proto3,enum=bytebase.store.ExportFormat" json:"format,omitempty"`- // The zip password provide by users.- // Leave it empty if no needs to encrypt the zip file.+ // The zip password provided by users.+ // Leave it empty if there is no need to encrypt the zip file.Password *string `protobuf:"bytes,4,opt,name=password,proto3,oneof" json:"password,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/plan_check_run.pb.go b/backend/generated-go/store/plan_check_run.pb.goindex 662b7d37a6..fb8e75b0af 100644--- a/backend/generated-go/store/plan_check_run.pb.go+++ b/backend/generated-go/store/plan_check_run.pb.go@@ -394,7 +394,7 @@ func (*PlanCheckRunResult_Result_SqlReviewReport_) isPlanCheckRunResult_Result_Rtype PlanCheckRunResult_Result_SqlSummaryReport struct {state protoimpl.MessageState `protogen:"open.v1"`- // statement_types are the types of statements that are found in the sql.+ // statement_types are the types of statements found in the SQL.StatementTypes []string `protobuf:"bytes,2,rep,name=statement_types,json=statementTypes,proto3" json:"statement_types,omitempty"`AffectedRows int64 `protobuf:"varint,3,opt,name=affected_rows,json=affectedRows,proto3" json:"affected_rows,omitempty"`ChangedResources *ChangedResources `protobuf:"bytes,4,opt,name=changed_resources,json=changedResources,proto3" json:"changed_resources,omitempty"`@@ -457,7 +457,7 @@ type PlanCheckRunResult_Result_SqlReviewReport struct {state protoimpl.MessageState `protogen:"open.v1"`Line int32 `protobuf:"varint,1,opt,name=line,proto3" json:"line,omitempty"`Column int32 `protobuf:"varint,2,opt,name=column,proto3" json:"column,omitempty"`- // 1-based Position of the SQL statement.+ // 1-based position of the SQL statement.// To supersede `line` and `column` above.StartPosition *Position `protobuf:"bytes,8,opt,name=start_position,json=startPosition,proto3" json:"start_position,omitempty"`EndPosition *Position `protobuf:"bytes,9,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`diff --git a/backend/generated-go/store/policy.pb.go b/backend/generated-go/store/policy.pb.goindex e0a766d6ca..02ded430dc 100644--- a/backend/generated-go/store/policy.pb.go+++ b/backend/generated-go/store/policy.pb.go@@ -657,8 +657,8 @@ func (x *SQLReviewRule) GetComment() string {type TagPolicy struct {state protoimpl.MessageState `protogen:"open.v1"`- // tags is the key - value map for resources.- // for example, the environment resource can have the sql review config tag, like "bb.tag.review_config": "reviewConfigs/{review config resource id}"+ // tags is the key-value map for resources.+ // For example, the environment resource can have the SQL review config tag, such as "bb.tag.review_config": "reviewConfigs/{review config resource id}".Tags map[string]string `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -873,7 +873,7 @@ type QueryDataPolicy struct {state protoimpl.MessageState `protogen:"open.v1"`// The query timeout duration.Timeout *durationpb.Duration `protobuf:"bytes,1,opt,name=timeout,proto3" json:"timeout,omitempty"`- // Disable export data in the SQL editor+ // Disable exporting data in the SQL editor.DisableExport bool `protobuf:"varint,2,opt,name=disable_export,json=disableExport,proto3" json:"disable_export,omitempty"`// The size limit in bytes.// The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0.@@ -1116,9 +1116,9 @@ func (x *RolloutPolicy_Checkers_RequiredStatusChecks) GetPlanCheckEnforcement()type MaskingExceptionPolicy_MaskingException struct {state protoimpl.MessageState `protogen:"open.v1"`- // action is the action that the user can access sensitive data.+ // action is the action by which the user can access sensitive data.Action MaskingExceptionPolicy_MaskingException_Action `protobuf:"varint,1,opt,name=action,proto3,enum=bytebase.store.MaskingExceptionPolicy_MaskingException_Action" json:"action,omitempty"`- // Member is the principal who bind to this exception policy instance.+ // Member is the principal who binds to this exception policy instance.//// Format: users/{userUID} or groups/{group email}Member string `protobuf:"bytes,4,opt,name=member,proto3" json:"member,omitempty"`diff --git a/backend/generated-go/store/project.pb.go b/backend/generated-go/store/project.pb.goindex 5cf55b26c3..60453be7fc 100644--- a/backend/generated-go/store/project.pb.go+++ b/backend/generated-go/store/project.pb.go@@ -21,11 +21,15 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Label represents a categorization tag that can be applied to issues.type Label struct {- state protoimpl.MessageState `protogen:"open.v1"`- Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`- Color string `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"`- Group string `protobuf:"bytes,3,opt,name=group,proto3" json:"group,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // The display text of the label.+ Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`+ // The color for the label in hex format (e.g., "#FF0000").+ Color string `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"`+ // Optional group name for organizing related labels.+ Group string `protobuf:"bytes,3,opt,name=group,proto3" json:"group,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -81,9 +85,11 @@ func (x *Label) GetGroup() string {return ""}+// Project contains settings and configuration for a Bytebase project.type Project struct {- state protoimpl.MessageState `protogen:"open.v1"`- IssueLabels []*Label `protobuf:"bytes,2,rep,name=issue_labels,json=issueLabels,proto3" json:"issue_labels,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Available labels that can be applied to issues in this project.+ IssueLabels []*Label `protobuf:"bytes,2,rep,name=issue_labels,json=issueLabels,proto3" json:"issue_labels,omitempty"`// Force issue labels to be used when creating an issue.ForceIssueLabels bool `protobuf:"varint,3,opt,name=force_issue_labels,json=forceIssueLabels,proto3" json:"force_issue_labels,omitempty"`// Allow modifying statement after issue is created.@@ -101,10 +107,10 @@ type Project struct {PostgresDatabaseTenantMode bool `protobuf:"varint,9,opt,name=postgres_database_tenant_mode,json=postgresDatabaseTenantMode,proto3" json:"postgres_database_tenant_mode,omitempty"`// Whether to allow the issue creator to self-approve the issue.AllowSelfApproval bool `protobuf:"varint,10,opt,name=allow_self_approval,json=allowSelfApproval,proto3" json:"allow_self_approval,omitempty"`- // Execution retry policy for the task run.+ // Configuration for automatic retry on task execution failures.ExecutionRetryPolicy *Project_ExecutionRetryPolicy `protobuf:"bytes,11,opt,name=execution_retry_policy,json=executionRetryPolicy,proto3" json:"execution_retry_policy,omitempty"`// The maximum number of databases to sample during CI data validation.- // Without specification, sampling is disabled, resulting in a full validation.+ // If not specified, sampling is disabled, resulting in a full validation.CiSamplingSize int32 `protobuf:"varint,12,opt,name=ci_sampling_size,json=ciSamplingSize,proto3" json:"ci_sampling_size,omitempty"`// The maximum number of parallel tasks to run during the rollout.ParallelTasksPerRollout int32 `protobuf:"varint,13,opt,name=parallel_tasks_per_rollout,json=parallelTasksPerRollout,proto3" json:"parallel_tasks_per_rollout,omitempty"`@@ -246,9 +252,10 @@ func (x *Project) GetEnforceSqlReview() bool {return false}+// ExecutionRetryPolicy defines retry behavior for failed task executions.type Project_ExecutionRetryPolicy struct {state protoimpl.MessageState `protogen:"open.v1"`- // The maximum number of retries for the lock timeout issue.+ // The maximum number of retry attempts for lock timeout errors.MaximumRetries int32 `protobuf:"varint,1,opt,name=maximum_retries,json=maximumRetries,proto3" json:"maximum_retries,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/store/project_webhook.pb.go b/backend/generated-go/store/project_webhook.pb.goindex 6bf007cc97..9c992173bf 100644--- a/backend/generated-go/store/project_webhook.pb.go+++ b/backend/generated-go/store/project_webhook.pb.go@@ -23,7 +23,7 @@ const (type ProjectWebhookPayload struct {state protoimpl.MessageState `protogen:"open.v1"`- // if direct_message is set, the notification is sent directly+ // 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.DirectMessage bool `protobuf:"varint,1,opt,name=direct_message,json=directMessage,proto3" json:"direct_message,omitempty"`diff --git a/backend/generated-go/store/release.pb.go b/backend/generated-go/store/release.pb.goindex 328e91424f..5690ef589b 100644--- a/backend/generated-go/store/release.pb.go+++ b/backend/generated-go/store/release.pb.go@@ -187,7 +187,7 @@ type ReleasePayload_File struct {state protoimpl.MessageState `protogen:"open.v1"`// The unique identifier for the file.Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`- // The path of the file. e.g. `2.2/V0001_create_table.sql`.+ // The path of the file, e.g., `2.2/V0001_create_table.sql`.Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`// The sheet that holds the content.// Format: projects/{project}/sheets/{sheet}diff --git a/backend/generated-go/store/setting.pb.go b/backend/generated-go/store/setting.pb.goindex a99d92dd2d..506ceb5a01 100644--- a/backend/generated-go/store/setting.pb.go+++ b/backend/generated-go/store/setting.pb.go@@ -337,7 +337,7 @@ type WorkspaceProfileSetting struct {Announcement *Announcement `protobuf:"bytes,7,opt,name=announcement,proto3" json:"announcement,omitempty"`// The max duration for role expired.MaximumRoleExpiration *durationpb.Duration `protobuf:"bytes,8,opt,name=maximum_role_expiration,json=maximumRoleExpiration,proto3" json:"maximum_role_expiration,omitempty"`- // The workspace domain, e.g. bytebase.com.+ // The workspace domain, e.g., bytebase.com.Domains []string `protobuf:"bytes,9,rep,name=domains,proto3" json:"domains,omitempty"`// Only user and group from the domains can be created and login.EnforceIdentityDomain bool `protobuf:"varint,10,opt,name=enforce_identity_domain,json=enforceIdentityDomain,proto3" json:"enforce_identity_domain,omitempty"`@@ -460,9 +460,9 @@ func (x *WorkspaceProfileSetting) GetEnableMetricCollection() bool {type Announcement struct {state protoimpl.MessageState `protogen:"open.v1"`- // The alert level of announcemnt+ // The alert level of the announcement.Level Announcement_AlertLevel `protobuf:"varint,1,opt,name=level,proto3,enum=bytebase.store.Announcement_AlertLevel" json:"level,omitempty"`- // The text of announcemnt+ // The text of the announcement.Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`// The optional link, user can follow the link to check extra detailsLink string `protobuf:"bytes,3,opt,name=link,proto3" json:"link,omitempty"`@@ -949,15 +949,15 @@ func (x *SCIMSetting) GetToken() string {type PasswordRestrictionSetting struct {state protoimpl.MessageState `protogen:"open.v1"`- // min_length is the minimum length for password, should no less than 8.+ // min_length is the minimum length for password, should be no less than 8.MinLength int32 `protobuf:"varint,1,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`- // require_number requires the password must contains at least one number.+ // require_number requires the password must contain at least one number.RequireNumber bool `protobuf:"varint,2,opt,name=require_number,json=requireNumber,proto3" json:"require_number,omitempty"`- // require_letter requires the password must contains at least one letter, regardless of upper case or lower case+ // require_letter requires the password must contain at least one letter, regardless of upper case or lower caseRequireLetter bool `protobuf:"varint,3,opt,name=require_letter,json=requireLetter,proto3" json:"require_letter,omitempty"`- // require_uppercase_letter requires the password must contains at least one upper case letter.+ // require_uppercase_letter requires the password must contain at least one upper case letter.RequireUppercaseLetter bool `protobuf:"varint,4,opt,name=require_uppercase_letter,json=requireUppercaseLetter,proto3" json:"require_uppercase_letter,omitempty"`- // require_uppercase_letter requires the password must contains at least one special character.+ // require_special_character requires the password must contain at least one special character.RequireSpecialCharacter bool `protobuf:"varint,5,opt,name=require_special_character,json=requireSpecialCharacter,proto3" json:"require_special_character,omitempty"`// require_reset_password_for_first_login requires users to reset their password after the 1st login.RequireResetPasswordForFirstLogin bool `protobuf:"varint,6,opt,name=require_reset_password_for_first_login,json=requireResetPasswordForFirstLogin,proto3" json:"require_reset_password_for_first_login,omitempty"`diff --git a/backend/generated-go/store/task.pb.go b/backend/generated-go/store/task.pb.goindex 346fce00ae..ea7128ef10 100644--- a/backend/generated-go/store/task.pb.go+++ b/backend/generated-go/store/task.pb.go@@ -21,14 +21,19 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Type represents the type of database operation to perform.type Task_Type int32const (Task_TASK_TYPE_UNSPECIFIED Task_Type = 0- Task_DATABASE_CREATE Task_Type = 1- Task_DATABASE_MIGRATE Task_Type = 2- Task_DATABASE_EXPORT Task_Type = 5- Task_DATABASE_SDL Task_Type = 6+ // Create a new database.+ Task_DATABASE_CREATE Task_Type = 1+ // Apply schema/data migrations to an existing database.+ Task_DATABASE_MIGRATE Task_Type = 2+ // Export data from a database.+ Task_DATABASE_EXPORT Task_Type = 5+ // Apply declarative schema changes (state-based migration).+ Task_DATABASE_SDL Task_Type = 6)// Enum value maps for Task_Type.@@ -76,14 +81,17 @@ func (Task_Type) EnumDescriptor() ([]byte, []int) {return file_store_task_proto_rawDescGZIP(), []int{0, 0}}-// MigrateType is the database migration type.+// MigrateType is the database migration type for imperative migrations.type Task_MigrateType int32const (Task_MIGRATE_TYPE_UNSPECIFIED Task_MigrateType = 0- Task_DDL Task_MigrateType = 1- Task_DML Task_MigrateType = 2- Task_GHOST Task_MigrateType = 3+ // DDL changes (Data Definition Language) for schema modifications.+ Task_DDL Task_MigrateType = 1+ // DML changes (Data Manipulation Language) for data modifications.+ Task_DML Task_MigrateType = 2+ // Online schema migration using gh-ost tool.+ Task_GHOST Task_MigrateType = 3)// Enum value maps for Task_MigrateType.@@ -129,28 +137,40 @@ func (Task_MigrateType) EnumDescriptor() ([]byte, []int) {return file_store_task_proto_rawDescGZIP(), []int{0, 1}}+// Task is the metadata for database operation tasks.type Task struct {state protoimpl.MessageState `protogen:"open.v1"`- // common fields- Skipped bool `protobuf:"varint,1,opt,name=skipped,proto3" json:"skipped,omitempty"`+ // Whether the task was skipped during execution.+ Skipped bool `protobuf:"varint,1,opt,name=skipped,proto3" json:"skipped,omitempty"`+ // Reason why the task was skipped.SkippedReason string `protobuf:"bytes,2,opt,name=skipped_reason,json=skippedReason,proto3" json:"skipped_reason,omitempty"`- SpecId string `protobuf:"bytes,3,opt,name=spec_id,json=specId,proto3" json:"spec_id,omitempty"`- SheetId int32 `protobuf:"varint,4,opt,name=sheet_id,json=sheetId,proto3" json:"sheet_id,omitempty"`- // Create database fields.+ // UUID that identifies the spec this task implements.+ SpecId string `protobuf:"bytes,3,opt,name=spec_id,json=specId,proto3" json:"spec_id,omitempty"`+ // The sheet ID containing SQL statements for this task.+ SheetId int32 `protobuf:"varint,4,opt,name=sheet_id,json=sheetId,proto3" json:"sheet_id,omitempty"`+ // The environment where the database will be created.EnvironmentId string `protobuf:"bytes,5,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`- DatabaseName string `protobuf:"bytes,6,opt,name=database_name,json=databaseName,proto3" json:"database_name,omitempty"`- TableName string `protobuf:"bytes,7,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`- CharacterSet string `protobuf:"bytes,8,opt,name=character_set,json=characterSet,proto3" json:"character_set,omitempty"`- Collation string `protobuf:"bytes,9,opt,name=collation,proto3" json:"collation,omitempty"`- // Update database fields.- SchemaVersion string `protobuf:"bytes,10,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`- EnablePriorBackup bool `protobuf:"varint,11,opt,name=enable_prior_backup,json=enablePriorBackup,proto3" json:"enable_prior_backup,omitempty"`- // ghost flags.- Flags map[string]string `protobuf:"bytes,12,rep,name=flags,proto3" json:"flags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`+ // Name of the database to create.+ DatabaseName string `protobuf:"bytes,6,opt,name=database_name,json=databaseName,proto3" json:"database_name,omitempty"`+ // Optional table name to create (required for some databases like MongoDB).+ TableName string `protobuf:"bytes,7,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`+ // Character set for the new database.+ CharacterSet string `protobuf:"bytes,8,opt,name=character_set,json=characterSet,proto3" json:"character_set,omitempty"`+ // Collation for the new database.+ Collation string `protobuf:"bytes,9,opt,name=collation,proto3" json:"collation,omitempty"`+ // Schema version after migration is applied.+ SchemaVersion string `protobuf:"bytes,10,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`+ // Whether to create an automatic backup before applying changes.+ EnablePriorBackup bool `protobuf:"varint,11,opt,name=enable_prior_backup,json=enablePriorBackup,proto3" json:"enable_prior_backup,omitempty"`+ // Configuration flags for gh-ost migration tool.+ Flags map[string]string `protobuf:"bytes,12,rep,name=flags,proto3" json:"flags,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`+ // Source information if task is created from a release.TaskReleaseSource *TaskReleaseSource `protobuf:"bytes,13,opt,name=task_release_source,json=taskReleaseSource,proto3" json:"task_release_source,omitempty"`- MigrateType Task_MigrateType `protobuf:"varint,16,opt,name=migrate_type,json=migrateType,proto3,enum=bytebase.store.Task_MigrateType" json:"migrate_type,omitempty"`- // Export data fields.- Password string `protobuf:"bytes,14,opt,name=password,proto3" json:"password,omitempty"`+ // The type of migration (DDL, DML, or GHOST).+ MigrateType Task_MigrateType `protobuf:"varint,16,opt,name=migrate_type,json=migrateType,proto3,enum=bytebase.store.Task_MigrateType" json:"migrate_type,omitempty"`+ // Password to encrypt the exported data archive.+ Password string `protobuf:"bytes,14,opt,name=password,proto3" json:"password,omitempty"`+ // Format of the exported data (SQL, CSV, JSON, etc).Format ExportFormat `protobuf:"varint,15,opt,name=format,proto3,enum=bytebase.store.ExportFormat" json:"format,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -298,8 +318,10 @@ func (x *Task) GetFormat() ExportFormat {return ExportFormat_FORMAT_UNSPECIFIED}+// TaskReleaseSource contains information about the release file this task originated from.type TaskReleaseSource struct {state protoimpl.MessageState `protogen:"open.v1"`+ // Resource name of the release file.// Format: projects/{project}/releases/{release}/files/{id}File string `protobuf:"bytes,1,opt,name=file,proto3" json:"file,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/store/task_run.pb.go b/backend/generated-go/store/task_run.pb.goindex a62d338f23..1cc612be9d 100644--- a/backend/generated-go/store/task_run.pb.go+++ b/backend/generated-go/store/task_run.pb.go@@ -22,17 +22,25 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// Status represents the current execution state of a task run.type TaskRun_Status int32const (TaskRun_STATUS_UNSPECIFIED TaskRun_Status = 0- TaskRun_PENDING TaskRun_Status = 1- TaskRun_RUNNING TaskRun_Status = 2- TaskRun_DONE TaskRun_Status = 3- TaskRun_FAILED TaskRun_Status = 4- TaskRun_CANCELED TaskRun_Status = 5- TaskRun_NOT_STARTED TaskRun_Status = 6- TaskRun_SKIPPED TaskRun_Status = 7+ // Task run is queued and waiting to execute.+ TaskRun_PENDING TaskRun_Status = 1+ // Task run is currently executing.+ TaskRun_RUNNING TaskRun_Status = 2+ // Task run completed successfully.+ TaskRun_DONE TaskRun_Status = 3+ // Task run encountered an error and failed.+ TaskRun_FAILED TaskRun_Status = 4+ // Task run was canceled by user or system.+ TaskRun_CANCELED TaskRun_Status = 5+ // Task run has not started yet.+ TaskRun_NOT_STARTED TaskRun_Status = 6+ // Task run was skipped and will not execute.+ TaskRun_SKIPPED TaskRun_Status = 7)// Enum value maps for TaskRun_Status.@@ -86,6 +94,7 @@ func (TaskRun_Status) EnumDescriptor() ([]byte, []int) {return file_store_task_run_proto_rawDescGZIP(), []int{0, 0}}+// TaskRun represents an execution attempt of a task.type TaskRun struct {state protoimpl.MessageState `protogen:"open.v1"`unknownFields protoimpl.UnknownFields@@ -122,18 +131,23 @@ func (*TaskRun) Descriptor() ([]byte, []int) {return file_store_task_run_proto_rawDescGZIP(), []int{0}}+// TaskRunResult contains the outcome and metadata from a task run execution.type TaskRunResult struct {- state protoimpl.MessageState `protogen:"open.v1"`- Detail string `protobuf:"bytes,1,opt,name=detail,proto3" json:"detail,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Detailed execution information or error message.+ Detail string `protobuf:"bytes,1,opt,name=detail,proto3" json:"detail,omitempty"`+ // Resource name of the changelog entry created by this run.// Format: instances/{instance}/databases/{database}/changelogs/{changelog}Changelog string `protobuf:"bytes,8,opt,name=changelog,proto3" json:"changelog,omitempty"`- Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`- // The following fields are used for error reporting.+ // Schema version after the migration was applied.+ Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`+ // Starting position in the SQL statement where an error occurred.StartPosition *Position `protobuf:"bytes,4,opt,name=start_position,json=startPosition,proto3" json:"start_position,omitempty"`- EndPosition *Position `protobuf:"bytes,5,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`- // The uid of the export archive.+ // Ending position in the SQL statement where an error occurred.+ EndPosition *Position `protobuf:"bytes,5,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`+ // UID of the export archive generated for export tasks.ExportArchiveUid int32 `protobuf:"varint,6,opt,name=export_archive_uid,json=exportArchiveUid,proto3" json:"export_archive_uid,omitempty"`- // The prior backup detail that will be used to rollback the task run.+ // Backup details that can be used to rollback changes.PriorBackupDetail *PriorBackupDetail `protobuf:"bytes,7,opt,name=prior_backup_detail,json=priorBackupDetail,proto3" json:"prior_backup_detail,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -218,8 +232,10 @@ func (x *TaskRunResult) GetPriorBackupDetail() *PriorBackupDetail {return nil}+// PriorBackupDetail contains information about automatic backups created before migration.type PriorBackupDetail struct {- state protoimpl.MessageState `protogen:"open.v1"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // List of backup operations performed.Items []*PriorBackupDetail_Item `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -262,9 +278,12 @@ func (x *PriorBackupDetail) GetItems() []*PriorBackupDetail_Item {return nil}+// SchedulerInfo contains information about task scheduling and execution delays.type SchedulerInfo struct {- state protoimpl.MessageState `protogen:"open.v1"`- ReportTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`+ state protoimpl.MessageState `protogen:"open.v1"`+ // Timestamp when the scheduler reported this information.+ ReportTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`+ // Reason why the task run is currently waiting.WaitingCause *SchedulerInfo_WaitingCause `protobuf:"bytes,2,opt,name=waiting_cause,json=waitingCause,proto3" json:"waiting_cause,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -314,14 +333,17 @@ func (x *SchedulerInfo) GetWaitingCause() *SchedulerInfo_WaitingCause {return nil}+// Item represents a single backup operation for a table.type PriorBackupDetail_Item struct {state protoimpl.MessageState `protogen:"open.v1"`- // The original table information.+ // The original table that was backed up.SourceTable *PriorBackupDetail_Item_Table `protobuf:"bytes,1,opt,name=source_table,json=sourceTable,proto3" json:"source_table,omitempty"`- // The target backup table information.- TargetTable *PriorBackupDetail_Item_Table `protobuf:"bytes,2,opt,name=target_table,json=targetTable,proto3" json:"target_table,omitempty"`- StartPosition *Position `protobuf:"bytes,3,opt,name=start_position,json=startPosition,proto3" json:"start_position,omitempty"`- EndPosition *Position `protobuf:"bytes,4,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`+ // The backup table where data was copied.+ TargetTable *PriorBackupDetail_Item_Table `protobuf:"bytes,2,opt,name=target_table,json=targetTable,proto3" json:"target_table,omitempty"`+ // Starting position in SQL for this backup operation.+ StartPosition *Position `protobuf:"bytes,3,opt,name=start_position,json=startPosition,proto3" json:"start_position,omitempty"`+ // Ending position in SQL for this backup operation.+ EndPosition *Position `protobuf:"bytes,4,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -384,12 +406,15 @@ func (x *PriorBackupDetail_Item) GetEndPosition() *Position {return nil}+// Table identifies a database table.type PriorBackupDetail_Item_Table struct {state protoimpl.MessageState `protogen:"open.v1"`- // The database information.+ // The database containing the table.// Format: instances/{instance}/databases/{database}- Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`- Schema string `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`+ Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`+ // Schema name (for databases that support schemas).+ Schema string `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`+ // Table name.Table string `protobuf:"bytes,3,opt,name=table,proto3" json:"table,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -446,6 +471,7 @@ func (x *PriorBackupDetail_Item_Table) GetTable() string {return ""}+// WaitingCause indicates why a task run is waiting to execute.type SchedulerInfo_WaitingCause struct {state protoimpl.MessageState `protogen:"open.v1"`// Types that are valid to be assigned to Cause:@@ -527,14 +553,17 @@ type isSchedulerInfo_WaitingCause_Cause interface {}type SchedulerInfo_WaitingCause_ConnectionLimit struct {+ // Task is waiting due to database connection limit.ConnectionLimit bool `protobuf:"varint,1,opt,name=connection_limit,json=connectionLimit,proto3,oneof"`}type SchedulerInfo_WaitingCause_TaskUid struct {+ // Task is waiting for another task to complete.TaskUid int32 `protobuf:"varint,2,opt,name=task_uid,json=taskUid,proto3,oneof"`}type SchedulerInfo_WaitingCause_ParallelTasksLimit struct {+ // Task is waiting due to parallel execution limit.ParallelTasksLimit bool `protobuf:"varint,3,opt,name=parallel_tasks_limit,json=parallelTasksLimit,proto3,oneof"`}diff --git a/backend/generated-go/store/task_run_log.pb.go b/backend/generated-go/store/task_run_log.pb.goindex 543d6f1570..a8fe368f18 100644--- a/backend/generated-go/store/task_run_log.pb.go+++ b/backend/generated-go/store/task_run_log.pb.go@@ -107,9 +107,9 @@ type TaskRunLog_TaskRunStatusUpdate_Status int32const (TaskRunLog_TaskRunStatusUpdate_STATUS_UNSPECIFIED TaskRunLog_TaskRunStatusUpdate_Status = 0- // the task run is ready to be executed by the scheduler+ // The task run is ready to be executed by the scheduler.TaskRunLog_TaskRunStatusUpdate_RUNNING_WAITING TaskRunLog_TaskRunStatusUpdate_Status = 1- // the task run is being executed by the scheduler+ // The task run is being executed by the scheduler.TaskRunLog_TaskRunStatusUpdate_RUNNING_RUNNING TaskRunLog_TaskRunStatusUpdate_Status = 2)diff --git a/backend/generated-go/store/user.pb.go b/backend/generated-go/store/user.pb.goindex bcb310d1aa..474dcdbb18 100644--- a/backend/generated-go/store/user.pb.go+++ b/backend/generated-go/store/user.pb.go@@ -83,11 +83,11 @@ type MFAConfig struct {state protoimpl.MessageState `protogen:"open.v1"`// The otp_secret is the secret key used to validate the OTP code.OtpSecret string `protobuf:"bytes,1,opt,name=otp_secret,json=otpSecret,proto3" json:"otp_secret,omitempty"`- // The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two phase commits.+ // The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two-phase commits.TempOtpSecret string `protobuf:"bytes,2,opt,name=temp_otp_secret,json=tempOtpSecret,proto3" json:"temp_otp_secret,omitempty"`// The recovery_codes are the codes that can be used to recover the account.RecoveryCodes []string `protobuf:"bytes,3,rep,name=recovery_codes,json=recoveryCodes,proto3" json:"recovery_codes,omitempty"`- // The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two phase commits.+ // The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two-phase commits.TempRecoveryCodes []string `protobuf:"bytes,4,rep,name=temp_recovery_codes,json=tempRecoveryCodes,proto3" json:"temp_recovery_codes,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -155,7 +155,7 @@ type UserProfile struct {state protoimpl.MessageState `protogen:"open.v1"`LastLoginTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=last_login_time,json=lastLoginTime,proto3" json:"last_login_time,omitempty"`LastChangePasswordTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_change_password_time,json=lastChangePasswordTime,proto3" json:"last_change_password_time,omitempty"`- // source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ // The source indicates where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.Source string `protobuf:"bytes,3,opt,name=source,proto3" json:"source,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/auth_service.pb.go b/backend/generated-go/v1/auth_service.pb.goindex 84f98c14b8..d3a6dbb61b 100644--- a/backend/generated-go/v1/auth_service.pb.go+++ b/backend/generated-go/v1/auth_service.pb.go@@ -308,7 +308,7 @@ type LoginResponse struct {MfaTempToken *string `protobuf:"bytes,2,opt,name=mfa_temp_token,json=mfaTempToken,proto3,oneof" json:"mfa_temp_token,omitempty"`// Whether user must reset password before continuing.RequireResetPassword bool `protobuf:"varint,3,opt,name=require_reset_password,json=requireResetPassword,proto3" json:"require_reset_password,omitempty"`- // The user of successful login.+ // The user from the successful login.User *User `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/changelist_service.pb.go b/backend/generated-go/v1/changelist_service.pb.goindex dc343fd303..de1f34742f 100644--- a/backend/generated-go/v1/changelist_service.pb.go+++ b/backend/generated-go/v1/changelist_service.pb.go@@ -148,16 +148,16 @@ type ListChangelistsRequest struct {// Format: projects/{project}Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// Pagination is not currently implemented. This field is reserved for future use.- // The maximum number of databases to return. The service may return fewer than+ // The maximum number of changelists to return. The service may return fewer than// this value.- // If unspecified, at most 50 databases will be returned.+ // If unspecified, at most 50 changelists will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`// Pagination is not currently implemented. This field is reserved for future use.- // A page token, received from a previous `ListDatabases` call.+ // A page token, received from a previous `ListChangelists` call.// Provide this to retrieve the subsequent page.//- // When paginating, all other parameters provided to `ListDatabases` must match+ // When paginating, all other parameters provided to `ListChangelists` must match// the call that provided the page token.PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`unknownFields protoimpl.UnknownFields@@ -475,6 +475,7 @@ func (x *Changelist) GetChanges() []*Changelist_Change {type Changelist_Change struct {state protoimpl.MessageState `protogen:"open.v1"`// The sheet containing the SQL statement.+ // Format: projects/{project}/sheets/{sheet}Sheet string `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`// The source of this change.// Format: instances/{instance}/databases/{database}/changelogs/{changelog}diff --git a/backend/generated-go/v1/database_service.pb.go b/backend/generated-go/v1/database_service.pb.goindex 57ae854bea..4852f4e6f2 100644--- a/backend/generated-go/v1/database_service.pb.go+++ b/backend/generated-go/v1/database_service.pb.go@@ -3662,7 +3662,7 @@ type ProcedureMetadata struct {// The definition is the definition of a procedure.Definition string `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`// The signature is the name with the number and type of input arguments the- // function takes.+ // procedure takes.Signature string `protobuf:"bytes,3,opt,name=signature,proto3" json:"signature,omitempty"`// MySQL specific metadata.CharacterSetClient string `protobuf:"bytes,4,opt,name=character_set_client,json=characterSetClient,proto3" json:"character_set_client,omitempty"`diff --git a/backend/generated-go/v1/iam_policy.pb.go b/backend/generated-go/v1/iam_policy.pb.goindex aea63385d2..7e68df979e 100644--- a/backend/generated-go/v1/iam_policy.pb.go+++ b/backend/generated-go/v1/iam_policy.pb.go@@ -197,7 +197,7 @@ type IamPolicy struct {// A binding binds one or more project members to a single project role.Bindings []*Binding `protobuf:"bytes,1,rep,name=bindings,proto3" json:"bindings,omitempty"`// The current etag of the policy.- // If an etag is provided and does not match the current etag of the poliy,+ // 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.Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/idp_service.pb.go b/backend/generated-go/v1/idp_service.pb.goindex af0a56433e..d412ba9703 100644--- a/backend/generated-go/v1/idp_service.pb.go+++ b/backend/generated-go/v1/idp_service.pb.go@@ -1115,10 +1115,10 @@ func (x *OIDCIdentityProviderConfig) GetAuthEndpoint() string {// LDAPIdentityProviderConfig is the structure for LDAP identity provider config.type LDAPIdentityProviderConfig struct {state protoimpl.MessageState `protogen:"open.v1"`- // Host is the hostname or IP address of the LDAP server, e.g.+ // Host is the hostname or IP address of the LDAP server, e.g.,// "ldap.example.com".Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`- // Port is the port number of the LDAP server, e.g. 389. When not set, the+ // Port is the port number of the LDAP server, e.g., 389. When not set, the// default port of the corresponding security protocol will be used, i.e. 389// for StartTLS and 636 for LDAPS.Port int32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`@@ -1129,9 +1129,9 @@ type LDAPIdentityProviderConfig struct {BindDn string `protobuf:"bytes,4,opt,name=bind_dn,json=bindDn,proto3" json:"bind_dn,omitempty"`// BindPassword is the password of the user to bind as a service account.BindPassword string `protobuf:"bytes,5,opt,name=bind_password,json=bindPassword,proto3" json:"bind_password,omitempty"`- // BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com".+ // BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com".BaseDn string `protobuf:"bytes,6,opt,name=base_dn,json=baseDn,proto3" json:"base_dn,omitempty"`- // UserFilter is the filter to search for users, e.g. "(uid=%s)".+ // UserFilter is the filter to search for users, e.g., "(uid=%s)".UserFilter string `protobuf:"bytes,7,opt,name=user_filter,json=userFilter,proto3" json:"user_filter,omitempty"`// SecurityProtocol is the security protocol to be used for establishing// connections with the LDAP server.diff --git a/backend/generated-go/v1/instance_role_service.pb.go b/backend/generated-go/v1/instance_role_service.pb.goindex 5ab5a87cec..775b026434 100644--- a/backend/generated-go/v1/instance_role_service.pb.go+++ b/backend/generated-go/v1/instance_role_service.pb.go@@ -222,7 +222,7 @@ type InstanceRole struct {// The expiration for the role's password.ValidUntil *string `protobuf:"bytes,5,opt,name=valid_until,json=validUntil,proto3,oneof" json:"valid_until,omitempty"`// The role attribute.- // For PostgreSQL, it containt 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 PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html// For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.htmlAttribute *string `protobuf:"bytes,6,opt,name=attribute,proto3,oneof" json:"attribute,omitempty"`unknownFields protoimpl.UnknownFieldsdiff --git a/backend/generated-go/v1/instance_service.pb.go b/backend/generated-go/v1/instance_service.pb.goindex 9c67e4b217..ba94251915 100644--- a/backend/generated-go/v1/instance_service.pb.go+++ b/backend/generated-go/v1/instance_service.pb.go@@ -812,7 +812,7 @@ type SyncInstanceRequest struct {// Format: instances/{instance}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// 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 instances will be synced.+ // the instance metadata (such as the database list) and any newly discovered databases will be synced.EnableFullSync bool `protobuf:"varint,2,opt,name=enable_full_sync,json=enableFullSync,proto3" json:"enable_full_sync,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/issue_service.pb.go b/backend/generated-go/v1/issue_service.pb.goindex 52c5cb94f0..c9fb3a9475 100644--- a/backend/generated-go/v1/issue_service.pb.go+++ b/backend/generated-go/v1/issue_service.pb.go@@ -1047,7 +1047,7 @@ func (x *ApproveIssueRequest) GetComment() string {type RejectIssueRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of the issue to add an rejection.+ // The name of the issue to add a rejection.// Format: projects/{project}/issues/{issue}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The comment explaining the rejection decision.@@ -1385,7 +1385,7 @@ type GrantRequest struct {// The user to be granted.// Format: users/{email}.User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`- // The condition for the role. Same as the condtion in IAM Binding message.+ // The condition for the role. Same as the condition in IAM Binding message.Condition *expr.Expr `protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`// The duration for which the grant is valid.Expiration *durationpb.Duration `protobuf:"bytes,4,opt,name=expiration,proto3" json:"expiration,omitempty"`diff --git a/backend/generated-go/v1/release_service.pb.go b/backend/generated-go/v1/release_service.pb.goindex e304c13849..49f62c885b 100644--- a/backend/generated-go/v1/release_service.pb.go+++ b/backend/generated-go/v1/release_service.pb.go@@ -984,7 +984,7 @@ type Release_File struct {state protoimpl.MessageState `protogen:"open.v1"`// The unique identifier for the file.Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`- // The path of the file. e.g. `2.2/V0001_create_table.sql`.+ // The path of the file. e.g., `2.2/V0001_create_table.sql`.Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`// The type of the file.Type Release_File_Type `protobuf:"varint,5,opt,name=type,proto3,enum=bytebase.v1.Release_File_Type" json:"type,omitempty"`@@ -1108,7 +1108,7 @@ type Release_VCSSource struct {state protoimpl.MessageState `protogen:"open.v1"`// The type of VCS.VcsType VCSType `protobuf:"varint,1,opt,name=vcs_type,json=vcsType,proto3,enum=bytebase.v1.VCSType" json:"vcs_type,omitempty"`- // The url link to the e.g. GitHub commit or pull request.+ // The url link to the e.g., GitHub commit or pull request.Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/review_config_service.pb.go b/backend/generated-go/v1/review_config_service.pb.goindex a2ff3edf70..de707bf796 100644--- a/backend/generated-go/v1/review_config_service.pb.go+++ b/backend/generated-go/v1/review_config_service.pb.go@@ -27,9 +27,9 @@ const (type ListReviewConfigsRequest struct {state protoimpl.MessageState `protogen:"open.v1"`// Pagination is not currently implemented. This field is reserved for future use.- // The maximum number of sql review to return. The service may return fewer than+ // The maximum number of SQL review configs to return. The service may return fewer than// this value.- // If unspecified, at most 10 sql review will be returned.+ // If unspecified, at most 10 SQL review configs will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`// Pagination is not currently implemented. This field is reserved for future use.@@ -88,7 +88,7 @@ func (x *ListReviewConfigsRequest) GetPageToken() string {type ListReviewConfigsResponse struct {state protoimpl.MessageState `protogen:"open.v1"`- // The sql review from the specified request.+ // The SQL review configs from the specified request.ReviewConfigs []*ReviewConfig `protobuf:"bytes,1,rep,name=review_configs,json=reviewConfigs,proto3" json:"review_configs,omitempty"`// A token, which can be sent as `page_token` to retrieve the next page.// If this field is omitted, there are no subsequent pages.@@ -143,7 +143,7 @@ func (x *ListReviewConfigsResponse) GetNextPageToken() string {type CreateReviewConfigRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // The sql review to create.+ // The SQL review config to create.ReviewConfig *ReviewConfig `protobuf:"bytes,1,opt,name=review_config,json=reviewConfig,proto3" json:"review_config,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache@@ -188,9 +188,9 @@ func (x *CreateReviewConfigRequest) GetReviewConfig() *ReviewConfig {type UpdateReviewConfigRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // The sql review to update.+ // The SQL review config to update.//- // The name field is used to identify the sql review to update.+ // The name field is used to identify the SQL review config to update.ReviewConfig *ReviewConfig `protobuf:"bytes,1,opt,name=review_config,json=reviewConfig,proto3" json:"review_config,omitempty"`// The list of fields to update.UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`@@ -254,7 +254,7 @@ func (x *UpdateReviewConfigRequest) GetAllowMissing() bool {type GetReviewConfigRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of the sql review to retrieve.+ // The name of the SQL review config to retrieve.// Format: reviewConfigs/{reviewConfig}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`unknownFields protoimpl.UnknownFields@@ -300,7 +300,7 @@ func (x *GetReviewConfigRequest) GetName() string {type DeleteReviewConfigRequest struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of the sql review to delete.+ // The name of the SQL review config to delete.// Format: reviewConfigs/{reviewConfig}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`unknownFields protoimpl.UnknownFields@@ -346,7 +346,7 @@ func (x *DeleteReviewConfigRequest) GetName() string {type ReviewConfig struct {state protoimpl.MessageState `protogen:"open.v1"`- // The name of the sql review to retrieve.+ // The name of the SQL review config.// Format: reviewConfigs/{reviewConfig}Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// The title of the review configuration.@@ -355,8 +355,8 @@ type ReviewConfig struct {Enabled bool `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`// The SQL review rules to enforce.Rules []*SQLReviewRule `protobuf:"bytes,7,rep,name=rules,proto3" json:"rules,omitempty"`- // resources using the config.- // Format: {resource}/{resource id}, for example, environments/test.+ // Resources using the config.+ // Format: {resource}/{resource id}, e.g., environments/test.Resources []string `protobuf:"bytes,8,rep,name=resources,proto3" json:"resources,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCachediff --git a/backend/generated-go/v1/risk_service.pb.go b/backend/generated-go/v1/risk_service.pb.goindex 142754b597..2fe064b262 100644--- a/backend/generated-go/v1/risk_service.pb.go+++ b/backend/generated-go/v1/risk_service.pb.go@@ -25,15 +25,21 @@ const (_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20))+// The source of the database change for risk assessment.type Risk_Source int32const (Risk_SOURCE_UNSPECIFIED Risk_Source = 0- Risk_DDL Risk_Source = 1- Risk_DML Risk_Source = 2- Risk_CREATE_DATABASE Risk_Source = 3- Risk_DATA_EXPORT Risk_Source = 6- Risk_REQUEST_ROLE Risk_Source = 7+ // Data Definition Language statements (CREATE, ALTER, DROP, etc.).+ Risk_DDL Risk_Source = 1+ // Data Manipulation Language statements (INSERT, UPDATE, DELETE, etc.).+ Risk_DML Risk_Source = 2+ // Database creation operations.+ Risk_CREATE_DATABASE Risk_Source = 3+ // Data export operations.+ Risk_DATA_EXPORT Risk_Source = 6+ // Role access requests.+ Risk_REQUEST_ROLE Risk_Source = 7)// Enum value maps for Risk_Source.@@ -407,7 +413,8 @@ func (x *DeleteRiskRequest) GetName() string {type Risk struct {state protoimpl.MessageState `protogen:"open.v1"`// Format: risks/{risk}- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`+ // The source of the operation being assessed for risk.Source Risk_Source `protobuf:"varint,3,opt,name=source,proto3,enum=bytebase.v1.Risk_Source" json:"source,omitempty"`// The title of the risk rule.Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`diff --git a/backend/generated-go/v1/rollout_service.pb.go b/backend/generated-go/v1/rollout_service.pb.goindex b60a1015d5..42e8fda2c2 100644--- a/backend/generated-go/v1/rollout_service.pb.go+++ b/backend/generated-go/v1/rollout_service.pb.go@@ -362,9 +362,9 @@ type TaskRunLogEntry_TaskRunStatusUpdate_Status int32const (// Unspecified status.TaskRunLogEntry_TaskRunStatusUpdate_STATUS_UNSPECIFIED TaskRunLogEntry_TaskRunStatusUpdate_Status = 0- // the task run is ready to be executed by the scheduler+ // The task run is ready to be executed by the scheduler.TaskRunLogEntry_TaskRunStatusUpdate_RUNNING_WAITING TaskRunLogEntry_TaskRunStatusUpdate_Status = 1- // the task run is being executed by the scheduler+ // The task run is being executed by the scheduler.TaskRunLogEntry_TaskRunStatusUpdate_RUNNING_RUNNING TaskRunLogEntry_TaskRunStatusUpdate_Status = 2)@@ -1335,7 +1335,7 @@ type Rollout struct {// The title of the rollout, inherited from the associated plan.// This field is output only and cannot be directly set.Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`- // stages and thus tasks of the rollout.+ // Stages and thus tasks of the rollout.Stages []*Stage `protobuf:"bytes,5,rep,name=stages,proto3" json:"stages,omitempty"`// Format: users/[email protected]Creator string `protobuf:"bytes,6,opt,name=creator,proto3" json:"creator,omitempty"`@@ -1440,7 +1440,7 @@ type Stage struct {// Use "-" for {stage} when the stage has no environment or deleted environment.Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// id is the environment id of the stage.- // e.g. "prod".+ // e.g., "prod".// Use "-" when the stage has no environment or deleted environment.Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`// environment is the environment of the stage.@@ -2254,9 +2254,9 @@ type Task_DatabaseCreate struct {// The project owning the database.// Format: projects/{project}Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`- // database name+ // Database name.Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`- // table name+ // Table name.Table string `protobuf:"bytes,3,opt,name=table,proto3" json:"table,omitempty"`// Format: projects/{project}/sheets/{sheet}Sheet string `protobuf:"bytes,4,opt,name=sheet,proto3" json:"sheet,omitempty"`diff --git a/backend/generated-go/v1/setting_service.pb.go b/backend/generated-go/v1/setting_service.pb.goindex 81aa61f891..34664f4d34 100644--- a/backend/generated-go/v1/setting_service.pb.go+++ b/backend/generated-go/v1/setting_service.pb.go@@ -985,7 +985,7 @@ type WorkspaceProfileSetting struct {Announcement *Announcement `protobuf:"bytes,7,opt,name=announcement,proto3" json:"announcement,omitempty"`// The max duration for role expired.MaximumRoleExpiration *durationpb.Duration `protobuf:"bytes,8,opt,name=maximum_role_expiration,json=maximumRoleExpiration,proto3" json:"maximum_role_expiration,omitempty"`- // The workspace domain, e.g. bytebase.com.+ // The workspace domain, e.g., bytebase.com.Domains []string `protobuf:"bytes,9,rep,name=domains,proto3" json:"domains,omitempty"`// Only user and group from the domains can be created and login.EnforceIdentityDomain bool `protobuf:"varint,10,opt,name=enforce_identity_domain,json=enforceIdentityDomain,proto3" json:"enforce_identity_domain,omitempty"`diff --git a/backend/generated-go/v1/sheet_service.pb.go b/backend/generated-go/v1/sheet_service.pb.goindex cac942e80f..3f02faa4bb 100644--- a/backend/generated-go/v1/sheet_service.pb.go+++ b/backend/generated-go/v1/sheet_service.pb.go@@ -288,7 +288,7 @@ type UpdateSheetRequest struct {Sheet *Sheet `protobuf:"bytes,1,opt,name=sheet,proto3" json:"sheet,omitempty"`// The list of fields to be updated.// Fields are specified relative to the sheet.- // (e.g. `title`, `statement`; *not* `sheet.title` or `sheet.statement`)+ // (e.g., `title`, `statement`; *not* `sheet.title` or `sheet.statement`)// Only support update the following fields for now:// - `title`// - `statement`diff --git a/backend/generated-go/v1/worksheet_service.pb.go b/backend/generated-go/v1/worksheet_service.pb.goindex 7a5c070538..3e25be30e4 100644--- a/backend/generated-go/v1/worksheet_service.pb.go+++ b/backend/generated-go/v1/worksheet_service.pb.go@@ -180,7 +180,7 @@ type UpdateWorksheetRequest struct {Worksheet *Worksheet `protobuf:"bytes,1,opt,name=worksheet,proto3" json:"worksheet,omitempty"`// The list of fields to be updated.// Fields are specified relative to the worksheet.- // (e.g. `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)+ // (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)// Only support update the following fields for now:// - `title`// - `statement`diff --git a/frontend/src/types/proto-es/v1/auth_service_pb.d.ts b/frontend/src/types/proto-es/v1/auth_service_pb.d.tsindex db55957c6c..3ec0ced4f0 100644--- a/frontend/src/types/proto-es/v1/auth_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/auth_service_pb.d.ts@@ -174,7 +174,7 @@ export declare type LoginResponse = Message<"bytebase.v1.LoginResponse"> & {requireResetPassword: boolean;/**- * The user of successful login.+ * The user from the successful login.** @generated from field: bytebase.v1.User user = 4;*/diff --git a/frontend/src/types/proto-es/v1/changelist_service_pb.d.ts b/frontend/src/types/proto-es/v1/changelist_service_pb.d.tsindex adf2391ebe..20d859e22d 100644--- a/frontend/src/types/proto-es/v1/changelist_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/changelist_service_pb.d.ts@@ -87,9 +87,9 @@ export declare type ListChangelistsRequest = Message<"bytebase.v1.ListChangelist/*** Pagination is not currently implemented. This field is reserved for future use.- * The maximum number of databases to return. The service may return fewer than+ * The maximum number of changelists to return. The service may return fewer than* this value.- * If unspecified, at most 50 databases will be returned.+ * If unspecified, at most 50 changelists will be returned.* The maximum value is 1000; values above 1000 will be coerced to 1000.** @generated from field: int32 page_size = 2;@@ -98,10 +98,10 @@ export declare type ListChangelistsRequest = Message<"bytebase.v1.ListChangelist/*** Pagination is not currently implemented. This field is reserved for future use.- * A page token, received from a previous `ListDatabases` call.+ * A page token, received from a previous `ListChangelists` call.* Provide this to retrieve the subsequent page.*- * When paginating, all other parameters provided to `ListDatabases` must match+ * When paginating, all other parameters provided to `ListChangelists` must match* the call that provided the page token.** @generated from field: string page_token = 3;@@ -261,6 +261,7 @@ export declare const ChangelistSchema: GenMessage<Changelist>;export declare type Changelist_Change = Message<"bytebase.v1.Changelist.Change"> & {/*** The sheet containing the SQL statement.+ * Format: projects/{project}/sheets/{sheet}** @generated from field: string sheet = 1;*/diff --git a/frontend/src/types/proto-es/v1/database_service_pb.d.ts b/frontend/src/types/proto-es/v1/database_service_pb.d.tsindex 10128c7194..3a3fd330e6 100644--- a/frontend/src/types/proto-es/v1/database_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/database_service_pb.d.ts@@ -1938,7 +1938,7 @@ export declare type ProcedureMetadata = Message<"bytebase.v1.ProcedureMetadata">/*** The signature is the name with the number and type of input arguments the- * function takes.+ * procedure takes.** @generated from field: string signature = 3;*/diff --git a/frontend/src/types/proto-es/v1/iam_policy_pb.d.ts b/frontend/src/types/proto-es/v1/iam_policy_pb.d.tsindex 9d1f559e7c..e4e9cfee92 100644--- a/frontend/src/types/proto-es/v1/iam_policy_pb.d.ts+++ b/frontend/src/types/proto-es/v1/iam_policy_pb.d.ts@@ -84,7 +84,7 @@ export declare type IamPolicy = Message<"bytebase.v1.IamPolicy"> & {/*** The current etag of the policy.- * If an etag is provided and does not match the current etag of the poliy,+ * 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.** @generated from field: string etag = 2;diff --git a/frontend/src/types/proto-es/v1/idp_service_pb.d.ts b/frontend/src/types/proto-es/v1/idp_service_pb.d.tsindex fe4cc089ca..a6e915b257 100644--- a/frontend/src/types/proto-es/v1/idp_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/idp_service_pb.d.ts@@ -494,7 +494,7 @@ export declare const OIDCIdentityProviderConfigSchema: GenMessage<OIDCIdentityPr*/export declare type LDAPIdentityProviderConfig = Message<"bytebase.v1.LDAPIdentityProviderConfig"> & {/**- * Host is the hostname or IP address of the LDAP server, e.g.+ * Host is the hostname or IP address of the LDAP server, e.g.,* "ldap.example.com".** @generated from field: string host = 1;@@ -502,7 +502,7 @@ export declare type LDAPIdentityProviderConfig = Message<"bytebase.v1.LDAPIdentihost: string;/**- * Port is the port number of the LDAP server, e.g. 389. When not set, the+ * Port is the port number of the LDAP server, e.g., 389. When not set, the* default port of the corresponding security protocol will be used, i.e. 389* for StartTLS and 636 for LDAPS.*@@ -533,14 +533,14 @@ export declare type LDAPIdentityProviderConfig = Message<"bytebase.v1.LDAPIdentibindPassword: string;/**- * BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com".+ * BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com".** @generated from field: string base_dn = 6;*/baseDn: string;/**- * UserFilter is the filter to search for users, e.g. "(uid=%s)".+ * UserFilter is the filter to search for users, e.g., "(uid=%s)".** @generated from field: string user_filter = 7;*/diff --git a/frontend/src/types/proto-es/v1/instance_role_service_pb.d.ts b/frontend/src/types/proto-es/v1/instance_role_service_pb.d.tsindex 80df4e137b..ffdf8e68c6 100644--- a/frontend/src/types/proto-es/v1/instance_role_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/instance_role_service_pb.d.ts@@ -150,7 +150,7 @@ export declare type InstanceRole = Message<"bytebase.v1.InstanceRole"> & {/*** The role attribute.- * For PostgreSQL, it containt 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 PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html* For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html** @generated from field: optional string attribute = 6;diff --git a/frontend/src/types/proto-es/v1/instance_service_pb.d.ts b/frontend/src/types/proto-es/v1/instance_service_pb.d.tsindex fe0d644571..f71b5602da 100644--- a/frontend/src/types/proto-es/v1/instance_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/instance_service_pb.d.ts@@ -279,7 +279,7 @@ export declare type SyncInstanceRequest = Message<"bytebase.v1.SyncInstanceReque/*** 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 instances will be synced.+ * the instance metadata (such as the database list) and any newly discovered databases will be synced.** @generated from field: bool enable_full_sync = 2;*/diff --git a/frontend/src/types/proto-es/v1/issue_service_pb.d.ts b/frontend/src/types/proto-es/v1/issue_service_pb.d.tsindex 0ecc6ef804..464910e295 100644--- a/frontend/src/types/proto-es/v1/issue_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/issue_service_pb.d.ts@@ -368,7 +368,7 @@ export declare const ApproveIssueRequestSchema: GenMessage<ApproveIssueRequest>;*/export declare type RejectIssueRequest = Message<"bytebase.v1.RejectIssueRequest"> & {/**- * The name of the issue to add an rejection.+ * The name of the issue to add a rejection.* Format: projects/{project}/issues/{issue}** @generated from field: string name = 1;@@ -758,7 +758,7 @@ export declare type GrantRequest = Message<"bytebase.v1.GrantRequest"> & {user: string;/**- * The condition for the role. Same as the condtion in IAM Binding message.+ * The condition for the role. Same as the condition in IAM Binding message.** @generated from field: google.type.Expr condition = 3;*/diff --git a/frontend/src/types/proto-es/v1/release_service_pb.d.ts b/frontend/src/types/proto-es/v1/release_service_pb.d.tsindex 0c1128ab96..14f5278d01 100644--- a/frontend/src/types/proto-es/v1/release_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/release_service_pb.d.ts@@ -468,7 +468,7 @@ export declare type Release_File = Message<"bytebase.v1.Release.File"> & {id: string;/**- * The path of the file. e.g. `2.2/V0001_create_table.sql`.+ * The path of the file. e.g., `2.2/V0001_create_table.sql`.** @generated from field: string path = 2;*/@@ -623,7 +623,7 @@ export declare type Release_VCSSource = Message<"bytebase.v1.Release.VCSSource">vcsType: VCSType;/**- * The url link to the e.g. GitHub commit or pull request.+ * The url link to the e.g., GitHub commit or pull request.** @generated from field: string url = 2;*/diff --git a/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts b/frontend/src/types/proto-es/v1/review_config_service_pb.d.tsindex 3f8e3e3180..15ae2ae1cd 100644--- a/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts@@ -18,9 +18,9 @@ export declare const file_v1_review_config_service: GenFile;export declare type ListReviewConfigsRequest = Message<"bytebase.v1.ListReviewConfigsRequest"> & {/*** Pagination is not currently implemented. This field is reserved for future use.- * The maximum number of sql review to return. The service may return fewer than+ * The maximum number of SQL review configs to return. The service may return fewer than* this value.- * If unspecified, at most 10 sql review will be returned.+ * If unspecified, at most 10 SQL review configs will be returned.* The maximum value is 1000; values above 1000 will be coerced to 1000.** @generated from field: int32 page_size = 1;@@ -50,7 +50,7 @@ export declare const ListReviewConfigsRequestSchema: GenMessage<ListReviewConfig*/export declare type ListReviewConfigsResponse = Message<"bytebase.v1.ListReviewConfigsResponse"> & {/**- * The sql review from the specified request.+ * The SQL review configs from the specified request.** @generated from field: repeated bytebase.v1.ReviewConfig review_configs = 1;*/@@ -76,7 +76,7 @@ export declare const ListReviewConfigsResponseSchema: GenMessage<ListReviewConfi*/export declare type CreateReviewConfigRequest = Message<"bytebase.v1.CreateReviewConfigRequest"> & {/**- * The sql review to create.+ * The SQL review config to create.** @generated from field: bytebase.v1.ReviewConfig review_config = 1;*/@@ -94,9 +94,9 @@ export declare const CreateReviewConfigRequestSchema: GenMessage<CreateReviewCon*/export declare type UpdateReviewConfigRequest = Message<"bytebase.v1.UpdateReviewConfigRequest"> & {/**- * The sql review to update.+ * The SQL review config to update.*- * The name field is used to identify the sql review to update.+ * The name field is used to identify the SQL review config to update.** @generated from field: bytebase.v1.ReviewConfig review_config = 1;*/@@ -129,7 +129,7 @@ export declare const UpdateReviewConfigRequestSchema: GenMessage<UpdateReviewCon*/export declare type GetReviewConfigRequest = Message<"bytebase.v1.GetReviewConfigRequest"> & {/**- * The name of the sql review to retrieve.+ * The name of the SQL review config to retrieve.* Format: reviewConfigs/{reviewConfig}** @generated from field: string name = 1;@@ -148,7 +148,7 @@ export declare const GetReviewConfigRequestSchema: GenMessage<GetReviewConfigReq*/export declare type DeleteReviewConfigRequest = Message<"bytebase.v1.DeleteReviewConfigRequest"> & {/**- * The name of the sql review to delete.+ * The name of the SQL review config to delete.* Format: reviewConfigs/{reviewConfig}** @generated from field: string name = 1;@@ -167,7 +167,7 @@ export declare const DeleteReviewConfigRequestSchema: GenMessage<DeleteReviewCon*/export declare type ReviewConfig = Message<"bytebase.v1.ReviewConfig"> & {/**- * The name of the sql review to retrieve.+ * The name of the SQL review config.* Format: reviewConfigs/{reviewConfig}** @generated from field: string name = 1;@@ -196,8 +196,8 @@ export declare type ReviewConfig = Message<"bytebase.v1.ReviewConfig"> & {rules: SQLReviewRule[];/**- * resources using the config.- * Format: {resource}/{resource id}, for example, environments/test.+ * Resources using the config.+ * Format: {resource}/{resource id}, e.g., environments/test.** @generated from field: repeated string resources = 8;*/diff --git a/frontend/src/types/proto-es/v1/risk_service_pb.d.ts b/frontend/src/types/proto-es/v1/risk_service_pb.d.tsindex 1e407c0fe6..e06530b2e2 100644--- a/frontend/src/types/proto-es/v1/risk_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/risk_service_pb.d.ts@@ -175,6 +175,8 @@ export declare type Risk = Message<"bytebase.v1.Risk"> & {name: string;/**+ * The source of the operation being assessed for risk.+ ** @generated from field: bytebase.v1.Risk.Source source = 3;*/source: Risk_Source;@@ -263,6 +265,8 @@ export declare type Risk = Message<"bytebase.v1.Risk"> & {export declare const RiskSchema: GenMessage<Risk>;/**+ * The source of the database change for risk assessment.+ ** @generated from enum bytebase.v1.Risk.Source*/export enum Risk_Source {@@ -272,26 +276,36 @@ export enum Risk_Source {SOURCE_UNSPECIFIED = 0,/**+ * Data Definition Language statements (CREATE, ALTER, DROP, etc.).+ ** @generated from enum value: DDL = 1;*/DDL = 1,/**+ * Data Manipulation Language statements (INSERT, UPDATE, DELETE, etc.).+ ** @generated from enum value: DML = 2;*/DML = 2,/**+ * Database creation operations.+ ** @generated from enum value: CREATE_DATABASE = 3;*/CREATE_DATABASE = 3,/**+ * Data export operations.+ ** @generated from enum value: DATA_EXPORT = 6;*/DATA_EXPORT = 6,/**+ * Role access requests.+ ** @generated from enum value: REQUEST_ROLE = 7;*/REQUEST_ROLE = 7,diff --git a/frontend/src/types/proto-es/v1/risk_service_pb.js b/frontend/src/types/proto-es/v1/risk_service_pb.jsindex 8a287ff0f7..20c645f18c 100644--- a/frontend/src/types/proto-es/v1/risk_service_pb.js+++ b/frontend/src/types/proto-es/v1/risk_service_pb.js@@ -74,6 +74,8 @@ export const Risk_SourceSchema = /*@__PURE__*/enumDesc(file_v1_risk_service, 6, 0);/**+ * The source of the database change for risk assessment.+ ** @generated from enum bytebase.v1.Risk.Source*/export const Risk_Source = /*@__PURE__*/diff --git a/frontend/src/types/proto-es/v1/rollout_service_pb.d.ts b/frontend/src/types/proto-es/v1/rollout_service_pb.d.tsindex e75ee9c6fd..862d53a2e2 100644--- a/frontend/src/types/proto-es/v1/rollout_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/rollout_service_pb.d.ts@@ -468,7 +468,7 @@ export declare type Rollout = Message<"bytebase.v1.Rollout"> & {title: string;/**- * stages and thus tasks of the rollout.+ * Stages and thus tasks of the rollout.** @generated from field: repeated bytebase.v1.Stage stages = 5;*/@@ -520,7 +520,7 @@ export declare type Stage = Message<"bytebase.v1.Stage"> & {/*** id is the environment id of the stage.- * e.g. "prod".+ * e.g., "prod".* Use "-" when the stage has no environment or deleted environment.** @generated from field: string id = 3;@@ -656,14 +656,14 @@ export declare type Task_DatabaseCreate = Message<"bytebase.v1.Task.DatabaseCreaproject: string;/**- * database name+ * Database name.** @generated from field: string database = 2;*/database: string;/**- * table name+ * Table name.** @generated from field: string table = 3;*/@@ -1595,14 +1595,14 @@ export enum TaskRunLogEntry_TaskRunStatusUpdate_Status {STATUS_UNSPECIFIED = 0,/**- * the task run is ready to be executed by the scheduler+ * The task run is ready to be executed by the scheduler.** @generated from enum value: RUNNING_WAITING = 1;*/RUNNING_WAITING = 1,/**- * the task run is being executed by the scheduler+ * The task run is being executed by the scheduler.** @generated from enum value: RUNNING_RUNNING = 2;*/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.tsindex 436d62f1b0..6a09cf09f2 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@@ -585,7 +585,7 @@ export declare type WorkspaceProfileSetting = Message<"bytebase.v1.WorkspaceProfmaximumRoleExpiration?: Duration;/**- * The workspace domain, e.g. bytebase.com.+ * The workspace domain, e.g., bytebase.com.** @generated from field: repeated string domains = 9;*/diff --git a/frontend/src/types/proto-es/v1/sheet_service_pb.d.ts b/frontend/src/types/proto-es/v1/sheet_service_pb.d.tsindex a914b32147..0a33e9a036 100644--- a/frontend/src/types/proto-es/v1/sheet_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/sheet_service_pb.d.ts@@ -121,7 +121,7 @@ export declare type UpdateSheetRequest = Message<"bytebase.v1.UpdateSheetRequest/*** The list of fields to be updated.* Fields are specified relative to the sheet.- * (e.g. `title`, `statement`; *not* `sheet.title` or `sheet.statement`)+ * (e.g., `title`, `statement`; *not* `sheet.title` or `sheet.statement`)* Only support update the following fields for now:* - `title`* - `statement`diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts b/frontend/src/types/proto-es/v1/worksheet_service_pb.d.tsindex ebc8a90324..07154deb63 100644--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts+++ b/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts@@ -65,7 +65,7 @@ export declare type UpdateWorksheetRequest = Message<"bytebase.v1.UpdateWorkshee/*** The list of fields to be updated.* Fields are specified relative to the worksheet.- * (e.g. `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)+ * (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)* Only support update the following fields for now:* - `title`* - `statement`diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yamlindex 103eeceda3..10a59d7638 100644--- a/proto/gen/grpc-doc/openapi.yaml+++ b/proto/gen/grpc-doc/openapi.yaml@@ -3720,9 +3720,9 @@ paths:in: querydescription: |-Pagination is not currently implemented. This field is reserved for future use.- The maximum number of databases to return. The service may return fewer than+ The maximum number of changelists to return. The service may return fewer thanthis value.- If unspecified, at most 50 databases will be returned.+ If unspecified, at most 50 changelists will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000.schema:type: integer@@ -3731,10 +3731,10 @@ paths:in: querydescription: |-Pagination is not currently implemented. This field is reserved for future use.- A page token, received from a previous `ListDatabases` call.+ A page token, received from a previous `ListChangelists` call.Provide this to retrieve the subsequent page.- When paginating, all other parameters provided to `ListDatabases` must match+ When paginating, all other parameters provided to `ListChangelists` must matchthe call that provided the page token.schema:type: string@@ -6477,7 +6477,7 @@ paths:description: |-The list of fields to be updated.Fields are specified relative to the sheet.- (e.g. `title`, `statement`; *not* `sheet.title` or `sheet.statement`)+ (e.g., `title`, `statement`; *not* `sheet.title` or `sheet.statement`)Only support update the following fields for now:- `title`- `statement`@@ -6926,9 +6926,9 @@ paths:in: querydescription: |-Pagination is not currently implemented. This field is reserved for future use.- The maximum number of sql review to return. The service may return fewer than+ The maximum number of SQL review configs to return. The service may return fewer thanthis value.- If unspecified, at most 10 sql review will be returned.+ If unspecified, at most 10 SQL review configs will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000.schema:type: integer@@ -8125,7 +8125,7 @@ paths:description: |-The list of fields to be updated.Fields are specified relative to the worksheet.- (e.g. `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)+ (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)Only support update the following fields for now:- `title`- `statement`@@ -8831,6 +8831,8 @@ components:type: arrayitems:type: string+ description: List of role names that must approve, in order.+ description: ApprovalFlow defines the sequence of approvals required.ApprovalTemplate:type: objectproperties:@@ -8838,14 +8840,19 @@ components:type: stringdescription: |-The unique identifier for the approval template.- For built-in templates, use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").- For custom templates, use a UUID or other unique identifier.+ Built-in templates use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").+ Custom templates use a UUID or other unique identifier.flow:- $ref: '#/components/schemas/ApprovalFlow'+ allOf:+ - $ref: '#/components/schemas/ApprovalFlow'+ description: The approval workflow specification.title:type: string+ description: Human-readable title of the approval template.description:type: string+ description: Detailed description of when this template applies.+ description: ApprovalTemplate defines the approval workflow and requirements for an issue.ApproveIssueRequest:required:- name@@ -9358,7 +9365,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Range'- description: The ranges of sub-strings correspond to the statements on the sheet.+ description: The ranges of substrings correspond to the statements on the sheet.ChangedResourceProcedure:type: objectproperties:@@ -9368,7 +9375,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Range'- description: The ranges of sub-strings correspond to the statements on the sheet.+ description: The ranges of substrings correspond to the statements on the sheet.ChangedResourceSchema:type: objectproperties:@@ -9397,12 +9404,12 @@ components:type: stringtableRows:type: string- description: estimated row count of the table+ description: The estimated row count of the table.ranges:type: arrayitems:$ref: '#/components/schemas/Range'- description: The ranges of sub-strings correspond to the statements on the sheet.+ description: The ranges of substrings correspond to the statements on the sheet.ChangedResourceView:type: objectproperties:@@ -9412,7 +9419,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Range'- description: The ranges of sub-strings correspond to the statements on the sheet.+ description: The ranges of substrings correspond to the statements on the sheet.ChangedResources:type: objectproperties:@@ -9425,16 +9432,21 @@ components:properties:description:type: string+ description: Human-readable description of this changelist.changes:type: arrayitems:$ref: '#/components/schemas/Changelist_Change'+ description: The list of changes in this changelist.+ description: Changelist represents a collection of database changes that can be applied together.Changelist_Change:type: objectproperties:sheet:type: string- description: The sheet containing the SQL statement.+ description: |-+ The sheet containing the SQL statement.+ Format: projects/{project}/sheets/{sheet}source:type: stringdescription: |-@@ -9932,7 +9944,7 @@ components:type: stringuseSsl:type: boolean- description: Use SSL to connect to the data source. By default, we use system default SSL configuration.+ description: Use SSL to connect to the data source. By default, we use the system's SSL configuration.sslCa:type: stringobfuscatedSslCa:@@ -9962,7 +9974,7 @@ components:srv:type: booleandescription: |-- srv, authentication_database and replica_set are used for MongoDB.+ 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.authenticationDatabase:type: string@@ -10032,7 +10044,7 @@ components:description: direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string.region:type: string- description: region is the location of where the DB is, works for AWS RDS. For example, us-east-1.+ description: Region is the location of the database, used for AWS RDS. For example, us-east-1.warehouseId:type: stringdescription: warehouse_id is used by Databricks.@@ -10069,7 +10081,7 @@ components:properties:secretType:enum:- - SAECRET_TYPE_UNSPECIFIED+ - SECRET_TYPE_UNSPECIFIED- VAULT_KV_V2- AWS_SECRETS_MANAGER- GCP_SECRET_MANAGER@@ -10302,7 +10314,7 @@ components:type: booleandrifted:type: boolean- description: The schema is drifted from the source of truth.+ description: The schema has drifted from the source of truth.version:type: stringdescription: The version of database schema.@@ -10934,18 +10946,22 @@ components:role:type: stringdescription: |-- The requested role.+ The role being requested for the user.Format: roles/EXPORTER.user:type: stringdescription: |-- The user to be granted.+ The user who will receive the role.Format: users/{userUID}.condition:- $ref: '#/components/schemas/Expr'+ allOf:+ - $ref: '#/components/schemas/Expr'+ description: Optional conditional expression that limits when the grant applies.expiration:pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$type: string+ description: Duration after which the grant automatically expires.+ description: GrantRequest contains details for requesting database access permissions.GridLevel:type: objectproperties:@@ -10985,7 +11001,7 @@ components:member:type: stringdescription: |-- Member is the principal who belong to this group.+ Member is the principal who belongs to this group.Format: users/{userUID}.role:@@ -11181,7 +11197,7 @@ components:syncInterval:pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$type: string- description: How often the instance is synced.+ description: The interval between automatic instance synchronizations.maximumConnections:type: integerdescription: |-@@ -11193,7 +11209,7 @@ components:items:type: stringdescription: |-- Enable sync for following databases.+ Enable sync for the following databases.Default empty, means sync all schemas & databases.mysqlLowerCaseTableNames:type: integer@@ -11292,20 +11308,26 @@ components:type: stringdescription: |-The role attribute.- For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html- For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html+ 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 is the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.htmldescription: InstanceRole is the API message for instance role.Issue:type: objectproperties:approval:- $ref: '#/components/schemas/IssuePayloadApproval'+ allOf:+ - $ref: '#/components/schemas/IssuePayloadApproval'+ description: Approval information for the issue workflow.grantRequest:- $ref: '#/components/schemas/GrantRequest'+ allOf:+ - $ref: '#/components/schemas/GrantRequest'+ description: Access grant request details if this is a grant request issue.labels:type: arrayitems:type: string+ description: Labels attached to categorize and filter the issue.+ description: Issue is the metadata for issues that track database operations and access requests.IssueComment:type: objectproperties:@@ -11459,18 +11481,22 @@ components:type: objectproperties:approvalTemplate:- $ref: '#/components/schemas/ApprovalTemplate'+ allOf:+ - $ref: '#/components/schemas/ApprovalTemplate'+ description: The approval template being used for this issue.approvers:type: arrayitems:$ref: '#/components/schemas/IssuePayloadApproval_Approver'+ description: List of approvers and their current status.approvalFindingDone:type: booleandescription: |-- If the value is `false`, it means that the backend is still finding matching approval templates.- If `true`, other fields are available.+ Whether the system has finished finding a matching approval template.+ False means the backend is still searching for matching templates.approvalFindingError:type: string+ description: Error message if approval template finding failed.riskLevel:enum:- RISK_LEVEL_UNSPECIFIED@@ -11478,10 +11504,9 @@ components:- MODERATE- HIGHtype: string+ description: The assessed risk level for this issue.format: enum- description: |-- IssuePayloadApproval is a part of the payload of an issue.- IssuePayloadApproval records the approval template used and the approval history.+ description: IssuePayloadApproval records the approval template used and approval history for an issue.IssuePayloadApproval_Approver:type: objectproperties:@@ -11492,24 +11517,28 @@ components:- APPROVED- REJECTEDtype: string- description: The new status.+ description: The current approval status.format: enumprincipalId:type: integer- description: The principal id of the approver.+ description: The ID of the principal who is the approver.format: int32+ description: Approver represents a user who can approve or reject an issue.Item_Table:type: objectproperties:database:type: stringdescription: |-- The database information.+ The database containing the table.Format: instances/{instance}/databases/{database}schema:type: string+ description: Schema name (for databases that support schemas).table:type: string+ description: Table name.+ description: Table identifies a database table.KerberosConfig:type: objectproperties:@@ -11534,12 +11563,12 @@ components:host:type: stringdescription: |-- Host is the hostname or IP address of the LDAP server, e.g.+ Host is the hostname or IP address of the LDAP server, e.g.,"ldap.example.com".port:type: integerdescription: |-- Port is the port number of the LDAP server, e.g. 389. When not set, the+ Port is the port number of the LDAP server, e.g., 389. When not set, thedefault port of the corresponding security protocol will be used, i.e. 389for StartTLS and 636 for LDAPS.format: int32@@ -11556,10 +11585,10 @@ components:description: BindPassword is the password of the user to bind as a service account.baseDn:type: string- description: BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com".+ description: BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com".userFilter:type: string- description: UserFilter is the filter to search for users, e.g. "(uid=%s)".+ description: UserFilter is the filter to search for users, e.g., "(uid=%s)".securityProtocol:enum:- SECURITY_PROTOCOL_UNSPECIFIED@@ -11819,7 +11848,7 @@ components:type: arrayitems:$ref: '#/components/schemas/ReviewConfig'- description: The sql review from the specified request.+ description: The SQL review configs from the specified request.nextPageToken:type: stringdescription: |-@@ -11960,7 +11989,7 @@ components:user:allOf:- $ref: '#/components/schemas/User'- description: The user of successful login.+ description: The user from the successful login.LogoutRequest:type: objectproperties: {}@@ -12578,6 +12607,8 @@ components:type: arrayitems:$ref: '#/components/schemas/PriorBackupDetail_Item'+ description: List of backup operations performed.+ description: PriorBackupDetail contains information about automatic backups created before migration.PriorBackupDetail_Item:type: objectproperties:@@ -12605,6 +12636,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Label'+ description: Available labels that can be applied to issues in this project.forceIssueLabels:type: booleandescription: Force issue labels to be used when creating an issue.@@ -12634,12 +12666,12 @@ components:executionRetryPolicy:allOf:- $ref: '#/components/schemas/Project_ExecutionRetryPolicy'- description: Execution retry policy for the task run.+ description: Configuration for automatic retry on task execution failures.ciSamplingSize:type: integerdescription: |-The maximum number of databases to sample during CI data validation.- Without specification, sampling is disabled, resulting in a full validation.+ If not specified, sampling is disabled, resulting in a full validation.format: int32parallelTasksPerRollout:type: integer@@ -12657,6 +12689,7 @@ components:description: |-Whether to enforce SQL review checks to pass before issue creation.If enabled, issues cannot be created when SQL review finds errors.+ description: Project contains settings and configuration for a Bytebase project.Project_ExecutionRetryPolicy:type: objectproperties:@@ -12912,7 +12945,7 @@ components:name:type: stringdescription: |-- The name of the issue to add an rejection.+ The name of the issue to add a rejection.Format: projects/{project}/issues/{issue}comment:type: string@@ -12968,7 +13001,7 @@ components:description: The unique identifier for the file.path:type: string- description: The path of the file. e.g. `2.2/V0001_create_table.sql`.+ description: The path of the file. e.g., `2.2/V0001_create_table.sql`.type:enum:- TYPE_UNSPECIFIED@@ -13028,7 +13061,7 @@ components:format: enumurl:type: string- description: The url link to the e.g. GitHub commit or pull request.+ description: The url link to the e.g., GitHub commit or pull request.description: Version control system source information.RemoveDataSourceRequest:required:@@ -13102,7 +13135,7 @@ components:allOf:- $ref: '#/components/schemas/Position'description: |-- 1-based Position of the SQL statement.+ 1-based position of the SQL statement.To supersede `line` and `column` above.endPosition:$ref: '#/components/schemas/Position'@@ -13113,7 +13146,7 @@ components:type: arrayitems:type: string- description: statement_types are the types of statements that are found in the sql.+ description: statement_types are the types of statements found in the SQL.affectedRows:type: stringchangedResources:@@ -13125,7 +13158,7 @@ components:readOnly: truetype: stringdescription: |-- The name of the sql review to retrieve.+ The name of the SQL review config.Format: reviewConfigs/{reviewConfig}title:type: string@@ -13143,8 +13176,8 @@ components:items:type: stringdescription: |-- resources using the config.- Format: {resource}/{resource id}, for example, environments/test.+ Resources using the config.+ Format: {resource}/{resource id}, e.g., environments/test.Revision:type: objectproperties:@@ -13232,6 +13265,7 @@ components:- DATA_EXPORT- REQUEST_ROLEtype: string+ description: The source of the operation being assessed for risk.format: enumtitle:type: string@@ -13352,7 +13386,7 @@ components:type: arrayitems:$ref: '#/components/schemas/Stage'- description: stages and thus tasks of the rollout.+ description: Stages and thus tasks of the rollout.creator:readOnly: truetype: string@@ -14219,7 +14253,7 @@ components:type: stringdescription: |-id is the environment id of the stage.- e.g. "prod".+ e.g., "prod".Use "-" when the stage has no environment or deleted environment.environment:type: string@@ -14347,7 +14381,7 @@ components:type: booleandescription: |-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 instances will be synced.+ the instance metadata (such as the database list) and any newly discovered databases will be synced.SyncInstanceResponse:type: objectproperties:@@ -14610,6 +14644,7 @@ components:TaskRun:type: objectproperties: {}+ description: TaskRun represents an execution attempt of a task.TaskRunLog:type: objectproperties:@@ -14799,10 +14834,10 @@ components:Format: projects/{project}database:type: string- description: database name+ description: Database name.table:type: string- description: table name+ description: Table name.sheet:type: stringdescription: 'Format: projects/{project}/sheets/{sheet}'@@ -14942,18 +14977,16 @@ components:properties:name:type: string- description: The name is the name of the trigger.+ description: The name of the trigger.event:type: string- description: |-- The event is the event of the trigger, such as INSERT, UPDATE, DELETE,- TRUNCATE.+ description: The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE.timing:type: string- description: The timing is the timing of the trigger, such as BEFORE, AFTER.+ description: The timing of when the trigger fires, such as BEFORE or AFTER.body:type: string- description: The body is the body of the trigger.+ description: The body of the trigger.sqlMode:type: stringcharacterSetClient:@@ -15335,7 +15368,7 @@ components:type: arrayitems:type: string- description: The workspace domain, e.g. bytebase.com.+ description: The workspace domain, e.g., bytebase.com.enforceIdentityDomain:type: booleandescription: Only user and group from the domains can be created and login.diff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.mdindex 2cb9824b5c..911e6de7e3 100644--- a/proto/gen/grpc-doc/store/README.md+++ b/proto/gen/grpc-doc/store/README.md@@ -50,7 +50,6 @@- [ChangelogPayload.MigrationType](#bytebase-store-ChangelogPayload-MigrationType)- [ChangelogPayload.Type](#bytebase-store-ChangelogPayload-Type)-- [store/data_source.proto](#store_data_source-proto)- [store/database.proto](#store_database-proto)- [BoundingBox](#bytebase-store-BoundingBox)- [CheckConstraintMetadata](#bytebase-store-CheckConstraintMetadata)@@ -360,13 +359,13 @@<a name="bytebase-store-PageToken"></a>### PageToken-Used internally for obfuscating the page token.+PageToken is used internally for obfuscating pagination tokens.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| limit | [int32](#int32) | | |-| offset | [int32](#int32) | | |+| limit | [int32](#int32) | | Maximum number of items to return. |+| offset | [int32](#int32) | | Number of items to skip before starting to return results. |@@ -376,8 +375,7 @@ Used internally for obfuscating the page token.<a name="bytebase-store-Position"></a>### Position-Position in a text expressed as zero-based line and zero-based column byte-offset.+Position in a text expressed as zero-based line and column byte offset.| Field | Type | Label | Description |@@ -393,13 +391,13 @@ offset.<a name="bytebase-store-Range"></a>### Range-+Range represents a span within a text or sequence.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| start | [int32](#int32) | | |-| end | [int32](#int32) | | |+| start | [int32](#int32) | | Start index (inclusive). |+| end | [int32](#int32) | | End index (exclusive). |@@ -411,7 +409,7 @@ offset.<a name="bytebase-store-Engine"></a>### Engine-+Engine represents the type of database system.| Name | Number | Description || ---- | ------ | ----------- |@@ -447,7 +445,7 @@ offset.<a name="bytebase-store-ExportFormat"></a>### ExportFormat-+ExportFormat represents the file format for exported data.| Name | Number | Description || ---- | ------ | ----------- |@@ -462,21 +460,21 @@ offset.<a name="bytebase-store-MaskingLevel"></a>### MaskingLevel-+MaskingLevel represents the level of data masking applied to sensitive information.| Name | Number | Description || ---- | ------ | ----------- || MASKING_LEVEL_UNSPECIFIED | 0 | |-| NONE | 1 | |-| PARTIAL | 2 | |-| FULL | 3 | |+| NONE | 1 | No masking applied. |+| PARTIAL | 2 | Partial masking (e.g., showing first/last characters). |+| FULL | 3 | Full masking (all characters masked). |<a name="bytebase-store-RiskLevel"></a>### RiskLevel-+RiskLevel represents the assessed risk level of a database operation.| Name | Number | Description || ---- | ------ | ----------- |@@ -490,7 +488,7 @@ offset.<a name="bytebase-store-VCSType"></a>### VCSType-+VCSType represents the type of version control system.| Name | Number | Description || ---- | ------ | ----------- |@@ -545,7 +543,7 @@ offset.| Name | Number | Description || ---- | ------ | ----------- |-| STATUS_UNSPECIFIED | 0 | Unspecified. |+| STATUS_UNSPECIFIED | 0 | Unspecified status. || SUCCESS | 1 | || WARNING | 2 | || ERROR | 3 | |@@ -569,12 +567,12 @@ offset.<a name="bytebase-store-ApprovalFlow"></a>### ApprovalFlow-+ApprovalFlow defines the sequence of approvals required.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| roles | [string](#string) | repeated | |+| roles | [string](#string) | repeated | List of role names that must approve, in order. |@@ -584,15 +582,15 @@ offset.<a name="bytebase-store-ApprovalTemplate"></a>### ApprovalTemplate-+ApprovalTemplate defines the approval workflow and requirements for an issue.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| id | [string](#string) | | The unique identifier for the approval template. For built-in templates, use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba"). For custom templates, use a UUID or other unique identifier. |-| flow | [ApprovalFlow](#bytebase-store-ApprovalFlow) | | |-| title | [string](#string) | | |-| description | [string](#string) | | |+| id | [string](#string) | | The unique identifier for the approval template. Built-in templates use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba"). Custom templates use a UUID or other unique identifier. |+| flow | [ApprovalFlow](#bytebase-store-ApprovalFlow) | | The approval workflow specification. |+| title | [string](#string) | | Human-readable title of the approval template. |+| description | [string](#string) | | Detailed description of when this template applies. |@@ -602,17 +600,16 @@ offset.<a name="bytebase-store-IssuePayloadApproval"></a>### IssuePayloadApproval-IssuePayloadApproval is a part of the payload of an issue.-IssuePayloadApproval records the approval template used and the approval history.+IssuePayloadApproval records the approval template used and approval history for an issue.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| approval_template | [ApprovalTemplate](#bytebase-store-ApprovalTemplate) | | |-| approvers | [IssuePayloadApproval.Approver](#bytebase-store-IssuePayloadApproval-Approver) | repeated | |-| approval_finding_done | [bool](#bool) | | If the value is `false`, it means that the backend is still finding matching approval templates. If `true`, other fields are available. |-| approval_finding_error | [string](#string) | | |-| risk_level | [RiskLevel](#bytebase-store-RiskLevel) | | |+| approval_template | [ApprovalTemplate](#bytebase-store-ApprovalTemplate) | | The approval template being used for this issue. |+| approvers | [IssuePayloadApproval.Approver](#bytebase-store-IssuePayloadApproval-Approver) | repeated | List of approvers and their current status. |+| approval_finding_done | [bool](#bool) | | Whether the system has finished finding a matching approval template. False means the backend is still searching for matching templates. |+| approval_finding_error | [string](#string) | | Error message if approval template finding failed. |+| risk_level | [RiskLevel](#bytebase-store-RiskLevel) | | The assessed risk level for this issue. |@@ -622,13 +619,13 @@ IssuePayloadApproval records the approval template used and the approval history<a name="bytebase-store-IssuePayloadApproval-Approver"></a>### IssuePayloadApproval.Approver-+Approver represents a user who can approve or reject an issue.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| status | [IssuePayloadApproval.Approver.Status](#bytebase-store-IssuePayloadApproval-Approver-Status) | | The new status. |-| principal_id | [int32](#int32) | | The principal id of the approver. |+| status | [IssuePayloadApproval.Approver.Status](#bytebase-store-IssuePayloadApproval-Approver-Status) | | The current approval status. |+| principal_id | [int32](#int32) | | The ID of the principal who is the approver. |@@ -640,14 +637,14 @@ IssuePayloadApproval records the approval template used and the approval history<a name="bytebase-store-IssuePayloadApproval-Approver-Status"></a>### IssuePayloadApproval.Approver.Status-+Status represents the approver's decision state.| Name | Number | Description || ---- | ------ | ----------- || STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| APPROVED | 2 | |-| REJECTED | 3 | |+| PENDING | 1 | Approval is pending from this approver. |+| APPROVED | 2 | Approver has approved the issue. |+| REJECTED | 3 | Approver has rejected the issue. |@@ -674,15 +671,15 @@ IssuePayloadApproval records the approval template used and the approval history| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The project or workspace the audit log belongs to. Formats: - projects/{project} - workspaces/{workspace} |-| method | [string](#string) | | e.g. /bytebase.v1.SQLService/Query |-| resource | [string](#string) | | resource name projects/{project} |+| method | [string](#string) | | Example: /bytebase.v1.SQLService/Query |+| resource | [string](#string) | | The resource name. Example: projects/{project} || user | [string](#string) | | Format: users/{userUID}. || severity | [AuditLog.Severity](#bytebase-store-AuditLog-Severity) | | || request | [string](#string) | | Marshalled request. || response | [string](#string) | | Marshalled response. Some fields are omitted because they are too large or contain sensitive information. || status | [google.rpc.Status](#google-rpc-Status) | | || latency | [google.protobuf.Duration](#google-protobuf-Duration) | | The latency of the RPC. |-| service_data | [google.protobuf.Any](#google-protobuf-Any) | | service-specific data about the request, response, and other activities. |+| service_data | [google.protobuf.Any](#google-protobuf-Any) | | The service-specific data about the request, response, and other activities. || request_metadata | [RequestMetadata](#bytebase-store-RequestMetadata) | | Metadata about the operation. |@@ -744,13 +741,13 @@ Metadata about the request.<a name="bytebase-store-Changelist"></a>### Changelist-+Changelist represents a collection of database changes that can be applied together.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| description | [string](#string) | | |-| changes | [Changelist.Change](#bytebase-store-Changelist-Change) | repeated | |+| description | [string](#string) | | Human-readable description of this changelist. |+| changes | [Changelist.Change](#bytebase-store-Changelist-Change) | repeated | The list of changes in this changelist. |@@ -760,13 +757,13 @@ Metadata about the request.<a name="bytebase-store-Changelist-Change"></a>### Changelist.Change-+Change represents a single database modification within the changelist.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| sheet | [string](#string) | | The name of a sheet. |-| source | [string](#string) | | The source of origin. 1) changes: instances/{instance}/databases/{database}/changelogs/{changelog}. 2) raw SQL if empty. |+| sheet | [string](#string) | | Resource name of the sheet containing the SQL statements. |+| source | [string](#string) | | The source where this change originated from. Format: instances/{instance}/databases/{database}/changelogs/{changelog} for changes from changelog. Empty for raw SQL changes. |@@ -814,7 +811,7 @@ Metadata about the request.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | |-| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |+| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of substrings correspond to the statements on the sheet. |@@ -830,7 +827,7 @@ Metadata about the request.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | |-| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |+| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of substrings correspond to the statements on the sheet. |@@ -865,8 +862,8 @@ Metadata about the request.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | |-| table_rows | [int64](#int64) | | estimated row count of the table |-| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |+| table_rows | [int64](#int64) | | The estimated row count of the table. |+| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of substrings correspond to the statements on the sheet. |@@ -882,7 +879,7 @@ Metadata about the request.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | |-| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of sub-strings correspond to the statements on the sheet. |+| ranges | [Range](#bytebase-store-Range) | repeated | The ranges of substrings correspond to the statements on the sheet. |@@ -964,22 +961,6 @@ MigrationType is the type for imperative schema migration.-<a name="store_data_source-proto"></a>-<p align="right"><a href="#top">Top</a></p>--## store/data_source.proto------------<a name="store_database-proto"></a><p align="right"><a href="#top">Top</a></p>@@ -1013,7 +994,7 @@ BoundingBox defines the bounding box for spatial indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a check constraint. |+| name | [string](#string) | | The name of the check constraint. || expression | [string](#string) | | The expression is the expression of a check constraint. |@@ -1029,7 +1010,7 @@ BoundingBox defines the bounding box for spatial indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a column. |+| name | [string](#string) | | The name of the column. || semantic_type | [string](#string) | | || labels | [ColumnCatalog.LabelsEntry](#bytebase-store-ColumnCatalog-LabelsEntry) | repeated | The user labels for a column. || classification | [string](#string) | | |@@ -1067,9 +1048,9 @@ ColumnMetadata is the metadata for columns.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a column. |+| name | [string](#string) | | The name of the column. || position | [int32](#int32) | | The position is the position in columns. |-| default | [string](#string) | | The default value of column. |+| default | [string](#string) | | The default value of the column. || default_null | [bool](#bool) | | Deprecated. || default_expression | [string](#string) | | Deprecated. || default_on_null | [bool](#bool) | | Oracle specific metadata. The default_on_null is the default on null of a column. |@@ -1128,7 +1109,7 @@ DatabaseMetadata is the metadata for databases.| last_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || backup_available | [bool](#bool) | | || datashare | [bool](#bool) | | |-| drifted | [bool](#bool) | | The schema is drifted from the source of truth. |+| drifted | [bool](#bool) | | The schema has drifted from the source of truth. || version | [string](#string) | | The version of database schema. |@@ -1161,12 +1142,12 @@ DatabaseSchemaMetadata is the schema metadata for databases.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | |-| schemas | [SchemaMetadata](#bytebase-store-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-store-ExtensionMetadata) | repeated | The extensions is the list of extensions in a database. |+| schemas | [SchemaMetadata](#bytebase-store-SchemaMetadata) | repeated | The list of schemas in a database. |+| character_set | [string](#string) | | The character set of the database. |+| collation | [string](#string) | | The collation of the database. |+| extensions | [ExtensionMetadata](#bytebase-store-ExtensionMetadata) | repeated | The list of extensions in a database. || datashare | [bool](#bool) | | The database belongs to a datashare. |-| service_name | [string](#string) | | The service name of the database. It's the Oracle specific concept. |+| service_name | [string](#string) | | The service name of the database. It's an Oracle-specific concept. || linked_databases | [LinkedDatabaseMetadata](#bytebase-store-LinkedDatabaseMetadata) | repeated | || owner | [string](#string) | | || search_path | [string](#string) | | The search_path is the search path of a PostgreSQL database. |@@ -1236,8 +1217,8 @@ DimensionalConfig defines dimensional and constraint parameters for spatial inde| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of a type. |-| values | [string](#string) | repeated | The enum values of a type. |+| name | [string](#string) | | The name of the enum type. |+| values | [string](#string) | repeated | The enum values of the type. || comment | [string](#string) | | || skip_dump | [bool](#bool) | | |@@ -1275,8 +1256,8 @@ 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. |+| name | [string](#string) | | The name of the extension. |+| schema | [string](#string) | | The schema where the extension is installed. However, 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. |@@ -1293,7 +1274,7 @@ ExtensionMetadata is the metadata for extensions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a external table. |+| name | [string](#string) | | The name of the 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-store-ColumnMetadata) | repeated | The columns is the ordered list of columns in a foreign table. |@@ -1311,7 +1292,7 @@ ForeignKeyMetadata is the metadata for foreign keys.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a foreign key. |+| name | [string](#string) | | The name of the 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. |@@ -1333,7 +1314,7 @@ FunctionMetadata is the metadata for functions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a function. |+| name | [string](#string) | | The name of the 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. |@@ -1389,10 +1370,10 @@ IndexMetadata is the metadata for indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of an index. |+| name | [string](#string) | | The name of the index. || expressions | [string](#string) | repeated | The expressions are the ordered columns or expressions of an index. This could refer to a column or an expression. |-| key_length | [int64](#int64) | repeated | The key_lengths are the ordered key lengths of an index. If the key length is not specified, it's -1. |-| descending | [bool](#bool) | repeated | The descending is the ordered descending of an index. |+| key_length | [int64](#int64) | repeated | The ordered list of key lengths for the index. If the key length is not specified, it is -1. |+| descending | [bool](#bool) | repeated | The ordered list of descending flags for the index columns. || 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. |@@ -1453,12 +1434,12 @@ MaterializedViewMetadata is the metadata for materialized views.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a view. |+| name | [string](#string) | | The name of the materialized 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-store-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a view. |-| triggers | [TriggerMetadata](#bytebase-store-TriggerMetadata) | repeated | The columns is the ordered list of columns in a table. |-| indexes | [IndexMetadata](#bytebase-store-IndexMetadata) | repeated | The indexes is the list of indexes in a table. |+| dependency_columns | [DependencyColumn](#bytebase-store-DependencyColumn) | repeated | The list of dependency columns of the view. |+| triggers | [TriggerMetadata](#bytebase-store-TriggerMetadata) | repeated | The ordered list of columns in the materialized view. |+| indexes | [IndexMetadata](#bytebase-store-IndexMetadata) | repeated | The list of indexes in the materialized view. || skip_dump | [bool](#bool) | | |@@ -1538,7 +1519,7 @@ PackageMetadata is the metadata for packages.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a package. |+| name | [string](#string) | | The name of the package. || definition | [string](#string) | | The definition is the definition of a package. |@@ -1554,7 +1535,7 @@ ProcedureMetadata is the metadata for procedures.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a procedure. |+| name | [string](#string) | | The name of the 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 function takes. || character_set_client | [string](#string) | | MySQL specific metadata. |@@ -1577,13 +1558,13 @@ RuleMetadata is the metadata for PostgreSQL rules.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of the rule. |-| event | [string](#string) | | The event is the event type of the rule: SELECT, INSERT, UPDATE, or DELETE. |-| condition | [string](#string) | | The condition is the WHERE condition of the rule (optional). |-| action | [string](#string) | | The action is the command(s) to execute when the rule fires. |+| name | [string](#string) | | The name of the rule. |+| event | [string](#string) | | The event type of the rule: SELECT, INSERT, UPDATE, or DELETE. |+| condition | [string](#string) | | The WHERE condition of the rule (optional). |+| action | [string](#string) | | The command(s) to execute when the rule fires. || is_instead | [bool](#bool) | | The is_instead indicates whether this is an INSTEAD rule. || is_enabled | [bool](#bool) | | The is_enabled indicates whether the rule is enabled. |-| definition | [string](#string) | | The definition is the full CREATE RULE statement. |+| definition | [string](#string) | | The full CREATE RULE statement. |@@ -1598,7 +1579,7 @@ RuleMetadata is the metadata for PostgreSQL rules.| 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. |+| name | [string](#string) | | The schema name. It is an empty string for databases without such concept such as MySQL. || tables | [TableCatalog](#bytebase-store-TableCatalog) | repeated | The table_configs is the list of configs for tables in a schema. |@@ -1615,17 +1596,17 @@ This is the concept of schema in Postgres, but it's a no-op for MySQL.| 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-store-TableMetadata) | repeated | The tables is the list of tables in a schema. |-| external_tables | [ExternalTableMetadata](#bytebase-store-ExternalTableMetadata) | repeated | The external_tables is the list of external tables in a schema. |-| views | [ViewMetadata](#bytebase-store-ViewMetadata) | repeated | The views is the list of views in a schema. |-| functions | [FunctionMetadata](#bytebase-store-FunctionMetadata) | repeated | The functions is the list of functions in a schema. |-| procedures | [ProcedureMetadata](#bytebase-store-ProcedureMetadata) | repeated | The procedures is the list of procedures in a schema. |-| streams | [StreamMetadata](#bytebase-store-StreamMetadata) | repeated | The streams is the list of streams in a schema, currently, only used for Snowflake. |-| tasks | [TaskMetadata](#bytebase-store-TaskMetadata) | repeated | The routines is the list of routines in a schema, currently, only used for Snowflake. |-| materialized_views | [MaterializedViewMetadata](#bytebase-store-MaterializedViewMetadata) | repeated | The materialized_views is the list of materialized views in a schema. |-| sequences | [SequenceMetadata](#bytebase-store-SequenceMetadata) | repeated | The sequences is the list of sequences in a schema. |-| packages | [PackageMetadata](#bytebase-store-PackageMetadata) | repeated | The packages is the list of packages in a schema. |+| name | [string](#string) | | The schema name. It is an empty string for databases without such concept such as MySQL. |+| tables | [TableMetadata](#bytebase-store-TableMetadata) | repeated | The list of tables in a schema. |+| external_tables | [ExternalTableMetadata](#bytebase-store-ExternalTableMetadata) | repeated | The list of external tables in a schema. |+| views | [ViewMetadata](#bytebase-store-ViewMetadata) | repeated | The list of views in a schema. |+| functions | [FunctionMetadata](#bytebase-store-FunctionMetadata) | repeated | The list of functions in a schema. |+| procedures | [ProcedureMetadata](#bytebase-store-ProcedureMetadata) | repeated | The list of procedures in a schema. |+| streams | [StreamMetadata](#bytebase-store-StreamMetadata) | repeated | The list of streams in a schema, currently only used for Snowflake. |+| tasks | [TaskMetadata](#bytebase-store-TaskMetadata) | repeated | The list of tasks in a schema, currently only used for Snowflake. |+| materialized_views | [MaterializedViewMetadata](#bytebase-store-MaterializedViewMetadata) | repeated | The list of materialized views in a schema. |+| sequences | [SequenceMetadata](#bytebase-store-SequenceMetadata) | repeated | The list of sequences in a schema. |+| packages | [PackageMetadata](#bytebase-store-PackageMetadata) | repeated | The list of packages in a schema. || owner | [string](#string) | | || comment | [string](#string) | | || events | [EventMetadata](#bytebase-store-EventMetadata) | repeated | |@@ -1650,12 +1631,12 @@ This is the concept of schema in Postgres, but it's a no-op for MySQL.| 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. |+| increment | [string](#string) | | The increment value of a sequence. |+| cycle | [bool](#bool) | | 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. |+| last_value | [string](#string) | | The last value of a sequence. |+| owner_table | [string](#string) | | The table that owns the sequence. |+| owner_column | [string](#string) | | The column that owns the sequence. || comment | [string](#string) | | || skip_dump | [bool](#bool) | | |@@ -1737,7 +1718,7 @@ StorageConfig defines storage and performance parameters for spatial indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a stream. |+| name | [string](#string) | | The name of the 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. |@@ -1759,7 +1740,7 @@ StorageConfig defines storage and performance parameters for spatial indexes.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a table. |+| name | [string](#string) | | The name of the table. || columns | [ColumnCatalog](#bytebase-store-ColumnCatalog) | repeated | The column_configs is the ordered list of configs for columns in a table. || object_schema | [ObjectSchema](#bytebase-store-ObjectSchema) | optional | || classification | [string](#string) | | |@@ -1777,12 +1758,12 @@ TableMetadata is the metadata for tables.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a table. |+| name | [string](#string) | | The name of the table. || columns | [ColumnMetadata](#bytebase-store-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. || indexes | [IndexMetadata](#bytebase-store-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. |+| charset | [string](#string) | | The character set of the 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. |@@ -1814,7 +1795,7 @@ TablePartitionMetadata is the metadata for table partitions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a table partition. |+| name | [string](#string) | | The name of the table partition. || type | [TablePartitionMetadata.Type](#bytebase-store-TablePartitionMetadata-Type) | | The type of a table partition. || expression | [string](#string) | | The expression is the expression of a table partition. For PostgreSQL, the expression is the text of {FOR VALUES partition_bound_spec}, see https://www.postgresql.org/docs/current/sql-createtable.html. For MySQL, the expression is the `expr` or `column_list` of the following syntax. PARTITION BY { [LINEAR] HASH(expr) | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) | RANGE{(expr) | COLUMNS(column_list)} | LIST{(expr) | COLUMNS(column_list)} }. || value | [string](#string) | | The value is the value of a table partition. For MySQL, the value is for RANGE and LIST partition types, - For a RANGE partition, it contains the value set in the partition's VALUES LESS THAN clause, which can be either an integer or MAXVALUE. - For a LIST partition, this column contains the values defined in the partition's VALUES IN clause, which is a list of comma-separated integer values. - For others, it's an empty string. |@@ -1836,8 +1817,8 @@ TablePartitionMetadata is the metadata for table partitions.| 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 |+| name | [string](#string) | | The name of the task. |+| id | [string](#string) | | The Snowflake-generated ID of the 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. |@@ -1878,10 +1859,10 @@ TessellationConfig defines tessellation parameters for spatial indexes.| 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. |+| name | [string](#string) | | The name of the trigger. |+| event | [string](#string) | | The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE. |+| timing | [string](#string) | | The timing of when the trigger fires, such as BEFORE or AFTER. |+| body | [string](#string) | | The body of the trigger. || sql_mode | [string](#string) | | || character_set_client | [string](#string) | | || collation_connection | [string](#string) | | |@@ -1901,12 +1882,12 @@ ViewMetadata is the metadata for views.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name is the name of a view. |+| name | [string](#string) | | The name of the 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-store-DependencyColumn) | repeated | The dependency_columns is the list of dependency columns of a view. |-| columns | [ColumnMetadata](#bytebase-store-ColumnMetadata) | repeated | The columns is the ordered list of columns in a table. |-| triggers | [TriggerMetadata](#bytebase-store-TriggerMetadata) | repeated | The triggers is the list of triggers in a view. |+| dependency_columns | [DependencyColumn](#bytebase-store-DependencyColumn) | repeated | The list of dependency columns of a view. |+| columns | [ColumnMetadata](#bytebase-store-ColumnMetadata) | repeated | The ordered list of columns in the view. |+| triggers | [TriggerMetadata](#bytebase-store-TriggerMetadata) | repeated | The list of triggers in the view. || skip_dump | [bool](#bool) | | || rules | [RuleMetadata](#bytebase-store-RuleMetadata) | repeated | The rules is the list of rules in a view (PostgreSQL specific). |@@ -1988,8 +1969,8 @@ ViewMetadata is the metadata for views.<a name="bytebase-store-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:+The type is the type of a table partition. Some database engines may not+support all types. Only available 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:@@ -2102,7 +2083,7 @@ LIST, HASH (https://www.postgresql.org/docs/current/ddl-partitioning.html)| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| member | [string](#string) | | Member is the principal who belong to this group.+| member | [string](#string) | | Member is the principal who belongs to this group.Format: users/{userUID}. || role | [GroupMember.Role](#bytebase-store-GroupMember-Role) | | |@@ -2121,7 +2102,7 @@ Format: users/{userUID}. || Field | Type | Label | Description || ----- | ---- | ----- | ----------- || members | [GroupMember](#bytebase-store-GroupMember) | repeated | |-| source | [string](#string) | | source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. |+| source | [string](#string) | | The source indicates where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. |@@ -2318,7 +2299,7 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| ---- | ------ | ----------- || OAUTH2_AUTH_STYLE_UNSPECIFIED | 0 | || IN_PARAMS | 1 | IN_PARAMS sends the "client_id" and "client_secret" in the POST body as application/x-www-form-urlencoded parameters. |-| IN_HEADER | 2 | IN_HEADER sends the client_id and client_password using HTTP Basic Authorization. This is an optional style described in the OAuth2 RFC 6749 section 2.3.1. |+| IN_HEADER | 2 | IN_HEADER sends the client_id and client_secret using HTTP Basic Authorization. This is an optional style described in the OAuth2 RFC 6749 section 2.3.1. |@@ -2349,7 +2330,7 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| username | [string](#string) | | || password | [string](#string) | | || obfuscated_password | [string](#string) | | |-| use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use system default SSL configuration. |+| use_ssl | [bool](#bool) | | Use SSL to connect to the data source. By default, we use the system's SSL configuration. || ssl_ca | [string](#string) | | || obfuscated_ssl_ca | [string](#string) | | || ssl_cert | [string](#string) | | |@@ -2360,7 +2341,7 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| host | [string](#string) | | || port | [string](#string) | | || database | [string](#string) | | |-| 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. |+| 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. |@@ -2382,7 +2363,7 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| sasl_config | [SASLConfig](#bytebase-store-SASLConfig) | | || additional_addresses | [DataSource.Address](#bytebase-store-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. |+| region | [string](#string) | | Region is the location of the database, used 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_obfuscated_password are master credentials used by redis sentinel mode. |@@ -2516,7 +2497,7 @@ OIDCIdentityProviderConfig is the structure for OIDC identity provider config.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || role_id | [string](#string) | | |-| secret_id | [string](#string) | | the secret id for the role without ttl. |+| secret_id | [string](#string) | | The secret ID for the role without TTL. || type | [DataSourceExternalSecret.AppRoleAuthOption.SecretType](#bytebase-store-DataSourceExternalSecret-AppRoleAuthOption-SecretType) | | || mount_path | [string](#string) | | The path where the approle auth method is mounted. |@@ -2539,9 +2520,9 @@ Instance is the proto for instances.| version | [string](#string) | | || external_link | [string](#string) | | || data_sources | [DataSource](#bytebase-store-DataSource) | repeated | |-| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | How often the instance is synced. |+| sync_interval | [google.protobuf.Duration](#google-protobuf-Duration) | | The interval between automatic instance synchronizations. || maximum_connections | [int32](#int32) | | The maximum number of connections. The default is 10 if the value is unset or zero. |-| sync_databases | [string](#string) | repeated | Enable sync for following databases. Default empty, means sync all schemas & databases. |+| sync_databases | [string](#string) | repeated | Enable sync for the following databases. Default empty, means sync all schemas & databases. || mysql_lower_case_table_names | [int32](#int32) | | The lower_case_table_names config for MySQL instances. It is used to determine whether the table names and database names are case sensitive. || last_sync_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || roles | [InstanceRole](#bytebase-store-InstanceRole) | repeated | |@@ -2579,7 +2560,7 @@ InstanceRole is the API message for instance role.| name | [string](#string) | | The role name. || connection_limit | [int32](#int32) | optional | The connection count limit for this role. || valid_until | [string](#string) | optional | The expiration for the role's password. |-| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |+| 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 is the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |@@ -2686,7 +2667,7 @@ InstanceRole is the API message for instance role.| Name | Number | Description || ---- | ------ | ----------- |-| SAECRET_TYPE_UNSPECIFIED | 0 | |+| SECRET_TYPE_UNSPECIFIED | 0 | || 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 |@@ -2754,15 +2735,15 @@ InstanceRole is the API message for instance role.<a name="bytebase-store-GrantRequest"></a>### GrantRequest-+GrantRequest contains details for requesting database access permissions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| role | [string](#string) | | The requested role. Format: roles/EXPORTER. |-| user | [string](#string) | | The user to be granted. Format: users/{userUID}. |-| condition | [google.type.Expr](#google-type-Expr) | | |-| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | |+| role | [string](#string) | | The role being requested for the user. Format: roles/EXPORTER. |+| user | [string](#string) | | The user who will receive the role. Format: users/{userUID}. |+| condition | [google.type.Expr](#google-type-Expr) | | Optional conditional expression that limits when the grant applies. |+| expiration | [google.protobuf.Duration](#google-protobuf-Duration) | | Duration after which the grant automatically expires. |@@ -2772,14 +2753,14 @@ InstanceRole is the API message for instance role.<a name="bytebase-store-Issue"></a>### Issue-+Issue is the metadata for issues that track database operations and access requests.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| approval | [IssuePayloadApproval](#bytebase-store-IssuePayloadApproval) | | |-| grant_request | [GrantRequest](#bytebase-store-GrantRequest) | | |-| labels | [string](#string) | repeated | |+| approval | [IssuePayloadApproval](#bytebase-store-IssuePayloadApproval) | | Approval information for the issue workflow. |+| grant_request | [GrantRequest](#bytebase-store-GrantRequest) | | Access grant request details if this is a grant request issue. |+| labels | [string](#string) | repeated | Labels attached to categorize and filter the issue. |@@ -2791,28 +2772,28 @@ InstanceRole is the API message for instance role.<a name="bytebase-store-Issue-Status"></a>### Issue.Status-+Status represents the current state of the issue.| Name | Number | Description || ---- | ------ | ----------- || ISSUE_STATUS_UNSPECIFIED | 0 | |-| OPEN | 1 | |-| DONE | 2 | |-| CANCELED | 3 | |+| OPEN | 1 | Issue is open and pending action. |+| DONE | 2 | Issue has been completed successfully. |+| CANCELED | 3 | Issue was canceled and will not be completed. |<a name="bytebase-store-Issue-Type"></a>### Issue.Type-+Type represents the category of issue.| Name | Number | Description || ---- | ------ | ----------- || ISSUE_TYPE_UNSPECIFIED | 0 | |-| DATABASE_CHANGE | 1 | |-| GRANT_REQUEST | 2 | |-| DATABASE_EXPORT | 3 | |+| DATABASE_CHANGE | 1 | Issue for database schema or data changes. |+| GRANT_REQUEST | 2 | Issue requesting database access permissions. |+| DATABASE_EXPORT | 3 | Issue for exporting data from databases. |@@ -3134,7 +3115,7 @@ InstanceRole is the API message for instance role.| targets | [string](#string) | repeated | The list of targets. Multi-database format: [instances/{instance-id}/databases/{database-name}]. Single database group format: [projects/{project}/databaseGroups/{databaseGroup}]. || sheet | [string](#string) | | The resource name of the sheet. Format: projects/{project}/sheets/{sheet} || format | [ExportFormat](#bytebase-store-ExportFormat) | | The format of the exported file. |-| password | [string](#string) | optional | The zip password provide by users. Leave it empty if no needs to encrypt the zip file. |+| password | [string](#string) | optional | The zip password provided by users. Leave it empty if there is no need to encrypt the zip file. |@@ -3286,7 +3267,7 @@ Type is the database change type.| ----- | ---- | ----- | ----------- || line | [int32](#int32) | | || column | [int32](#int32) | | |-| start_position | [Position](#bytebase-store-Position) | | 1-based Position of the SQL statement. To supersede `line` and `column` above. |+| start_position | [Position](#bytebase-store-Position) | | 1-based position of the SQL statement. To supersede `line` and `column` above. || end_position | [Position](#bytebase-store-Position) | | |@@ -3302,7 +3283,7 @@ Type is the database change type.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| statement_types | [string](#string) | repeated | statement_types are the types of statements that are found in the sql. |+| statement_types | [string](#string) | repeated | statement_types are the types of statements found in the SQL. || affected_rows | [int64](#int64) | | || changed_resources | [ChangedResources](#bytebase-store-ChangedResources) | | |@@ -3445,8 +3426,8 @@ MaskingExceptionPolicy is the allowlist of users who can access sensitive data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| action | [MaskingExceptionPolicy.MaskingException.Action](#bytebase-store-MaskingExceptionPolicy-MaskingException-Action) | | action is the action that the user can access sensitive data. |-| member | [string](#string) | | Member is the principal who bind to this exception policy instance.+| action | [MaskingExceptionPolicy.MaskingException.Action](#bytebase-store-MaskingExceptionPolicy-MaskingException-Action) | | action is the action by which the user can access sensitive data. |+| member | [string](#string) | | Member is the principal who binds to this exception policy instance.Format: users/{userUID} or groups/{group email} || condition | [google.type.Expr](#google-type-Expr) | | The condition that is associated with this exception policy instance. |@@ -3507,7 +3488,7 @@ QueryDataPolicy is the policy configuration for querying data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | The query timeout duration. |-| disable_export | [bool](#bool) | | Disable export data in the SQL editor |+| disable_export | [bool](#bool) | | Disable exporting data in the SQL editor. || maximum_result_size | [int64](#int64) | | The size limit in bytes. The default value is 100MB, we will use the default value if the setting not exists, or the limit <= 0. || maximum_result_rows | [int32](#int32) | | The return rows limit. The default value is -1, means no limit. || disable_copy_data | [bool](#bool) | | Disable copying data. |@@ -3592,7 +3573,7 @@ QueryDataPolicy is the policy configuration for querying data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| tags | [TagPolicy.TagsEntry](#bytebase-store-TagPolicy-TagsEntry) | repeated | tags is the key - value map for resources. for example, the environment resource can have the sql review config tag, like "bb.tag.review_config": "reviewConfigs/{review config resource id}" |+| tags | [TagPolicy.TagsEntry](#bytebase-store-TagPolicy-TagsEntry) | repeated | tags is the key-value map for resources. For example, the environment resource can have the SQL review config tag, such as "bb.tag.review_config": "reviewConfigs/{review config resource id}". |@@ -3732,14 +3713,14 @@ QueryDataPolicy is the policy configuration for querying data.<a name="bytebase-store-Label"></a>### Label-+Label represents a categorization tag that can be applied to issues.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| value | [string](#string) | | |-| color | [string](#string) | | |-| group | [string](#string) | | |+| value | [string](#string) | | The display text of the label. |+| color | [string](#string) | | The color for the label in hex format (e.g., "#FF0000"). |+| group | [string](#string) | | Optional group name for organizing related labels. |@@ -3749,12 +3730,12 @@ QueryDataPolicy is the policy configuration for querying data.<a name="bytebase-store-Project"></a>### Project-+Project contains settings and configuration for a Bytebase project.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| issue_labels | [Label](#bytebase-store-Label) | repeated | |+| issue_labels | [Label](#bytebase-store-Label) | repeated | Available labels that can be applied to 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 statement after issue is created. || auto_resolve_issue | [bool](#bool) | | Enable auto resolve issue. |@@ -3763,8 +3744,8 @@ QueryDataPolicy is the policy configuration for querying data.| skip_backup_errors | [bool](#bool) | | Whether to skip backup errors and continue the data migration. || postgres_database_tenant_mode | [bool](#bool) | | Whether to enable the database tenant mode for PostgreSQL. If enabled, the issue will be created with the prepend "set role <db_owner>" statement. || allow_self_approval | [bool](#bool) | | Whether to allow the issue creator to self-approve the issue. |-| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-store-Project-ExecutionRetryPolicy) | | Execution retry policy for the task run. |-| ci_sampling_size | [int32](#int32) | | The maximum number of databases to sample during CI data validation. Without specification, sampling is disabled, resulting in a full validation. |+| execution_retry_policy | [Project.ExecutionRetryPolicy](#bytebase-store-Project-ExecutionRetryPolicy) | | Configuration for automatic retry on task execution failures. |+| ci_sampling_size | [int32](#int32) | | The maximum number of databases to sample during CI data validation. If not specified, sampling is disabled, resulting in a full validation. || parallel_tasks_per_rollout | [int32](#int32) | | The maximum number of parallel tasks to run during the rollout. || labels | [Project.LabelsEntry](#bytebase-store-Project-LabelsEntry) | repeated | Labels are key-value pairs that can be attached to the project. For example, { "environment": "production", "team": "backend" } || enforce_sql_review | [bool](#bool) | | Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors. |@@ -3777,12 +3758,12 @@ QueryDataPolicy is the policy configuration for querying data.<a name="bytebase-store-Project-ExecutionRetryPolicy"></a>### Project.ExecutionRetryPolicy-+ExecutionRetryPolicy defines retry behavior for failed task executions.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| maximum_retries | [int32](#int32) | | The maximum number of retries for the lock timeout issue. |+| maximum_retries | [int32](#int32) | | The maximum number of retry attempts for lock timeout errors. |@@ -3829,7 +3810,7 @@ QueryDataPolicy is the policy configuration for querying data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| 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. |+| 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. |@@ -3910,7 +3891,7 @@ QueryDataPolicy is the policy configuration for querying data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || id | [string](#string) | | The unique identifier for the file. |-| path | [string](#string) | | The path of the file. e.g. `2.2/V0001_create_table.sql`. |+| path | [string](#string) | | The path of the file, e.g., `2.2/V0001_create_table.sql`. || sheet | [string](#string) | | The sheet that holds the content. Format: projects/{project}/sheets/{sheet} || sheet_sha256 | [string](#string) | | The SHA256 hash value of the sheet. || type | [ReleasePayload.File.Type](#bytebase-store-ReleasePayload-File-Type) | | |@@ -4218,8 +4199,8 @@ QueryDataPolicy is the policy configuration for querying data.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| level | [Announcement.AlertLevel](#bytebase-store-Announcement-AlertLevel) | | The alert level of announcemnt |-| text | [string](#string) | | The text of announcemnt |+| level | [Announcement.AlertLevel](#bytebase-store-Announcement-AlertLevel) | | The alert level of the announcement. |+| text | [string](#string) | | The text of the announcement. || link | [string](#string) | | The optional link, user can follow the link to check extra details |@@ -4474,11 +4455,11 @@ QueryDataPolicy is the policy configuration for querying data.| 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_uppercase_letter requires the password must contains at least one special character. |+| min_length | [int32](#int32) | | min_length is the minimum length for password, should be no less than 8. |+| require_number | [bool](#bool) | | require_number requires the password must contain at least one number. |+| require_letter | [bool](#bool) | | require_letter requires the password must contain at least one letter, regardless of upper case or lower case |+| require_uppercase_letter | [bool](#bool) | | require_uppercase_letter requires the password must contain at least one upper case letter. |+| require_special_character | [bool](#bool) | | require_special_character requires the password must contain 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. |@@ -4653,7 +4634,7 @@ QueryDataPolicy is the policy configuration for querying data.| token_duration | [google.protobuf.Duration](#google-protobuf-Duration) | | The duration for token. || announcement | [Announcement](#bytebase-store-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. |+| 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-store-DatabaseChangeMode) | | The workspace database change mode. || disallow_password_signin | [bool](#bool) | | Whether to disallow password signin. (Except workspace admins) |@@ -4813,27 +4794,27 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.<a name="bytebase-store-Task"></a>### Task-+Task is the metadata for database operation tasks.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| skipped | [bool](#bool) | | common fields |-| skipped_reason | [string](#string) | | |-| spec_id | [string](#string) | | |-| sheet_id | [int32](#int32) | | |-| environment_id | [string](#string) | | Create database fields. |-| database_name | [string](#string) | | |-| table_name | [string](#string) | | |-| character_set | [string](#string) | | |-| collation | [string](#string) | | |-| schema_version | [string](#string) | | Update database fields. |-| enable_prior_backup | [bool](#bool) | | |-| flags | [Task.FlagsEntry](#bytebase-store-Task-FlagsEntry) | repeated | ghost flags. |-| task_release_source | [TaskReleaseSource](#bytebase-store-TaskReleaseSource) | | |-| migrate_type | [Task.MigrateType](#bytebase-store-Task-MigrateType) | | |-| password | [string](#string) | | Export data fields. |-| format | [ExportFormat](#bytebase-store-ExportFormat) | | |+| skipped | [bool](#bool) | | Whether the task was skipped during execution. |+| skipped_reason | [string](#string) | | Reason why the task was skipped. |+| spec_id | [string](#string) | | UUID that identifies the spec this task implements. |+| sheet_id | [int32](#int32) | | The sheet ID containing SQL statements for this task. |+| environment_id | [string](#string) | | The environment where the database will be created. |+| database_name | [string](#string) | | Name of the database to create. |+| table_name | [string](#string) | | Optional table name to create (required for some databases like MongoDB). |+| character_set | [string](#string) | | Character set for the new database. |+| collation | [string](#string) | | Collation for the new database. |+| schema_version | [string](#string) | | Schema version after migration is applied. |+| enable_prior_backup | [bool](#bool) | | Whether to create an automatic backup before applying changes. |+| flags | [Task.FlagsEntry](#bytebase-store-Task-FlagsEntry) | repeated | Configuration flags for gh-ost migration tool. |+| task_release_source | [TaskReleaseSource](#bytebase-store-TaskReleaseSource) | | Source information if task is created from a release. |+| migrate_type | [Task.MigrateType](#bytebase-store-Task-MigrateType) | | The type of migration (DDL, DML, or GHOST). |+| password | [string](#string) | | Password to encrypt the exported data archive. |+| format | [ExportFormat](#bytebase-store-ExportFormat) | | Format of the exported data (SQL, CSV, JSON, etc). |@@ -4859,12 +4840,12 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.<a name="bytebase-store-TaskReleaseSource"></a>### TaskReleaseSource-+TaskReleaseSource contains information about the release file this task originated from.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| file | [string](#string) | | Format: projects/{project}/releases/{release}/files/{id} |+| file | [string](#string) | | Resource name of the release file. Format: projects/{project}/releases/{release}/files/{id} |@@ -4876,29 +4857,29 @@ We support three levels of AlertLevel: INFO, WARNING, and ERROR.<a name="bytebase-store-Task-MigrateType"></a>### Task.MigrateType-MigrateType is the database migration type.+MigrateType is the database migration type for imperative migrations.| Name | Number | Description || ---- | ------ | ----------- || MIGRATE_TYPE_UNSPECIFIED | 0 | |-| DDL | 1 | |-| DML | 2 | |-| GHOST | 3 | |+| DDL | 1 | DDL changes (Data Definition Language) for schema modifications. |+| DML | 2 | DML changes (Data Manipulation Language) for data modifications. |+| GHOST | 3 | Online schema migration using gh-ost tool. |<a name="bytebase-store-Task-Type"></a>### Task.Type-+Type represents the type of database operation to perform.| Name | Number | Description || ---- | ------ | ----------- || TASK_TYPE_UNSPECIFIED | 0 | |-| DATABASE_CREATE | 1 | |-| DATABASE_MIGRATE | 2 | |-| DATABASE_EXPORT | 5 | |-| DATABASE_SDL | 6 | |+| DATABASE_CREATE | 1 | Create a new database. |+| DATABASE_MIGRATE | 2 | Apply schema/data migrations to an existing database. |+| DATABASE_EXPORT | 5 | Export data from a database. |+| DATABASE_SDL | 6 | Apply declarative schema changes (state-based migration). |@@ -4919,12 +4900,12 @@ MigrateType is the database migration type.<a name="bytebase-store-PriorBackupDetail"></a>### PriorBackupDetail-+PriorBackupDetail contains information about automatic backups created before migration.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| items | [PriorBackupDetail.Item](#bytebase-store-PriorBackupDetail-Item) | repeated | |+| items | [PriorBackupDetail.Item](#bytebase-store-PriorBackupDetail-Item) | repeated | List of backup operations performed. |@@ -4934,15 +4915,15 @@ MigrateType is the database migration type.<a name="bytebase-store-PriorBackupDetail-Item"></a>### PriorBackupDetail.Item-+Item represents a single backup operation for a table.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| source_table | [PriorBackupDetail.Item.Table](#bytebase-store-PriorBackupDetail-Item-Table) | | The original table information. |-| target_table | [PriorBackupDetail.Item.Table](#bytebase-store-PriorBackupDetail-Item-Table) | | The target backup table information. |-| start_position | [Position](#bytebase-store-Position) | | |-| end_position | [Position](#bytebase-store-Position) | | |+| source_table | [PriorBackupDetail.Item.Table](#bytebase-store-PriorBackupDetail-Item-Table) | | The original table that was backed up. |+| target_table | [PriorBackupDetail.Item.Table](#bytebase-store-PriorBackupDetail-Item-Table) | | The backup table where data was copied. |+| start_position | [Position](#bytebase-store-Position) | | Starting position in SQL for this backup operation. |+| end_position | [Position](#bytebase-store-Position) | | Ending position in SQL for this backup operation. |@@ -4952,14 +4933,14 @@ MigrateType is the database migration type.<a name="bytebase-store-PriorBackupDetail-Item-Table"></a>### PriorBackupDetail.Item.Table-+Table identifies a database table.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| database | [string](#string) | | The database information. Format: instances/{instance}/databases/{database} |-| schema | [string](#string) | | |-| table | [string](#string) | | |+| database | [string](#string) | | The database containing the table. Format: instances/{instance}/databases/{database} |+| schema | [string](#string) | | Schema name (for databases that support schemas). |+| table | [string](#string) | | Table name. |@@ -4969,13 +4950,13 @@ MigrateType is the database migration type.<a name="bytebase-store-SchedulerInfo"></a>### SchedulerInfo-+SchedulerInfo contains information about task scheduling and execution delays.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| waiting_cause | [SchedulerInfo.WaitingCause](#bytebase-store-SchedulerInfo-WaitingCause) | | |+| report_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp when the scheduler reported this information. |+| waiting_cause | [SchedulerInfo.WaitingCause](#bytebase-store-SchedulerInfo-WaitingCause) | | Reason why the task run is currently waiting. |@@ -4985,14 +4966,14 @@ MigrateType is the database migration type.<a name="bytebase-store-SchedulerInfo-WaitingCause"></a>### SchedulerInfo.WaitingCause-+WaitingCause indicates why a task run is waiting to execute.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| connection_limit | [bool](#bool) | | |-| task_uid | [int32](#int32) | | |-| parallel_tasks_limit | [bool](#bool) | | |+| connection_limit | [bool](#bool) | | Task is waiting due to database connection limit. |+| task_uid | [int32](#int32) | | Task is waiting for another task to complete. |+| parallel_tasks_limit | [bool](#bool) | | Task is waiting due to parallel execution limit. |@@ -5002,7 +4983,7 @@ MigrateType is the database migration type.<a name="bytebase-store-TaskRun"></a>### TaskRun-+TaskRun represents an execution attempt of a task.@@ -5012,18 +4993,18 @@ MigrateType is the database migration type.<a name="bytebase-store-TaskRunResult"></a>### TaskRunResult-+TaskRunResult contains the outcome and metadata from a task run execution.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| detail | [string](#string) | | |-| changelog | [string](#string) | | Format: instances/{instance}/databases/{database}/changelogs/{changelog} |-| version | [string](#string) | | |-| start_position | [Position](#bytebase-store-Position) | | The following fields are used for error reporting. |-| end_position | [Position](#bytebase-store-Position) | | |-| export_archive_uid | [int32](#int32) | | The uid of the export archive. |-| prior_backup_detail | [PriorBackupDetail](#bytebase-store-PriorBackupDetail) | | The prior backup detail that will be used to rollback the task run. |+| detail | [string](#string) | | Detailed execution information or error message. |+| changelog | [string](#string) | | Resource name of the changelog entry created by this run. Format: instances/{instance}/databases/{database}/changelogs/{changelog} |+| version | [string](#string) | | Schema version after the migration was applied. |+| start_position | [Position](#bytebase-store-Position) | | Starting position in the SQL statement where an error occurred. |+| end_position | [Position](#bytebase-store-Position) | | Ending position in the SQL statement where an error occurred. |+| export_archive_uid | [int32](#int32) | | UID of the export archive generated for export tasks. |+| prior_backup_detail | [PriorBackupDetail](#bytebase-store-PriorBackupDetail) | | Backup details that can be used to rollback changes. |@@ -5035,18 +5016,18 @@ MigrateType is the database migration type.<a name="bytebase-store-TaskRun-Status"></a>### TaskRun.Status-+Status represents the current execution state of a task run.| Name | Number | Description || ---- | ------ | ----------- || STATUS_UNSPECIFIED | 0 | |-| PENDING | 1 | |-| RUNNING | 2 | |-| DONE | 3 | |-| FAILED | 4 | |-| CANCELED | 5 | |-| NOT_STARTED | 6 | |-| SKIPPED | 7 | |+| PENDING | 1 | Task run is queued and waiting to execute. |+| RUNNING | 2 | Task run is currently executing. |+| DONE | 3 | Task run completed successfully. |+| FAILED | 4 | Task run encountered an error and failed. |+| CANCELED | 5 | Task run was canceled by user or system. |+| NOT_STARTED | 6 | Task run has not started yet. |+| SKIPPED | 7 | Task run was skipped and will not execute. |@@ -5286,8 +5267,8 @@ MigrateType is the database migration type.| Name | Number | Description || ---- | ------ | ----------- || STATUS_UNSPECIFIED | 0 | |-| RUNNING_WAITING | 1 | the task run is ready to be executed by the scheduler |-| RUNNING_RUNNING | 2 | the task run is being executed by the scheduler |+| RUNNING_WAITING | 1 | The task run is ready to be executed by the scheduler. |+| RUNNING_RUNNING | 2 | The task run is being executed by the scheduler. |@@ -5352,9 +5333,9 @@ MFAConfig is the MFA configuration for a user.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || otp_secret | [string](#string) | | The otp_secret is the secret key used to validate the OTP code. |-| temp_otp_secret | [string](#string) | | The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two phase commits. |+| temp_otp_secret | [string](#string) | | The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two-phase commits. || recovery_codes | [string](#string) | repeated | The recovery_codes are the codes that can be used to recover the account. |-| temp_recovery_codes | [string](#string) | repeated | The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two phase commits. |+| temp_recovery_codes | [string](#string) | repeated | The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two-phase commits. |@@ -5371,7 +5352,7 @@ MFAConfig is the MFA configuration for a user.| ----- | ---- | ----- | ----------- || last_login_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || last_change_password_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |-| 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. |+| source | [string](#string) | | The source indicates where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. |diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.htmlindex 6bfbf887aa..1426295959 100644--- a/proto/gen/grpc-doc/store/index.html+++ b/proto/gen/grpc-doc/store/index.html@@ -356,17 +356,6 @@- </ul>- </li>--- <li>- <a href="#store%2fdata_source.proto">store/data_source.proto</a>- <ul>----</ul></li>@@ -1574,7 +1563,7 @@<h3 id="bytebase.store.PageToken">PageToken</h3>- <p>Used internally for obfuscating the page token.</p>+ <p>PageToken is used internally for obfuscating pagination tokens.</p><table class="field-table">@@ -1587,14 +1576,14 @@<td>limit</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Maximum number of items to return. </p></td></tr><tr><td>offset</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Number of items to skip before starting to return results. </p></td></tr></tbody>@@ -1605,7 +1594,7 @@<h3 id="bytebase.store.Position">Position</h3>- <p>Position in a text expressed as zero-based line and zero-based column byte</p><p>offset.</p>+ <p>Position in a text expressed as zero-based line and column byte offset.</p><table class="field-table">@@ -1636,7 +1625,7 @@<h3 id="bytebase.store.Range">Range</h3>- <p></p>+ <p>Range represents a span within a text or sequence.</p><table class="field-table">@@ -1649,14 +1638,14 @@<td>start</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Start index (inclusive). </p></td></tr><tr><td>end</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>End index (exclusive). </p></td></tr></tbody>@@ -1669,7 +1658,7 @@<h3 id="bytebase.store.Engine">Engine</h3>- <p></p>+ <p>Engine represents the type of database system.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -1836,7 +1825,7 @@</table><h3 id="bytebase.store.ExportFormat">ExportFormat</h3>- <p></p>+ <p>ExportFormat represents the file format for exported data.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -1877,7 +1866,7 @@</table><h3 id="bytebase.store.MaskingLevel">MaskingLevel</h3>- <p></p>+ <p>MaskingLevel represents the level of data masking applied to sensitive information.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -1893,26 +1882,26 @@<tr><td>NONE</td><td>1</td>- <td><p></p></td>+ <td><p>No masking applied.</p></td></tr><tr><td>PARTIAL</td><td>2</td>- <td><p></p></td>+ <td><p>Partial masking (e.g., showing first/last characters).</p></td></tr><tr><td>FULL</td><td>3</td>- <td><p></p></td>+ <td><p>Full masking (all characters masked).</p></td></tr></tbody></table><h3 id="bytebase.store.RiskLevel">RiskLevel</h3>- <p></p>+ <p>RiskLevel represents the assessed risk level of a database operation.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -1947,7 +1936,7 @@</table><h3 id="bytebase.store.VCSType">VCSType</h3>- <p></p>+ <p>VCSType represents the type of version control system.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -2072,7 +2061,7 @@ TODO: use range instead. </p></td><tr><td>STATUS_UNSPECIFIED</td><td>0</td>- <td><p>Unspecified.</p></td>+ <td><p>Unspecified status.</p></td></tr><tr>@@ -2109,7 +2098,7 @@ TODO: use range instead. </p></td><h3 id="bytebase.store.ApprovalFlow">ApprovalFlow</h3>- <p></p>+ <p>ApprovalFlow defines the sequence of approvals required.</p><table class="field-table">@@ -2122,7 +2111,7 @@ TODO: use range instead. </p></td><td>roles</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>List of role names that must approve, in order. </p></td></tr></tbody>@@ -2133,7 +2122,7 @@ TODO: use range instead. </p></td><h3 id="bytebase.store.ApprovalTemplate">ApprovalTemplate</h3>- <p></p>+ <p>ApprovalTemplate defines the approval workflow and requirements for an issue.</p><table class="field-table">@@ -2147,29 +2136,29 @@ TODO: use range instead. </p></td><td><a href="#string">string</a></td><td></td><td><p>The unique identifier for the approval template.-For built-in templates, use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").-For custom templates, use a UUID or other unique identifier. </p></td>+Built-in templates use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").+Custom templates use a UUID or other unique identifier. </p></td></tr><tr><td>flow</td><td><a href="#bytebase.store.ApprovalFlow">ApprovalFlow</a></td><td></td>- <td><p> </p></td>+ <td><p>The approval workflow specification. </p></td></tr><tr><td>title</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Human-readable title of the approval template. </p></td></tr><tr><td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Detailed description of when this template applies. </p></td></tr></tbody>@@ -2180,7 +2169,7 @@ For custom templates, use a UUID or other unique identifier. </p></td><h3 id="bytebase.store.IssuePayloadApproval">IssuePayloadApproval</h3>- <p>IssuePayloadApproval is a part of the payload of an issue.</p><p>IssuePayloadApproval records the approval template used and the approval history.</p>+ <p>IssuePayloadApproval records the approval template used and approval history for an issue.</p><table class="field-table">@@ -2193,36 +2182,36 @@ For custom templates, use a UUID or other unique identifier. </p></td><td>approval_template</td><td><a href="#bytebase.store.ApprovalTemplate">ApprovalTemplate</a></td><td></td>- <td><p> </p></td>+ <td><p>The approval template being used for this issue. </p></td></tr><tr><td>approvers</td><td><a href="#bytebase.store.IssuePayloadApproval.Approver">IssuePayloadApproval.Approver</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>List of approvers and their current status. </p></td></tr><tr><td>approval_finding_done</td><td><a href="#bool">bool</a></td><td></td>- <td><p>If the value is `false`, it means that the backend is still finding matching approval templates.-If `true`, other fields are available. </p></td>+ <td><p>Whether the system has finished finding a matching approval template.+False means the backend is still searching for matching templates. </p></td></tr><tr><td>approval_finding_error</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Error message if approval template finding failed. </p></td></tr><tr><td>risk_level</td><td><a href="#bytebase.store.RiskLevel">RiskLevel</a></td><td></td>- <td><p> </p></td>+ <td><p>The assessed risk level for this issue. </p></td></tr></tbody>@@ -2233,7 +2222,7 @@ If `true`, other fields are available. </p></td><h3 id="bytebase.store.IssuePayloadApproval.Approver">IssuePayloadApproval.Approver</h3>- <p></p>+ <p>Approver represents a user who can approve or reject an issue.</p><table class="field-table">@@ -2246,14 +2235,14 @@ If `true`, other fields are available. </p></td><td>status</td><td><a href="#bytebase.store.IssuePayloadApproval.Approver.Status">IssuePayloadApproval.Approver.Status</a></td><td></td>- <td><p>The new status. </p></td>+ <td><p>The current approval status. </p></td></tr><tr><td>principal_id</td><td><a href="#int32">int32</a></td><td></td>- <td><p>The principal id of the approver. </p></td>+ <td><p>The ID of the principal who is the approver. </p></td></tr></tbody>@@ -2266,7 +2255,7 @@ If `true`, other fields are available. </p></td><h3 id="bytebase.store.IssuePayloadApproval.Approver.Status">IssuePayloadApproval.Approver.Status</h3>- <p></p>+ <p>Status represents the approver's decision state.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -2282,19 +2271,19 @@ If `true`, other fields are available. </p></td><tr><td>PENDING</td><td>1</td>- <td><p></p></td>+ <td><p>Approval is pending from this approver.</p></td></tr><tr><td>APPROVED</td><td>2</td>- <td><p></p></td>+ <td><p>Approver has approved the issue.</p></td></tr><tr><td>REJECTED</td><td>3</td>- <td><p></p></td>+ <td><p>Approver has rejected the issue.</p></td></tr></tbody>@@ -2336,15 +2325,15 @@ Formats:<td>method</td><td><a href="#string">string</a></td><td></td>- <td><p>e.g. /bytebase.v1.SQLService/Query </p></td>+ <td><p>Example: /bytebase.v1.SQLService/Query </p></td></tr><tr><td>resource</td><td><a href="#string">string</a></td><td></td>- <td><p>resource name-projects/{project} </p></td>+ <td><p>The resource name.+Example: projects/{project} </p></td></tr><tr>@@ -2394,7 +2383,7 @@ Some fields are omitted because they are too large or contain sensitive informat<td>service_data</td><td><a href="#google.protobuf.Any">google.protobuf.Any</a></td><td></td>- <td><p>service-specific data about the request, response, and other activities. </p></td>+ <td><p>The service-specific data about the request, response, and other activities. </p></td></tr><tr>@@ -2523,7 +2512,7 @@ This information is not authenticated and should be treated accordingly. </p></t<h3 id="bytebase.store.Changelist">Changelist</h3>- <p></p>+ <p>Changelist represents a collection of database changes that can be applied together.</p><table class="field-table">@@ -2536,14 +2525,14 @@ This information is not authenticated and should be treated accordingly. </p></t<td>description</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Human-readable description of this changelist. </p></td></tr><tr><td>changes</td><td><a href="#bytebase.store.Changelist.Change">Changelist.Change</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>The list of changes in this changelist. </p></td></tr></tbody>@@ -2554,7 +2543,7 @@ This information is not authenticated and should be treated accordingly. </p></t<h3 id="bytebase.store.Changelist.Change">Changelist.Change</h3>- <p></p>+ <p>Change represents a single database modification within the changelist.</p><table class="field-table">@@ -2567,16 +2556,16 @@ This information is not authenticated and should be treated accordingly. </p></t<td>sheet</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of a sheet. </p></td>+ <td><p>Resource name of the sheet containing the SQL statements. </p></td></tr><tr><td>source</td><td><a href="#string">string</a></td><td></td>- <td><p>The source of origin.-1) changes: instances/{instance}/databases/{database}/changelogs/{changelog}.-2) raw SQL if empty. </p></td>+ <td><p>The source where this change originated from.+Format: instances/{instance}/databases/{database}/changelogs/{changelog} for changes from changelog.+Empty for raw SQL changes. </p></td></tr></tbody>@@ -2652,7 +2641,7 @@ This information is not authenticated and should be treated accordingly. </p></t<td>ranges</td><td><a href="#bytebase.store.Range">Range</a></td><td>repeated</td>- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>+ <td><p>The ranges of substrings correspond to the statements on the sheet. </p></td></tr></tbody>@@ -2683,7 +2672,7 @@ This information is not authenticated and should be treated accordingly. </p></t<td>ranges</td><td><a href="#bytebase.store.Range">Range</a></td><td>repeated</td>- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>+ <td><p>The ranges of substrings correspond to the statements on the sheet. </p></td></tr></tbody>@@ -2766,14 +2755,14 @@ This information is not authenticated and should be treated accordingly. </p></t<td>table_rows</td><td><a href="#int64">int64</a></td><td></td>- <td><p>estimated row count of the table </p></td>+ <td><p>The estimated row count of the table. </p></td></tr><tr><td>ranges</td><td><a href="#bytebase.store.Range">Range</a></td><td>repeated</td>- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>+ <td><p>The ranges of substrings correspond to the statements on the sheet. </p></td></tr></tbody>@@ -2804,7 +2793,7 @@ This information is not authenticated and should be treated accordingly. </p></t<td>ranges</td><td><a href="#bytebase.store.Range">Range</a></td><td>repeated</td>- <td><p>The ranges of sub-strings correspond to the statements on the sheet. </p></td>+ <td><p>The ranges of substrings correspond to the statements on the sheet. </p></td></tr></tbody>@@ -2998,20 +2987,6 @@ Format: projects/{project}/sheets/{sheet} </p></td>- <div class="file-heading">- <h2 id="store/data_source.proto">store/data_source.proto</h2><a href="#title">Top</a>- </div>- <p></p>----------<div class="file-heading"><h2 id="store/database.proto">store/database.proto</h2><a href="#title">Top</a></div>@@ -3077,7 +3052,7 @@ Format: projects/{project}/sheets/{sheet} </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>+ <td><p>The name of the check constraint. </p></td></tr><tr>@@ -3108,7 +3083,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a column. </p></td>+ <td><p>The name of the column. </p></td></tr><tr>@@ -3212,7 +3187,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a column. </p></td>+ <td><p>The name of the column. </p></td></tr><tr>@@ -3226,7 +3201,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>default</td><td><a href="#string">string</a></td><td></td>- <td><p>The default value of column. </p></td>+ <td><p>The default value of the column. </p></td></tr><tr>@@ -3444,7 +3419,7 @@ from SQL files), the system cannot automatically drop the constraint. </p></td><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>+ <td><p>The schema has drifted from the source of truth. </p></td></tr><tr>@@ -3513,28 +3488,28 @@ from SQL files), the system cannot automatically drop the constraint. </p></td><td>schemas</td><td><a href="#bytebase.store.SchemaMetadata">SchemaMetadata</a></td><td>repeated</td>- <td><p>The schemas is the list of schemas in a database. </p></td>+ <td><p>The list of schemas in a database. </p></td></tr><tr><td>character_set</td><td><a href="#string">string</a></td><td></td>- <td><p>The character_set is the character set of a database. </p></td>+ <td><p>The character set of the database. </p></td></tr><tr><td>collation</td><td><a href="#string">string</a></td><td></td>- <td><p>The collation is the collation of a database. </p></td>+ <td><p>The collation of the database. </p></td></tr><tr><td>extensions</td><td><a href="#bytebase.store.ExtensionMetadata">ExtensionMetadata</a></td><td>repeated</td>- <td><p>The extensions is the list of extensions in a database. </p></td>+ <td><p>The list of extensions in a database. </p></td></tr><tr>@@ -3548,7 +3523,7 @@ from SQL files), the system cannot automatically drop the constraint. </p></td><td>service_name</td><td><a href="#string">string</a></td><td></td>- <td><p>The service name of the database. It's the Oracle specific concept. </p></td>+ <td><p>The service name of the database. It's an Oracle-specific concept. </p></td></tr><tr>@@ -3717,14 +3692,14 @@ Examples: POINT, LINE, POLYGON, COLLECTION </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of a type. </p></td>+ <td><p>The name of the enum 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>The enum values of the type. </p></td></tr><tr>@@ -3828,14 +3803,14 @@ Examples: POINT, LINE, POLYGON, COLLECTION </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of an extension. </p></td>+ <td><p>The name of the 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+ <td><p>The schema where the extension is installed. However, the extension usageis not limited to the schema. </p></td></tr>@@ -3874,7 +3849,7 @@ is not limited to the schema. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a external table. </p></td>+ <td><p>The name of the external table. </p></td></tr><tr>@@ -3919,7 +3894,7 @@ is not limited to the schema. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a foreign key. </p></td>+ <td><p>The name of the foreign key. </p></td></tr><tr>@@ -3995,7 +3970,7 @@ It's empty string for other databases. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a function. </p></td>+ <td><p>The name of the function. </p></td></tr><tr>@@ -4146,7 +4121,7 @@ For PostgreSQL, it'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 is the name of an index. </p></td>+ <td><p>The name of the index. </p></td></tr><tr>@@ -4161,15 +4136,15 @@ This could refer to a column or an expression. </p></td><td>key_length</td><td><a href="#int64">int64</a></td><td>repeated</td>- <td><p>The key_lengths are the ordered key lengths of an index.-If the key length is not specified, it's -1. </p></td>+ <td><p>The ordered list of key lengths for the index.+If the key length is not specified, it is -1. </p></td></tr><tr><td>descending</td><td><a href="#bool">bool</a></td><td>repeated</td>- <td><p>The descending is the ordered descending of an index. </p></td>+ <td><p>The ordered list of descending flags for the index columns. </p></td></tr><tr>@@ -4356,7 +4331,7 @@ engine. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a view. </p></td>+ <td><p>The name of the materialized view. </p></td></tr><tr>@@ -4377,21 +4352,21 @@ engine. </p></td><td>dependency_columns</td><td><a href="#bytebase.store.DependencyColumn">DependencyColumn</a></td><td>repeated</td>- <td><p>The dependency_columns is the list of dependency columns of a view. </p></td>+ <td><p>The list of dependency columns of the view. </p></td></tr><tr><td>triggers</td><td><a href="#bytebase.store.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td>- <td><p>The columns is the ordered list of columns in a table. </p></td>+ <td><p>The ordered list of columns in the materialized view. </p></td></tr><tr><td>indexes</td><td><a href="#bytebase.store.IndexMetadata">IndexMetadata</a></td><td>repeated</td>- <td><p>The indexes is the list of indexes in a table. </p></td>+ <td><p>The list of indexes in the materialized view. </p></td></tr><tr>@@ -4546,7 +4521,7 @@ engine. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a package. </p></td>+ <td><p>The name of the package. </p></td></tr><tr>@@ -4577,7 +4552,7 @@ engine. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a procedure. </p></td>+ <td><p>The name of the procedure. </p></td></tr><tr>@@ -4658,28 +4633,28 @@ function takes. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of the rule. </p></td>+ <td><p>The name of the rule. </p></td></tr><tr><td>event</td><td><a href="#string">string</a></td><td></td>- <td><p>The event is the event type of the rule: SELECT, INSERT, UPDATE, or DELETE. </p></td>+ <td><p>The event type of the rule: SELECT, INSERT, UPDATE, or DELETE. </p></td></tr><tr><td>condition</td><td><a href="#string">string</a></td><td></td>- <td><p>The condition is the WHERE condition of the rule (optional). </p></td>+ <td><p>The WHERE condition of the rule (optional). </p></td></tr><tr><td>action</td><td><a href="#string">string</a></td><td></td>- <td><p>The action is the command(s) to execute when the rule fires. </p></td>+ <td><p>The command(s) to execute when the rule fires. </p></td></tr><tr>@@ -4700,7 +4675,7 @@ function takes. </p></td><td>definition</td><td><a href="#string">string</a></td><td></td>- <td><p>The definition is the full CREATE RULE statement. </p></td>+ <td><p>The full CREATE RULE statement. </p></td></tr></tbody>@@ -4724,7 +4699,7 @@ function takes. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the schema name.+ <td><p>The schema name.It is an empty string for databases without such concept such as MySQL. </p></td></tr>@@ -4756,7 +4731,7 @@ It is an empty string for databases without such concept such as MySQL. </p></td<td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the schema name.+ <td><p>The schema name.It is an empty string for databases without such concept such as MySQL. </p></td></tr>@@ -4764,72 +4739,70 @@ It is an empty string for databases without such concept such as MySQL. </p></td<td>tables</td><td><a href="#bytebase.store.TableMetadata">TableMetadata</a></td><td>repeated</td>- <td><p>The tables is the list of tables in a schema. </p></td>+ <td><p>The list of tables in a schema. </p></td></tr><tr><td>external_tables</td><td><a href="#bytebase.store.ExternalTableMetadata">ExternalTableMetadata</a></td><td>repeated</td>- <td><p>The external_tables is the list of external tables in a schema. </p></td>+ <td><p>The list of external tables in a schema. </p></td></tr><tr><td>views</td><td><a href="#bytebase.store.ViewMetadata">ViewMetadata</a></td><td>repeated</td>- <td><p>The views is the list of views in a schema. </p></td>+ <td><p>The list of views in a schema. </p></td></tr><tr><td>functions</td><td><a href="#bytebase.store.FunctionMetadata">FunctionMetadata</a></td><td>repeated</td>- <td><p>The functions is the list of functions in a schema. </p></td>+ <td><p>The list of functions in a schema. </p></td></tr><tr><td>procedures</td><td><a href="#bytebase.store.ProcedureMetadata">ProcedureMetadata</a></td><td>repeated</td>- <td><p>The procedures is the list of procedures in a schema. </p></td>+ <td><p>The list of procedures in a schema. </p></td></tr><tr><td>streams</td><td><a href="#bytebase.store.StreamMetadata">StreamMetadata</a></td><td>repeated</td>- <td><p>The streams is the list of streams in a schema, currently, only used for-Snowflake. </p></td>+ <td><p>The list of streams in a schema, currently only used for Snowflake. </p></td></tr><tr><td>tasks</td><td><a href="#bytebase.store.TaskMetadata">TaskMetadata</a></td><td>repeated</td>- <td><p>The routines is the list of routines in a schema, currently, only used for-Snowflake. </p></td>+ <td><p>The list of tasks in a schema, currently only used for Snowflake. </p></td></tr><tr><td>materialized_views</td><td><a href="#bytebase.store.MaterializedViewMetadata">MaterializedViewMetadata</a></td><td>repeated</td>- <td><p>The materialized_views is the list of materialized views in a schema. </p></td>+ <td><p>The list of materialized views in a schema. </p></td></tr><tr><td>sequences</td><td><a href="#bytebase.store.SequenceMetadata">SequenceMetadata</a></td><td>repeated</td>- <td><p>The sequences is the list of sequences in a schema. </p></td>+ <td><p>The list of sequences in a schema. </p></td></tr><tr><td>packages</td><td><a href="#bytebase.store.PackageMetadata">PackageMetadata</a></td><td>repeated</td>- <td><p>The packages is the list of packages in a schema. </p></td>+ <td><p>The list of packages in a schema. </p></td></tr><tr>@@ -4923,14 +4896,14 @@ Snowflake. </p></td><td>increment</td><td><a href="#string">string</a></td><td></td>- <td><p>Increment value of a sequence. </p></td>+ <td><p>The increment value of a sequence. </p></td></tr><tr><td>cycle</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Cycle is whether the sequence cycles. </p></td>+ <td><p>Whether the sequence cycles. </p></td></tr><tr>@@ -4944,21 +4917,21 @@ Snowflake. </p></td><td>last_value</td><td><a href="#string">string</a></td><td></td>- <td><p>Last value of a sequence. </p></td>+ <td><p>The 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>+ <td><p>The table that owns 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>+ <td><p>The column that owns the sequence. </p></td></tr><tr>@@ -5197,7 +5170,7 @@ Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST"<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 stream. </p></td></tr><tr>@@ -5270,7 +5243,7 @@ Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST"<td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a table. </p></td>+ <td><p>The name of the table. </p></td></tr><tr>@@ -5315,7 +5288,7 @@ Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST"<td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a table. </p></td>+ <td><p>The name of the table. </p></td></tr><tr>@@ -5350,7 +5323,7 @@ Examples: "SPATIAL" (MySQL/SQL Server), "GIST"/"SPGIST"<td>charset</td><td><a href="#string">string</a></td><td></td>- <td><p>The character set of table. </p></td>+ <td><p>The character set of the table. </p></td></tr><tr>@@ -5496,7 +5469,7 @@ CLUSTERED or NONCLUSTERED. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a table partition. </p></td>+ <td><p>The name of the table partition. </p></td></tr><tr>@@ -5588,15 +5561,15 @@ in syntax [SUB]PARTITION {number}. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a task. </p></td>+ <td><p>The name of the task. </p></td></tr><tr><td>id</td><td><a href="#string">string</a></td><td></td>- <td><p>The id is the snowflake-generated id of a task.-Example: 01ad32a0-1bb6-5e93-0000-000000000001 </p></td>+ <td><p>The Snowflake-generated ID of the task.+Example: 01ad32a0-1bb6-5e93-0000-000000000001. </p></td></tr><tr>@@ -5722,29 +5695,28 @@ Examples: GEOMETRY_GRID, GEOGRAPHY_GRID, GEOMETRY_AUTO_GRID, GEOGRAPHY_AUTO_GRID<td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of the trigger. </p></td>+ <td><p>The name of the 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>+ <td><p>The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE. </p></td></tr><tr><td>timing</td><td><a href="#string">string</a></td><td></td>- <td><p>The timing is the timing of the trigger, such as BEFORE, AFTER. </p></td>+ <td><p>The timing of when the trigger fires, such as BEFORE or AFTER. </p></td></tr><tr><td>body</td><td><a href="#string">string</a></td><td></td>- <td><p>The body is the body of the trigger. </p></td>+ <td><p>The body of the trigger. </p></td></tr><tr>@@ -5803,7 +5775,7 @@ TRUNCATE. </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name is the name of a view. </p></td>+ <td><p>The name of the view. </p></td></tr><tr>@@ -5824,21 +5796,21 @@ TRUNCATE. </p></td><td>dependency_columns</td><td><a href="#bytebase.store.DependencyColumn">DependencyColumn</a></td><td>repeated</td>- <td><p>The dependency_columns is the list of dependency columns of a view. </p></td>+ <td><p>The list of dependency columns of a view. </p></td></tr><tr><td>columns</td><td><a href="#bytebase.store.ColumnMetadata">ColumnMetadata</a></td><td>repeated</td>- <td><p>The columns is the ordered list of columns in a table. </p></td>+ <td><p>The ordered list of columns in the view. </p></td></tr><tr><td>triggers</td><td><a href="#bytebase.store.TriggerMetadata">TriggerMetadata</a></td><td>repeated</td>- <td><p>The triggers is the list of triggers in a view. </p></td>+ <td><p>The list of triggers in the view. </p></td></tr><tr>@@ -6028,7 +6000,7 @@ TRUNCATE. </p></td></table><h3 id="bytebase.store.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>+ <p>The type is the type of a table partition. Some database engines may not</p><p>support all types. Only available 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>@@ -6206,7 +6178,7 @@ TRUNCATE. </p></td><td>member</td><td><a href="#string">string</a></td><td></td>- <td><p>Member is the principal who belong to this group.+ <td><p>Member is the principal who belongs to this group.Format: users/{userUID}. </p></td></tr>@@ -6246,7 +6218,7 @@ Format: users/{userUID}. </p></td><td>source</td><td><a href="#string">string</a></td><td></td>- <td><p>source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td>+ <td><p>The source indicates where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td></tr></tbody>@@ -6758,7 +6730,7 @@ as application/x-www-form-urlencoded parameters.</p></td><tr><td>IN_HEADER</td><td>2</td>- <td><p>IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.+ <td><p>IN_HEADER sends the client_id and client_secret using HTTP Basic Authorization.This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></td></tr>@@ -6826,7 +6798,7 @@ This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.</p></t<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>+ <td><p>Use SSL to connect to the data source. By default, we use the system's SSL configuration. </p></td></tr><tr>@@ -6907,7 +6879,7 @@ validated (e.g., self-signed certs, VPN environments). </p></td><td>srv</td><td><a href="#bool">bool</a></td><td></td>- <td><p>srv, authentication_database and replica_set are used for MongoDB.+ <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>@@ -7064,7 +7036,7 @@ Used for authentication when connecting to the data source. </p></td><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>+ <td><p>Region is the location of the database, used for AWS RDS. For example, us-east-1. </p></td></tr><tr>@@ -7438,7 +7410,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e<td>secret_id</td><td><a href="#string">string</a></td><td></td>- <td><p>the secret id for the role without ttl. </p></td>+ <td><p>The secret ID for the role without TTL. </p></td></tr><tr>@@ -7518,7 +7490,7 @@ See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_e<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>+ <td><p>The interval between automatic instance synchronizations. </p></td></tr><tr>@@ -7533,7 +7505,7 @@ The default is 10 if the value is unset or zero. </p></td><td>sync_databases</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p>Enable sync for following databases.+ <td><p>Enable sync for the following databases.Default empty, means sync all schemas & databases. </p></td></tr>@@ -7641,8 +7613,8 @@ For example, { "org_group": "infrastructure", "environment&#<td><a href="#string">string</a></td><td>optional</td><td><p>The role attribute.-For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html-For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td>+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 is the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td></tr></tbody>@@ -7887,7 +7859,7 @@ For MySQL, it's the global privileges as GRANT statements, which means it on<tbody><tr>- <td>SAECRET_TYPE_UNSPECIFIED</td>+ <td>SECRET_TYPE_UNSPECIFIED</td><td>0</td><td><p></p></td></tr>@@ -7993,7 +7965,7 @@ For MySQL, it's the global privileges as GRANT statements, which means it on<h3 id="bytebase.store.GrantRequest">GrantRequest</h3>- <p></p>+ <p>GrantRequest contains details for requesting database access permissions.</p><table class="field-table">@@ -8006,7 +7978,7 @@ For MySQL, it's the global privileges as GRANT statements, which means it on<td>role</td><td><a href="#string">string</a></td><td></td>- <td><p>The requested role.+ <td><p>The role being requested for the user.Format: roles/EXPORTER. </p></td></tr>@@ -8014,7 +7986,7 @@ Format: roles/EXPORTER. </p></td><td>user</td><td><a href="#string">string</a></td><td></td>- <td><p>The user to be granted.+ <td><p>The user who will receive the role.Format: users/{userUID}. </p></td></tr>@@ -8022,14 +7994,14 @@ Format: users/{userUID}. </p></td><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td>- <td><p> </p></td>+ <td><p>Optional conditional expression that limits when the grant applies. </p></td></tr><tr><td>expiration</td><td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td><td></td>- <td><p> </p></td>+ <td><p>Duration after which the grant automatically expires. </p></td></tr></tbody>@@ -8040,7 +8012,7 @@ Format: users/{userUID}. </p></td><h3 id="bytebase.store.Issue">Issue</h3>- <p></p>+ <p>Issue is the metadata for issues that track database operations and access requests.</p><table class="field-table">@@ -8053,21 +8025,21 @@ Format: users/{userUID}. </p></td><td>approval</td><td><a href="#bytebase.store.IssuePayloadApproval">IssuePayloadApproval</a></td><td></td>- <td><p> </p></td>+ <td><p>Approval information for the issue workflow. </p></td></tr><tr><td>grant_request</td><td><a href="#bytebase.store.GrantRequest">GrantRequest</a></td><td></td>- <td><p> </p></td>+ <td><p>Access grant request details if this is a grant request issue. </p></td></tr><tr><td>labels</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Labels attached to categorize and filter the issue. </p></td></tr></tbody>@@ -8080,7 +8052,7 @@ Format: users/{userUID}. </p></td><h3 id="bytebase.store.Issue.Status">Issue.Status</h3>- <p></p>+ <p>Status represents the current state of the issue.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -8096,26 +8068,26 @@ Format: users/{userUID}. </p></td><tr><td>OPEN</td><td>1</td>- <td><p></p></td>+ <td><p>Issue is open and pending action.</p></td></tr><tr><td>DONE</td><td>2</td>- <td><p></p></td>+ <td><p>Issue has been completed successfully.</p></td></tr><tr><td>CANCELED</td><td>3</td>- <td><p></p></td>+ <td><p>Issue was canceled and will not be completed.</p></td></tr></tbody></table><h3 id="bytebase.store.Issue.Type">Issue.Type</h3>- <p></p>+ <p>Type represents the category of issue.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -8131,19 +8103,19 @@ Format: users/{userUID}. </p></td><tr><td>DATABASE_CHANGE</td><td>1</td>- <td><p></p></td>+ <td><p>Issue for database schema or data changes.</p></td></tr><tr><td>GRANT_REQUEST</td><td>2</td>- <td><p></p></td>+ <td><p>Issue requesting database access permissions.</p></td></tr><tr><td>DATABASE_EXPORT</td><td>3</td>- <td><p></p></td>+ <td><p>Issue for exporting data from databases.</p></td></tr></tbody>@@ -8914,8 +8886,8 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>password</td><td><a href="#string">string</a></td><td>optional</td>- <td><p>The zip password provide by users.-Leave it empty if no needs to encrypt the zip file. </p></td>+ <td><p>The zip password provided by users.+Leave it empty if there is no need to encrypt the zip file. </p></td></tr></tbody>@@ -9284,7 +9256,7 @@ Leave it empty if no needs to encrypt the zip file. </p></td><td>start_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td>- <td><p>1-based Position of the SQL statement.+ <td><p>1-based position of the SQL statement.To supersede `line` and `column` above. </p></td></tr>@@ -9316,7 +9288,7 @@ To supersede `line` and `column` above. </p></td><td>statement_types</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p>statement_types are the types of statements that are found in the sql. </p></td>+ <td><p>statement_types are the types of statements found in the SQL. </p></td></tr><tr>@@ -9611,14 +9583,14 @@ A binding binds one or more members or groups to a single role. </p></td><td>action</td><td><a href="#bytebase.store.MaskingExceptionPolicy.MaskingException.Action">MaskingExceptionPolicy.MaskingException.Action</a></td><td></td>- <td><p>action is the action that the user can access sensitive data. </p></td>+ <td><p>action is the action by which the user can access sensitive data. </p></td></tr><tr><td>member</td><td><a href="#string">string</a></td><td></td>- <td><p>Member is the principal who bind to this exception policy instance.+ <td><p>Member is the principal who binds to this exception policy instance.Format: users/{userUID} or groups/{group email} </p></td></tr>@@ -9727,7 +9699,7 @@ Format: users/{userUID} or groups/{group email} </p></td><td>disable_export</td><td><a href="#bool">bool</a></td><td></td>- <td><p>Disable export data in the SQL editor </p></td>+ <td><p>Disable exporting data in the SQL editor. </p></td></tr><tr>@@ -9920,8 +9892,8 @@ These checks are performed in UI workflows only. </p></td><td>tags</td><td><a href="#bytebase.store.TagPolicy.TagsEntry">TagPolicy.TagsEntry</a></td><td>repeated</td>- <td><p>tags is the key - value map for resources.-for example, the environment resource can have the sql review config tag, like "bb.tag.review_config": "reviewConfigs/{review config resource id}" </p></td>+ <td><p>tags is the key-value map for resources.+For example, the environment resource can have the SQL review config tag, such as "bb.tag.review_config": "reviewConfigs/{review config resource id}". </p></td></tr></tbody>@@ -10222,7 +10194,7 @@ for example, the environment resource can have the sql review config tag, like &<h3 id="bytebase.store.Label">Label</h3>- <p></p>+ <p>Label represents a categorization tag that can be applied to issues.</p><table class="field-table">@@ -10235,21 +10207,21 @@ for example, the environment resource can have the sql review config tag, like &<td>value</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The display text of the label. </p></td></tr><tr><td>color</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>The color for the label in hex format (e.g., "#FF0000"). </p></td></tr><tr><td>group</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Optional group name for organizing related labels. </p></td></tr></tbody>@@ -10260,7 +10232,7 @@ for example, the environment resource can have the sql review config tag, like &<h3 id="bytebase.store.Project">Project</h3>- <p></p>+ <p>Project contains settings and configuration for a Bytebase project.</p><table class="field-table">@@ -10273,7 +10245,7 @@ for example, the environment resource can have the sql review config tag, like &<td>issue_labels</td><td><a href="#bytebase.store.Label">Label</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>Available labels that can be applied to issues in this project. </p></td></tr><tr>@@ -10337,7 +10309,7 @@ If enabled, the issue will be created with the prepend "set role <db_owne<td>execution_retry_policy</td><td><a href="#bytebase.store.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</a></td><td></td>- <td><p>Execution retry policy for the task run. </p></td>+ <td><p>Configuration for automatic retry on task execution failures. </p></td></tr><tr>@@ -10345,7 +10317,7 @@ If enabled, the issue will be created with the prepend "set role <db_owne<td><a href="#int32">int32</a></td><td></td><td><p>The maximum number of databases to sample during CI data validation.-Without specification, sampling is disabled, resulting in a full validation. </p></td>+If not specified, sampling is disabled, resulting in a full validation. </p></td></tr><tr>@@ -10379,7 +10351,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td><h3 id="bytebase.store.Project.ExecutionRetryPolicy">Project.ExecutionRetryPolicy</h3>- <p></p>+ <p>ExecutionRetryPolicy defines retry behavior for failed task executions.</p><table class="field-table">@@ -10392,7 +10364,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td><td>maximum_retries</td><td><a href="#int32">int32</a></td><td></td>- <td><p>The maximum number of retries for the lock timeout issue. </p></td>+ <td><p>The maximum number of retry attempts for lock timeout errors. </p></td></tr></tbody>@@ -10461,7 +10433,7 @@ If enabled, issues cannot be created when SQL review finds errors. </p></td><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+ <td><p>If direct_message is set, the notification is sent directlyto the persons and url will be ignored.IM integration setting should be set for this function to work. </p></td></tr>@@ -10591,7 +10563,7 @@ IM integration setting should be set for this function to work. </p></td><td>path</td><td><a href="#string">string</a></td><td></td>- <td><p>The path of the file. e.g. `2.2/V0001_create_table.sql`. </p></td>+ <td><p>The path of the file, e.g., `2.2/V0001_create_table.sql`. </p></td></tr><tr>@@ -11204,14 +11176,14 @@ But frontend can be started with a single rule easily. </p></td><td>level</td><td><a href="#bytebase.store.Announcement.AlertLevel">Announcement.AlertLevel</a></td><td></td>- <td><p>The alert level of announcemnt </p></td>+ <td><p>The alert level of the announcement. </p></td></tr><tr><td>text</td><td><a href="#string">string</a></td><td></td>- <td><p>The text of announcemnt </p></td>+ <td><p>The text of the announcement. </p></td></tr><tr>@@ -11788,35 +11760,35 @@ are /[a-z][0-9]-/. </p></td><td>min_length</td><td><a href="#int32">int32</a></td><td></td>- <td><p>min_length is the minimum length for password, should no less than 8. </p></td>+ <td><p>min_length is the minimum length for password, should be no less than 8. </p></td></tr><tr><td>require_number</td><td><a href="#bool">bool</a></td><td></td>- <td><p>require_number requires the password must contains at least one number. </p></td>+ <td><p>require_number requires the password must contain at least one number. </p></td></tr><tr><td>require_letter</td><td><a href="#bool">bool</a></td><td></td>- <td><p>require_letter requires the password must contains at least one letter, regardless of upper case or lower case </p></td>+ <td><p>require_letter requires the password must contain 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>+ <td><p>require_uppercase_letter requires the password must contain 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_uppercase_letter requires the password must contains at least one special character. </p></td>+ <td><p>require_special_character requires the password must contain at least one special character. </p></td></tr><tr>@@ -12231,7 +12203,7 @@ are /[a-z][0-9]-/. </p></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>+ <td><p>The workspace domain, e.g., bytebase.com. </p></td></tr><tr>@@ -12608,7 +12580,7 @@ Default to this mode.</p></td><h3 id="bytebase.store.Task">Task</h3>- <p></p>+ <p>Task is the metadata for database operation tasks.</p><table class="field-table">@@ -12621,112 +12593,112 @@ Default to this mode.</p></td><td>skipped</td><td><a href="#bool">bool</a></td><td></td>- <td><p>common fields </p></td>+ <td><p>Whether the task was skipped during execution. </p></td></tr><tr><td>skipped_reason</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Reason why the task was skipped. </p></td></tr><tr><td>spec_id</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>UUID that identifies the spec this task implements. </p></td></tr><tr><td>sheet_id</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>The sheet ID containing SQL statements for this task. </p></td></tr><tr><td>environment_id</td><td><a href="#string">string</a></td><td></td>- <td><p>Create database fields. </p></td>+ <td><p>The environment where the database will be created. </p></td></tr><tr><td>database_name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Name of the database to create. </p></td></tr><tr><td>table_name</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Optional table name to create (required for some databases like MongoDB). </p></td></tr><tr><td>character_set</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Character set for the new database. </p></td></tr><tr><td>collation</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Collation for the new database. </p></td></tr><tr><td>schema_version</td><td><a href="#string">string</a></td><td></td>- <td><p>Update database fields. </p></td>+ <td><p>Schema version after migration is applied. </p></td></tr><tr><td>enable_prior_backup</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Whether to create an automatic backup before applying changes. </p></td></tr><tr><td>flags</td><td><a href="#bytebase.store.Task.FlagsEntry">Task.FlagsEntry</a></td><td>repeated</td>- <td><p>ghost flags. </p></td>+ <td><p>Configuration flags for gh-ost migration tool. </p></td></tr><tr><td>task_release_source</td><td><a href="#bytebase.store.TaskReleaseSource">TaskReleaseSource</a></td><td></td>- <td><p> </p></td>+ <td><p>Source information if task is created from a release. </p></td></tr><tr><td>migrate_type</td><td><a href="#bytebase.store.Task.MigrateType">Task.MigrateType</a></td><td></td>- <td><p> </p></td>+ <td><p>The type of migration (DDL, DML, or GHOST). </p></td></tr><tr><td>password</td><td><a href="#string">string</a></td><td></td>- <td><p>Export data fields. </p></td>+ <td><p>Password to encrypt the exported data archive. </p></td></tr><tr><td>format</td><td><a href="#bytebase.store.ExportFormat">ExportFormat</a></td><td></td>- <td><p> </p></td>+ <td><p>Format of the exported data (SQL, CSV, JSON, etc). </p></td></tr></tbody>@@ -12768,7 +12740,7 @@ Default to this mode.</p></td><h3 id="bytebase.store.TaskReleaseSource">TaskReleaseSource</h3>- <p></p>+ <p>TaskReleaseSource contains information about the release file this task originated from.</p><table class="field-table">@@ -12781,7 +12753,8 @@ Default to this mode.</p></td><td>file</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: projects/{project}/releases/{release}/files/{id} </p></td>+ <td><p>Resource name of the release file.+Format: projects/{project}/releases/{release}/files/{id} </p></td></tr></tbody>@@ -12794,7 +12767,7 @@ Default to this mode.</p></td><h3 id="bytebase.store.Task.MigrateType">Task.MigrateType</h3>- <p>MigrateType is the database migration type.</p>+ <p>MigrateType is the database migration type for imperative migrations.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -12810,26 +12783,26 @@ Default to this mode.</p></td><tr><td>DDL</td><td>1</td>- <td><p></p></td>+ <td><p>DDL changes (Data Definition Language) for schema modifications.</p></td></tr><tr><td>DML</td><td>2</td>- <td><p></p></td>+ <td><p>DML changes (Data Manipulation Language) for data modifications.</p></td></tr><tr><td>GHOST</td><td>3</td>- <td><p></p></td>+ <td><p>Online schema migration using gh-ost tool.</p></td></tr></tbody></table><h3 id="bytebase.store.Task.Type">Task.Type</h3>- <p></p>+ <p>Type represents the type of database operation to perform.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -12845,25 +12818,25 @@ Default to this mode.</p></td><tr><td>DATABASE_CREATE</td><td>1</td>- <td><p></p></td>+ <td><p>Create a new database.</p></td></tr><tr><td>DATABASE_MIGRATE</td><td>2</td>- <td><p></p></td>+ <td><p>Apply schema/data migrations to an existing database.</p></td></tr><tr><td>DATABASE_EXPORT</td><td>5</td>- <td><p></p></td>+ <td><p>Export data from a database.</p></td></tr><tr><td>DATABASE_SDL</td><td>6</td>- <td><p></p></td>+ <td><p>Apply declarative schema changes (state-based migration).</p></td></tr></tbody>@@ -12882,7 +12855,7 @@ Default to this mode.</p></td><h3 id="bytebase.store.PriorBackupDetail">PriorBackupDetail</h3>- <p></p>+ <p>PriorBackupDetail contains information about automatic backups created before migration.</p><table class="field-table">@@ -12895,7 +12868,7 @@ Default to this mode.</p></td><td>items</td><td><a href="#bytebase.store.PriorBackupDetail.Item">PriorBackupDetail.Item</a></td><td>repeated</td>- <td><p> </p></td>+ <td><p>List of backup operations performed. </p></td></tr></tbody>@@ -12906,7 +12879,7 @@ Default to this mode.</p></td><h3 id="bytebase.store.PriorBackupDetail.Item">PriorBackupDetail.Item</h3>- <p></p>+ <p>Item represents a single backup operation for a table.</p><table class="field-table">@@ -12919,28 +12892,28 @@ Default to this mode.</p></td><td>source_table</td><td><a href="#bytebase.store.PriorBackupDetail.Item.Table">PriorBackupDetail.Item.Table</a></td><td></td>- <td><p>The original table information. </p></td>+ <td><p>The original table that was backed up. </p></td></tr><tr><td>target_table</td><td><a href="#bytebase.store.PriorBackupDetail.Item.Table">PriorBackupDetail.Item.Table</a></td><td></td>- <td><p>The target backup table information. </p></td>+ <td><p>The backup table where data was copied. </p></td></tr><tr><td>start_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td>- <td><p> </p></td>+ <td><p>Starting position in SQL for this backup operation. </p></td></tr><tr><td>end_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td>- <td><p> </p></td>+ <td><p>Ending position in SQL for this backup operation. </p></td></tr></tbody>@@ -12951,7 +12924,7 @@ Default to this mode.</p></td><h3 id="bytebase.store.PriorBackupDetail.Item.Table">PriorBackupDetail.Item.Table</h3>- <p></p>+ <p>Table identifies a database table.</p><table class="field-table">@@ -12964,7 +12937,7 @@ Default to this mode.</p></td><td>database</td><td><a href="#string">string</a></td><td></td>- <td><p>The database information.+ <td><p>The database containing the table.Format: instances/{instance}/databases/{database} </p></td></tr>@@ -12972,14 +12945,14 @@ Format: instances/{instance}/databases/{database} </p></td><td>schema</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Schema name (for databases that support schemas). </p></td></tr><tr><td>table</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Table name. </p></td></tr></tbody>@@ -12990,7 +12963,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.store.SchedulerInfo">SchedulerInfo</h3>- <p></p>+ <p>SchedulerInfo contains information about task scheduling and execution delays.</p><table class="field-table">@@ -13003,14 +12976,14 @@ Format: instances/{instance}/databases/{database} </p></td><td>report_time</td><td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td><td></td>- <td><p> </p></td>+ <td><p>Timestamp when the scheduler reported this information. </p></td></tr><tr><td>waiting_cause</td><td><a href="#bytebase.store.SchedulerInfo.WaitingCause">SchedulerInfo.WaitingCause</a></td><td></td>- <td><p> </p></td>+ <td><p>Reason why the task run is currently waiting. </p></td></tr></tbody>@@ -13021,7 +12994,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.store.SchedulerInfo.WaitingCause">SchedulerInfo.WaitingCause</h3>- <p></p>+ <p>WaitingCause indicates why a task run is waiting to execute.</p><table class="field-table">@@ -13034,21 +13007,21 @@ Format: instances/{instance}/databases/{database} </p></td><td>connection_limit</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Task is waiting due to database connection limit. </p></td></tr><tr><td>task_uid</td><td><a href="#int32">int32</a></td><td></td>- <td><p> </p></td>+ <td><p>Task is waiting for another task to complete. </p></td></tr><tr><td>parallel_tasks_limit</td><td><a href="#bool">bool</a></td><td></td>- <td><p> </p></td>+ <td><p>Task is waiting due to parallel execution limit. </p></td></tr></tbody>@@ -13059,14 +13032,14 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.store.TaskRun">TaskRun</h3>- <p></p>+ <p>TaskRun represents an execution attempt of a task.</p><h3 id="bytebase.store.TaskRunResult">TaskRunResult</h3>- <p></p>+ <p>TaskRunResult contains the outcome and metadata from a task run execution.</p><table class="field-table">@@ -13079,49 +13052,50 @@ Format: instances/{instance}/databases/{database} </p></td><td>detail</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Detailed execution information or error message. </p></td></tr><tr><td>changelog</td><td><a href="#string">string</a></td><td></td>- <td><p>Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td>+ <td><p>Resource name of the changelog entry created by this run.+Format: instances/{instance}/databases/{database}/changelogs/{changelog} </p></td></tr><tr><td>version</td><td><a href="#string">string</a></td><td></td>- <td><p> </p></td>+ <td><p>Schema version after the migration was applied. </p></td></tr><tr><td>start_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td>- <td><p>The following fields are used for error reporting. </p></td>+ <td><p>Starting position in the SQL statement where an error occurred. </p></td></tr><tr><td>end_position</td><td><a href="#bytebase.store.Position">Position</a></td><td></td>- <td><p> </p></td>+ <td><p>Ending position in the SQL statement where an error occurred. </p></td></tr><tr><td>export_archive_uid</td><td><a href="#int32">int32</a></td><td></td>- <td><p>The uid of the export archive. </p></td>+ <td><p>UID of the export archive generated for export tasks. </p></td></tr><tr><td>prior_backup_detail</td><td><a href="#bytebase.store.PriorBackupDetail">PriorBackupDetail</a></td><td></td>- <td><p>The prior backup detail that will be used to rollback the task run. </p></td>+ <td><p>Backup details that can be used to rollback changes. </p></td></tr></tbody>@@ -13134,7 +13108,7 @@ Format: instances/{instance}/databases/{database} </p></td><h3 id="bytebase.store.TaskRun.Status">TaskRun.Status</h3>- <p></p>+ <p>Status represents the current execution state of a task run.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -13150,43 +13124,43 @@ Format: instances/{instance}/databases/{database} </p></td><tr><td>PENDING</td><td>1</td>- <td><p></p></td>+ <td><p>Task run is queued and waiting to execute.</p></td></tr><tr><td>RUNNING</td><td>2</td>- <td><p></p></td>+ <td><p>Task run is currently executing.</p></td></tr><tr><td>DONE</td><td>3</td>- <td><p></p></td>+ <td><p>Task run completed successfully.</p></td></tr><tr><td>FAILED</td><td>4</td>- <td><p></p></td>+ <td><p>Task run encountered an error and failed.</p></td></tr><tr><td>CANCELED</td><td>5</td>- <td><p></p></td>+ <td><p>Task run was canceled by user or system.</p></td></tr><tr><td>NOT_STARTED</td><td>6</td>- <td><p></p></td>+ <td><p>Task run has not started yet.</p></td></tr><tr><td>SKIPPED</td><td>7</td>- <td><p></p></td>+ <td><p>Task run was skipped and will not execute.</p></td></tr></tbody>@@ -13668,13 +13642,13 @@ The indexes of the executed commands. </p></td><tr><td>RUNNING_WAITING</td><td>1</td>- <td><p>the task run is ready to be executed by the scheduler</p></td>+ <td><p>The task run is ready to be executed by the scheduler.</p></td></tr><tr><td>RUNNING_RUNNING</td><td>2</td>- <td><p>the task run is being executed by the scheduler</p></td>+ <td><p>The task run is being executed by the scheduler.</p></td></tr></tbody>@@ -13843,7 +13817,7 @@ The indexes of the executed commands. </p></td><td>temp_otp_secret</td><td><a href="#string">string</a></td><td></td>- <td><p>The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two phase commits. </p></td>+ <td><p>The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two-phase commits. </p></td></tr><tr>@@ -13857,7 +13831,7 @@ The indexes of the executed commands. </p></td><td>temp_recovery_codes</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p>The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two phase commits. </p></td>+ <td><p>The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two-phase commits. </p></td></tr></tbody>@@ -13895,7 +13869,7 @@ The indexes of the executed commands. </p></td><td>source</td><td><a href="#string">string</a></td><td></td>- <td><p>source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td>+ <td><p>The source indicates where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID. </p></td></tr></tbody>diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.mdindex e8825ef1a0..f1a6dc3816 100644--- a/proto/gen/grpc-doc/v1/README.md+++ b/proto/gen/grpc-doc/v1/README.md@@ -1195,7 +1195,7 @@ InstanceRole is the API message for instance role.| password | [string](#string) | optional | The role password. || connection_limit | [int32](#int32) | optional | The connection count limit for this role. || valid_until | [string](#string) | optional | The expiration for the role's password. |-| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |+| attribute | [string](#string) | optional | The role attribute. For PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html |@@ -1762,7 +1762,7 @@ For example: name == "sample instance" name.matches("sample") re| 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 instances will be synced. |+| 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. |@@ -2865,7 +2865,7 @@ ProcedureMetadata is the metadata for procedures.| ----- | ---- | ----- | ----------- || 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 function takes. |+| 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) | | |@@ -3529,7 +3529,7 @@ DatabaseService manages databases and their schemas.| ----- | ---- | ----- | ----------- || 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 condtion in IAM Binding message. |+| 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. |@@ -3816,7 +3816,7 @@ For example: creator == "users/[email protected]" && status in [&#| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the issue to add an rejection. Format: projects/{project}/issues/{issue} |+| 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. |@@ -4732,7 +4732,7 @@ For examples: (source == "DML" && level == 200) || (source == &#| 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. |+| 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) |@@ -5316,7 +5316,7 @@ IAM policy that binds members to roles.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || bindings | [Binding](#bytebase-v1-Binding) | repeated | Collection of binding. A binding binds one or more project members to a single project role. |-| etag | [string](#string) | | The current etag of the policy. If an etag is provided and does not match the current etag of the poliy, the call will be blocked and an ABORTED error will be returned. |+| 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. |@@ -5611,7 +5611,7 @@ Context for identity provider authentication.| 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 of successful login. |+| user | [User](#bytebase-v1-User) | | The user from the successful login. |@@ -5794,7 +5794,7 @@ A single change in a changelist.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| sheet | [string](#string) | | The sheet containing the SQL statement. |+| sheet | [string](#string) | | The sheet containing the SQL statement. Format: projects/{project}/sheets/{sheet} || source | [string](#string) | | The source of this change. Format: instances/{instance}/databases/{database}/changelogs/{changelog} If empty, the change is from raw SQL. |@@ -5860,10 +5860,10 @@ Request message for listing changelists.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || parent | [string](#string) | | The parent, which owns this collection of changelists. Format: projects/{project} |-| page_size | [int32](#int32) | | Pagination is not currently implemented. This field is reserved for future use. The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 50 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |-| page_token | [string](#string) | | Pagination is not currently implemented. This field is reserved for future use. A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page.+| page_size | [int32](#int32) | | Pagination is not currently implemented. This field is reserved for future use. The maximum number of changelists to return. The service may return fewer than this value. If unspecified, at most 50 changelists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |+| page_token | [string](#string) | | Pagination is not currently implemented. This field is reserved for future use. A page token, received from a previous `ListChangelists` 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. |+When paginating, all other parameters provided to `ListChangelists` must match the call that provided the page token. |@@ -6449,13 +6449,13 @@ LDAPIdentityProviderConfig is the structure for LDAP identity provider config.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g. "ldap.example.com". |-| port | [int32](#int32) | | Port is the port number of the LDAP server, e.g. 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS. |+| host | [string](#string) | | Host is the hostname or IP address of the LDAP server, e.g., "ldap.example.com". |+| port | [int32](#int32) | | Port is the port number of the LDAP server, e.g., 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS. || skip_tls_verify | [bool](#bool) | | SkipTLSVerify controls whether to skip TLS certificate verification. || bind_dn | [string](#string) | | BindDN is the DN of the user to bind as a service account to perform search requests. || bind_password | [string](#string) | | BindPassword is the password of the user to bind as a service account. |-| base_dn | [string](#string) | | BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com". |-| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g. "(uid=%s)". |+| base_dn | [string](#string) | | BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com". |+| user_filter | [string](#string) | | UserFilter is the filter to search for users, e.g., "(uid=%s)". || security_protocol | [LDAPIdentityProviderConfig.SecurityProtocol](#bytebase-v1-LDAPIdentityProviderConfig-SecurityProtocol) | | SecurityProtocol is the security protocol to be used for establishing connections with the LDAP server. || field_mapping | [FieldMapping](#bytebase-v1-FieldMapping) | | FieldMapping is the mapping of the user attributes returned by the LDAP server. |@@ -9037,7 +9037,7 @@ A SQL file in a release.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || id | [string](#string) | | The unique identifier for the file. |-| path | [string](#string) | | The path of the file. e.g. `2.2/V0001_create_table.sql`. |+| path | [string](#string) | | The path of the file. e.g., `2.2/V0001_create_table.sql`. || type | [Release.File.Type](#bytebase-v1-Release-File-Type) | | The type of the file. || version | [string](#string) | | The version identifier for the file. || migration_type | [Release.File.MigrationType](#bytebase-v1-Release-File-MigrationType) | | The migration type of the file. For versioned files, it is the migration type of the file. For declarative files, this field is always DDL, thus meaningless. |@@ -9062,7 +9062,7 @@ Version control system source information.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || vcs_type | [VCSType](#bytebase-v1-VCSType) | | The type of VCS. |-| url | [string](#string) | | The url link to the e.g. GitHub commit or pull request. |+| url | [string](#string) | | The url link to the e.g., GitHub commit or pull request. |@@ -9205,7 +9205,7 @@ ReleaseService manages releases for coordinating deployments.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The sql review to create. |+| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to create. |@@ -9220,7 +9220,7 @@ ReleaseService manages releases for coordinating deployments.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the sql review to delete. Format: reviewConfigs/{reviewConfig} |+| name | [string](#string) | | The name of the SQL review config to delete. Format: reviewConfigs/{reviewConfig} |@@ -9235,7 +9235,7 @@ ReleaseService manages releases for coordinating deployments.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the sql review to retrieve. Format: reviewConfigs/{reviewConfig} |+| name | [string](#string) | | The name of the SQL review config to retrieve. Format: reviewConfigs/{reviewConfig} |@@ -9250,7 +9250,7 @@ ReleaseService manages releases for coordinating deployments.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| page_size | [int32](#int32) | | Pagination is not currently implemented. This field is reserved for future use. The maximum number of sql review to return. The service may return fewer than this value. If unspecified, at most 10 sql review will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |+| page_size | [int32](#int32) | | Pagination is not currently implemented. This field is reserved for future use. The maximum number of SQL review configs to return. The service may return fewer than this value. If unspecified, at most 10 SQL review configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. || page_token | [string](#string) | | Pagination is not currently implemented. This field is reserved for future use. A page token, provide this to retrieve the subsequent page.When paginating, all other parameters provided to `ListReviewConfigs` must match the call that provided the page token. |@@ -9268,7 +9268,7 @@ When paginating, all other parameters provided to `ListReviewConfigs` must match| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| review_configs | [ReviewConfig](#bytebase-v1-ReviewConfig) | repeated | The sql review from the specified request. |+| review_configs | [ReviewConfig](#bytebase-v1-ReviewConfig) | repeated | The SQL review configs 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. |@@ -9284,11 +9284,11 @@ When paginating, all other parameters provided to `ListReviewConfigs` must match| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| name | [string](#string) | | The name of the sql review to retrieve. Format: reviewConfigs/{reviewConfig} |+| name | [string](#string) | | The name of the SQL review config. Format: reviewConfigs/{reviewConfig} || title | [string](#string) | | The title of the review configuration. || enabled | [bool](#bool) | | Whether the review configuration is enabled. || rules | [SQLReviewRule](#bytebase-v1-SQLReviewRule) | repeated | The SQL review rules to enforce. |-| resources | [string](#string) | repeated | resources using the config. Format: {resource}/{resource id}, for example, environments/test. |+| resources | [string](#string) | repeated | Resources using the config. Format: {resource}/{resource id}, e.g., environments/test. |@@ -9303,9 +9303,9 @@ When paginating, all other parameters provided to `ListReviewConfigs` must match| Field | Type | Label | Description || ----- | ---- | ----- | ----------- |-| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The sql review to update.+| review_config | [ReviewConfig](#bytebase-v1-ReviewConfig) | | The SQL review config to update.-The name field is used to identify the sql review to update. |+The name field is used to identify the SQL review config to update. || update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to update. || allow_missing | [bool](#bool) | | If set to true, and the config is not found, a new config will be created. In this situation, `update_mask` is ignored. |@@ -9616,7 +9616,7 @@ When paginating, all other parameters provided to `ListRisks` must match the cal| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | Format: risks/{risk} |-| source | [Risk.Source](#bytebase-v1-Risk-Source) | | |+| source | [Risk.Source](#bytebase-v1-Risk-Source) | | The source of the operation being assessed for risk. || title | [string](#string) | | The title of the risk rule. || level | [RiskLevel](#bytebase-v1-RiskLevel) | | The risk level assigned when this rule matches. || active | [bool](#bool) | | Whether the risk rule is active. |@@ -9661,16 +9661,16 @@ The risk's `name` field is used to identify the risk to update. Format: risk<a name="bytebase-v1-Risk-Source"></a>### Risk.Source-+The source of the database change for risk assessment.| Name | Number | Description || ---- | ------ | ----------- || SOURCE_UNSPECIFIED | 0 | |-| DDL | 1 | |-| DML | 2 | |-| CREATE_DATABASE | 3 | |-| DATA_EXPORT | 6 | |-| REQUEST_ROLE | 7 | |+| DDL | 1 | Data Definition Language statements (CREATE, ALTER, DROP, etc.). |+| DML | 2 | Data Manipulation Language statements (INSERT, UPDATE, DELETE, etc.). |+| CREATE_DATABASE | 3 | Database creation operations. |+| DATA_EXPORT | 6 | Data export operations. |+| REQUEST_ROLE | 7 | Role access requests. |@@ -10155,7 +10155,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| name | [string](#string) | | The resource name of the rollout. Format: projects/{project}/rollouts/{rollout} || plan | [string](#string) | | The plan that this rollout is based on. Format: projects/{project}/plans/{plan} || title | [string](#string) | | The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set. |-| stages | [Stage](#bytebase-v1-Stage) | repeated | stages and thus tasks of the rollout. |+| stages | [Stage](#bytebase-v1-Stage) | repeated | Stages and thus tasks of the rollout. || creator | [string](#string) | | Format: users/[email protected] || create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | || update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |@@ -10175,7 +10175,7 @@ When paginating, all other parameters provided to `ListTaskRuns` must match the| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || name | [string](#string) | | Format: projects/{project}/rollouts/{rollout}/stages/{stage} Use "-" for {stage} when the stage has no environment or deleted environment. |-| id | [string](#string) | | id is the environment id of the stage. e.g. "prod". Use "-" when the stage has no environment or deleted environment. |+| id | [string](#string) | | id is the environment id of the stage. e.g., "prod". Use "-" when the stage has no environment or deleted environment. || environment | [string](#string) | | environment is the environment of the stage. Format: environments/{environment} for valid environments, or "environments/-" for stages without environment or with deleted environments. || tasks | [Task](#bytebase-v1-Task) | repeated | The tasks within this stage. |@@ -10218,8 +10218,8 @@ Payload for creating a new database.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || project | [string](#string) | | The project owning the database. Format: projects/{project} |-| database | [string](#string) | | database name |-| table | [string](#string) | | table name |+| database | [string](#string) | | Database name. |+| table | [string](#string) | | Table name. || sheet | [string](#string) | | Format: projects/{project}/sheets/{sheet} || character_set | [string](#string) | | The character set for the database. || collation | [string](#string) | | The collation for the database. |@@ -10721,8 +10721,8 @@ Internal status for task run execution.| Name | Number | Description || ---- | ------ | ----------- || STATUS_UNSPECIFIED | 0 | Unspecified status. |-| RUNNING_WAITING | 1 | the task run is ready to be executed by the scheduler |-| RUNNING_RUNNING | 2 | the task run is being executed by the scheduler |+| RUNNING_WAITING | 1 | The task run is ready to be executed by the scheduler. |+| RUNNING_RUNNING | 2 | The task run is being executed by the scheduler. |@@ -10922,7 +10922,7 @@ RolloutService manages the execution of deployment plans.| sheet | [Sheet](#bytebase-v1-Sheet) | | The sheet to update.The sheet's `name` field is used to identify the sheet to update. Format: projects/{project}/sheets/{sheet} |-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the sheet. (e.g. `title`, `statement`; *not* `sheet.title` or `sheet.statement`) Only support update the following fields for now: - `title` - `statement` |+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the sheet. (e.g., `title`, `statement`; *not* `sheet.title` or `sheet.statement`) Only support update the following fields for now: - `title` - `statement` || allow_missing | [bool](#bool) | | If set to true, and the sheet is not found, a new sheet will be created. In this situation, `update_mask` is ignored. |@@ -11290,7 +11290,7 @@ The organizer's `worksheet` field is used to identify the worksheet. Format:| worksheet | [Worksheet](#bytebase-v1-Worksheet) | | The worksheet to update.The worksheet's `name` field is used to identify the worksheet to update. Format: worksheets/{worksheet} |-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the worksheet. (e.g. `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`) Only support update the following fields for now: - `title` - `statement` - `starred` - `visibility` |+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the worksheet. (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`) Only support update the following fields for now: - `title` - `statement` - `starred` - `visibility` |diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.htmlindex 6d594ec272..ca2054e90c 100644--- a/proto/gen/grpc-doc/v1/index.html+++ b/proto/gen/grpc-doc/v1/index.html@@ -4027,7 +4027,7 @@ The role name is the unique name for the role. </p></td><td><a href="#string">string</a></td><td>optional</td><td><p>The role attribute.-For PostgreSQL, it containt 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 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.htmlFor MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html </p></td></tr>@@ -5577,7 +5577,7 @@ Format: instances/{instance} </p></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 instances will be synced. </p></td>+the instance metadata (such as the database list) and any newly discovered databases will be synced. </p></td></tr></tbody>@@ -8602,7 +8602,7 @@ view. </p></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>+procedure takes. </p></td></tr><tr>@@ -10748,7 +10748,7 @@ Format: users/{email}. </p></td><td>condition</td><td><a href="#google.type.Expr">google.type.Expr</a></td><td></td>- <td><p>The condition for the role. Same as the condtion in IAM Binding message. </p></td>+ <td><p>The condition for the role. Same as the condition in IAM Binding message. </p></td></tr><tr>@@ -11542,7 +11542,7 @@ 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 an rejection.+ <td><p>The name of the issue to add a rejection.Format: projects/{project}/issues/{issue} </p></td></tr>@@ -13893,7 +13893,7 @@ For examples:<td>domains</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p>The workspace domain, e.g. bytebase.com. </p></td>+ <td><p>The workspace domain, e.g., bytebase.com. </p></td></tr><tr>@@ -15561,7 +15561,7 @@ A binding binds one or more project members to a single project role. </p></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 poliy,+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>@@ -16348,7 +16348,7 @@ Format: idps/{idp} </p></td><td>user</td><td><a href="#bytebase.v1.User">User</a></td><td></td>- <td><p>The user of successful login. </p></td>+ <td><p>The user from the successful login. </p></td></tr></tbody>@@ -16721,7 +16721,8 @@ Format: users/{email} </p></td><td>sheet</td><td><a href="#string">string</a></td><td></td>- <td><p>The sheet containing the SQL statement. </p></td>+ <td><p>The sheet containing the SQL statement.+Format: projects/{project}/sheets/{sheet} </p></td></tr><tr>@@ -16856,9 +16857,9 @@ Format: projects/{project} </p></td><td><a href="#int32">int32</a></td><td></td><td><p>Pagination is not currently implemented. This field is reserved for future use.-The maximum number of databases to return. The service may return fewer than+The maximum number of changelists to return. The service may return fewer thanthis value.-If unspecified, at most 50 databases will be returned.+If unspecified, at most 50 changelists will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>@@ -16867,10 +16868,10 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td><td><a href="#string">string</a></td><td></td><td><p>Pagination is not currently implemented. This field is reserved for future use.-A page token, received from a previous `ListDatabases` call.+A page token, received from a previous `ListChangelists` call.Provide this to retrieve the subsequent page.-When paginating, all other parameters provided to `ListDatabases` must match+When paginating, all other parameters provided to `ListChangelists` must matchthe call that provided the page token. </p></td></tr>@@ -18348,7 +18349,7 @@ Format: idps/{idp} </p></td><td>host</td><td><a href="#string">string</a></td><td></td>- <td><p>Host is the hostname or IP address of the LDAP server, e.g.+ <td><p>Host is the hostname or IP address of the LDAP server, e.g.,"ldap.example.com". </p></td></tr>@@ -18356,7 +18357,7 @@ Format: idps/{idp} </p></td><td>port</td><td><a href="#int32">int32</a></td><td></td>- <td><p>Port is the port number of the LDAP server, e.g. 389. When not set, the+ <td><p>Port is the port number of the LDAP server, e.g., 389. When not set, thedefault port of the corresponding security protocol will be used, i.e. 389for StartTLS and 636 for LDAPS. </p></td></tr>@@ -18387,14 +18388,14 @@ search requests. </p></td><td>base_dn</td><td><a href="#string">string</a></td><td></td>- <td><p>BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com". </p></td>+ <td><p>BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com". </p></td></tr><tr><td>user_filter</td><td><a href="#string">string</a></td><td></td>- <td><p>UserFilter is the filter to search for users, e.g. "(uid=%s)". </p></td>+ <td><p>UserFilter is the filter to search for users, e.g., "(uid=%s)". </p></td></tr><tr>@@ -25491,7 +25492,7 @@ If the digest is not empty, it must be unique in the project. Otherwise, an ALRE<td>path</td><td><a href="#string">string</a></td><td></td>- <td><p>The path of the file. e.g. `2.2/V0001_create_table.sql`. </p></td>+ <td><p>The path of the file. e.g., `2.2/V0001_create_table.sql`. </p></td></tr><tr>@@ -25577,7 +25578,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td>url</td><td><a href="#string">string</a></td><td></td>- <td><p>The url link to the e.g. GitHub commit or pull request. </p></td>+ <td><p>The url link to the e.g., GitHub commit or pull request. </p></td></tr></tbody>@@ -26000,7 +26001,7 @@ Permissions required: bb.releases.check</p></td><td>review_config</td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td><td></td>- <td><p>The sql review to create. </p></td>+ <td><p>The SQL review config to create. </p></td></tr></tbody>@@ -26024,7 +26025,7 @@ Permissions required: bb.releases.check</p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of the sql review to delete.+ <td><p>The name of the SQL review config to delete.Format: reviewConfigs/{reviewConfig} </p></td></tr>@@ -26049,7 +26050,7 @@ Format: reviewConfigs/{reviewConfig} </p></td><td>name</td><td><a href="#string">string</a></td><td></td>- <td><p>The name of the sql review to retrieve.+ <td><p>The name of the SQL review config to retrieve.Format: reviewConfigs/{reviewConfig} </p></td></tr>@@ -26075,9 +26076,9 @@ Format: reviewConfigs/{reviewConfig} </p></td><td><a href="#int32">int32</a></td><td></td><td><p>Pagination is not currently implemented. This field is reserved for future use.-The maximum number of sql review to return. The service may return fewer than+The maximum number of SQL review configs to return. The service may return fewer thanthis value.-If unspecified, at most 10 sql review will be returned.+If unspecified, at most 10 SQL review configs will be returned.The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td></tr>@@ -26113,7 +26114,7 @@ the call that provided the page token. </p></td><td>review_configs</td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td><td>repeated</td>- <td><p>The sql review from the specified request. </p></td>+ <td><p>The SQL review configs from the specified request. </p></td></tr><tr>@@ -26145,7 +26146,7 @@ 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 sql review to retrieve.+ <td><p>The name of the SQL review config.Format: reviewConfigs/{reviewConfig} </p></td></tr>@@ -26174,8 +26175,8 @@ Format: reviewConfigs/{reviewConfig} </p></td><td>resources</td><td><a href="#string">string</a></td><td>repeated</td>- <td><p>resources using the config.-Format: {resource}/{resource id}, for example, environments/test. </p></td>+ <td><p>Resources using the config.+Format: {resource}/{resource id}, e.g., environments/test. </p></td></tr></tbody>@@ -26199,9 +26200,9 @@ Format: {resource}/{resource id}, for example, environments/test. </p></td><td>review_config</td><td><a href="#bytebase.v1.ReviewConfig">ReviewConfig</a></td><td></td>- <td><p>The sql review to update.+ <td><p>The SQL review config to update.-The name field is used to identify the sql review to update. </p></td>+The name field is used to identify the SQL review config to update. </p></td></tr><tr>@@ -27036,7 +27037,7 @@ If this field is omitted, there are no subsequent pages. </p></td><td>source</td><td><a href="#bytebase.v1.Risk.Source">Risk.Source</a></td><td></td>- <td><p> </p></td>+ <td><p>The source of the operation being assessed for risk. </p></td></tr><tr>@@ -27167,7 +27168,7 @@ In this situation, `update_mask` is ignored. </p></td><h3 id="bytebase.v1.Risk.Source">Risk.Source</h3>- <p></p>+ <p>The source of the database change for risk assessment.</p><table class="enum-table"><thead><tr><td>Name</td><td>Number</td><td>Description</td></tr>@@ -27183,31 +27184,31 @@ In this situation, `update_mask` is ignored. </p></td><tr><td>DDL</td><td>1</td>- <td><p></p></td>+ <td><p>Data Definition Language statements (CREATE, ALTER, DROP, etc.).</p></td></tr><tr><td>DML</td><td>2</td>- <td><p></p></td>+ <td><p>Data Manipulation Language statements (INSERT, UPDATE, DELETE, etc.).</p></td></tr><tr><td>CREATE_DATABASE</td><td>3</td>- <td><p></p></td>+ <td><p>Database creation operations.</p></td></tr><tr><td>DATA_EXPORT</td><td>6</td>- <td><p></p></td>+ <td><p>Data export operations.</p></td></tr><tr><td>REQUEST_ROLE</td><td>7</td>- <td><p></p></td>+ <td><p>Role access requests.</p></td></tr></tbody>@@ -28349,7 +28350,7 @@ This field is output only and cannot be directly set. </p></td><td>stages</td><td><a href="#bytebase.v1.Stage">Stage</a></td><td>repeated</td>- <td><p>stages and thus tasks of the rollout. </p></td>+ <td><p>Stages and thus tasks of the rollout. </p></td></tr><tr>@@ -28411,7 +28412,7 @@ Use "-" for {stage} when the stage has no environment or deleted environ<td><a href="#string">string</a></td><td></td><td><p>id is the environment id of the stage.-e.g. "prod".+e.g., "prod".Use "-" when the stage has no environment or deleted environment. </p></td></tr>@@ -28557,14 +28558,14 @@ Format: projects/{project} </p></td><td>database</td><td><a href="#string">string</a></td><td></td>- <td><p>database name </p></td>+ <td><p>Database name. </p></td></tr><tr><td>table</td><td><a href="#string">string</a></td><td></td>- <td><p>table name </p></td>+ <td><p>Table name. </p></td></tr><tr>@@ -29879,13 +29880,13 @@ Use payload DatabaseDataExport.</p></td><tr><td>RUNNING_WAITING</td><td>1</td>- <td><p>the task run is ready to be executed by the scheduler</p></td>+ <td><p>The task run is ready to be executed by the scheduler.</p></td></tr><tr><td>RUNNING_RUNNING</td><td>2</td>- <td><p>the task run is being executed by the scheduler</p></td>+ <td><p>The task run is being executed by the scheduler.</p></td></tr></tbody>@@ -30535,7 +30536,7 @@ Format: projects/{project}/sheets/{sheet} </p></td><td></td><td><p>The list of fields to be updated.Fields are specified relative to the sheet.-(e.g. `title`, `statement`; *not* `sheet.title` or `sheet.statement`)+(e.g., `title`, `statement`; *not* `sheet.title` or `sheet.statement`)Only support update the following fields for now:- `title`- `statement` </p></td>@@ -31681,7 +31682,7 @@ Format: worksheets/{worksheet} </p></td><td></td><td><p>The list of fields to be updated.Fields are specified relative to the worksheet.-(e.g. `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)+(e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)Only support update the following fields for now:- `title`- `statement`diff --git a/proto/store/store/advice.proto b/proto/store/store/advice.protoindex c8290bec4c..f0fc5eeea8 100644--- a/proto/store/store/advice.proto+++ b/proto/store/store/advice.proto@@ -10,7 +10,7 @@ message Advice {reserved 5;enum Status {- // Unspecified.+ // Unspecified status.STATUS_UNSPECIFIED = 0;SUCCESS = 1;WARNING = 2;diff --git a/proto/store/store/approval.proto b/proto/store/store/approval.protoindex 74fb38e291..3473575815 100644--- a/proto/store/store/approval.proto+++ b/proto/store/store/approval.proto@@ -6,45 +6,59 @@ import "store/common.proto";option go_package = "generated-go/store";-// IssuePayloadApproval is a part of the payload of an issue.-// IssuePayloadApproval records the approval template used and the approval history.+// IssuePayloadApproval records the approval template used and approval history for an issue.message IssuePayloadApproval {+ // Approver represents a user who can approve or reject an issue.message Approver {+ // Status represents the approver's decision state.enum Status {STATUS_UNSPECIFIED = 0;+ // Approval is pending from this approver.PENDING = 1;+ // Approver has approved the issue.APPROVED = 2;+ // Approver has rejected the issue.REJECTED = 3;}- // The new status.+ // The current approval status.Status status = 1;- // The principal id of the approver.+ // The ID of the principal who is the approver.int32 principal_id = 2;}+ // The approval template being used for this issue.ApprovalTemplate approval_template = 1;+ // List of approvers and their current status.repeated Approver approvers = 2;- // If the value is `false`, it means that the backend is still finding matching approval templates.- // If `true`, other fields are available.+ // Whether the system has finished finding a matching approval template.+ // False means the backend is still searching for matching templates.bool approval_finding_done = 3;+ // Error message if approval template finding failed.string approval_finding_error = 4;+ // The assessed risk level for this issue.RiskLevel risk_level = 5;}+// ApprovalTemplate defines the approval workflow and requirements for an issue.message ApprovalTemplate {// The unique identifier for the approval template.- // For built-in templates, use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").- // For custom templates, use a UUID or other unique identifier.+ // Built-in templates use "bb." prefix (e.g., "bb.project-owner", "bb.workspace-dba").+ // Custom templates use a UUID or other unique identifier.string id = 4;+ // The approval workflow specification.ApprovalFlow flow = 1;+ // Human-readable title of the approval template.string title = 2;+ // Detailed description of when this template applies.string description = 3;}+// ApprovalFlow defines the sequence of approvals required.message ApprovalFlow {+ // List of role names that must approve, in order.repeated string roles = 1;}diff --git a/proto/store/store/audit_log.proto b/proto/store/store/audit_log.protoindex 92c50a1a7f..c10a50f254 100644--- a/proto/store/store/audit_log.proto+++ b/proto/store/store/audit_log.proto@@ -15,11 +15,11 @@ message AuditLog {// - workspaces/{workspace}string parent = 1;- // e.g. /bytebase.v1.SQLService/Query+ // Example: /bytebase.v1.SQLService/Querystring method = 2;- // resource name- // projects/{project}+ // The resource name.+ // Example: projects/{project}string resource = 3;// Format: users/{userUID}.@@ -39,7 +39,7 @@ message AuditLog {// The latency of the RPC.google.protobuf.Duration latency = 9;- // service-specific data about the request, response, and other activities.+ // The service-specific data about the request, response, and other activities.google.protobuf.Any service_data = 10;// Metadata about the operation.diff --git a/proto/store/store/changelist.proto b/proto/store/store/changelist.protoindex 9d5f2996a8..b7a36145b0 100644--- a/proto/store/store/changelist.proto+++ b/proto/store/store/changelist.proto@@ -4,16 +4,20 @@ package bytebase.store;option go_package = "generated-go/store";+// Changelist represents a collection of database changes that can be applied together.message Changelist {+ // Human-readable description of this changelist.string description = 1;+ // Change represents a single database modification within the changelist.message Change {- // The name of a sheet.+ // Resource name of the sheet containing the SQL statements.string sheet = 1;- // The source of origin.- // 1) changes: instances/{instance}/databases/{database}/changelogs/{changelog}.- // 2) raw SQL if empty.+ // The source where this change originated from.+ // Format: instances/{instance}/databases/{database}/changelogs/{changelog} for changes from changelog.+ // Empty for raw SQL changes.string source = 2;}+ // The list of changes in this changelist.repeated Change changes = 2;}diff --git a/proto/store/store/changelog.proto b/proto/store/store/changelog.protoindex e468d5028b..d24c49aa4a 100644--- a/proto/store/store/changelog.proto+++ b/proto/store/store/changelog.proto@@ -72,30 +72,30 @@ message ChangedResourceSchema {message ChangedResourceTable {string name = 1;- // estimated row count of the table+ // The estimated row count of the table.int64 table_rows = 2;- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.repeated Range ranges = 3;}message ChangedResourceView {string name = 1;- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.repeated Range ranges = 2;}message ChangedResourceFunction {string name = 1;- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.repeated Range ranges = 2;}message ChangedResourceProcedure {string name = 1;- // The ranges of sub-strings correspond to the statements on the sheet.+ // The ranges of substrings correspond to the statements on the sheet.repeated Range ranges = 2;}diff --git a/proto/store/store/common.proto b/proto/store/store/common.protoindex 9bb4c52cd5..35f5ccf35e 100644--- a/proto/store/store/common.proto+++ b/proto/store/store/common.proto@@ -4,12 +4,15 @@ package bytebase.store;option go_package = "generated-go/store";-// Used internally for obfuscating the page token.+// PageToken is used internally for obfuscating pagination tokens.message PageToken {+ // Maximum number of items to return.int32 limit = 1;+ // Number of items to skip before starting to return results.int32 offset = 2;}+// Engine represents the type of database system.enum Engine {ENGINE_UNSPECIFIED = 0;CLICKHOUSE = 1;@@ -39,6 +42,7 @@ enum Engine {CASSANDRA = 28;}+// VCSType represents the type of version control system.enum VCSType {VCS_TYPE_UNSPECIFIED = 0;GITHUB = 1;@@ -47,13 +51,18 @@ enum VCSType {AZURE_DEVOPS = 4;}+// MaskingLevel represents the level of data masking applied to sensitive information.enum MaskingLevel {MASKING_LEVEL_UNSPECIFIED = 0;+ // No masking applied.NONE = 1;+ // Partial masking (e.g., showing first/last characters).PARTIAL = 2;+ // Full masking (all characters masked).FULL = 3;}+// ExportFormat represents the file format for exported data.enum ExportFormat {FORMAT_UNSPECIFIED = 0;CSV = 1;@@ -62,6 +71,7 @@ enum ExportFormat {XLSX = 4;}+// RiskLevel represents the assessed risk level of a database operation.enum RiskLevel {RISK_LEVEL_UNSPECIFIED = 0;LOW = 1;@@ -69,8 +79,7 @@ enum RiskLevel {HIGH = 3;}-// Position in a text expressed as zero-based line and zero-based column byte-// offset.+// Position in a text expressed as zero-based line and column byte offset.message Position {// Line position in a text (zero-based).int32 line = 1;@@ -78,7 +87,10 @@ message Position {int32 column = 2;}+// Range represents a span within a text or sequence.message Range {+ // Start index (inclusive).int32 start = 1;+ // End index (exclusive).int32 end = 2;}diff --git a/proto/store/store/data_source.proto b/proto/store/store/data_source.protodeleted file mode 100644index 23767848cf..0000000000--- a/proto/store/store/data_source.proto+++ /dev/null@@ -1,5 +0,0 @@-syntax = "proto3";--package bytebase.store;--option go_package = "generated-go/store";diff --git a/proto/store/store/database.proto b/proto/store/store/database.protoindex 60495acf71..7fd4d46730 100644--- a/proto/store/store/database.proto+++ b/proto/store/store/database.proto@@ -13,7 +13,7 @@ message DatabaseMetadata {google.protobuf.Timestamp last_sync_time = 2;bool backup_available = 3;bool datashare = 4;- // The schema is drifted from the source of truth.+ // The schema has drifted from the source of truth.bool drifted = 6;// The version of database schema.string version = 7;@@ -23,22 +23,22 @@ message DatabaseMetadata {message DatabaseSchemaMetadata {string name = 1;- // The schemas is the list of schemas in a database.+ // The list of schemas in a database.repeated SchemaMetadata schemas = 2;- // The character_set is the character set of a database.+ // The character set of the database.string character_set = 3;- // The collation is the collation of a database.+ // The collation of the database.string collation = 4;- // The extensions is the list of extensions in a database.+ // The list of extensions in a database.repeated ExtensionMetadata extensions = 5;// The database belongs to a datashare.bool datashare = 6;- // The service name of the database. It's the Oracle specific concept.+ // The service name of the database. It's an Oracle-specific concept.string service_name = 7;repeated LinkedDatabaseMetadata linked_databases = 8;@@ -60,40 +60,38 @@ message LinkedDatabaseMetadata {// SchemaMetadata is the metadata for schemas.// This is the concept of schema in Postgres, but it's a no-op for MySQL.message SchemaMetadata {- // The name is the schema name.+ // The schema name.// It is an empty string for databases without such concept such as MySQL.string name = 1;- // The tables is the list of tables in a schema.+ // The list of tables in a schema.repeated TableMetadata tables = 2;- // The external_tables is the list of external tables in a schema.+ // The list of external tables in a schema.repeated ExternalTableMetadata external_tables = 3;- // The views is the list of views in a schema.+ // The list of views in a schema.repeated ViewMetadata views = 4;- // The functions is the list of functions in a schema.+ // The list of functions in a schema.repeated FunctionMetadata functions = 5;- // The procedures is the list of procedures in a schema.+ // The list of procedures in a schema.repeated ProcedureMetadata procedures = 6;- // The streams is the list of streams in a schema, currently, only used for- // Snowflake.+ // The list of streams in a schema, currently only used for Snowflake.repeated StreamMetadata streams = 7;- // The routines is the list of routines in a schema, currently, only used for- // Snowflake.+ // The list of tasks in a schema, currently only used for Snowflake.repeated TaskMetadata tasks = 8;- // The materialized_views is the list of materialized views in a schema.+ // The list of materialized views in a schema.repeated MaterializedViewMetadata materialized_views = 9;- // The sequences is the list of sequences in a schema.+ // The list of sequences in a schema.repeated SequenceMetadata sequences = 10;- // The packages is the list of packages in a schema.+ // The list of packages in a schema.repeated PackageMetadata packages = 11;string owner = 12;@@ -108,10 +106,10 @@ message SchemaMetadata {}message EnumTypeMetadata {- // The name of a type.+ // The name of the enum type.string name = 1;- // The enum values of a type.+ // The enum values of the type.repeated string values = 2;string comment = 3;@@ -154,22 +152,22 @@ message SequenceMetadata {// The maximum value of a sequence.string max_value = 5;- // Increment value of a sequence.+ // The increment value of a sequence.string increment = 6;- // Cycle is whether the sequence cycles.+ // Whether the sequence cycles.bool cycle = 7;// Cache size of a sequence.string cache_size = 8;- // Last value of a sequence.+ // The last value of a sequence.string last_value = 9;- // The owner table of the sequence.+ // The table that owns the sequence.string owner_table = 10;- // The owner column of the sequence.+ // The column that owns the sequence.string owner_column = 11;string comment = 12;@@ -178,17 +176,16 @@ message SequenceMetadata {}message TriggerMetadata {- // The name is the name of the trigger.+ // The name of the trigger.string name = 1;- // The event is the event of the trigger, such as INSERT, UPDATE, DELETE,- // TRUNCATE.+ // The event that triggers this action, such as INSERT, UPDATE, DELETE, or TRUNCATE.string event = 3;- // The timing is the timing of the trigger, such as BEFORE, AFTER.+ // The timing of when the trigger fires, such as BEFORE or AFTER.string timing = 4;- // The body is the body of the trigger.+ // The body of the trigger.string body = 5;string sql_mode = 6;@@ -204,16 +201,16 @@ message TriggerMetadata {// RuleMetadata is the metadata for PostgreSQL rules.message RuleMetadata {- // The name is the name of the rule.+ // The name of the rule.string name = 1;- // The event is the event type of the rule: SELECT, INSERT, UPDATE, or DELETE.+ // The event type of the rule: SELECT, INSERT, UPDATE, or DELETE.string event = 2;- // The condition is the WHERE condition of the rule (optional).+ // The WHERE condition of the rule (optional).string condition = 3;- // The action is the command(s) to execute when the rule fires.+ // The command(s) to execute when the rule fires.string action = 4;// The is_instead indicates whether this is an INSTEAD rule.@@ -222,16 +219,16 @@ message RuleMetadata {// The is_enabled indicates whether the rule is enabled.bool is_enabled = 6;- // The definition is the full CREATE RULE statement.+ // The full CREATE RULE statement.string definition = 7;}message TaskMetadata {- // The name is the name of a task.+ // The name of the task.string name = 1;- // The id is the snowflake-generated id of a task.- // Example: 01ad32a0-1bb6-5e93-0000-000000000001+ // The Snowflake-generated ID of the task.+ // Example: 01ad32a0-1bb6-5e93-0000-000000000001.string id = 2;// The owner of the task.@@ -265,7 +262,7 @@ message TaskMetadata {}message StreamMetadata {- // The name is the name of a stream.+ // The name of the stream.string name = 1;// The table_name is the name of the table/view that the stream is created on.@@ -302,7 +299,7 @@ message StreamMetadata {// TableMetadata is the metadata for tables.message TableMetadata {- // The name is the name of a table.+ // The name of the table.string name = 1;// The columns is the ordered list of columns in a table.@@ -320,7 +317,7 @@ message TableMetadata {// The collation is the collation of a table.string collation = 5;- // The character set of table.+ // The character set of the table.string charset = 17;// The row_count is the estimated number of rows of a table.@@ -376,7 +373,7 @@ message TableMetadata {}message CheckConstraintMetadata {- // The name is the name of a check constraint.+ // The name of the check constraint.string name = 1;// The expression is the expression of a check constraint.@@ -384,7 +381,7 @@ message CheckConstraintMetadata {}message ExternalTableMetadata {- // The name is the name of a external table.+ // The name of the external table.string name = 1;// The external_server_name is the name of the external server.@@ -399,11 +396,11 @@ message ExternalTableMetadata {// TablePartitionMetadata is the metadata for table partitions.message TablePartitionMetadata {- // The name is the name of a table partition.+ // The name of the table partition.string name = 1;- // Type is the type of a table partition, some database engines may not- // support all types. Only avilable for the following database engines now:+ // The type is the type of a table partition. Some database engines may not+ // support all types. Only available 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:@@ -462,13 +459,13 @@ message TablePartitionMetadata {// ColumnMetadata is the metadata for columns.message ColumnMetadata {- // The name is the name of a column.+ // The name of the column.string name = 1;// The position is the position in columns.int32 position = 2;- // The default value of column.+ // The default value of the column.string default = 3;// Deprecated.bool default_null = 4;@@ -559,7 +556,7 @@ message GenerationMetadata {// ViewMetadata is the metadata for views.message ViewMetadata {- // The name is the name of a view.+ // The name of the view.string name = 1;// The definition is the definition of a view.@@ -568,13 +565,13 @@ message ViewMetadata {// The comment is the comment of a view.string comment = 3;- // The dependency_columns is the list of dependency columns of a view.+ // The list of dependency columns of a view.repeated DependencyColumn dependency_columns = 4;- // The columns is the ordered list of columns in a table.+ // The ordered list of columns in the view.repeated ColumnMetadata columns = 5;- // The triggers is the list of triggers in a view.+ // The list of triggers in the view.repeated TriggerMetadata triggers = 6;bool skip_dump = 7;@@ -597,7 +594,7 @@ message DependencyColumn {// MaterializedViewMetadata is the metadata for materialized views.message MaterializedViewMetadata {- // The name is the name of a view.+ // The name of the materialized view.string name = 1;// The definition is the definition of a view.@@ -606,13 +603,13 @@ message MaterializedViewMetadata {// The comment is the comment of a view.string comment = 3;- // The dependency_columns is the list of dependency columns of a view.+ // The list of dependency columns of the view.repeated DependencyColumn dependency_columns = 4;- // The columns is the ordered list of columns in a table.+ // The ordered list of columns in the materialized view.repeated TriggerMetadata triggers = 5;- // The indexes is the list of indexes in a table.+ // The list of indexes in the materialized view.repeated IndexMetadata indexes = 6;bool skip_dump = 7;@@ -628,7 +625,7 @@ message DependencyTable {// FunctionMetadata is the metadata for functions.message FunctionMetadata {- // The name is the name of a function.+ // The name of the function.string name = 1;// The definition is the definition of a function.@@ -658,7 +655,7 @@ message FunctionMetadata {// ProcedureMetadata is the metadata for procedures.message ProcedureMetadata {- // The name is the name of a procedure.+ // The name of the procedure.string name = 1;// The definition is the definition of a procedure.@@ -684,7 +681,7 @@ message ProcedureMetadata {// PackageMetadata is the metadata for packages.message PackageMetadata {- // The name is the name of a package.+ // The name of the package.string name = 1;// The definition is the definition of a package.@@ -693,18 +690,18 @@ message PackageMetadata {// IndexMetadata is the metadata for indexes.message IndexMetadata {- // The name is the name of an index.+ // The name of the index.string name = 1;// The expressions are the ordered columns or expressions of an index.// This could refer to a column or an expression.repeated string expressions = 2;- // The key_lengths are the ordered key lengths of an index.- // If the key length is not specified, it's -1.+ // The ordered list of key lengths for the index.+ // If the key length is not specified, it is -1.repeated int64 key_length = 9;- // The descending is the ordered descending of an index.+ // The ordered list of descending flags for the index columns.repeated bool descending = 10;// The type is the type of an index.@@ -843,10 +840,10 @@ message DimensionalConfig {// ExtensionMetadata is the metadata for extensions.message ExtensionMetadata {- // The name is the name of an extension.+ // The name of the extension.string name = 1;- // The schema is the extension that is installed to. But the extension usage+ // The schema where the extension is installed. However, the extension usage// is not limited to the schema.string schema = 2;@@ -859,7 +856,7 @@ message ExtensionMetadata {// ForeignKeyMetadata is the metadata for foreign keys.message ForeignKeyMetadata {- // The name is the name of a foreign key.+ // The name of the foreign key.string name = 1;// The columns are the ordered referencing columns of a foreign key.@@ -907,7 +904,7 @@ message DatabaseConfig {}message SchemaCatalog {- // The name is the schema name.+ // The schema name.// It is an empty string for databases without such concept such as MySQL.string name = 1;@@ -916,7 +913,7 @@ message SchemaCatalog {}message TableCatalog {- // The name is the name of a table.+ // The name of the table.string name = 1;// The column_configs is the ordered list of configs for columns in a table.@@ -928,7 +925,7 @@ message TableCatalog {}message ColumnCatalog {- // The name is the name of a column.+ // The name of the column.string name = 1;string semantic_type = 2;diff --git a/proto/store/store/group.proto b/proto/store/store/group.protoindex 3f36ca3581..6adb3797ab 100644--- a/proto/store/store/group.proto+++ b/proto/store/store/group.proto@@ -5,7 +5,7 @@ package bytebase.store;option go_package = "generated-go/store";message GroupMember {- // Member is the principal who belong to this group.+ // Member is the principal who belongs to this group.//// Format: users/{userUID}.string member = 1;@@ -21,6 +21,6 @@ message GroupMember {message GroupPayload {repeated GroupMember members = 1;- // source means where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ // The source indicates where the group comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.string source = 2;}diff --git a/proto/store/store/idp.proto b/proto/store/store/idp.protoindex a02ac537a3..94ee210c35 100644--- a/proto/store/store/idp.proto+++ b/proto/store/store/idp.proto@@ -135,7 +135,7 @@ enum OAuth2AuthStyle {// IN_PARAMS sends the "client_id" and "client_secret" in the POST body// as application/x-www-form-urlencoded parameters.IN_PARAMS = 1;- // IN_HEADER sends the client_id and client_password using HTTP Basic Authorization.+ // IN_HEADER sends the client_id and client_secret using HTTP Basic Authorization.// This is an optional style described in the OAuth2 RFC 6749 section 2.3.1.IN_HEADER = 2;}diff --git a/proto/store/store/instance.proto b/proto/store/store/instance.protoindex d33cc97207..57491f73d5 100644--- a/proto/store/store/instance.proto+++ b/proto/store/store/instance.proto@@ -18,14 +18,14 @@ message Instance {repeated DataSource data_sources = 6;- // How often the instance is synced.+ // The interval between automatic instance synchronizations.google.protobuf.Duration sync_interval = 7;// The maximum number of connections.// The default is 10 if the value is unset or zero.int32 maximum_connections = 8;- // Enable sync for following databases.+ // Enable sync for the following databases.// Default empty, means sync all schemas & databases.repeated string sync_databases = 9;@@ -54,8 +54,8 @@ message InstanceRole {optional string valid_until = 3;// The role attribute.- // For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html- // For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html+ // 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 is the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.htmloptional string attribute = 4;}@@ -65,7 +65,7 @@ message DataSource {string username = 3;string password = 37;string obfuscated_password = 4;- // Use SSL to connect to the data source. By default, we use system default SSL configuration.+ // Use SSL to connect to the data source. By default, we use the system's SSL configuration.bool use_ssl = 30;string ssl_ca = 38;string obfuscated_ssl_ca = 5;@@ -83,7 +83,7 @@ message DataSource {string port = 9;string database = 10;- // srv, authentication_database and replica_set are used for MongoDB.+ // 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.bool srv = 11;// authentication_database is the database name to authenticate against, which stores the user credentials.@@ -165,7 +165,7 @@ message DataSource {// direct_connection is used for MongoDB to dispatch all the operations to the node specified in the connection string.bool direct_connection = 27;- // region is the location of where the DB is, works for AWS RDS. For example, us-east-1.+ // Region is the location of the database, used for AWS RDS. For example, us-east-1.string region = 28;// warehouse_id is used by Databricks.@@ -218,7 +218,7 @@ enum DataSourceType {message DataSourceExternalSecret {enum SecretType {- SAECRET_TYPE_UNSPECIFIED = 0;+ SECRET_TYPE_UNSPECIFIED = 0;// ref: https://developer.hashicorp.com/vault/api-docs/secret/kv/kv-v2VAULT_KV_V2 = 1;// ref: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html@@ -240,7 +240,7 @@ message DataSourceExternalSecret {message AppRoleAuthOption {string role_id = 1;- // the secret id for the role without ttl.+ // The secret ID for the role without TTL.string secret_id = 2;enum SecretType {diff --git a/proto/store/store/issue.proto b/proto/store/store/issue.protoindex 42c1ae38c0..c3973a2c82 100644--- a/proto/store/store/issue.proto+++ b/proto/store/store/issue.proto@@ -8,33 +8,48 @@ import "store/approval.proto";option go_package = "generated-go/store";+// Issue is the metadata for issues that track database operations and access requests.message Issue {+ // Type represents the category of issue.enum Type {ISSUE_TYPE_UNSPECIFIED = 0;+ // Issue for database schema or data changes.DATABASE_CHANGE = 1;+ // Issue requesting database access permissions.GRANT_REQUEST = 2;+ // Issue for exporting data from databases.DATABASE_EXPORT = 3;}+ // Status represents the current state of the issue.enum Status {ISSUE_STATUS_UNSPECIFIED = 0;+ // Issue is open and pending action.OPEN = 1;+ // Issue has been completed successfully.DONE = 2;+ // Issue was canceled and will not be completed.CANCELED = 3;}+ // Approval information for the issue workflow.IssuePayloadApproval approval = 1;+ // Access grant request details if this is a grant request issue.GrantRequest grant_request = 2;+ // Labels attached to categorize and filter the issue.repeated string labels = 3;}+// GrantRequest contains details for requesting database access permissions.message GrantRequest {- // The requested role.+ // The role being requested for the user.// Format: roles/EXPORTER.string role = 1;- // The user to be granted.+ // The user who will receive the role.// Format: users/{userUID}.string user = 2;+ // Optional conditional expression that limits when the grant applies.google.type.Expr condition = 3;+ // Duration after which the grant automatically expires.google.protobuf.Duration expiration = 4;}diff --git a/proto/store/store/plan.proto b/proto/store/store/plan.protoindex 8e88e98c44..cca9e93499 100644--- a/proto/store/store/plan.proto+++ b/proto/store/store/plan.proto@@ -95,8 +95,8 @@ message PlanConfig {string sheet = 2;// The format of the exported file.ExportFormat format = 3;- // The zip password provide by users.- // Leave it empty if no needs to encrypt the zip file.+ // The zip password provided by users.+ // Leave it empty if there is no need to encrypt the zip file.optional string password = 4;}diff --git a/proto/store/store/plan_check_run.proto b/proto/store/store/plan_check_run.protoindex 6e3d123c30..86facccee5 100644--- a/proto/store/store/plan_check_run.proto+++ b/proto/store/store/plan_check_run.proto@@ -52,7 +52,7 @@ message PlanCheckRunResult {message SqlSummaryReport {reserved 1;- // statement_types are the types of statements that are found in the sql.+ // statement_types are the types of statements found in the SQL.repeated string statement_types = 2;int64 affected_rows = 3;ChangedResources changed_resources = 4;@@ -62,7 +62,7 @@ message PlanCheckRunResult {int32 line = 1;int32 column = 2;- // 1-based Position of the SQL statement.+ // 1-based position of the SQL statement.// To supersede `line` and `column` above.Position start_position = 8;Position end_position = 9;diff --git a/proto/store/store/policy.proto b/proto/store/store/policy.protoindex 6639e7d17c..cf03c05df3 100644--- a/proto/store/store/policy.proto+++ b/proto/store/store/policy.proto@@ -68,10 +68,10 @@ message MaskingExceptionPolicy {QUERY = 1;EXPORT = 2;}- // action is the action that the user can access sensitive data.+ // action is the action by which the user can access sensitive data.Action action = 1;- // Member is the principal who bind to this exception policy instance.+ // Member is the principal who binds to this exception policy instance.//// Format: users/{userUID} or groups/{group email}string member = 4;@@ -111,8 +111,8 @@ enum SQLReviewRuleLevel {}message TagPolicy {- // tags is the key - value map for resources.- // for example, the environment resource can have the sql review config tag, like "bb.tag.review_config": "reviewConfigs/{review config resource id}"+ // tags is the key-value map for resources.+ // For example, the environment resource can have the SQL review config tag, such as "bb.tag.review_config": "reviewConfigs/{review config resource id}".map<string, string> tags = 1;}@@ -155,7 +155,7 @@ message QueryDataPolicy {// The query timeout duration.google.protobuf.Duration timeout = 1;- // Disable export data in the SQL editor+ // Disable exporting data in the SQL editor.bool disable_export = 2;// The size limit in bytes.diff --git a/proto/store/store/project.proto b/proto/store/store/project.protoindex 12c496737a..f5a9e5f29c 100644--- a/proto/store/store/project.proto+++ b/proto/store/store/project.proto@@ -4,15 +4,21 @@ package bytebase.store;option go_package = "generated-go/store";+// Label represents a categorization tag that can be applied to issues.message Label {+ // The display text of the label.string value = 1;+ // The color for the label in hex format (e.g., "#FF0000").string color = 2;+ // Optional group name for organizing related labels.string group = 3;}+// Project contains settings and configuration for a Bytebase project.message Project {reserved 1;+ // Available labels that can be applied to issues in this project.repeated Label issue_labels = 2;// Force issue labels to be used when creating an issue.bool force_issue_labels = 3;@@ -36,16 +42,17 @@ message Project {// Whether to allow the issue creator to self-approve the issue.bool allow_self_approval = 10;- // Execution retry policy for the task run.+ // Configuration for automatic retry on task execution failures.ExecutionRetryPolicy execution_retry_policy = 11;+ // ExecutionRetryPolicy defines retry behavior for failed task executions.message ExecutionRetryPolicy {- // The maximum number of retries for the lock timeout issue.+ // The maximum number of retry attempts for lock timeout errors.int32 maximum_retries = 1;}// The maximum number of databases to sample during CI data validation.- // Without specification, sampling is disabled, resulting in a full validation.+ // If not specified, sampling is disabled, resulting in a full validation.int32 ci_sampling_size = 12;// The maximum number of parallel tasks to run during the rollout.diff --git a/proto/store/store/project_webhook.proto b/proto/store/store/project_webhook.protoindex 592fc199a9..1c477c7dd7 100644--- a/proto/store/store/project_webhook.proto+++ b/proto/store/store/project_webhook.proto@@ -5,7 +5,7 @@ package bytebase.store;option go_package = "generated-go/store";message ProjectWebhookPayload {- // if direct_message is set, the notification is sent directly+ // 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.bool direct_message = 1;diff --git a/proto/store/store/release.proto b/proto/store/store/release.protoindex 9533a3cac2..a6946e2f4b 100644--- a/proto/store/store/release.proto+++ b/proto/store/store/release.proto@@ -17,7 +17,7 @@ message ReleasePayload {message File {// The unique identifier for the file.string id = 1;- // The path of the file. e.g. `2.2/V0001_create_table.sql`.+ // The path of the file, e.g., `2.2/V0001_create_table.sql`.string path = 2;// The sheet that holds the content.// Format: projects/{project}/sheets/{sheet}diff --git a/proto/store/store/setting.proto b/proto/store/store/setting.protoindex c461365996..d28b82ac53 100644--- a/proto/store/store/setting.proto+++ b/proto/store/store/setting.proto@@ -51,7 +51,7 @@ message WorkspaceProfileSetting {// The max duration for role expired.google.protobuf.Duration maximum_role_expiration = 8;- // The workspace domain, e.g. bytebase.com.+ // The workspace domain, e.g., bytebase.com.repeated string domains = 9;// Only user and group from the domains can be created and login.@@ -76,10 +76,10 @@ message Announcement {ALERT_LEVEL_CRITICAL = 3;}- // The alert level of announcemnt+ // The alert level of the announcement.AlertLevel level = 1;- // The text of announcemnt+ // The text of the announcement.string text = 2;// The optional link, user can follow the link to check extra details@@ -287,15 +287,15 @@ message SCIMSetting {}message PasswordRestrictionSetting {- // min_length is the minimum length for password, should no less than 8.+ // min_length is the minimum length for password, should be no less than 8.int32 min_length = 1;- // require_number requires the password must contains at least one number.+ // require_number requires the password must contain at least one number.bool require_number = 2;- // require_letter requires the password must contains at least one letter, regardless of upper case or lower case+ // require_letter requires the password must contain at least one letter, regardless of upper case or lower casebool require_letter = 3;- // require_uppercase_letter requires the password must contains at least one upper case letter.+ // require_uppercase_letter requires the password must contain at least one upper case letter.bool require_uppercase_letter = 4;- // require_uppercase_letter requires the password must contains at least one special character.+ // require_special_character requires the password must contain at least one special character.bool require_special_character = 5;// require_reset_password_for_first_login requires users to reset their password after the 1st login.bool require_reset_password_for_first_login = 6;diff --git a/proto/store/store/task.proto b/proto/store/store/task.protoindex 534516eb6a..137a14fa46 100644--- a/proto/store/store/task.proto+++ b/proto/store/store/task.proto@@ -6,50 +6,72 @@ import "store/common.proto";option go_package = "generated-go/store";+// Task is the metadata for database operation tasks.message Task {+ // Type represents the type of database operation to perform.enum Type {TASK_TYPE_UNSPECIFIED = 0;+ // Create a new database.DATABASE_CREATE = 1;+ // Apply schema/data migrations to an existing database.DATABASE_MIGRATE = 2;+ // Export data from a database.DATABASE_EXPORT = 5;+ // Apply declarative schema changes (state-based migration).DATABASE_SDL = 6;}- // MigrateType is the database migration type.+ // MigrateType is the database migration type for imperative migrations.enum MigrateType {MIGRATE_TYPE_UNSPECIFIED = 0;+ // DDL changes (Data Definition Language) for schema modifications.DDL = 1;+ // DML changes (Data Manipulation Language) for data modifications.DML = 2;+ // Online schema migration using gh-ost tool.GHOST = 3;}- // common fields+ // Whether the task was skipped during execution.bool skipped = 1;+ // Reason why the task was skipped.string skipped_reason = 2;+ // UUID that identifies the spec this task implements.string spec_id = 3;+ // The sheet ID containing SQL statements for this task.int32 sheet_id = 4;- // Create database fields.+ // The environment where the database will be created.string environment_id = 5;+ // Name of the database to create.string database_name = 6;+ // Optional table name to create (required for some databases like MongoDB).string table_name = 7;+ // Character set for the new database.string character_set = 8;+ // Collation for the new database.string collation = 9;- // Update database fields.+ // Schema version after migration is applied.string schema_version = 10;+ // Whether to create an automatic backup before applying changes.bool enable_prior_backup = 11;- // ghost flags.+ // Configuration flags for gh-ost migration tool.map<string, string> flags = 12;+ // Source information if task is created from a release.TaskReleaseSource task_release_source = 13;+ // The type of migration (DDL, DML, or GHOST).MigrateType migrate_type = 16;- // Export data fields.+ // Password to encrypt the exported data archive.string password = 14;+ // Format of the exported data (SQL, CSV, JSON, etc).ExportFormat format = 15;}+// TaskReleaseSource contains information about the release file this task originated from.message TaskReleaseSource {+ // Resource name of the release file.// Format: projects/{project}/releases/{release}/files/{id}string file = 1;}diff --git a/proto/store/store/task_run.proto b/proto/store/store/task_run.protoindex 137cd75896..9d2c695518 100644--- a/proto/store/store/task_run.proto+++ b/proto/store/store/task_run.proto@@ -7,66 +7,95 @@ import "store/common.proto";option go_package = "generated-go/store";+// TaskRun represents an execution attempt of a task.message TaskRun {+ // Status represents the current execution state of a task run.enum Status {STATUS_UNSPECIFIED = 0;+ // Task run is queued and waiting to execute.PENDING = 1;+ // Task run is currently executing.RUNNING = 2;+ // Task run completed successfully.DONE = 3;+ // Task run encountered an error and failed.FAILED = 4;+ // Task run was canceled by user or system.CANCELED = 5;+ // Task run has not started yet.NOT_STARTED = 6;+ // Task run was skipped and will not execute.SKIPPED = 7;}}+// TaskRunResult contains the outcome and metadata from a task run execution.message TaskRunResult {+ // Detailed execution information or error message.string detail = 1;+ // Resource name of the changelog entry created by this run.// Format: instances/{instance}/databases/{database}/changelogs/{changelog}string changelog = 8;+ // Schema version after the migration was applied.string version = 3;- // The following fields are used for error reporting.+ // Starting position in the SQL statement where an error occurred.Position start_position = 4;+ // Ending position in the SQL statement where an error occurred.Position end_position = 5;- // The uid of the export archive.+ // UID of the export archive generated for export tasks.int32 export_archive_uid = 6;- // The prior backup detail that will be used to rollback the task run.+ // Backup details that can be used to rollback changes.PriorBackupDetail prior_backup_detail = 7;}+// PriorBackupDetail contains information about automatic backups created before migration.message PriorBackupDetail {+ // Item represents a single backup operation for a table.message Item {+ // Table identifies a database table.message Table {- // The database information.+ // The database containing the table.// Format: instances/{instance}/databases/{database}string database = 1;+ // Schema name (for databases that support schemas).string schema = 2;+ // Table name.string table = 3;}- // The original table information.+ // The original table that was backed up.Table source_table = 1;- // The target backup table information.+ // The backup table where data was copied.Table target_table = 2;+ // Starting position in SQL for this backup operation.Position start_position = 3;+ // Ending position in SQL for this backup operation.Position end_position = 4;}+ // List of backup operations performed.repeated Item items = 1;}+// SchedulerInfo contains information about task scheduling and execution delays.message SchedulerInfo {+ // Timestamp when the scheduler reported this information.google.protobuf.Timestamp report_time = 1;+ // WaitingCause indicates why a task run is waiting to execute.message WaitingCause {oneof cause {+ // Task is waiting due to database connection limit.bool connection_limit = 1;+ // Task is waiting for another task to complete.int32 task_uid = 2;+ // Task is waiting due to parallel execution limit.bool parallel_tasks_limit = 3;}}+ // Reason why the task run is currently waiting.WaitingCause waiting_cause = 2;}diff --git a/proto/store/store/task_run_log.proto b/proto/store/store/task_run_log.protoindex c137130fae..26b2cc5167 100644--- a/proto/store/store/task_run_log.proto+++ b/proto/store/store/task_run_log.proto@@ -67,9 +67,9 @@ message TaskRunLog {Status status = 1;enum Status {STATUS_UNSPECIFIED = 0;- // the task run is ready to be executed by the scheduler+ // The task run is ready to be executed by the scheduler.RUNNING_WAITING = 1;- // the task run is being executed by the scheduler+ // The task run is being executed by the scheduler.RUNNING_RUNNING = 2;}}diff --git a/proto/store/store/user.proto b/proto/store/store/user.protoindex 23433f91c8..c6e8f628c3 100644--- a/proto/store/store/user.proto+++ b/proto/store/store/user.proto@@ -22,19 +22,19 @@ message MFAConfig {// The otp_secret is the secret key used to validate the OTP code.string otp_secret = 1;- // The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two phase commits.+ // The temp_otp_secret is the temporary secret key used to validate the OTP code and will replace the otp_secret in two-phase commits.string temp_otp_secret = 2;- // The recovery_codes are the codes that can be used to recover the account.+ // The recovery_codes are the codes that can be used to recover the account.repeated string recovery_codes = 3;- // The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two phase commits.+ // The temp_recovery_codes are the temporary codes that will replace the recovery_codes in two-phase commits.repeated string temp_recovery_codes = 4;}message UserProfile {google.protobuf.Timestamp last_login_time = 1;google.protobuf.Timestamp last_change_password_time = 2;- // source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.+ // The source indicates where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.string source = 3;}diff --git a/proto/v1/v1/auth_service.proto b/proto/v1/v1/auth_service.protoindex 0862e842f0..a5b042079f 100644--- a/proto/v1/v1/auth_service.proto+++ b/proto/v1/v1/auth_service.proto@@ -90,7 +90,7 @@ message LoginResponse {// Whether user must reset password before continuing.bool require_reset_password = 3;- // The user of successful login.+ // The user from the successful login.User user = 4;}diff --git a/proto/v1/v1/changelist_service.proto b/proto/v1/v1/changelist_service.protoindex 401122799d..a5a7839b71 100644--- a/proto/v1/v1/changelist_service.proto+++ b/proto/v1/v1/changelist_service.proto@@ -107,17 +107,17 @@ message ListChangelistsRequest {];// Pagination is not currently implemented. This field is reserved for future use.- // The maximum number of databases to return. The service may return fewer than+ // The maximum number of changelists to return. The service may return fewer than// this value.- // If unspecified, at most 50 databases will be returned.+ // If unspecified, at most 50 changelists will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 2;// Pagination is not currently implemented. This field is reserved for future use.- // A page token, received from a previous `ListDatabases` call.+ // A page token, received from a previous `ListChangelists` call.// Provide this to retrieve the subsequent page.//- // When paginating, all other parameters provided to `ListDatabases` must match+ // When paginating, all other parameters provided to `ListChangelists` must match// the call that provided the page token.string page_token = 3;}@@ -186,6 +186,7 @@ message Changelist {// A single change in a changelist.message Change {// The sheet containing the SQL statement.+ // Format: projects/{project}/sheets/{sheet}string sheet = 1;// The source of this change.// Format: instances/{instance}/databases/{database}/changelogs/{changelog}diff --git a/proto/v1/v1/database_service.proto b/proto/v1/v1/database_service.protoindex e60cf3c909..1d98736351 100644--- a/proto/v1/v1/database_service.proto+++ b/proto/v1/v1/database_service.proto@@ -992,7 +992,7 @@ message ProcedureMetadata {string definition = 2;// The signature is the name with the number and type of input arguments the- // function takes.+ // procedure takes.string signature = 3;// MySQL specific metadata.diff --git a/proto/v1/v1/iam_policy.proto b/proto/v1/v1/iam_policy.protoindex a388ca8c33..1605e0b4f6 100644--- a/proto/v1/v1/iam_policy.proto+++ b/proto/v1/v1/iam_policy.proto@@ -43,7 +43,7 @@ message IamPolicy {repeated Binding bindings = 1;// The current etag of the policy.- // If an etag is provided and does not match the current etag of the poliy,+ // 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.string etag = 2;}diff --git a/proto/v1/v1/idp_service.proto b/proto/v1/v1/idp_service.protoindex ed08e65415..69fabd6b56 100644--- a/proto/v1/v1/idp_service.proto+++ b/proto/v1/v1/idp_service.proto@@ -283,10 +283,10 @@ message OIDCIdentityProviderConfig {// LDAPIdentityProviderConfig is the structure for LDAP identity provider config.message LDAPIdentityProviderConfig {- // Host is the hostname or IP address of the LDAP server, e.g.+ // Host is the hostname or IP address of the LDAP server, e.g.,// "ldap.example.com".string host = 1;- // Port is the port number of the LDAP server, e.g. 389. When not set, the+ // Port is the port number of the LDAP server, e.g., 389. When not set, the// default port of the corresponding security protocol will be used, i.e. 389// for StartTLS and 636 for LDAPS.int32 port = 2;@@ -297,9 +297,9 @@ message LDAPIdentityProviderConfig {string bind_dn = 4;// BindPassword is the password of the user to bind as a service account.string bind_password = 5;- // BaseDN is the base DN to search for users, e.g. "ou=users,dc=example,dc=com".+ // BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com".string base_dn = 6;- // UserFilter is the filter to search for users, e.g. "(uid=%s)".+ // UserFilter is the filter to search for users, e.g., "(uid=%s)".string user_filter = 7;// SecurityProtocol is the security protocol to be used for establishing// connections with the LDAP server.diff --git a/proto/v1/v1/instance_role_service.proto b/proto/v1/v1/instance_role_service.protoindex 4dc8ae5200..333c5590da 100644--- a/proto/v1/v1/instance_role_service.proto+++ b/proto/v1/v1/instance_role_service.proto@@ -102,7 +102,7 @@ message InstanceRole {optional string valid_until = 5;// The role attribute.- // For PostgreSQL, it containt 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 PostgreSQL, it contains super_user, no_inherit, create_role, create_db, can_login, replication, and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html// For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON *.* TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.htmloptional string attribute = 6;}diff --git a/proto/v1/v1/instance_service.proto b/proto/v1/v1/instance_service.protoindex b1c4dc6017..444dc45102 100644--- a/proto/v1/v1/instance_service.proto+++ b/proto/v1/v1/instance_service.proto@@ -306,7 +306,7 @@ message SyncInstanceRequest {];// 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 instances will be synced.+ // the instance metadata (such as the database list) and any newly discovered databases will be synced.bool enable_full_sync = 2;}diff --git a/proto/v1/v1/issue_service.proto b/proto/v1/v1/issue_service.protoindex 93d2ffbe66..afa85912a4 100644--- a/proto/v1/v1/issue_service.proto+++ b/proto/v1/v1/issue_service.proto@@ -323,7 +323,7 @@ message ApproveIssueRequest {}message RejectIssueRequest {- // The name of the issue to add an rejection.+ // The name of the issue to add a rejection.// Format: projects/{project}/issues/{issue}string name = 1 [(google.api.field_behavior) = REQUIRED,@@ -480,7 +480,7 @@ message GrantRequest {// The user to be granted.// Format: users/{email}.string user = 2;- // The condition for the role. Same as the condtion in IAM Binding message.+ // The condition for the role. Same as the condition in IAM Binding message.google.type.Expr condition = 3;// The duration for which the grant is valid.google.protobuf.Duration expiration = 4;diff --git a/proto/v1/v1/release_service.proto b/proto/v1/v1/release_service.protoindex 5a85489a29..acb8b7fb60 100644--- a/proto/v1/v1/release_service.proto+++ b/proto/v1/v1/release_service.proto@@ -294,7 +294,7 @@ message Release {message File {// The unique identifier for the file.string id = 1;- // The path of the file. e.g. `2.2/V0001_create_table.sql`.+ // The path of the file. e.g., `2.2/V0001_create_table.sql`.string path = 2;// The type of the file.Type type = 5;@@ -345,7 +345,7 @@ message Release {message VCSSource {// The type of VCS.VCSType vcs_type = 1;- // The url link to the e.g. GitHub commit or pull request.+ // The url link to the e.g., GitHub commit or pull request.string url = 2;}}diff --git a/proto/v1/v1/review_config_service.proto b/proto/v1/v1/review_config_service.protoindex 9909a09f92..fe10511ba5 100644--- a/proto/v1/v1/review_config_service.proto+++ b/proto/v1/v1/review_config_service.proto@@ -69,9 +69,9 @@ service ReviewConfigService {message ListReviewConfigsRequest {// Pagination is not currently implemented. This field is reserved for future use.- // The maximum number of sql review to return. The service may return fewer than+ // The maximum number of SQL review configs to return. The service may return fewer than// this value.- // If unspecified, at most 10 sql review will be returned.+ // If unspecified, at most 10 SQL review configs will be returned.// The maximum value is 1000; values above 1000 will be coerced to 1000.int32 page_size = 1;@@ -84,7 +84,7 @@ message ListReviewConfigsRequest {}message ListReviewConfigsResponse {- // The sql review from the specified request.+ // The SQL review configs from the specified request.repeated ReviewConfig review_configs = 1;// A token, which can be sent as `page_token` to retrieve the next page.@@ -93,14 +93,14 @@ message ListReviewConfigsResponse {}message CreateReviewConfigRequest {- // The sql review to create.+ // The SQL review config to create.ReviewConfig review_config = 1 [(google.api.field_behavior) = REQUIRED];}message UpdateReviewConfigRequest {- // The sql review to update.+ // The SQL review config to update.//- // The name field is used to identify the sql review to update.+ // The name field is used to identify the SQL review config to update.ReviewConfig review_config = 1 [(google.api.field_behavior) = REQUIRED];// The list of fields to update.@@ -112,7 +112,7 @@ message UpdateReviewConfigRequest {}message GetReviewConfigRequest {- // The name of the sql review to retrieve.+ // The name of the SQL review config to retrieve.// Format: reviewConfigs/{reviewConfig}string name = 1 [(google.api.field_behavior) = REQUIRED,@@ -121,7 +121,7 @@ message GetReviewConfigRequest {}message DeleteReviewConfigRequest {- // The name of the sql review to delete.+ // The name of the SQL review config to delete.// Format: reviewConfigs/{reviewConfig}string name = 1 [(google.api.field_behavior) = REQUIRED,@@ -135,7 +135,7 @@ message ReviewConfig {pattern: "reviewConfigs/{reviewConfig}"};- // The name of the sql review to retrieve.+ // The name of the SQL review config.// Format: reviewConfigs/{reviewConfig}string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];@@ -148,7 +148,7 @@ message ReviewConfig {// The SQL review rules to enforce.repeated SQLReviewRule rules = 7;- // resources using the config.- // Format: {resource}/{resource id}, for example, environments/test.+ // Resources using the config.+ // Format: {resource}/{resource id}, e.g., environments/test.repeated string resources = 8;}diff --git a/proto/v1/v1/risk_service.proto b/proto/v1/v1/risk_service.protoindex 2030374e56..7458b426b9 100644--- a/proto/v1/v1/risk_service.proto+++ b/proto/v1/v1/risk_service.proto@@ -144,14 +144,21 @@ message Risk {// Format: risks/{risk}string name = 1;+ // The source of the database change for risk assessment.enum Source {SOURCE_UNSPECIFIED = 0;+ // Data Definition Language statements (CREATE, ALTER, DROP, etc.).DDL = 1;+ // Data Manipulation Language statements (INSERT, UPDATE, DELETE, etc.).DML = 2;+ // Database creation operations.CREATE_DATABASE = 3;+ // Data export operations.DATA_EXPORT = 6;+ // Role access requests.REQUEST_ROLE = 7;}+ // The source of the operation being assessed for risk.Source source = 3;// The title of the risk rule.diff --git a/proto/v1/v1/rollout_service.proto b/proto/v1/v1/rollout_service.protoindex e8bd8a382d..92be0cca32 100644--- a/proto/v1/v1/rollout_service.proto+++ b/proto/v1/v1/rollout_service.proto@@ -346,7 +346,7 @@ message Rollout {// This field is output only and cannot be directly set.string title = 4 [(google.api.field_behavior) = OUTPUT_ONLY];- // stages and thus tasks of the rollout.+ // Stages and thus tasks of the rollout.repeated Stage stages = 5;// Format: users/[email protected]@@ -374,7 +374,7 @@ message Stage {string name = 1;// id is the environment id of the stage.- // e.g. "prod".+ // e.g., "prod".// Use "-" when the stage has no environment or deleted environment.string id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];@@ -467,9 +467,9 @@ message Task {// The project owning the database.// Format: projects/{project}string project = 1;- // database name+ // Database name.string database = 2;- // table name+ // Table name.string table = 3;// Format: projects/{project}/sheets/{sheet}string sheet = 4;@@ -746,9 +746,9 @@ message TaskRunLogEntry {enum Status {// Unspecified status.STATUS_UNSPECIFIED = 0;- // the task run is ready to be executed by the scheduler+ // The task run is ready to be executed by the scheduler.RUNNING_WAITING = 1;- // the task run is being executed by the scheduler+ // The task run is being executed by the scheduler.RUNNING_RUNNING = 2;}}diff --git a/proto/v1/v1/setting_service.proto b/proto/v1/v1/setting_service.protoindex d2d058a465..f3da06e98a 100644--- a/proto/v1/v1/setting_service.proto+++ b/proto/v1/v1/setting_service.proto@@ -219,7 +219,7 @@ message WorkspaceProfileSetting {// The max duration for role expired.google.protobuf.Duration maximum_role_expiration = 8;- // The workspace domain, e.g. bytebase.com.+ // The workspace domain, e.g., bytebase.com.repeated string domains = 9;// Only user and group from the domains can be created and login.diff --git a/proto/v1/v1/sheet_service.proto b/proto/v1/v1/sheet_service.protoindex 80d2a47946..9e5895fa01 100644--- a/proto/v1/v1/sheet_service.proto+++ b/proto/v1/v1/sheet_service.proto@@ -108,7 +108,7 @@ message UpdateSheetRequest {// The list of fields to be updated.// Fields are specified relative to the sheet.- // (e.g. `title`, `statement`; *not* `sheet.title` or `sheet.statement`)+ // (e.g., `title`, `statement`; *not* `sheet.title` or `sheet.statement`)// Only support update the following fields for now:// - `title`// - `statement`diff --git a/proto/v1/v1/worksheet_service.proto b/proto/v1/v1/worksheet_service.protoindex e9144af627..85c00881aa 100644--- a/proto/v1/v1/worksheet_service.proto+++ b/proto/v1/v1/worksheet_service.proto@@ -106,7 +106,7 @@ message UpdateWorksheetRequest {// The list of fields to be updated.// Fields are specified relative to the worksheet.- // (e.g. `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)+ // (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)// Only support update the following fields for now:// - `title`// - `statement`